1 /*- 2 * Copyright (c) 1997,1998 Doug Rabson 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #include "opt_bus.h" 30 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> 36 #include <sys/kobj.h> 37 #include <sys/bus_private.h> 38 #include <sys/sysctl.h> 39 #include <sys/systm.h> 40 #include <machine/bus.h> 41 #include <sys/rman.h> 42 #include <machine/stdarg.h> /* for device_printf() */ 43 44 static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures"); 45 46 #ifdef BUS_DEBUG 47 48 static int bus_debug = 1; 49 SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RW, &bus_debug, 0, 50 "Debug bus code"); 51 52 #define PDEBUG(a) if (bus_debug) {printf(__FUNCTION__ ":%d: ", __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") 56 57 /* Produce the indenting, indent*2 spaces plus a '.' ahead of that to 58 * prevent syslog from deleting initial spaces 59 */ 60 #define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0) 61 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); 73 74 #else 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 */ 80 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 */ 92 #endif 93 94 TAILQ_HEAD(,device) bus_data_devices; 95 static int bus_data_generation = 1; 96 97 kobj_method_t null_methods[] = { 98 { 0, 0 } 99 }; 100 101 DEFINE_CLASS(null, null_methods, 0); 102 103 /* 104 * Devclass implementation 105 */ 106 107 static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses); 108 109 static devclass_t 110 devclass_find_internal(const char *classname, int create) 111 { 112 devclass_t dc; 113 114 PDEBUG(("looking for %s", classname)); 115 if (!classname) 116 return (NULL); 117 118 TAILQ_FOREACH(dc, &devclasses, link) { 119 if (!strcmp(dc->name, classname)) 120 return (dc); 121 } 122 123 PDEBUG(("%s not found%s", classname, (create? ", creating": ""))); 124 if (create) { 125 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1, 126 M_BUS, M_NOWAIT|M_ZERO); 127 if (!dc) 128 return (NULL); 129 dc->name = (char*) (dc + 1); 130 strcpy(dc->name, classname); 131 dc->devices = NULL; 132 dc->maxunit = 0; 133 TAILQ_INIT(&dc->drivers); 134 TAILQ_INSERT_TAIL(&devclasses, dc, link); 135 136 bus_data_generation_update(); 137 } 138 139 return (dc); 140 } 141 142 devclass_t 143 devclass_create(const char *classname) 144 { 145 return (devclass_find_internal(classname, TRUE)); 146 } 147 148 devclass_t 149 devclass_find(const char *classname) 150 { 151 return (devclass_find_internal(classname, FALSE)); 152 } 153 154 int 155 devclass_add_driver(devclass_t dc, driver_t *driver) 156 { 157 driverlink_t dl; 158 int i; 159 160 PDEBUG(("%s", DRIVERNAME(driver))); 161 162 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO); 163 if (!dl) 164 return (ENOMEM); 165 166 /* 167 * Compile the driver's methods. Also increase the reference count 168 * so that the class doesn't get freed when the last instance 169 * goes. This means we can safely use static methods and avoids a 170 * double-free in devclass_delete_driver. 171 */ 172 kobj_class_compile((kobj_class_t) driver); 173 174 /* 175 * Make sure the devclass which the driver is implementing exists. 176 */ 177 devclass_find_internal(driver->name, TRUE); 178 179 dl->driver = driver; 180 TAILQ_INSERT_TAIL(&dc->drivers, dl, link); 181 driver->refs++; 182 183 /* 184 * Call BUS_DRIVER_ADDED for any existing busses in this class. 185 */ 186 for (i = 0; i < dc->maxunit; i++) 187 if (dc->devices[i]) 188 BUS_DRIVER_ADDED(dc->devices[i], driver); 189 190 bus_data_generation_update(); 191 return (0); 192 } 193 194 int 195 devclass_delete_driver(devclass_t busclass, driver_t *driver) 196 { 197 devclass_t dc = devclass_find(driver->name); 198 driverlink_t dl; 199 device_t dev; 200 int i; 201 int error; 202 203 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass))); 204 205 if (!dc) 206 return (0); 207 208 /* 209 * Find the link structure in the bus' list of drivers. 210 */ 211 TAILQ_FOREACH(dl, &busclass->drivers, link) { 212 if (dl->driver == driver) 213 break; 214 } 215 216 if (!dl) { 217 PDEBUG(("%s not found in %s list", driver->name, 218 busclass->name)); 219 return (ENOENT); 220 } 221 222 /* 223 * Disassociate from any devices. We iterate through all the 224 * devices in the devclass of the driver and detach any which are 225 * using the driver and which have a parent in the devclass which 226 * we are deleting from. 227 * 228 * Note that since a driver can be in multiple devclasses, we 229 * should not detach devices which are not children of devices in 230 * the affected devclass. 231 */ 232 for (i = 0; i < dc->maxunit; i++) { 233 if (dc->devices[i]) { 234 dev = dc->devices[i]; 235 if (dev->driver == driver && dev->parent && 236 dev->parent->devclass == busclass) { 237 if ((error = device_detach(dev)) != 0) 238 return (error); 239 device_set_driver(dev, NULL); 240 } 241 } 242 } 243 244 TAILQ_REMOVE(&busclass->drivers, dl, link); 245 free(dl, M_BUS); 246 247 driver->refs--; 248 if (driver->refs == 0) 249 kobj_class_free((kobj_class_t) driver); 250 251 bus_data_generation_update(); 252 return (0); 253 } 254 255 static driverlink_t 256 devclass_find_driver_internal(devclass_t dc, const char *classname) 257 { 258 driverlink_t dl; 259 260 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc))); 261 262 TAILQ_FOREACH(dl, &dc->drivers, link) { 263 if (!strcmp(dl->driver->name, classname)) 264 return (dl); 265 } 266 267 PDEBUG(("not found")); 268 return (NULL); 269 } 270 271 driver_t * 272 devclass_find_driver(devclass_t dc, const char *classname) 273 { 274 driverlink_t dl; 275 276 dl = devclass_find_driver_internal(dc, classname); 277 if (dl) 278 return (dl->driver); 279 return (NULL); 280 } 281 282 const char * 283 devclass_get_name(devclass_t dc) 284 { 285 return (dc->name); 286 } 287 288 device_t 289 devclass_get_device(devclass_t dc, int unit) 290 { 291 if (dc == NULL || unit < 0 || unit >= dc->maxunit) 292 return (NULL); 293 return (dc->devices[unit]); 294 } 295 296 void * 297 devclass_get_softc(devclass_t dc, int unit) 298 { 299 device_t dev; 300 301 dev = devclass_get_device(dc, unit); 302 if (!dev) 303 return (NULL); 304 305 return (device_get_softc(dev)); 306 } 307 308 int 309 devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp) 310 { 311 int i; 312 int count; 313 device_t *list; 314 315 count = 0; 316 for (i = 0; i < dc->maxunit; i++) 317 if (dc->devices[i]) 318 count++; 319 320 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO); 321 if (!list) 322 return (ENOMEM); 323 324 count = 0; 325 for (i = 0; i < dc->maxunit; i++) { 326 if (dc->devices[i]) { 327 list[count] = dc->devices[i]; 328 count++; 329 } 330 } 331 332 *devlistp = list; 333 *devcountp = count; 334 335 return (0); 336 } 337 338 int 339 devclass_get_maxunit(devclass_t dc) 340 { 341 return (dc->maxunit); 342 } 343 344 int 345 devclass_find_free_unit(devclass_t dc, int unit) 346 { 347 if (dc == NULL) 348 return (unit); 349 while (unit < dc->maxunit && dc->devices[unit] != NULL) 350 unit++; 351 return (unit); 352 } 353 354 static int 355 devclass_alloc_unit(devclass_t dc, int *unitp) 356 { 357 int unit = *unitp; 358 359 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc))); 360 361 /* If we were given a wired unit number, check for existing device */ 362 /* XXX imp XXX */ 363 if (unit != -1) { 364 if (unit >= 0 && unit < dc->maxunit && 365 dc->devices[unit] != NULL) { 366 if (bootverbose) 367 printf("%s-: %s%d already exists, skipping it\n", 368 dc->name, dc->name, *unitp); 369 return (EEXIST); 370 } 371 } else { 372 /* Unwired device, find the next available slot for it */ 373 unit = 0; 374 while (unit < dc->maxunit && dc->devices[unit] != NULL) 375 unit++; 376 } 377 378 /* 379 * We've selected a unit beyond the length of the table, so let's 380 * extend the table to make room for all units up to and including 381 * this one. 382 */ 383 if (unit >= dc->maxunit) { 384 device_t *newlist; 385 int newsize; 386 387 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t)); 388 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT); 389 if (!newlist) 390 return (ENOMEM); 391 bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit); 392 bzero(newlist + dc->maxunit, 393 sizeof(device_t) * (newsize - dc->maxunit)); 394 if (dc->devices) 395 free(dc->devices, M_BUS); 396 dc->devices = newlist; 397 dc->maxunit = newsize; 398 } 399 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc))); 400 401 *unitp = unit; 402 return (0); 403 } 404 405 static int 406 devclass_add_device(devclass_t dc, device_t dev) 407 { 408 int buflen, error; 409 410 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc))); 411 412 buflen = strlen(dc->name) + 5; 413 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO); 414 if (!dev->nameunit) 415 return (ENOMEM); 416 417 if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) { 418 free(dev->nameunit, M_BUS); 419 dev->nameunit = NULL; 420 return (error); 421 } 422 dc->devices[dev->unit] = dev; 423 dev->devclass = dc; 424 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit); 425 426 return (0); 427 } 428 429 static int 430 devclass_delete_device(devclass_t dc, device_t dev) 431 { 432 if (!dc || !dev) 433 return (0); 434 435 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc))); 436 437 if (dev->devclass != dc || dc->devices[dev->unit] != dev) 438 panic("devclass_delete_device: inconsistent device class"); 439 dc->devices[dev->unit] = NULL; 440 if (dev->flags & DF_WILDCARD) 441 dev->unit = -1; 442 dev->devclass = NULL; 443 free(dev->nameunit, M_BUS); 444 dev->nameunit = NULL; 445 446 return (0); 447 } 448 449 static device_t 450 make_device(device_t parent, const char *name, int unit) 451 { 452 device_t dev; 453 devclass_t dc; 454 455 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit)); 456 457 if (name) { 458 dc = devclass_find_internal(name, TRUE); 459 if (!dc) { 460 printf("make_device: can't find device class %s\n", 461 name); 462 return (NULL); 463 } 464 } else { 465 dc = NULL; 466 } 467 468 dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO); 469 if (!dev) 470 return (NULL); 471 472 dev->parent = parent; 473 TAILQ_INIT(&dev->children); 474 kobj_init((kobj_t) dev, &null_class); 475 dev->driver = NULL; 476 dev->devclass = NULL; 477 dev->unit = unit; 478 dev->nameunit = NULL; 479 dev->desc = NULL; 480 dev->busy = 0; 481 dev->devflags = 0; 482 dev->flags = DF_ENABLED; 483 dev->order = 0; 484 if (unit == -1) 485 dev->flags |= DF_WILDCARD; 486 if (name) { 487 dev->flags |= DF_FIXEDCLASS; 488 if (devclass_add_device(dc, dev)) { 489 kobj_delete((kobj_t) dev, M_BUS); 490 return (NULL); 491 } 492 } 493 dev->ivars = NULL; 494 dev->softc = NULL; 495 496 dev->state = DS_NOTPRESENT; 497 498 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink); 499 bus_data_generation_update(); 500 501 return (dev); 502 } 503 504 static int 505 device_print_child(device_t dev, device_t child) 506 { 507 int retval = 0; 508 509 if (device_is_alive(child)) 510 retval += BUS_PRINT_CHILD(dev, child); 511 else 512 retval += device_printf(child, " not found\n"); 513 514 return (retval); 515 } 516 517 device_t 518 device_add_child(device_t dev, const char *name, int unit) 519 { 520 return (device_add_child_ordered(dev, 0, name, unit)); 521 } 522 523 device_t 524 device_add_child_ordered(device_t dev, int order, const char *name, int unit) 525 { 526 device_t child; 527 device_t place; 528 529 PDEBUG(("%s at %s with order %d as unit %d", 530 name, DEVICENAME(dev), order, unit)); 531 532 child = make_device(dev, name, unit); 533 if (child == NULL) 534 return (child); 535 child->order = order; 536 537 TAILQ_FOREACH(place, &dev->children, link) { 538 if (place->order > order) 539 break; 540 } 541 542 if (place) { 543 /* 544 * The device 'place' is the first device whose order is 545 * greater than the new child. 546 */ 547 TAILQ_INSERT_BEFORE(place, child, link); 548 } else { 549 /* 550 * The new child's order is greater or equal to the order of 551 * any existing device. Add the child to the tail of the list. 552 */ 553 TAILQ_INSERT_TAIL(&dev->children, child, link); 554 } 555 556 bus_data_generation_update(); 557 return (child); 558 } 559 560 int 561 device_delete_child(device_t dev, device_t child) 562 { 563 int error; 564 device_t grandchild; 565 566 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev))); 567 568 /* remove children first */ 569 while ( (grandchild = TAILQ_FIRST(&child->children)) ) { 570 error = device_delete_child(child, grandchild); 571 if (error) 572 return (error); 573 } 574 575 if ((error = device_detach(child)) != 0) 576 return (error); 577 if (child->devclass) 578 devclass_delete_device(child->devclass, child); 579 TAILQ_REMOVE(&dev->children, child, link); 580 TAILQ_REMOVE(&bus_data_devices, child, devlink); 581 device_set_desc(child, NULL); 582 free(child, M_BUS); 583 584 bus_data_generation_update(); 585 return (0); 586 } 587 588 /* 589 * Find only devices attached to this bus. 590 */ 591 device_t 592 device_find_child(device_t dev, const char *classname, int unit) 593 { 594 devclass_t dc; 595 device_t child; 596 597 dc = devclass_find(classname); 598 if (!dc) 599 return (NULL); 600 601 child = devclass_get_device(dc, unit); 602 if (child && child->parent == dev) 603 return (child); 604 return (NULL); 605 } 606 607 static driverlink_t 608 first_matching_driver(devclass_t dc, device_t dev) 609 { 610 if (dev->devclass) 611 return (devclass_find_driver_internal(dc, dev->devclass->name)); 612 return (TAILQ_FIRST(&dc->drivers)); 613 } 614 615 static driverlink_t 616 next_matching_driver(devclass_t dc, device_t dev, driverlink_t last) 617 { 618 if (dev->devclass) { 619 driverlink_t dl; 620 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link)) 621 if (!strcmp(dev->devclass->name, dl->driver->name)) 622 return (dl); 623 return (NULL); 624 } 625 return (TAILQ_NEXT(last, link)); 626 } 627 628 static int 629 device_probe_child(device_t dev, device_t child) 630 { 631 devclass_t dc; 632 driverlink_t best = 0; 633 driverlink_t dl; 634 int result, pri = 0; 635 int hasclass = (child->devclass != 0); 636 637 dc = dev->devclass; 638 if (!dc) 639 panic("device_probe_child: parent device has no devclass"); 640 641 if (child->state == DS_ALIVE) 642 return (0); 643 644 for (dl = first_matching_driver(dc, child); 645 dl; 646 dl = next_matching_driver(dc, child, dl)) { 647 PDEBUG(("Trying %s", DRIVERNAME(dl->driver))); 648 device_set_driver(child, dl->driver); 649 if (!hasclass) 650 device_set_devclass(child, dl->driver->name); 651 result = DEVICE_PROBE(child); 652 if (!hasclass) 653 device_set_devclass(child, 0); 654 655 /* 656 * If the driver returns SUCCESS, there can be no higher match 657 * for this device. 658 */ 659 if (result == 0) { 660 best = dl; 661 pri = 0; 662 break; 663 } 664 665 /* 666 * The driver returned an error so it certainly doesn't match. 667 */ 668 if (result > 0) { 669 device_set_driver(child, 0); 670 continue; 671 } 672 673 /* 674 * A priority lower than SUCCESS, remember the best matching 675 * driver. Initialise the value of pri for the first match. 676 */ 677 if (best == 0 || result > pri) { 678 best = dl; 679 pri = result; 680 continue; 681 } 682 } 683 684 /* 685 * If we found a driver, change state and initialise the devclass. 686 */ 687 if (best) { 688 if (!child->devclass) 689 device_set_devclass(child, best->driver->name); 690 device_set_driver(child, best->driver); 691 if (pri < 0) { 692 /* 693 * A bit bogus. Call the probe method again to make 694 * sure that we have the right description. 695 */ 696 DEVICE_PROBE(child); 697 } 698 child->state = DS_ALIVE; 699 700 bus_data_generation_update(); 701 return (0); 702 } 703 704 return (ENXIO); 705 } 706 707 device_t 708 device_get_parent(device_t dev) 709 { 710 return (dev->parent); 711 } 712 713 int 714 device_get_children(device_t dev, device_t **devlistp, int *devcountp) 715 { 716 int count; 717 device_t child; 718 device_t *list; 719 720 count = 0; 721 TAILQ_FOREACH(child, &dev->children, link) { 722 count++; 723 } 724 725 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO); 726 if (!list) 727 return (ENOMEM); 728 729 count = 0; 730 TAILQ_FOREACH(child, &dev->children, link) { 731 list[count] = child; 732 count++; 733 } 734 735 *devlistp = list; 736 *devcountp = count; 737 738 return (0); 739 } 740 741 driver_t * 742 device_get_driver(device_t dev) 743 { 744 return (dev->driver); 745 } 746 747 devclass_t 748 device_get_devclass(device_t dev) 749 { 750 return (dev->devclass); 751 } 752 753 const char * 754 device_get_name(device_t dev) 755 { 756 if (dev->devclass) 757 return (devclass_get_name(dev->devclass)); 758 return (NULL); 759 } 760 761 const char * 762 device_get_nameunit(device_t dev) 763 { 764 return (dev->nameunit); 765 } 766 767 int 768 device_get_unit(device_t dev) 769 { 770 return (dev->unit); 771 } 772 773 const char * 774 device_get_desc(device_t dev) 775 { 776 return (dev->desc); 777 } 778 779 u_int32_t 780 device_get_flags(device_t dev) 781 { 782 return (dev->devflags); 783 } 784 785 int 786 device_print_prettyname(device_t dev) 787 { 788 const char *name = device_get_name(dev); 789 790 if (name == 0) 791 return (printf("unknown: ")); 792 return (printf("%s%d: ", name, device_get_unit(dev))); 793 } 794 795 int 796 device_printf(device_t dev, const char * fmt, ...) 797 { 798 va_list ap; 799 int retval; 800 801 retval = device_print_prettyname(dev); 802 va_start(ap, fmt); 803 retval += vprintf(fmt, ap); 804 va_end(ap); 805 return (retval); 806 } 807 808 static void 809 device_set_desc_internal(device_t dev, const char* desc, int copy) 810 { 811 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) { 812 free(dev->desc, M_BUS); 813 dev->flags &= ~DF_DESCMALLOCED; 814 dev->desc = NULL; 815 } 816 817 if (copy && desc) { 818 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT); 819 if (dev->desc) { 820 strcpy(dev->desc, desc); 821 dev->flags |= DF_DESCMALLOCED; 822 } 823 } else { 824 /* Avoid a -Wcast-qual warning */ 825 dev->desc = (char *)(uintptr_t) desc; 826 } 827 828 bus_data_generation_update(); 829 } 830 831 void 832 device_set_desc(device_t dev, const char* desc) 833 { 834 device_set_desc_internal(dev, desc, FALSE); 835 } 836 837 void 838 device_set_desc_copy(device_t dev, const char* desc) 839 { 840 device_set_desc_internal(dev, desc, TRUE); 841 } 842 843 void 844 device_set_flags(device_t dev, u_int32_t flags) 845 { 846 dev->devflags = flags; 847 } 848 849 void * 850 device_get_softc(device_t dev) 851 { 852 return (dev->softc); 853 } 854 855 void 856 device_set_softc(device_t dev, void *softc) 857 { 858 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) 859 free(dev->softc, M_BUS); 860 dev->softc = softc; 861 if (dev->softc) 862 dev->flags |= DF_EXTERNALSOFTC; 863 else 864 dev->flags &= ~DF_EXTERNALSOFTC; 865 } 866 867 void * 868 device_get_ivars(device_t dev) 869 { 870 return (dev->ivars); 871 } 872 873 void 874 device_set_ivars(device_t dev, void * ivars) 875 { 876 if (!dev) 877 return; 878 879 dev->ivars = ivars; 880 881 return; 882 } 883 884 device_state_t 885 device_get_state(device_t dev) 886 { 887 return (dev->state); 888 } 889 890 void 891 device_enable(device_t dev) 892 { 893 dev->flags |= DF_ENABLED; 894 } 895 896 void 897 device_disable(device_t dev) 898 { 899 dev->flags &= ~DF_ENABLED; 900 } 901 902 void 903 device_busy(device_t dev) 904 { 905 if (dev->state < DS_ATTACHED) 906 panic("device_busy: called for unattached device"); 907 if (dev->busy == 0 && dev->parent) 908 device_busy(dev->parent); 909 dev->busy++; 910 dev->state = DS_BUSY; 911 } 912 913 void 914 device_unbusy(device_t dev) 915 { 916 if (dev->state != DS_BUSY) 917 panic("device_unbusy: called for non-busy device"); 918 dev->busy--; 919 if (dev->busy == 0) { 920 if (dev->parent) 921 device_unbusy(dev->parent); 922 dev->state = DS_ATTACHED; 923 } 924 } 925 926 void 927 device_quiet(device_t dev) 928 { 929 dev->flags |= DF_QUIET; 930 } 931 932 void 933 device_verbose(device_t dev) 934 { 935 dev->flags &= ~DF_QUIET; 936 } 937 938 int 939 device_is_quiet(device_t dev) 940 { 941 return ((dev->flags & DF_QUIET) != 0); 942 } 943 944 int 945 device_is_enabled(device_t dev) 946 { 947 return ((dev->flags & DF_ENABLED) != 0); 948 } 949 950 int 951 device_is_alive(device_t dev) 952 { 953 return (dev->state >= DS_ALIVE); 954 } 955 956 int 957 device_set_devclass(device_t dev, const char *classname) 958 { 959 devclass_t dc; 960 int error; 961 962 if (!classname) { 963 if (dev->devclass) 964 devclass_delete_device(dev->devclass, dev); 965 return (0); 966 } 967 968 if (dev->devclass) { 969 printf("device_set_devclass: device class already set\n"); 970 return (EINVAL); 971 } 972 973 dc = devclass_find_internal(classname, TRUE); 974 if (!dc) 975 return (ENOMEM); 976 977 error = devclass_add_device(dc, dev); 978 979 bus_data_generation_update(); 980 return (error); 981 } 982 983 int 984 device_set_driver(device_t dev, driver_t *driver) 985 { 986 if (dev->state >= DS_ATTACHED) 987 return (EBUSY); 988 989 if (dev->driver == driver) 990 return (0); 991 992 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) { 993 free(dev->softc, M_BUS); 994 dev->softc = NULL; 995 } 996 kobj_delete((kobj_t) dev, 0); 997 dev->driver = driver; 998 if (driver) { 999 kobj_init((kobj_t) dev, (kobj_class_t) driver); 1000 if (!(dev->flags & DF_EXTERNALSOFTC)) { 1001 dev->softc = malloc(driver->size, M_BUS, 1002 M_NOWAIT | M_ZERO); 1003 if (!dev->softc) { 1004 kobj_init((kobj_t) dev, &null_class); 1005 dev->driver = NULL; 1006 return (ENOMEM); 1007 } 1008 } 1009 } else { 1010 kobj_init((kobj_t) dev, &null_class); 1011 } 1012 1013 bus_data_generation_update(); 1014 return (0); 1015 } 1016 1017 int 1018 device_probe_and_attach(device_t dev) 1019 { 1020 device_t bus = dev->parent; 1021 int error = 0; 1022 int hasclass = (dev->devclass != 0); 1023 1024 if (dev->state >= DS_ALIVE) 1025 return (0); 1026 1027 if (dev->flags & DF_ENABLED) { 1028 error = device_probe_child(bus, dev); 1029 if (!error) { 1030 if (!device_is_quiet(dev)) 1031 device_print_child(bus, dev); 1032 error = DEVICE_ATTACH(dev); 1033 if (!error) 1034 dev->state = DS_ATTACHED; 1035 else { 1036 printf("device_probe_and_attach: %s%d attach returned %d\n", 1037 dev->driver->name, dev->unit, error); 1038 /* Unset the class; set in device_probe_child */ 1039 if (!hasclass) 1040 device_set_devclass(dev, 0); 1041 device_set_driver(dev, NULL); 1042 dev->state = DS_NOTPRESENT; 1043 } 1044 } else { 1045 if (!(dev->flags & DF_DONENOMATCH)) { 1046 BUS_PROBE_NOMATCH(bus, dev); 1047 dev->flags |= DF_DONENOMATCH; 1048 } 1049 } 1050 } else { 1051 if (bootverbose) { 1052 device_print_prettyname(dev); 1053 printf("not probed (disabled)\n"); 1054 } 1055 } 1056 1057 return (error); 1058 } 1059 1060 int 1061 device_detach(device_t dev) 1062 { 1063 int error; 1064 1065 PDEBUG(("%s", DEVICENAME(dev))); 1066 if (dev->state == DS_BUSY) 1067 return (EBUSY); 1068 if (dev->state != DS_ATTACHED) 1069 return (0); 1070 1071 if ((error = DEVICE_DETACH(dev)) != 0) 1072 return (error); 1073 device_printf(dev, "detached\n"); 1074 if (dev->parent) 1075 BUS_CHILD_DETACHED(dev->parent, dev); 1076 1077 if (!(dev->flags & DF_FIXEDCLASS)) 1078 devclass_delete_device(dev->devclass, dev); 1079 1080 dev->state = DS_NOTPRESENT; 1081 device_set_driver(dev, NULL); 1082 1083 return (0); 1084 } 1085 1086 int 1087 device_shutdown(device_t dev) 1088 { 1089 if (dev->state < DS_ATTACHED) 1090 return (0); 1091 return (DEVICE_SHUTDOWN(dev)); 1092 } 1093 1094 int 1095 device_set_unit(device_t dev, int unit) 1096 { 1097 devclass_t dc; 1098 int err; 1099 1100 dc = device_get_devclass(dev); 1101 if (unit < dc->maxunit && dc->devices[unit]) 1102 return (EBUSY); 1103 err = devclass_delete_device(dc, dev); 1104 if (err) 1105 return (err); 1106 dev->unit = unit; 1107 err = devclass_add_device(dc, dev); 1108 if (err) 1109 return (err); 1110 1111 bus_data_generation_update(); 1112 return (0); 1113 } 1114 1115 /*======================================*/ 1116 /* 1117 * Some useful method implementations to make life easier for bus drivers. 1118 */ 1119 1120 void 1121 resource_list_init(struct resource_list *rl) 1122 { 1123 SLIST_INIT(rl); 1124 } 1125 1126 void 1127 resource_list_free(struct resource_list *rl) 1128 { 1129 struct resource_list_entry *rle; 1130 1131 while ((rle = SLIST_FIRST(rl)) != NULL) { 1132 if (rle->res) 1133 panic("resource_list_free: resource entry is busy"); 1134 SLIST_REMOVE_HEAD(rl, link); 1135 free(rle, M_BUS); 1136 } 1137 } 1138 1139 void 1140 resource_list_add(struct resource_list *rl, int type, int rid, 1141 u_long start, u_long end, u_long count) 1142 { 1143 struct resource_list_entry *rle; 1144 1145 rle = resource_list_find(rl, type, rid); 1146 if (!rle) { 1147 rle = malloc(sizeof(struct resource_list_entry), M_BUS, 1148 M_NOWAIT); 1149 if (!rle) 1150 panic("resource_list_add: can't record entry"); 1151 SLIST_INSERT_HEAD(rl, rle, link); 1152 rle->type = type; 1153 rle->rid = rid; 1154 rle->res = NULL; 1155 } 1156 1157 if (rle->res) 1158 panic("resource_list_add: resource entry is busy"); 1159 1160 rle->start = start; 1161 rle->end = end; 1162 rle->count = count; 1163 } 1164 1165 struct resource_list_entry * 1166 resource_list_find(struct resource_list *rl, int type, int rid) 1167 { 1168 struct resource_list_entry *rle; 1169 1170 SLIST_FOREACH(rle, rl, link) { 1171 if (rle->type == type && rle->rid == rid) 1172 return (rle); 1173 } 1174 return (NULL); 1175 } 1176 1177 void 1178 resource_list_delete(struct resource_list *rl, int type, int rid) 1179 { 1180 struct resource_list_entry *rle = resource_list_find(rl, type, rid); 1181 1182 if (rle) { 1183 if (rle->res != NULL) 1184 panic("resource_list_delete: resource has not been released"); 1185 SLIST_REMOVE(rl, rle, resource_list_entry, link); 1186 free(rle, M_BUS); 1187 } 1188 } 1189 1190 struct resource * 1191 resource_list_alloc(struct resource_list *rl, device_t bus, device_t child, 1192 int type, int *rid, u_long start, u_long end, u_long count, u_int flags) 1193 { 1194 struct resource_list_entry *rle = 0; 1195 int passthrough = (device_get_parent(child) != bus); 1196 int isdefault = (start == 0UL && end == ~0UL); 1197 1198 if (passthrough) { 1199 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child, 1200 type, rid, start, end, count, flags)); 1201 } 1202 1203 rle = resource_list_find(rl, type, *rid); 1204 1205 if (!rle) 1206 return (NULL); /* no resource of that type/rid */ 1207 1208 if (rle->res) 1209 panic("resource_list_alloc: resource entry is busy"); 1210 1211 if (isdefault) { 1212 start = rle->start; 1213 count = max(count, rle->count); 1214 end = max(rle->end, start + count - 1); 1215 } 1216 1217 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, 1218 type, rid, start, end, count, flags); 1219 1220 /* 1221 * Record the new range. 1222 */ 1223 if (rle->res) { 1224 rle->start = rman_get_start(rle->res); 1225 rle->end = rman_get_end(rle->res); 1226 rle->count = count; 1227 } 1228 1229 return (rle->res); 1230 } 1231 1232 int 1233 resource_list_release(struct resource_list *rl, device_t bus, device_t child, 1234 int type, int rid, struct resource *res) 1235 { 1236 struct resource_list_entry *rle = 0; 1237 int passthrough = (device_get_parent(child) != bus); 1238 int error; 1239 1240 if (passthrough) { 1241 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child, 1242 type, rid, res)); 1243 } 1244 1245 rle = resource_list_find(rl, type, rid); 1246 1247 if (!rle) 1248 panic("resource_list_release: can't find resource"); 1249 if (!rle->res) 1250 panic("resource_list_release: resource entry is not busy"); 1251 1252 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, 1253 type, rid, res); 1254 if (error) 1255 return (error); 1256 1257 rle->res = NULL; 1258 return (0); 1259 } 1260 1261 /* 1262 * Call DEVICE_IDENTIFY for each driver. 1263 */ 1264 int 1265 bus_generic_probe(device_t dev) 1266 { 1267 devclass_t dc = dev->devclass; 1268 driverlink_t dl; 1269 1270 TAILQ_FOREACH(dl, &dc->drivers, link) { 1271 DEVICE_IDENTIFY(dl->driver, dev); 1272 } 1273 1274 return (0); 1275 } 1276 1277 int 1278 bus_generic_attach(device_t dev) 1279 { 1280 device_t child; 1281 1282 TAILQ_FOREACH(child, &dev->children, link) { 1283 device_probe_and_attach(child); 1284 } 1285 1286 return (0); 1287 } 1288 1289 int 1290 bus_generic_detach(device_t dev) 1291 { 1292 device_t child; 1293 int error; 1294 1295 if (dev->state != DS_ATTACHED) 1296 return (EBUSY); 1297 1298 TAILQ_FOREACH(child, &dev->children, link) { 1299 if ((error = device_detach(child)) != 0) 1300 return (error); 1301 } 1302 1303 return (0); 1304 } 1305 1306 int 1307 bus_generic_shutdown(device_t dev) 1308 { 1309 device_t child; 1310 1311 TAILQ_FOREACH(child, &dev->children, link) { 1312 device_shutdown(child); 1313 } 1314 1315 return (0); 1316 } 1317 1318 int 1319 bus_generic_suspend(device_t dev) 1320 { 1321 int error; 1322 device_t child, child2; 1323 1324 TAILQ_FOREACH(child, &dev->children, link) { 1325 error = DEVICE_SUSPEND(child); 1326 if (error) { 1327 for (child2 = TAILQ_FIRST(&dev->children); 1328 child2 && child2 != child; 1329 child2 = TAILQ_NEXT(child2, link)) 1330 DEVICE_RESUME(child2); 1331 return (error); 1332 } 1333 } 1334 return (0); 1335 } 1336 1337 int 1338 bus_generic_resume(device_t dev) 1339 { 1340 device_t child; 1341 1342 TAILQ_FOREACH(child, &dev->children, link) { 1343 DEVICE_RESUME(child); 1344 /* if resume fails, there's nothing we can usefully do... */ 1345 } 1346 return (0); 1347 } 1348 1349 int 1350 bus_print_child_header (device_t dev, device_t child) 1351 { 1352 int retval = 0; 1353 1354 if (device_get_desc(child)) { 1355 retval += device_printf(child, "<%s>", device_get_desc(child)); 1356 } else { 1357 retval += printf("%s", device_get_nameunit(child)); 1358 } 1359 1360 return (retval); 1361 } 1362 1363 int 1364 bus_print_child_footer (device_t dev, device_t child) 1365 { 1366 return (printf(" on %s\n", device_get_nameunit(dev))); 1367 } 1368 1369 int 1370 bus_generic_print_child(device_t dev, device_t child) 1371 { 1372 int retval = 0; 1373 1374 retval += bus_print_child_header(dev, child); 1375 retval += bus_print_child_footer(dev, child); 1376 1377 return (retval); 1378 } 1379 1380 int 1381 bus_generic_read_ivar(device_t dev, device_t child, int index, 1382 uintptr_t * result) 1383 { 1384 return (ENOENT); 1385 } 1386 1387 int 1388 bus_generic_write_ivar(device_t dev, device_t child, int index, 1389 uintptr_t value) 1390 { 1391 return (ENOENT); 1392 } 1393 1394 struct resource_list * 1395 bus_generic_get_resource_list (device_t dev, device_t child) 1396 { 1397 return (NULL); 1398 } 1399 1400 void 1401 bus_generic_driver_added(device_t dev, driver_t *driver) 1402 { 1403 device_t child; 1404 1405 DEVICE_IDENTIFY(driver, dev); 1406 TAILQ_FOREACH(child, &dev->children, link) { 1407 if (child->state == DS_NOTPRESENT) 1408 device_probe_and_attach(child); 1409 } 1410 } 1411 1412 int 1413 bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq, 1414 int flags, driver_intr_t *intr, void *arg, void **cookiep) 1415 { 1416 /* Propagate up the bus hierarchy until someone handles it. */ 1417 if (dev->parent) 1418 return (BUS_SETUP_INTR(dev->parent, child, irq, flags, 1419 intr, arg, cookiep)); 1420 return (EINVAL); 1421 } 1422 1423 int 1424 bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq, 1425 void *cookie) 1426 { 1427 /* Propagate up the bus hierarchy until someone handles it. */ 1428 if (dev->parent) 1429 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie)); 1430 return (EINVAL); 1431 } 1432 1433 struct resource * 1434 bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid, 1435 u_long start, u_long end, u_long count, u_int flags) 1436 { 1437 /* Propagate up the bus hierarchy until someone handles it. */ 1438 if (dev->parent) 1439 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid, 1440 start, end, count, flags)); 1441 return (NULL); 1442 } 1443 1444 int 1445 bus_generic_release_resource(device_t dev, device_t child, int type, int rid, 1446 struct resource *r) 1447 { 1448 /* Propagate up the bus hierarchy until someone handles it. */ 1449 if (dev->parent) 1450 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, 1451 r)); 1452 return (EINVAL); 1453 } 1454 1455 int 1456 bus_generic_activate_resource(device_t dev, device_t child, int type, int rid, 1457 struct resource *r) 1458 { 1459 /* Propagate up the bus hierarchy until someone handles it. */ 1460 if (dev->parent) 1461 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, 1462 r)); 1463 return (EINVAL); 1464 } 1465 1466 int 1467 bus_generic_deactivate_resource(device_t dev, device_t child, int type, 1468 int rid, struct resource *r) 1469 { 1470 /* Propagate up the bus hierarchy until someone handles it. */ 1471 if (dev->parent) 1472 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid, 1473 r)); 1474 return (EINVAL); 1475 } 1476 1477 int 1478 bus_generic_rl_get_resource (device_t dev, device_t child, int type, int rid, 1479 u_long *startp, u_long *countp) 1480 { 1481 struct resource_list * rl = NULL; 1482 struct resource_list_entry * rle = NULL; 1483 1484 rl = BUS_GET_RESOURCE_LIST(dev, child); 1485 if (!rl) 1486 return (EINVAL); 1487 1488 rle = resource_list_find(rl, type, rid); 1489 if (!rle) 1490 return (ENOENT); 1491 1492 if (startp) 1493 *startp = rle->start; 1494 if (countp) 1495 *countp = rle->count; 1496 1497 return (0); 1498 } 1499 1500 int 1501 bus_generic_rl_set_resource (device_t dev, device_t child, int type, int rid, 1502 u_long start, u_long count) 1503 { 1504 struct resource_list * rl = NULL; 1505 1506 rl = BUS_GET_RESOURCE_LIST(dev, child); 1507 if (!rl) 1508 return (EINVAL); 1509 1510 resource_list_add(rl, type, rid, start, (start + count - 1), count); 1511 1512 return (0); 1513 } 1514 1515 void 1516 bus_generic_rl_delete_resource (device_t dev, device_t child, int type, int rid) 1517 { 1518 struct resource_list * rl = NULL; 1519 1520 rl = BUS_GET_RESOURCE_LIST(dev, child); 1521 if (!rl) 1522 return; 1523 1524 resource_list_delete(rl, type, rid); 1525 1526 return; 1527 } 1528 1529 int 1530 bus_generic_rl_release_resource (device_t dev, device_t child, int type, 1531 int rid, struct resource *r) 1532 { 1533 struct resource_list * rl = NULL; 1534 1535 rl = BUS_GET_RESOURCE_LIST(dev, child); 1536 if (!rl) 1537 return (EINVAL); 1538 1539 return (resource_list_release(rl, dev, child, type, rid, r)); 1540 } 1541 1542 struct resource * 1543 bus_generic_rl_alloc_resource (device_t dev, device_t child, int type, 1544 int *rid, u_long start, u_long end, u_long count, u_int flags) 1545 { 1546 struct resource_list * rl = NULL; 1547 1548 rl = BUS_GET_RESOURCE_LIST(dev, child); 1549 if (!rl) 1550 return (NULL); 1551 1552 return (resource_list_alloc(rl, dev, child, type, rid, 1553 start, end, count, flags)); 1554 } 1555 1556 /* 1557 * Some convenience functions to make it easier for drivers to use the 1558 * resource-management functions. All these really do is hide the 1559 * indirection through the parent's method table, making for slightly 1560 * less-wordy code. In the future, it might make sense for this code 1561 * to maintain some sort of a list of resources allocated by each device. 1562 */ 1563 struct resource * 1564 bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end, 1565 u_long count, u_int flags) 1566 { 1567 if (dev->parent == 0) 1568 return (0); 1569 return (BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end, 1570 count, flags)); 1571 } 1572 1573 int 1574 bus_activate_resource(device_t dev, int type, int rid, struct resource *r) 1575 { 1576 if (dev->parent == 0) 1577 return (EINVAL); 1578 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r)); 1579 } 1580 1581 int 1582 bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r) 1583 { 1584 if (dev->parent == 0) 1585 return (EINVAL); 1586 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r)); 1587 } 1588 1589 int 1590 bus_release_resource(device_t dev, int type, int rid, struct resource *r) 1591 { 1592 if (dev->parent == 0) 1593 return (EINVAL); 1594 return (BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r)); 1595 } 1596 1597 int 1598 bus_setup_intr(device_t dev, struct resource *r, int flags, 1599 driver_intr_t handler, void *arg, void **cookiep) 1600 { 1601 if (dev->parent == 0) 1602 return (EINVAL); 1603 return (BUS_SETUP_INTR(dev->parent, dev, r, flags, 1604 handler, arg, cookiep)); 1605 } 1606 1607 int 1608 bus_teardown_intr(device_t dev, struct resource *r, void *cookie) 1609 { 1610 if (dev->parent == 0) 1611 return (EINVAL); 1612 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie)); 1613 } 1614 1615 int 1616 bus_set_resource(device_t dev, int type, int rid, 1617 u_long start, u_long count) 1618 { 1619 return BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid, 1620 start, count); 1621 } 1622 1623 int 1624 bus_get_resource(device_t dev, int type, int rid, 1625 u_long *startp, u_long *countp) 1626 { 1627 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid, 1628 startp, countp)); 1629 } 1630 1631 u_long 1632 bus_get_resource_start(device_t dev, int type, int rid) 1633 { 1634 u_long start, count; 1635 int error; 1636 1637 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid, 1638 &start, &count); 1639 if (error) 1640 return (0); 1641 return (start); 1642 } 1643 1644 u_long 1645 bus_get_resource_count(device_t dev, int type, int rid) 1646 { 1647 u_long start, count; 1648 int error; 1649 1650 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid, 1651 &start, &count); 1652 if (error) 1653 return (0); 1654 return (count); 1655 } 1656 1657 void 1658 bus_delete_resource(device_t dev, int type, int rid) 1659 { 1660 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid); 1661 } 1662 1663 static int 1664 root_print_child(device_t dev, device_t child) 1665 { 1666 int retval = 0; 1667 1668 retval += bus_print_child_header(dev, child); 1669 retval += printf("\n"); 1670 1671 return (retval); 1672 } 1673 1674 static int 1675 root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg, 1676 void **cookiep) 1677 { 1678 /* 1679 * If an interrupt mapping gets to here something bad has happened. 1680 */ 1681 panic("root_setup_intr"); 1682 } 1683 1684 static kobj_method_t root_methods[] = { 1685 /* Device interface */ 1686 KOBJMETHOD(device_shutdown, bus_generic_shutdown), 1687 KOBJMETHOD(device_suspend, bus_generic_suspend), 1688 KOBJMETHOD(device_resume, bus_generic_resume), 1689 1690 /* Bus interface */ 1691 KOBJMETHOD(bus_print_child, root_print_child), 1692 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar), 1693 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar), 1694 KOBJMETHOD(bus_setup_intr, root_setup_intr), 1695 1696 { 0, 0 } 1697 }; 1698 1699 static driver_t root_driver = { 1700 "root", 1701 root_methods, 1702 1, /* no softc */ 1703 }; 1704 1705 device_t root_bus; 1706 devclass_t root_devclass; 1707 1708 static int 1709 root_bus_module_handler(module_t mod, int what, void* arg) 1710 { 1711 switch (what) { 1712 case MOD_LOAD: 1713 TAILQ_INIT(&bus_data_devices); 1714 kobj_class_compile((kobj_class_t) &root_driver); 1715 root_bus = make_device(NULL, "root", 0); 1716 root_bus->desc = "System root bus"; 1717 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver); 1718 root_bus->driver = &root_driver; 1719 root_bus->state = DS_ATTACHED; 1720 root_devclass = devclass_find_internal("root", FALSE); 1721 return (0); 1722 1723 case MOD_SHUTDOWN: 1724 device_shutdown(root_bus); 1725 return (0); 1726 } 1727 1728 return (0); 1729 } 1730 1731 static moduledata_t root_bus_mod = { 1732 "rootbus", 1733 root_bus_module_handler, 1734 0 1735 }; 1736 DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 1737 1738 void 1739 root_bus_configure(void) 1740 { 1741 device_t dev; 1742 1743 PDEBUG((".")); 1744 1745 TAILQ_FOREACH(dev, &root_bus->children, link) { 1746 device_probe_and_attach(dev); 1747 } 1748 } 1749 1750 int 1751 driver_module_handler(module_t mod, int what, void *arg) 1752 { 1753 int error, i; 1754 struct driver_module_data *dmd; 1755 devclass_t bus_devclass; 1756 1757 dmd = (struct driver_module_data *)arg; 1758 bus_devclass = devclass_find_internal(dmd->dmd_busname, TRUE); 1759 error = 0; 1760 1761 switch (what) { 1762 case MOD_LOAD: 1763 if (dmd->dmd_chainevh) 1764 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg); 1765 1766 for (i = 0; !error && i < dmd->dmd_ndrivers; i++) { 1767 PDEBUG(("Loading module: driver %s on bus %s", 1768 DRIVERNAME(dmd->dmd_drivers[i]), dmd->dmd_busname)); 1769 error = devclass_add_driver(bus_devclass, 1770 dmd->dmd_drivers[i]); 1771 } 1772 if (error) 1773 break; 1774 1775 /* 1776 * The drivers loaded in this way are assumed to all 1777 * implement the same devclass. 1778 */ 1779 *dmd->dmd_devclass = 1780 devclass_find_internal(dmd->dmd_drivers[0]->name, TRUE); 1781 break; 1782 1783 case MOD_UNLOAD: 1784 for (i = 0; !error && i < dmd->dmd_ndrivers; i++) { 1785 PDEBUG(("Unloading module: driver %s from bus %s", 1786 DRIVERNAME(dmd->dmd_drivers[i]), 1787 dmd->dmd_busname)); 1788 error = devclass_delete_driver(bus_devclass, 1789 dmd->dmd_drivers[i]); 1790 } 1791 1792 if (!error && dmd->dmd_chainevh) 1793 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg); 1794 break; 1795 } 1796 1797 return (error); 1798 } 1799 1800 #ifdef BUS_DEBUG 1801 1802 /* the _short versions avoid iteration by not calling anything that prints 1803 * more than oneliners. I love oneliners. 1804 */ 1805 1806 static void 1807 print_device_short(device_t dev, int indent) 1808 { 1809 if (!dev) 1810 return; 1811 1812 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n", 1813 dev->unit, dev->desc, 1814 (dev->parent? "":"no "), 1815 (TAILQ_EMPTY(&dev->children)? "no ":""), 1816 (dev->flags&DF_ENABLED? "enabled,":"disabled,"), 1817 (dev->flags&DF_FIXEDCLASS? "fixed,":""), 1818 (dev->flags&DF_WILDCARD? "wildcard,":""), 1819 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""), 1820 (dev->ivars? "":"no "), 1821 (dev->softc? "":"no "), 1822 dev->busy)); 1823 } 1824 1825 static void 1826 print_device(device_t dev, int indent) 1827 { 1828 if (!dev) 1829 return; 1830 1831 print_device_short(dev, indent); 1832 1833 indentprintf(("Parent:\n")); 1834 print_device_short(dev->parent, indent+1); 1835 indentprintf(("Driver:\n")); 1836 print_driver_short(dev->driver, indent+1); 1837 indentprintf(("Devclass:\n")); 1838 print_devclass_short(dev->devclass, indent+1); 1839 } 1840 1841 void 1842 print_device_tree_short(device_t dev, int indent) 1843 /* print the device and all its children (indented) */ 1844 { 1845 device_t child; 1846 1847 if (!dev) 1848 return; 1849 1850 print_device_short(dev, indent); 1851 1852 TAILQ_FOREACH(child, &dev->children, link) { 1853 print_device_tree_short(child, indent+1); 1854 } 1855 } 1856 1857 void 1858 print_device_tree(device_t dev, int indent) 1859 /* print the device and all its children (indented) */ 1860 { 1861 device_t child; 1862 1863 if (!dev) 1864 return; 1865 1866 print_device(dev, indent); 1867 1868 TAILQ_FOREACH(child, &dev->children, link) { 1869 print_device_tree(child, indent+1); 1870 } 1871 } 1872 1873 static void 1874 print_driver_short(driver_t *driver, int indent) 1875 { 1876 if (!driver) 1877 return; 1878 1879 indentprintf(("driver %s: softc size = %d\n", 1880 driver->name, driver->size)); 1881 } 1882 1883 static void 1884 print_driver(driver_t *driver, int indent) 1885 { 1886 if (!driver) 1887 return; 1888 1889 print_driver_short(driver, indent); 1890 } 1891 1892 1893 static void 1894 print_driver_list(driver_list_t drivers, int indent) 1895 { 1896 driverlink_t driver; 1897 1898 TAILQ_FOREACH(driver, &drivers, link) { 1899 print_driver(driver->driver, indent); 1900 } 1901 } 1902 1903 static void 1904 print_devclass_short(devclass_t dc, int indent) 1905 { 1906 if ( !dc ) 1907 return; 1908 1909 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit)); 1910 } 1911 1912 static void 1913 print_devclass(devclass_t dc, int indent) 1914 { 1915 int i; 1916 1917 if ( !dc ) 1918 return; 1919 1920 print_devclass_short(dc, indent); 1921 indentprintf(("Drivers:\n")); 1922 print_driver_list(dc->drivers, indent+1); 1923 1924 indentprintf(("Devices:\n")); 1925 for (i = 0; i < dc->maxunit; i++) 1926 if (dc->devices[i]) 1927 print_device(dc->devices[i], indent+1); 1928 } 1929 1930 void 1931 print_devclass_list_short(void) 1932 { 1933 devclass_t dc; 1934 1935 printf("Short listing of devclasses, drivers & devices:\n"); 1936 TAILQ_FOREACH(dc, &devclasses, link) { 1937 print_devclass_short(dc, 0); 1938 } 1939 } 1940 1941 void 1942 print_devclass_list(void) 1943 { 1944 devclass_t dc; 1945 1946 printf("Full listing of devclasses, drivers & devices:\n"); 1947 TAILQ_FOREACH(dc, &devclasses, link) { 1948 print_devclass(dc, 0); 1949 } 1950 } 1951 1952 #endif 1953 1954 /* 1955 * User-space access to the device tree. 1956 * 1957 * We implement a small set of nodes: 1958 * 1959 * hw.bus Single integer read method to obtain the 1960 * current generation count. 1961 * hw.bus.devices Reads the entire device tree in flat space. 1962 * hw.bus.rman Resource manager interface 1963 * 1964 * We might like to add the ability to scan devclasses and/or drivers to 1965 * determine what else is currently loaded/available. 1966 */ 1967 SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL); 1968 1969 static int 1970 sysctl_bus(SYSCTL_HANDLER_ARGS) 1971 { 1972 struct u_businfo ubus; 1973 1974 ubus.ub_version = BUS_USER_VERSION; 1975 ubus.ub_generation = bus_data_generation; 1976 1977 return (SYSCTL_OUT(req, &ubus, sizeof(ubus))); 1978 } 1979 SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus, 1980 "bus-related data"); 1981 1982 static int 1983 sysctl_devices(SYSCTL_HANDLER_ARGS) 1984 { 1985 int *name = (int *)arg1; 1986 u_int namelen = arg2; 1987 int index; 1988 struct device *dev; 1989 struct u_device udev; /* XXX this is a bit big */ 1990 int error; 1991 1992 if (namelen != 2) 1993 return (EINVAL); 1994 1995 if (bus_data_generation_check(name[0])) 1996 return (EINVAL); 1997 1998 index = name[1]; 1999 2000 /* 2001 * Scan the list of devices, looking for the requested index. 2002 */ 2003 TAILQ_FOREACH(dev, &bus_data_devices, devlink) { 2004 if (index-- == 0) 2005 break; 2006 } 2007 if (dev == NULL) 2008 return (ENOENT); 2009 2010 /* 2011 * Populate the return array. 2012 */ 2013 udev.dv_handle = (uintptr_t)dev; 2014 udev.dv_parent = (uintptr_t)dev->parent; 2015 if (dev->nameunit == NULL) { 2016 udev.dv_name[0] = 0; 2017 } else { 2018 snprintf(udev.dv_name, 32, "%s", dev->nameunit); 2019 } 2020 if (dev->desc == NULL) { 2021 udev.dv_desc[0] = 0; 2022 } else { 2023 snprintf(udev.dv_desc, 32, "%s", dev->desc); 2024 } 2025 if ((dev->driver == NULL) || (dev->driver->name == NULL)) { 2026 udev.dv_drivername[0] = 0; 2027 } else { 2028 snprintf(udev.dv_drivername, 32, "%s", dev->driver->name); 2029 } 2030 error = SYSCTL_OUT(req, &udev, sizeof(udev)); 2031 return (error); 2032 } 2033 2034 SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices, 2035 "system device tree"); 2036 2037 /* 2038 * Sysctl interface for scanning the resource lists. 2039 * 2040 * We take two input parameters; the index into the list of resource 2041 * managers, and the resource offset into the list. 2042 */ 2043 static int 2044 sysctl_rman(SYSCTL_HANDLER_ARGS) 2045 { 2046 int *name = (int *)arg1; 2047 u_int namelen = arg2; 2048 int rman_idx, res_idx; 2049 struct rman *rm; 2050 struct resource *res; 2051 struct u_rman urm; 2052 struct u_resource ures; 2053 int error; 2054 2055 if (namelen != 3) 2056 return (EINVAL); 2057 2058 if (bus_data_generation_check(name[0])) 2059 return (EINVAL); 2060 rman_idx = name[1]; 2061 res_idx = name[2]; 2062 2063 /* 2064 * Find the indexed resource manager 2065 */ 2066 TAILQ_FOREACH(rm, &rman_head, rm_link) { 2067 if (rman_idx-- == 0) 2068 break; 2069 } 2070 if (rm == NULL) 2071 return (ENOENT); 2072 2073 /* 2074 * If the resource index is -1, we want details on the 2075 * resource manager. 2076 */ 2077 if (res_idx == -1) { 2078 urm.rm_handle = (uintptr_t)rm; 2079 snprintf(urm.rm_descr, RM_TEXTLEN, "%s", rm->rm_descr); 2080 urm.rm_descr[RM_TEXTLEN - 1] = '\0'; 2081 urm.rm_start = rm->rm_start; 2082 urm.rm_size = rm->rm_end - rm->rm_start + 1; 2083 urm.rm_type = rm->rm_type; 2084 2085 error = SYSCTL_OUT(req, &urm, sizeof(urm)); 2086 return (error); 2087 } 2088 2089 /* 2090 * Find the indexed resource and return it. 2091 */ 2092 TAILQ_FOREACH(res, &rm->rm_list, r_link) { 2093 if (res_idx-- == 0) { 2094 ures.r_handle = (uintptr_t)res; 2095 ures.r_parent = (uintptr_t)res->r_rm; 2096 ures.r_device = (uintptr_t)res->r_dev; 2097 if (res->r_dev != NULL) { 2098 if (device_get_name(res->r_dev) != NULL) { 2099 snprintf(ures.r_devname, RM_TEXTLEN, 2100 "%s%d", 2101 device_get_name(res->r_dev), 2102 device_get_unit(res->r_dev)); 2103 } else { 2104 snprintf(ures.r_devname, RM_TEXTLEN, 2105 "nomatch"); 2106 } 2107 } else { 2108 ures.r_devname[0] = 0; 2109 } 2110 ures.r_start = res->r_start; 2111 ures.r_size = res->r_end - res->r_start + 1; 2112 ures.r_flags = res->r_flags; 2113 2114 error = SYSCTL_OUT(req, &ures, sizeof(ures)); 2115 return (error); 2116 } 2117 } 2118 return (ENOENT); 2119 } 2120 2121 SYSCTL_NODE(_hw_bus, OID_AUTO, rman, CTLFLAG_RD, sysctl_rman, 2122 "kernel resource manager"); 2123 2124 int 2125 bus_data_generation_check(int generation) 2126 { 2127 if (generation != bus_data_generation) 2128 return (1); 2129 2130 /* XXX generate optimised lists here? */ 2131 return (0); 2132 } 2133 2134 void 2135 bus_data_generation_update(void) 2136 { 2137 bus_data_generation++; 2138 } 2139