1/*- 2 * Copyright (c) 1997,1998,2003 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 27#include <sys/cdefs.h> 28__FBSDID("$FreeBSD: stable/11/sys/kern/subr_bus.c 351242 2019-08-19 23:57:37Z jhb $"); 29 30#include "opt_bus.h" 31 32#include <sys/param.h> 33#include <sys/conf.h> 34#include <sys/filio.h> 35#include <sys/lock.h> 36#include <sys/kernel.h> 37#include <sys/kobj.h> 38#include <sys/limits.h> 39#include <sys/malloc.h> 40#include <sys/module.h> 41#include <sys/mutex.h> 42#include <sys/poll.h> 43#include <sys/priv.h> 44#include <sys/proc.h> 45#include <sys/condvar.h> 46#include <sys/queue.h> 47#include <machine/bus.h> 48#include <sys/random.h> 49#include <sys/rman.h> 50#include <sys/selinfo.h> 51#include <sys/signalvar.h> 52#include <sys/smp.h> 53#include <sys/sysctl.h> 54#include <sys/systm.h> 55#include <sys/uio.h> 56#include <sys/bus.h> 57#include <sys/cpuset.h> 58 59#include <net/vnet.h> 60 61#include <machine/cpu.h> 62#include <machine/stdarg.h> 63 64#include <vm/uma.h> 65#include <vm/vm.h> 66 67SYSCTL_NODE(_hw, OID_AUTO, bus, CTLFLAG_RW, NULL, NULL); 68SYSCTL_ROOT_NODE(OID_AUTO, dev, CTLFLAG_RW, NULL, NULL); 69 70/* 71 * Used to attach drivers to devclasses. 72 */ 73typedef struct driverlink *driverlink_t; 74struct driverlink { 75 kobj_class_t driver; 76 TAILQ_ENTRY(driverlink) link; /* list of drivers in devclass */ 77 int pass; 78 TAILQ_ENTRY(driverlink) passlink; 79}; 80 81/* 82 * Forward declarations 83 */ 84typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t; 85typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t; 86typedef TAILQ_HEAD(device_list, device) device_list_t; 87 88struct devclass { 89 TAILQ_ENTRY(devclass) link; 90 devclass_t parent; /* parent in devclass hierarchy */ 91 driver_list_t drivers; /* bus devclasses store drivers for bus */ 92 char *name; 93 device_t *devices; /* array of devices indexed by unit */ 94 int maxunit; /* size of devices array */ 95 int flags; 96#define DC_HAS_CHILDREN 1 97 98 struct sysctl_ctx_list sysctl_ctx; 99 struct sysctl_oid *sysctl_tree; 100}; 101 102/** 103 * @brief Implementation of device. 104 */ 105struct device { 106 /* 107 * A device is a kernel object. The first field must be the 108 * current ops table for the object. 109 */ 110 KOBJ_FIELDS; 111 112 /* 113 * Device hierarchy. 114 */ 115 TAILQ_ENTRY(device) link; /**< list of devices in parent */ 116 TAILQ_ENTRY(device) devlink; /**< global device list membership */ 117 device_t parent; /**< parent of this device */ 118 device_list_t children; /**< list of child devices */ 119 120 /* 121 * Details of this device. 122 */ 123 driver_t *driver; /**< current driver */ 124 devclass_t devclass; /**< current device class */ 125 int unit; /**< current unit number */ 126 char* nameunit; /**< name+unit e.g. foodev0 */ 127 char* desc; /**< driver specific description */ 128 int busy; /**< count of calls to device_busy() */ 129 device_state_t state; /**< current device state */ 130 uint32_t devflags; /**< api level flags for device_get_flags() */ 131 u_int flags; /**< internal device flags */ 132 u_int order; /**< order from device_add_child_ordered() */ 133 void *ivars; /**< instance variables */ 134 void *softc; /**< current driver's variables */ 135 136 struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */ 137 struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */ 138}; 139 140static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures"); 141static MALLOC_DEFINE(M_BUS_SC, "bus-sc", "Bus data structures, softc"); 142 143static void devctl2_init(void); 144 145#ifdef BUS_DEBUG 146 147static int bus_debug = 1; 148SYSCTL_INT(_debug, OID_AUTO, bus_debug, CTLFLAG_RWTUN, &bus_debug, 0, 149 "Bus debug level"); 150 151#define PDEBUG(a) if (bus_debug) {printf("%s:%d: ", __func__, __LINE__), printf a; printf("\n");} 152#define DEVICENAME(d) ((d)? device_get_name(d): "no device") 153#define DRIVERNAME(d) ((d)? d->name : "no driver") 154#define DEVCLANAME(d) ((d)? d->name : "no devclass") 155 156/** 157 * Produce the indenting, indent*2 spaces plus a '.' ahead of that to 158 * prevent syslog from deleting initial spaces 159 */ 160#define indentprintf(p) do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf(" "); printf p ; } while (0) 161 162static void print_device_short(device_t dev, int indent); 163static void print_device(device_t dev, int indent); 164void print_device_tree_short(device_t dev, int indent); 165void print_device_tree(device_t dev, int indent); 166static void print_driver_short(driver_t *driver, int indent); 167static void print_driver(driver_t *driver, int indent); 168static void print_driver_list(driver_list_t drivers, int indent); 169static void print_devclass_short(devclass_t dc, int indent); 170static void print_devclass(devclass_t dc, int indent); 171void print_devclass_list_short(void); 172void print_devclass_list(void); 173 174#else 175/* Make the compiler ignore the function calls */ 176#define PDEBUG(a) /* nop */ 177#define DEVICENAME(d) /* nop */ 178#define DRIVERNAME(d) /* nop */ 179#define DEVCLANAME(d) /* nop */ 180 181#define print_device_short(d,i) /* nop */ 182#define print_device(d,i) /* nop */ 183#define print_device_tree_short(d,i) /* nop */ 184#define print_device_tree(d,i) /* nop */ 185#define print_driver_short(d,i) /* nop */ 186#define print_driver(d,i) /* nop */ 187#define print_driver_list(d,i) /* nop */ 188#define print_devclass_short(d,i) /* nop */ 189#define print_devclass(d,i) /* nop */ 190#define print_devclass_list_short() /* nop */ 191#define print_devclass_list() /* nop */ 192#endif 193 194/* 195 * dev sysctl tree 196 */ 197 198enum { 199 DEVCLASS_SYSCTL_PARENT, 200}; 201 202static int 203devclass_sysctl_handler(SYSCTL_HANDLER_ARGS) 204{ 205 devclass_t dc = (devclass_t)arg1; 206 const char *value; 207 208 switch (arg2) { 209 case DEVCLASS_SYSCTL_PARENT: 210 value = dc->parent ? dc->parent->name : ""; 211 break; 212 default: 213 return (EINVAL); 214 } 215 return (SYSCTL_OUT_STR(req, value)); 216} 217 218static void 219devclass_sysctl_init(devclass_t dc) 220{ 221 222 if (dc->sysctl_tree != NULL) 223 return; 224 sysctl_ctx_init(&dc->sysctl_ctx); 225 dc->sysctl_tree = SYSCTL_ADD_NODE(&dc->sysctl_ctx, 226 SYSCTL_STATIC_CHILDREN(_dev), OID_AUTO, dc->name, 227 CTLFLAG_RD, NULL, ""); 228 SYSCTL_ADD_PROC(&dc->sysctl_ctx, SYSCTL_CHILDREN(dc->sysctl_tree), 229 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD, 230 dc, DEVCLASS_SYSCTL_PARENT, devclass_sysctl_handler, "A", 231 "parent class"); 232} 233 234enum { 235 DEVICE_SYSCTL_DESC, 236 DEVICE_SYSCTL_DRIVER, 237 DEVICE_SYSCTL_LOCATION, 238 DEVICE_SYSCTL_PNPINFO, 239 DEVICE_SYSCTL_PARENT, 240}; 241 242static int 243device_sysctl_handler(SYSCTL_HANDLER_ARGS) 244{ 245 device_t dev = (device_t)arg1; 246 const char *value; 247 char *buf; 248 int error; 249 250 buf = NULL; 251 switch (arg2) { 252 case DEVICE_SYSCTL_DESC: 253 value = dev->desc ? dev->desc : ""; 254 break; 255 case DEVICE_SYSCTL_DRIVER: 256 value = dev->driver ? dev->driver->name : ""; 257 break; 258 case DEVICE_SYSCTL_LOCATION: 259 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO); 260 bus_child_location_str(dev, buf, 1024); 261 break; 262 case DEVICE_SYSCTL_PNPINFO: 263 value = buf = malloc(1024, M_BUS, M_WAITOK | M_ZERO); 264 bus_child_pnpinfo_str(dev, buf, 1024); 265 break; 266 case DEVICE_SYSCTL_PARENT: 267 value = dev->parent ? dev->parent->nameunit : ""; 268 break; 269 default: 270 return (EINVAL); 271 } 272 error = SYSCTL_OUT_STR(req, value); 273 if (buf != NULL) 274 free(buf, M_BUS); 275 return (error); 276} 277 278static void 279device_sysctl_init(device_t dev) 280{ 281 devclass_t dc = dev->devclass; 282 int domain; 283 284 if (dev->sysctl_tree != NULL) 285 return; 286 devclass_sysctl_init(dc); 287 sysctl_ctx_init(&dev->sysctl_ctx); 288 dev->sysctl_tree = SYSCTL_ADD_NODE(&dev->sysctl_ctx, 289 SYSCTL_CHILDREN(dc->sysctl_tree), OID_AUTO, 290 dev->nameunit + strlen(dc->name), 291 CTLFLAG_RD, NULL, ""); 292 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree), 293 OID_AUTO, "%desc", CTLTYPE_STRING | CTLFLAG_RD, 294 dev, DEVICE_SYSCTL_DESC, device_sysctl_handler, "A", 295 "device description"); 296 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree), 297 OID_AUTO, "%driver", CTLTYPE_STRING | CTLFLAG_RD, 298 dev, DEVICE_SYSCTL_DRIVER, device_sysctl_handler, "A", 299 "device driver name"); 300 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree), 301 OID_AUTO, "%location", CTLTYPE_STRING | CTLFLAG_RD, 302 dev, DEVICE_SYSCTL_LOCATION, device_sysctl_handler, "A", 303 "device location relative to parent"); 304 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree), 305 OID_AUTO, "%pnpinfo", CTLTYPE_STRING | CTLFLAG_RD, 306 dev, DEVICE_SYSCTL_PNPINFO, device_sysctl_handler, "A", 307 "device identification"); 308 SYSCTL_ADD_PROC(&dev->sysctl_ctx, SYSCTL_CHILDREN(dev->sysctl_tree), 309 OID_AUTO, "%parent", CTLTYPE_STRING | CTLFLAG_RD, 310 dev, DEVICE_SYSCTL_PARENT, device_sysctl_handler, "A", 311 "parent device"); 312 if (bus_get_domain(dev, &domain) == 0) 313 SYSCTL_ADD_INT(&dev->sysctl_ctx, 314 SYSCTL_CHILDREN(dev->sysctl_tree), OID_AUTO, "%domain", 315 CTLFLAG_RD, NULL, domain, "NUMA domain"); 316} 317 318static void 319device_sysctl_update(device_t dev) 320{ 321 devclass_t dc = dev->devclass; 322 323 if (dev->sysctl_tree == NULL) 324 return; 325 sysctl_rename_oid(dev->sysctl_tree, dev->nameunit + strlen(dc->name)); 326} 327 328static void 329device_sysctl_fini(device_t dev) 330{ 331 if (dev->sysctl_tree == NULL) 332 return; 333 sysctl_ctx_free(&dev->sysctl_ctx); 334 dev->sysctl_tree = NULL; 335} 336 337/* 338 * /dev/devctl implementation 339 */ 340 341/* 342 * This design allows only one reader for /dev/devctl. This is not desirable 343 * in the long run, but will get a lot of hair out of this implementation. 344 * Maybe we should make this device a clonable device. 345 * 346 * Also note: we specifically do not attach a device to the device_t tree 347 * to avoid potential chicken and egg problems. One could argue that all 348 * of this belongs to the root node. One could also further argue that the 349 * sysctl interface that we have not might more properly be an ioctl 350 * interface, but at this stage of the game, I'm not inclined to rock that 351 * boat. 352 * 353 * I'm also not sure that the SIGIO support is done correctly or not, as 354 * I copied it from a driver that had SIGIO support that likely hasn't been 355 * tested since 3.4 or 2.2.8! 356 */ 357 358/* Deprecated way to adjust queue length */ 359static int sysctl_devctl_disable(SYSCTL_HANDLER_ARGS); 360SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_disable, CTLTYPE_INT | CTLFLAG_RWTUN | 361 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_disable, "I", 362 "devctl disable -- deprecated"); 363 364#define DEVCTL_DEFAULT_QUEUE_LEN 1000 365static int sysctl_devctl_queue(SYSCTL_HANDLER_ARGS); 366static int devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN; 367SYSCTL_PROC(_hw_bus, OID_AUTO, devctl_queue, CTLTYPE_INT | CTLFLAG_RWTUN | 368 CTLFLAG_MPSAFE, NULL, 0, sysctl_devctl_queue, "I", "devctl queue length"); 369 370static d_open_t devopen; 371static d_close_t devclose; 372static d_read_t devread; 373static d_ioctl_t devioctl; 374static d_poll_t devpoll; 375static d_kqfilter_t devkqfilter; 376 377static struct cdevsw dev_cdevsw = { 378 .d_version = D_VERSION, 379 .d_open = devopen, 380 .d_close = devclose, 381 .d_read = devread, 382 .d_ioctl = devioctl, 383 .d_poll = devpoll, 384 .d_kqfilter = devkqfilter, 385 .d_name = "devctl", 386}; 387 388struct dev_event_info 389{ 390 char *dei_data; 391 TAILQ_ENTRY(dev_event_info) dei_link; 392}; 393 394TAILQ_HEAD(devq, dev_event_info); 395 396static struct dev_softc 397{ 398 int inuse; 399 int nonblock; 400 int queued; 401 int async; 402 struct mtx mtx; 403 struct cv cv; 404 struct selinfo sel; 405 struct devq devq; 406 struct sigio *sigio; 407} devsoftc; 408 409static void filt_devctl_detach(struct knote *kn); 410static int filt_devctl_read(struct knote *kn, long hint); 411 412struct filterops devctl_rfiltops = { 413 .f_isfd = 1, 414 .f_detach = filt_devctl_detach, 415 .f_event = filt_devctl_read, 416}; 417 418static struct cdev *devctl_dev; 419 420static void 421devinit(void) 422{ 423 devctl_dev = make_dev_credf(MAKEDEV_ETERNAL, &dev_cdevsw, 0, NULL, 424 UID_ROOT, GID_WHEEL, 0600, "devctl"); 425 mtx_init(&devsoftc.mtx, "dev mtx", "devd", MTX_DEF); 426 cv_init(&devsoftc.cv, "dev cv"); 427 TAILQ_INIT(&devsoftc.devq); 428 knlist_init_mtx(&devsoftc.sel.si_note, &devsoftc.mtx); 429 devctl2_init(); 430} 431 432static int 433devopen(struct cdev *dev, int oflags, int devtype, struct thread *td) 434{ 435 436 mtx_lock(&devsoftc.mtx); 437 if (devsoftc.inuse) { 438 mtx_unlock(&devsoftc.mtx); 439 return (EBUSY); 440 } 441 /* move to init */ 442 devsoftc.inuse = 1; 443 mtx_unlock(&devsoftc.mtx); 444 return (0); 445} 446 447static int 448devclose(struct cdev *dev, int fflag, int devtype, struct thread *td) 449{ 450 451 mtx_lock(&devsoftc.mtx); 452 devsoftc.inuse = 0; 453 devsoftc.nonblock = 0; 454 devsoftc.async = 0; 455 cv_broadcast(&devsoftc.cv); 456 funsetown(&devsoftc.sigio); 457 mtx_unlock(&devsoftc.mtx); 458 return (0); 459} 460 461/* 462 * The read channel for this device is used to report changes to 463 * userland in realtime. We are required to free the data as well as 464 * the n1 object because we allocate them separately. Also note that 465 * we return one record at a time. If you try to read this device a 466 * character at a time, you will lose the rest of the data. Listening 467 * programs are expected to cope. 468 */ 469static int 470devread(struct cdev *dev, struct uio *uio, int ioflag) 471{ 472 struct dev_event_info *n1; 473 int rv; 474 475 mtx_lock(&devsoftc.mtx); 476 while (TAILQ_EMPTY(&devsoftc.devq)) { 477 if (devsoftc.nonblock) { 478 mtx_unlock(&devsoftc.mtx); 479 return (EAGAIN); 480 } 481 rv = cv_wait_sig(&devsoftc.cv, &devsoftc.mtx); 482 if (rv) { 483 /* 484 * Need to translate ERESTART to EINTR here? -- jake 485 */ 486 mtx_unlock(&devsoftc.mtx); 487 return (rv); 488 } 489 } 490 n1 = TAILQ_FIRST(&devsoftc.devq); 491 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link); 492 devsoftc.queued--; 493 mtx_unlock(&devsoftc.mtx); 494 rv = uiomove(n1->dei_data, strlen(n1->dei_data), uio); 495 free(n1->dei_data, M_BUS); 496 free(n1, M_BUS); 497 return (rv); 498} 499 500static int 501devioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td) 502{ 503 switch (cmd) { 504 505 case FIONBIO: 506 if (*(int*)data) 507 devsoftc.nonblock = 1; 508 else 509 devsoftc.nonblock = 0; 510 return (0); 511 case FIOASYNC: 512 if (*(int*)data) 513 devsoftc.async = 1; 514 else 515 devsoftc.async = 0; 516 return (0); 517 case FIOSETOWN: 518 return fsetown(*(int *)data, &devsoftc.sigio); 519 case FIOGETOWN: 520 *(int *)data = fgetown(&devsoftc.sigio); 521 return (0); 522 523 /* (un)Support for other fcntl() calls. */ 524 case FIOCLEX: 525 case FIONCLEX: 526 case FIONREAD: 527 default: 528 break; 529 } 530 return (ENOTTY); 531} 532 533static int 534devpoll(struct cdev *dev, int events, struct thread *td) 535{ 536 int revents = 0; 537 538 mtx_lock(&devsoftc.mtx); 539 if (events & (POLLIN | POLLRDNORM)) { 540 if (!TAILQ_EMPTY(&devsoftc.devq)) 541 revents = events & (POLLIN | POLLRDNORM); 542 else 543 selrecord(td, &devsoftc.sel); 544 } 545 mtx_unlock(&devsoftc.mtx); 546 547 return (revents); 548} 549 550static int 551devkqfilter(struct cdev *dev, struct knote *kn) 552{ 553 int error; 554 555 if (kn->kn_filter == EVFILT_READ) { 556 kn->kn_fop = &devctl_rfiltops; 557 knlist_add(&devsoftc.sel.si_note, kn, 0); 558 error = 0; 559 } else 560 error = EINVAL; 561 return (error); 562} 563 564static void 565filt_devctl_detach(struct knote *kn) 566{ 567 568 knlist_remove(&devsoftc.sel.si_note, kn, 0); 569} 570 571static int 572filt_devctl_read(struct knote *kn, long hint) 573{ 574 kn->kn_data = devsoftc.queued; 575 return (kn->kn_data != 0); 576} 577 578/** 579 * @brief Return whether the userland process is running 580 */ 581boolean_t 582devctl_process_running(void) 583{ 584 return (devsoftc.inuse == 1); 585} 586 587/** 588 * @brief Queue data to be read from the devctl device 589 * 590 * Generic interface to queue data to the devctl device. It is 591 * assumed that @p data is properly formatted. It is further assumed 592 * that @p data is allocated using the M_BUS malloc type. 593 */ 594void 595devctl_queue_data_f(char *data, int flags) 596{ 597 struct dev_event_info *n1 = NULL, *n2 = NULL; 598 599 if (strlen(data) == 0) 600 goto out; 601 if (devctl_queue_length == 0) 602 goto out; 603 n1 = malloc(sizeof(*n1), M_BUS, flags); 604 if (n1 == NULL) 605 goto out; 606 n1->dei_data = data; 607 mtx_lock(&devsoftc.mtx); 608 if (devctl_queue_length == 0) { 609 mtx_unlock(&devsoftc.mtx); 610 free(n1->dei_data, M_BUS); 611 free(n1, M_BUS); 612 return; 613 } 614 /* Leave at least one spot in the queue... */ 615 while (devsoftc.queued > devctl_queue_length - 1) { 616 n2 = TAILQ_FIRST(&devsoftc.devq); 617 TAILQ_REMOVE(&devsoftc.devq, n2, dei_link); 618 free(n2->dei_data, M_BUS); 619 free(n2, M_BUS); 620 devsoftc.queued--; 621 } 622 TAILQ_INSERT_TAIL(&devsoftc.devq, n1, dei_link); 623 devsoftc.queued++; 624 cv_broadcast(&devsoftc.cv); 625 KNOTE_LOCKED(&devsoftc.sel.si_note, 0); 626 mtx_unlock(&devsoftc.mtx); 627 selwakeup(&devsoftc.sel); 628 if (devsoftc.async && devsoftc.sigio != NULL) 629 pgsigio(&devsoftc.sigio, SIGIO, 0); 630 return; 631out: 632 /* 633 * We have to free data on all error paths since the caller 634 * assumes it will be free'd when this item is dequeued. 635 */ 636 free(data, M_BUS); 637 return; 638} 639 640void 641devctl_queue_data(char *data) 642{ 643 644 devctl_queue_data_f(data, M_NOWAIT); 645} 646 647/** 648 * @brief Send a 'notification' to userland, using standard ways 649 */ 650void 651devctl_notify_f(const char *system, const char *subsystem, const char *type, 652 const char *data, int flags) 653{ 654 int len = 0; 655 char *msg; 656 657 if (system == NULL) 658 return; /* BOGUS! Must specify system. */ 659 if (subsystem == NULL) 660 return; /* BOGUS! Must specify subsystem. */ 661 if (type == NULL) 662 return; /* BOGUS! Must specify type. */ 663 len += strlen(" system=") + strlen(system); 664 len += strlen(" subsystem=") + strlen(subsystem); 665 len += strlen(" type=") + strlen(type); 666 /* add in the data message plus newline. */ 667 if (data != NULL) 668 len += strlen(data); 669 len += 3; /* '!', '\n', and NUL */ 670 msg = malloc(len, M_BUS, flags); 671 if (msg == NULL) 672 return; /* Drop it on the floor */ 673 if (data != NULL) 674 snprintf(msg, len, "!system=%s subsystem=%s type=%s %s\n", 675 system, subsystem, type, data); 676 else 677 snprintf(msg, len, "!system=%s subsystem=%s type=%s\n", 678 system, subsystem, type); 679 devctl_queue_data_f(msg, flags); 680} 681 682void 683devctl_notify(const char *system, const char *subsystem, const char *type, 684 const char *data) 685{ 686 687 devctl_notify_f(system, subsystem, type, data, M_NOWAIT); 688} 689 690/* 691 * Common routine that tries to make sending messages as easy as possible. 692 * We allocate memory for the data, copy strings into that, but do not 693 * free it unless there's an error. The dequeue part of the driver should 694 * free the data. We don't send data when the device is disabled. We do 695 * send data, even when we have no listeners, because we wish to avoid 696 * races relating to startup and restart of listening applications. 697 * 698 * devaddq is designed to string together the type of event, with the 699 * object of that event, plus the plug and play info and location info 700 * for that event. This is likely most useful for devices, but less 701 * useful for other consumers of this interface. Those should use 702 * the devctl_queue_data() interface instead. 703 */ 704static void 705devaddq(const char *type, const char *what, device_t dev) 706{ 707 char *data = NULL; 708 char *loc = NULL; 709 char *pnp = NULL; 710 const char *parstr; 711 712 if (!devctl_queue_length)/* Rare race, but lost races safely discard */ 713 return; 714 data = malloc(1024, M_BUS, M_NOWAIT); 715 if (data == NULL) 716 goto bad; 717 718 /* get the bus specific location of this device */ 719 loc = malloc(1024, M_BUS, M_NOWAIT); 720 if (loc == NULL) 721 goto bad; 722 *loc = '\0'; 723 bus_child_location_str(dev, loc, 1024); 724 725 /* Get the bus specific pnp info of this device */ 726 pnp = malloc(1024, M_BUS, M_NOWAIT); 727 if (pnp == NULL) 728 goto bad; 729 *pnp = '\0'; 730 bus_child_pnpinfo_str(dev, pnp, 1024); 731 732 /* Get the parent of this device, or / if high enough in the tree. */ 733 if (device_get_parent(dev) == NULL) 734 parstr = "."; /* Or '/' ? */ 735 else 736 parstr = device_get_nameunit(device_get_parent(dev)); 737 /* String it all together. */ 738 snprintf(data, 1024, "%s%s at %s %s on %s\n", type, what, loc, pnp, 739 parstr); 740 free(loc, M_BUS); 741 free(pnp, M_BUS); 742 devctl_queue_data(data); 743 return; 744bad: 745 free(pnp, M_BUS); 746 free(loc, M_BUS); 747 free(data, M_BUS); 748 return; 749} 750 751/* 752 * A device was added to the tree. We are called just after it successfully 753 * attaches (that is, probe and attach success for this device). No call 754 * is made if a device is merely parented into the tree. See devnomatch 755 * if probe fails. If attach fails, no notification is sent (but maybe 756 * we should have a different message for this). 757 */ 758static void 759devadded(device_t dev) 760{ 761 devaddq("+", device_get_nameunit(dev), dev); 762} 763 764/* 765 * A device was removed from the tree. We are called just before this 766 * happens. 767 */ 768static void 769devremoved(device_t dev) 770{ 771 devaddq("-", device_get_nameunit(dev), dev); 772} 773 774/* 775 * Called when there's no match for this device. This is only called 776 * the first time that no match happens, so we don't keep getting this 777 * message. Should that prove to be undesirable, we can change it. 778 * This is called when all drivers that can attach to a given bus 779 * decline to accept this device. Other errors may not be detected. 780 */ 781static void 782devnomatch(device_t dev) 783{ 784 devaddq("?", "", dev); 785} 786 787static int 788sysctl_devctl_disable(SYSCTL_HANDLER_ARGS) 789{ 790 struct dev_event_info *n1; 791 int dis, error; 792 793 dis = (devctl_queue_length == 0); 794 error = sysctl_handle_int(oidp, &dis, 0, req); 795 if (error || !req->newptr) 796 return (error); 797 if (mtx_initialized(&devsoftc.mtx)) 798 mtx_lock(&devsoftc.mtx); 799 if (dis) { 800 while (!TAILQ_EMPTY(&devsoftc.devq)) { 801 n1 = TAILQ_FIRST(&devsoftc.devq); 802 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link); 803 free(n1->dei_data, M_BUS); 804 free(n1, M_BUS); 805 } 806 devsoftc.queued = 0; 807 devctl_queue_length = 0; 808 } else { 809 devctl_queue_length = DEVCTL_DEFAULT_QUEUE_LEN; 810 } 811 if (mtx_initialized(&devsoftc.mtx)) 812 mtx_unlock(&devsoftc.mtx); 813 return (0); 814} 815 816static int 817sysctl_devctl_queue(SYSCTL_HANDLER_ARGS) 818{ 819 struct dev_event_info *n1; 820 int q, error; 821 822 q = devctl_queue_length; 823 error = sysctl_handle_int(oidp, &q, 0, req); 824 if (error || !req->newptr) 825 return (error); 826 if (q < 0) 827 return (EINVAL); 828 if (mtx_initialized(&devsoftc.mtx)) 829 mtx_lock(&devsoftc.mtx); 830 devctl_queue_length = q; 831 while (devsoftc.queued > devctl_queue_length) { 832 n1 = TAILQ_FIRST(&devsoftc.devq); 833 TAILQ_REMOVE(&devsoftc.devq, n1, dei_link); 834 free(n1->dei_data, M_BUS); 835 free(n1, M_BUS); 836 devsoftc.queued--; 837 } 838 if (mtx_initialized(&devsoftc.mtx)) 839 mtx_unlock(&devsoftc.mtx); 840 return (0); 841} 842 843/** 844 * @brief safely quotes strings that might have double quotes in them. 845 * 846 * The devctl protocol relies on quoted strings having matching quotes. 847 * This routine quotes any internal quotes so the resulting string 848 * is safe to pass to snprintf to construct, for example pnp info strings. 849 * Strings are always terminated with a NUL, but may be truncated if longer 850 * than @p len bytes after quotes. 851 * 852 * @param dst Buffer to hold the string. Must be at least @p len bytes long 853 * @param src Original buffer. 854 * @param len Length of buffer pointed to by @dst, including trailing NUL 855 */ 856void 857devctl_safe_quote(char *dst, const char *src, size_t len) 858{ 859 char *walker = dst, *ep = dst + len - 1; 860 861 if (len == 0) 862 return; 863 while (src != NULL && walker < ep) 864 { 865 if (*src == '"' || *src == '\\') { 866 if (ep - walker < 2) 867 break; 868 *walker++ = '\\'; 869 } 870 *walker++ = *src++; 871 } 872 *walker = '\0'; 873} 874 875/* End of /dev/devctl code */ 876 877static TAILQ_HEAD(,device) bus_data_devices; 878static int bus_data_generation = 1; 879 880static kobj_method_t null_methods[] = { 881 KOBJMETHOD_END 882}; 883 884DEFINE_CLASS(null, null_methods, 0); 885 886/* 887 * Bus pass implementation 888 */ 889 890static driver_list_t passes = TAILQ_HEAD_INITIALIZER(passes); 891int bus_current_pass = BUS_PASS_ROOT; 892 893/** 894 * @internal 895 * @brief Register the pass level of a new driver attachment 896 * 897 * Register a new driver attachment's pass level. If no driver 898 * attachment with the same pass level has been added, then @p new 899 * will be added to the global passes list. 900 * 901 * @param new the new driver attachment 902 */ 903static void 904driver_register_pass(struct driverlink *new) 905{ 906 struct driverlink *dl; 907 908 /* We only consider pass numbers during boot. */ 909 if (bus_current_pass == BUS_PASS_DEFAULT) 910 return; 911 912 /* 913 * Walk the passes list. If we already know about this pass 914 * then there is nothing to do. If we don't, then insert this 915 * driver link into the list. 916 */ 917 TAILQ_FOREACH(dl, &passes, passlink) { 918 if (dl->pass < new->pass) 919 continue; 920 if (dl->pass == new->pass) 921 return; 922 TAILQ_INSERT_BEFORE(dl, new, passlink); 923 return; 924 } 925 TAILQ_INSERT_TAIL(&passes, new, passlink); 926} 927 928/** 929 * @brief Raise the current bus pass 930 * 931 * Raise the current bus pass level to @p pass. Call the BUS_NEW_PASS() 932 * method on the root bus to kick off a new device tree scan for each 933 * new pass level that has at least one driver. 934 */ 935void 936bus_set_pass(int pass) 937{ 938 struct driverlink *dl; 939 940 if (bus_current_pass > pass) 941 panic("Attempt to lower bus pass level"); 942 943 TAILQ_FOREACH(dl, &passes, passlink) { 944 /* Skip pass values below the current pass level. */ 945 if (dl->pass <= bus_current_pass) 946 continue; 947 948 /* 949 * Bail once we hit a driver with a pass level that is 950 * too high. 951 */ 952 if (dl->pass > pass) 953 break; 954 955 /* 956 * Raise the pass level to the next level and rescan 957 * the tree. 958 */ 959 bus_current_pass = dl->pass; 960 BUS_NEW_PASS(root_bus); 961 } 962 963 /* 964 * If there isn't a driver registered for the requested pass, 965 * then bus_current_pass might still be less than 'pass'. Set 966 * it to 'pass' in that case. 967 */ 968 if (bus_current_pass < pass) 969 bus_current_pass = pass; 970 KASSERT(bus_current_pass == pass, ("Failed to update bus pass level")); 971} 972 973/* 974 * Devclass implementation 975 */ 976 977static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses); 978 979/** 980 * @internal 981 * @brief Find or create a device class 982 * 983 * If a device class with the name @p classname exists, return it, 984 * otherwise if @p create is non-zero create and return a new device 985 * class. 986 * 987 * If @p parentname is non-NULL, the parent of the devclass is set to 988 * the devclass of that name. 989 * 990 * @param classname the devclass name to find or create 991 * @param parentname the parent devclass name or @c NULL 992 * @param create non-zero to create a devclass 993 */ 994static devclass_t 995devclass_find_internal(const char *classname, const char *parentname, 996 int create) 997{ 998 devclass_t dc; 999 1000 PDEBUG(("looking for %s", classname)); 1001 if (!classname) 1002 return (NULL); 1003 1004 TAILQ_FOREACH(dc, &devclasses, link) { 1005 if (!strcmp(dc->name, classname)) 1006 break; 1007 } 1008 1009 if (create && !dc) { 1010 PDEBUG(("creating %s", classname)); 1011 dc = malloc(sizeof(struct devclass) + strlen(classname) + 1, 1012 M_BUS, M_NOWAIT | M_ZERO); 1013 if (!dc) 1014 return (NULL); 1015 dc->parent = NULL; 1016 dc->name = (char*) (dc + 1); 1017 strcpy(dc->name, classname); 1018 TAILQ_INIT(&dc->drivers); 1019 TAILQ_INSERT_TAIL(&devclasses, dc, link); 1020 1021 bus_data_generation_update(); 1022 } 1023 1024 /* 1025 * If a parent class is specified, then set that as our parent so 1026 * that this devclass will support drivers for the parent class as 1027 * well. If the parent class has the same name don't do this though 1028 * as it creates a cycle that can trigger an infinite loop in 1029 * device_probe_child() if a device exists for which there is no 1030 * suitable driver. 1031 */ 1032 if (parentname && dc && !dc->parent && 1033 strcmp(classname, parentname) != 0) { 1034 dc->parent = devclass_find_internal(parentname, NULL, TRUE); 1035 dc->parent->flags |= DC_HAS_CHILDREN; 1036 } 1037 1038 return (dc); 1039} 1040 1041/** 1042 * @brief Create a device class 1043 * 1044 * If a device class with the name @p classname exists, return it, 1045 * otherwise create and return a new device class. 1046 * 1047 * @param classname the devclass name to find or create 1048 */ 1049devclass_t 1050devclass_create(const char *classname) 1051{ 1052 return (devclass_find_internal(classname, NULL, TRUE)); 1053} 1054 1055/** 1056 * @brief Find a device class 1057 * 1058 * If a device class with the name @p classname exists, return it, 1059 * otherwise return @c NULL. 1060 * 1061 * @param classname the devclass name to find 1062 */ 1063devclass_t 1064devclass_find(const char *classname) 1065{ 1066 return (devclass_find_internal(classname, NULL, FALSE)); 1067} 1068 1069/** 1070 * @brief Register that a device driver has been added to a devclass 1071 * 1072 * Register that a device driver has been added to a devclass. This 1073 * is called by devclass_add_driver to accomplish the recursive 1074 * notification of all the children classes of dc, as well as dc. 1075 * Each layer will have BUS_DRIVER_ADDED() called for all instances of 1076 * the devclass. 1077 * 1078 * We do a full search here of the devclass list at each iteration 1079 * level to save storing children-lists in the devclass structure. If 1080 * we ever move beyond a few dozen devices doing this, we may need to 1081 * reevaluate... 1082 * 1083 * @param dc the devclass to edit 1084 * @param driver the driver that was just added 1085 */ 1086static void 1087devclass_driver_added(devclass_t dc, driver_t *driver) 1088{ 1089 devclass_t parent; 1090 int i; 1091 1092 /* 1093 * Call BUS_DRIVER_ADDED for any existing busses in this class. 1094 */ 1095 for (i = 0; i < dc->maxunit; i++) 1096 if (dc->devices[i] && device_is_attached(dc->devices[i])) 1097 BUS_DRIVER_ADDED(dc->devices[i], driver); 1098 1099 /* 1100 * Walk through the children classes. Since we only keep a 1101 * single parent pointer around, we walk the entire list of 1102 * devclasses looking for children. We set the 1103 * DC_HAS_CHILDREN flag when a child devclass is created on 1104 * the parent, so we only walk the list for those devclasses 1105 * that have children. 1106 */ 1107 if (!(dc->flags & DC_HAS_CHILDREN)) 1108 return; 1109 parent = dc; 1110 TAILQ_FOREACH(dc, &devclasses, link) { 1111 if (dc->parent == parent) 1112 devclass_driver_added(dc, driver); 1113 } 1114} 1115 1116/** 1117 * @brief Add a device driver to a device class 1118 * 1119 * Add a device driver to a devclass. This is normally called 1120 * automatically by DRIVER_MODULE(). The BUS_DRIVER_ADDED() method of 1121 * all devices in the devclass will be called to allow them to attempt 1122 * to re-probe any unmatched children. 1123 * 1124 * @param dc the devclass to edit 1125 * @param driver the driver to register 1126 */ 1127int 1128devclass_add_driver(devclass_t dc, driver_t *driver, int pass, devclass_t *dcp) 1129{ 1130 driverlink_t dl; 1131 const char *parentname; 1132 1133 PDEBUG(("%s", DRIVERNAME(driver))); 1134 1135 /* Don't allow invalid pass values. */ 1136 if (pass <= BUS_PASS_ROOT) 1137 return (EINVAL); 1138 1139 dl = malloc(sizeof *dl, M_BUS, M_NOWAIT|M_ZERO); 1140 if (!dl) 1141 return (ENOMEM); 1142 1143 /* 1144 * Compile the driver's methods. Also increase the reference count 1145 * so that the class doesn't get freed when the last instance 1146 * goes. This means we can safely use static methods and avoids a 1147 * double-free in devclass_delete_driver. 1148 */ 1149 kobj_class_compile((kobj_class_t) driver); 1150 1151 /* 1152 * If the driver has any base classes, make the 1153 * devclass inherit from the devclass of the driver's 1154 * first base class. This will allow the system to 1155 * search for drivers in both devclasses for children 1156 * of a device using this driver. 1157 */ 1158 if (driver->baseclasses) 1159 parentname = driver->baseclasses[0]->name; 1160 else 1161 parentname = NULL; 1162 *dcp = devclass_find_internal(driver->name, parentname, TRUE); 1163 1164 dl->driver = driver; 1165 TAILQ_INSERT_TAIL(&dc->drivers, dl, link); 1166 driver->refs++; /* XXX: kobj_mtx */ 1167 dl->pass = pass; 1168 driver_register_pass(dl); 1169 1170 devclass_driver_added(dc, driver); 1171 bus_data_generation_update(); 1172 return (0); 1173} 1174 1175/** 1176 * @brief Register that a device driver has been deleted from a devclass 1177 * 1178 * Register that a device driver has been removed from a devclass. 1179 * This is called by devclass_delete_driver to accomplish the 1180 * recursive notification of all the children classes of busclass, as 1181 * well as busclass. Each layer will attempt to detach the driver 1182 * from any devices that are children of the bus's devclass. The function 1183 * will return an error if a device fails to detach. 1184 * 1185 * We do a full search here of the devclass list at each iteration 1186 * level to save storing children-lists in the devclass structure. If 1187 * we ever move beyond a few dozen devices doing this, we may need to 1188 * reevaluate... 1189 * 1190 * @param busclass the devclass of the parent bus 1191 * @param dc the devclass of the driver being deleted 1192 * @param driver the driver being deleted 1193 */ 1194static int 1195devclass_driver_deleted(devclass_t busclass, devclass_t dc, driver_t *driver) 1196{ 1197 devclass_t parent; 1198 device_t dev; 1199 int error, i; 1200 1201 /* 1202 * Disassociate from any devices. We iterate through all the 1203 * devices in the devclass of the driver and detach any which are 1204 * using the driver and which have a parent in the devclass which 1205 * we are deleting from. 1206 * 1207 * Note that since a driver can be in multiple devclasses, we 1208 * should not detach devices which are not children of devices in 1209 * the affected devclass. 1210 */ 1211 for (i = 0; i < dc->maxunit; i++) { 1212 if (dc->devices[i]) { 1213 dev = dc->devices[i]; 1214 if (dev->driver == driver && dev->parent && 1215 dev->parent->devclass == busclass) { 1216 if ((error = device_detach(dev)) != 0) 1217 return (error); 1218 BUS_PROBE_NOMATCH(dev->parent, dev); 1219 devnomatch(dev); 1220 dev->flags |= DF_DONENOMATCH; 1221 } 1222 } 1223 } 1224 1225 /* 1226 * Walk through the children classes. Since we only keep a 1227 * single parent pointer around, we walk the entire list of 1228 * devclasses looking for children. We set the 1229 * DC_HAS_CHILDREN flag when a child devclass is created on 1230 * the parent, so we only walk the list for those devclasses 1231 * that have children. 1232 */ 1233 if (!(busclass->flags & DC_HAS_CHILDREN)) 1234 return (0); 1235 parent = busclass; 1236 TAILQ_FOREACH(busclass, &devclasses, link) { 1237 if (busclass->parent == parent) { 1238 error = devclass_driver_deleted(busclass, dc, driver); 1239 if (error) 1240 return (error); 1241 } 1242 } 1243 return (0); 1244} 1245 1246/** 1247 * @brief Delete a device driver from a device class 1248 * 1249 * Delete a device driver from a devclass. This is normally called 1250 * automatically by DRIVER_MODULE(). 1251 * 1252 * If the driver is currently attached to any devices, 1253 * devclass_delete_driver() will first attempt to detach from each 1254 * device. If one of the detach calls fails, the driver will not be 1255 * deleted. 1256 * 1257 * @param dc the devclass to edit 1258 * @param driver the driver to unregister 1259 */ 1260int 1261devclass_delete_driver(devclass_t busclass, driver_t *driver) 1262{ 1263 devclass_t dc = devclass_find(driver->name); 1264 driverlink_t dl; 1265 int error; 1266 1267 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass))); 1268 1269 if (!dc) 1270 return (0); 1271 1272 /* 1273 * Find the link structure in the bus' list of drivers. 1274 */ 1275 TAILQ_FOREACH(dl, &busclass->drivers, link) { 1276 if (dl->driver == driver) 1277 break; 1278 } 1279 1280 if (!dl) { 1281 PDEBUG(("%s not found in %s list", driver->name, 1282 busclass->name)); 1283 return (ENOENT); 1284 } 1285 1286 error = devclass_driver_deleted(busclass, dc, driver); 1287 if (error != 0) 1288 return (error); 1289 1290 TAILQ_REMOVE(&busclass->drivers, dl, link); 1291 free(dl, M_BUS); 1292 1293 /* XXX: kobj_mtx */ 1294 driver->refs--; 1295 if (driver->refs == 0) 1296 kobj_class_free((kobj_class_t) driver); 1297 1298 bus_data_generation_update(); 1299 return (0); 1300} 1301 1302/** 1303 * @brief Quiesces a set of device drivers from a device class 1304 * 1305 * Quiesce a device driver from a devclass. This is normally called 1306 * automatically by DRIVER_MODULE(). 1307 * 1308 * If the driver is currently attached to any devices, 1309 * devclass_quiesece_driver() will first attempt to quiesce each 1310 * device. 1311 * 1312 * @param dc the devclass to edit 1313 * @param driver the driver to unregister 1314 */ 1315static int 1316devclass_quiesce_driver(devclass_t busclass, driver_t *driver) 1317{ 1318 devclass_t dc = devclass_find(driver->name); 1319 driverlink_t dl; 1320 device_t dev; 1321 int i; 1322 int error; 1323 1324 PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass))); 1325 1326 if (!dc) 1327 return (0); 1328 1329 /* 1330 * Find the link structure in the bus' list of drivers. 1331 */ 1332 TAILQ_FOREACH(dl, &busclass->drivers, link) { 1333 if (dl->driver == driver) 1334 break; 1335 } 1336 1337 if (!dl) { 1338 PDEBUG(("%s not found in %s list", driver->name, 1339 busclass->name)); 1340 return (ENOENT); 1341 } 1342 1343 /* 1344 * Quiesce all devices. We iterate through all the devices in 1345 * the devclass of the driver and quiesce any which are using 1346 * the driver and which have a parent in the devclass which we 1347 * are quiescing. 1348 * 1349 * Note that since a driver can be in multiple devclasses, we 1350 * should not quiesce devices which are not children of 1351 * devices in the affected devclass. 1352 */ 1353 for (i = 0; i < dc->maxunit; i++) { 1354 if (dc->devices[i]) { 1355 dev = dc->devices[i]; 1356 if (dev->driver == driver && dev->parent && 1357 dev->parent->devclass == busclass) { 1358 if ((error = device_quiesce(dev)) != 0) 1359 return (error); 1360 } 1361 } 1362 } 1363 1364 return (0); 1365} 1366 1367/** 1368 * @internal 1369 */ 1370static driverlink_t 1371devclass_find_driver_internal(devclass_t dc, const char *classname) 1372{ 1373 driverlink_t dl; 1374 1375 PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc))); 1376 1377 TAILQ_FOREACH(dl, &dc->drivers, link) { 1378 if (!strcmp(dl->driver->name, classname)) 1379 return (dl); 1380 } 1381 1382 PDEBUG(("not found")); 1383 return (NULL); 1384} 1385 1386/** 1387 * @brief Return the name of the devclass 1388 */ 1389const char * 1390devclass_get_name(devclass_t dc) 1391{ 1392 return (dc->name); 1393} 1394 1395/** 1396 * @brief Find a device given a unit number 1397 * 1398 * @param dc the devclass to search 1399 * @param unit the unit number to search for 1400 * 1401 * @returns the device with the given unit number or @c 1402 * NULL if there is no such device 1403 */ 1404device_t 1405devclass_get_device(devclass_t dc, int unit) 1406{ 1407 if (dc == NULL || unit < 0 || unit >= dc->maxunit) 1408 return (NULL); 1409 return (dc->devices[unit]); 1410} 1411 1412/** 1413 * @brief Find the softc field of a device given a unit number 1414 * 1415 * @param dc the devclass to search 1416 * @param unit the unit number to search for 1417 * 1418 * @returns the softc field of the device with the given 1419 * unit number or @c NULL if there is no such 1420 * device 1421 */ 1422void * 1423devclass_get_softc(devclass_t dc, int unit) 1424{ 1425 device_t dev; 1426 1427 dev = devclass_get_device(dc, unit); 1428 if (!dev) 1429 return (NULL); 1430 1431 return (device_get_softc(dev)); 1432} 1433 1434/** 1435 * @brief Get a list of devices in the devclass 1436 * 1437 * An array containing a list of all the devices in the given devclass 1438 * is allocated and returned in @p *devlistp. The number of devices 1439 * in the array is returned in @p *devcountp. The caller should free 1440 * the array using @c free(p, M_TEMP), even if @p *devcountp is 0. 1441 * 1442 * @param dc the devclass to examine 1443 * @param devlistp points at location for array pointer return 1444 * value 1445 * @param devcountp points at location for array size return value 1446 * 1447 * @retval 0 success 1448 * @retval ENOMEM the array allocation failed 1449 */ 1450int 1451devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp) 1452{ 1453 int count, i; 1454 device_t *list; 1455 1456 count = devclass_get_count(dc); 1457 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO); 1458 if (!list) 1459 return (ENOMEM); 1460 1461 count = 0; 1462 for (i = 0; i < dc->maxunit; i++) { 1463 if (dc->devices[i]) { 1464 list[count] = dc->devices[i]; 1465 count++; 1466 } 1467 } 1468 1469 *devlistp = list; 1470 *devcountp = count; 1471 1472 return (0); 1473} 1474 1475/** 1476 * @brief Get a list of drivers in the devclass 1477 * 1478 * An array containing a list of pointers to all the drivers in the 1479 * given devclass is allocated and returned in @p *listp. The number 1480 * of drivers in the array is returned in @p *countp. The caller should 1481 * free the array using @c free(p, M_TEMP). 1482 * 1483 * @param dc the devclass to examine 1484 * @param listp gives location for array pointer return value 1485 * @param countp gives location for number of array elements 1486 * return value 1487 * 1488 * @retval 0 success 1489 * @retval ENOMEM the array allocation failed 1490 */ 1491int 1492devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp) 1493{ 1494 driverlink_t dl; 1495 driver_t **list; 1496 int count; 1497 1498 count = 0; 1499 TAILQ_FOREACH(dl, &dc->drivers, link) 1500 count++; 1501 list = malloc(count * sizeof(driver_t *), M_TEMP, M_NOWAIT); 1502 if (list == NULL) 1503 return (ENOMEM); 1504 1505 count = 0; 1506 TAILQ_FOREACH(dl, &dc->drivers, link) { 1507 list[count] = dl->driver; 1508 count++; 1509 } 1510 *listp = list; 1511 *countp = count; 1512 1513 return (0); 1514} 1515 1516/** 1517 * @brief Get the number of devices in a devclass 1518 * 1519 * @param dc the devclass to examine 1520 */ 1521int 1522devclass_get_count(devclass_t dc) 1523{ 1524 int count, i; 1525 1526 count = 0; 1527 for (i = 0; i < dc->maxunit; i++) 1528 if (dc->devices[i]) 1529 count++; 1530 return (count); 1531} 1532 1533/** 1534 * @brief Get the maximum unit number used in a devclass 1535 * 1536 * Note that this is one greater than the highest currently-allocated 1537 * unit. If a null devclass_t is passed in, -1 is returned to indicate 1538 * that not even the devclass has been allocated yet. 1539 * 1540 * @param dc the devclass to examine 1541 */ 1542int 1543devclass_get_maxunit(devclass_t dc) 1544{ 1545 if (dc == NULL) 1546 return (-1); 1547 return (dc->maxunit); 1548} 1549 1550/** 1551 * @brief Find a free unit number in a devclass 1552 * 1553 * This function searches for the first unused unit number greater 1554 * that or equal to @p unit. 1555 * 1556 * @param dc the devclass to examine 1557 * @param unit the first unit number to check 1558 */ 1559int 1560devclass_find_free_unit(devclass_t dc, int unit) 1561{ 1562 if (dc == NULL) 1563 return (unit); 1564 while (unit < dc->maxunit && dc->devices[unit] != NULL) 1565 unit++; 1566 return (unit); 1567} 1568 1569/** 1570 * @brief Set the parent of a devclass 1571 * 1572 * The parent class is normally initialised automatically by 1573 * DRIVER_MODULE(). 1574 * 1575 * @param dc the devclass to edit 1576 * @param pdc the new parent devclass 1577 */ 1578void 1579devclass_set_parent(devclass_t dc, devclass_t pdc) 1580{ 1581 dc->parent = pdc; 1582} 1583 1584/** 1585 * @brief Get the parent of a devclass 1586 * 1587 * @param dc the devclass to examine 1588 */ 1589devclass_t 1590devclass_get_parent(devclass_t dc) 1591{ 1592 return (dc->parent); 1593} 1594 1595struct sysctl_ctx_list * 1596devclass_get_sysctl_ctx(devclass_t dc) 1597{ 1598 return (&dc->sysctl_ctx); 1599} 1600 1601struct sysctl_oid * 1602devclass_get_sysctl_tree(devclass_t dc) 1603{ 1604 return (dc->sysctl_tree); 1605} 1606 1607/** 1608 * @internal 1609 * @brief Allocate a unit number 1610 * 1611 * On entry, @p *unitp is the desired unit number (or @c -1 if any 1612 * will do). The allocated unit number is returned in @p *unitp. 1613 1614 * @param dc the devclass to allocate from 1615 * @param unitp points at the location for the allocated unit 1616 * number 1617 * 1618 * @retval 0 success 1619 * @retval EEXIST the requested unit number is already allocated 1620 * @retval ENOMEM memory allocation failure 1621 */ 1622static int 1623devclass_alloc_unit(devclass_t dc, device_t dev, int *unitp) 1624{ 1625 const char *s; 1626 int unit = *unitp; 1627 1628 PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc))); 1629 1630 /* Ask the parent bus if it wants to wire this device. */ 1631 if (unit == -1) 1632 BUS_HINT_DEVICE_UNIT(device_get_parent(dev), dev, dc->name, 1633 &unit); 1634 1635 /* If we were given a wired unit number, check for existing device */ 1636 /* XXX imp XXX */ 1637 if (unit != -1) { 1638 if (unit >= 0 && unit < dc->maxunit && 1639 dc->devices[unit] != NULL) { 1640 if (bootverbose) 1641 printf("%s: %s%d already exists; skipping it\n", 1642 dc->name, dc->name, *unitp); 1643 return (EEXIST); 1644 } 1645 } else { 1646 /* Unwired device, find the next available slot for it */ 1647 unit = 0; 1648 for (unit = 0;; unit++) { 1649 /* If there is an "at" hint for a unit then skip it. */ 1650 if (resource_string_value(dc->name, unit, "at", &s) == 1651 0) 1652 continue; 1653 1654 /* If this device slot is already in use, skip it. */ 1655 if (unit < dc->maxunit && dc->devices[unit] != NULL) 1656 continue; 1657 1658 break; 1659 } 1660 } 1661 1662 /* 1663 * We've selected a unit beyond the length of the table, so let's 1664 * extend the table to make room for all units up to and including 1665 * this one. 1666 */ 1667 if (unit >= dc->maxunit) { 1668 device_t *newlist, *oldlist; 1669 int newsize; 1670 1671 oldlist = dc->devices; 1672 newsize = roundup((unit + 1), MINALLOCSIZE / sizeof(device_t)); 1673 newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT); 1674 if (!newlist) 1675 return (ENOMEM); 1676 if (oldlist != NULL) 1677 bcopy(oldlist, newlist, sizeof(device_t) * dc->maxunit); 1678 bzero(newlist + dc->maxunit, 1679 sizeof(device_t) * (newsize - dc->maxunit)); 1680 dc->devices = newlist; 1681 dc->maxunit = newsize; 1682 if (oldlist != NULL) 1683 free(oldlist, M_BUS); 1684 } 1685 PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc))); 1686 1687 *unitp = unit; 1688 return (0); 1689} 1690 1691/** 1692 * @internal 1693 * @brief Add a device to a devclass 1694 * 1695 * A unit number is allocated for the device (using the device's 1696 * preferred unit number if any) and the device is registered in the 1697 * devclass. This allows the device to be looked up by its unit 1698 * number, e.g. by decoding a dev_t minor number. 1699 * 1700 * @param dc the devclass to add to 1701 * @param dev the device to add 1702 * 1703 * @retval 0 success 1704 * @retval EEXIST the requested unit number is already allocated 1705 * @retval ENOMEM memory allocation failure 1706 */ 1707static int 1708devclass_add_device(devclass_t dc, device_t dev) 1709{ 1710 int buflen, error; 1711 1712 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc))); 1713 1714 buflen = snprintf(NULL, 0, "%s%d$", dc->name, INT_MAX); 1715 if (buflen < 0) 1716 return (ENOMEM); 1717 dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT|M_ZERO); 1718 if (!dev->nameunit) 1719 return (ENOMEM); 1720 1721 if ((error = devclass_alloc_unit(dc, dev, &dev->unit)) != 0) { 1722 free(dev->nameunit, M_BUS); 1723 dev->nameunit = NULL; 1724 return (error); 1725 } 1726 dc->devices[dev->unit] = dev; 1727 dev->devclass = dc; 1728 snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit); 1729 1730 return (0); 1731} 1732 1733/** 1734 * @internal 1735 * @brief Delete a device from a devclass 1736 * 1737 * The device is removed from the devclass's device list and its unit 1738 * number is freed. 1739 1740 * @param dc the devclass to delete from 1741 * @param dev the device to delete 1742 * 1743 * @retval 0 success 1744 */ 1745static int 1746devclass_delete_device(devclass_t dc, device_t dev) 1747{ 1748 if (!dc || !dev) 1749 return (0); 1750 1751 PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc))); 1752 1753 if (dev->devclass != dc || dc->devices[dev->unit] != dev) 1754 panic("devclass_delete_device: inconsistent device class"); 1755 dc->devices[dev->unit] = NULL; 1756 if (dev->flags & DF_WILDCARD) 1757 dev->unit = -1; 1758 dev->devclass = NULL; 1759 free(dev->nameunit, M_BUS); 1760 dev->nameunit = NULL; 1761 1762 return (0); 1763} 1764 1765/** 1766 * @internal 1767 * @brief Make a new device and add it as a child of @p parent 1768 * 1769 * @param parent the parent of the new device 1770 * @param name the devclass name of the new device or @c NULL 1771 * to leave the devclass unspecified 1772 * @parem unit the unit number of the new device of @c -1 to 1773 * leave the unit number unspecified 1774 * 1775 * @returns the new device 1776 */ 1777static device_t 1778make_device(device_t parent, const char *name, int unit) 1779{ 1780 device_t dev; 1781 devclass_t dc; 1782 1783 PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit)); 1784 1785 if (name) { 1786 dc = devclass_find_internal(name, NULL, TRUE); 1787 if (!dc) { 1788 printf("make_device: can't find device class %s\n", 1789 name); 1790 return (NULL); 1791 } 1792 } else { 1793 dc = NULL; 1794 } 1795 1796 dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO); 1797 if (!dev) 1798 return (NULL); 1799 1800 dev->parent = parent; 1801 TAILQ_INIT(&dev->children); 1802 kobj_init((kobj_t) dev, &null_class); 1803 dev->driver = NULL; 1804 dev->devclass = NULL; 1805 dev->unit = unit; 1806 dev->nameunit = NULL; 1807 dev->desc = NULL; 1808 dev->busy = 0; 1809 dev->devflags = 0; 1810 dev->flags = DF_ENABLED; 1811 dev->order = 0; 1812 if (unit == -1) 1813 dev->flags |= DF_WILDCARD; 1814 if (name) { 1815 dev->flags |= DF_FIXEDCLASS; 1816 if (devclass_add_device(dc, dev)) { 1817 kobj_delete((kobj_t) dev, M_BUS); 1818 return (NULL); 1819 } 1820 } 1821 dev->ivars = NULL; 1822 dev->softc = NULL; 1823 1824 dev->state = DS_NOTPRESENT; 1825 1826 TAILQ_INSERT_TAIL(&bus_data_devices, dev, devlink); 1827 bus_data_generation_update(); 1828 1829 return (dev); 1830} 1831 1832/** 1833 * @internal 1834 * @brief Print a description of a device. 1835 */ 1836static int 1837device_print_child(device_t dev, device_t child) 1838{ 1839 int retval = 0; 1840 1841 if (device_is_alive(child)) 1842 retval += BUS_PRINT_CHILD(dev, child); 1843 else 1844 retval += device_printf(child, " not found\n"); 1845 1846 return (retval); 1847} 1848 1849/** 1850 * @brief Create a new device 1851 * 1852 * This creates a new device and adds it as a child of an existing 1853 * parent device. The new device will be added after the last existing 1854 * child with order zero. 1855 * 1856 * @param dev the device which will be the parent of the 1857 * new child device 1858 * @param name devclass name for new device or @c NULL if not 1859 * specified 1860 * @param unit unit number for new device or @c -1 if not 1861 * specified 1862 * 1863 * @returns the new device 1864 */ 1865device_t 1866device_add_child(device_t dev, const char *name, int unit) 1867{ 1868 return (device_add_child_ordered(dev, 0, name, unit)); 1869} 1870 1871/** 1872 * @brief Create a new device 1873 * 1874 * This creates a new device and adds it as a child of an existing 1875 * parent device. The new device will be added after the last existing 1876 * child with the same order. 1877 * 1878 * @param dev the device which will be the parent of the 1879 * new child device 1880 * @param order a value which is used to partially sort the 1881 * children of @p dev - devices created using 1882 * lower values of @p order appear first in @p 1883 * dev's list of children 1884 * @param name devclass name for new device or @c NULL if not 1885 * specified 1886 * @param unit unit number for new device or @c -1 if not 1887 * specified 1888 * 1889 * @returns the new device 1890 */ 1891device_t 1892device_add_child_ordered(device_t dev, u_int order, const char *name, int unit) 1893{ 1894 device_t child; 1895 device_t place; 1896 1897 PDEBUG(("%s at %s with order %u as unit %d", 1898 name, DEVICENAME(dev), order, unit)); 1899 KASSERT(name != NULL || unit == -1, 1900 ("child device with wildcard name and specific unit number")); 1901 1902 child = make_device(dev, name, unit); 1903 if (child == NULL) 1904 return (child); 1905 child->order = order; 1906 1907 TAILQ_FOREACH(place, &dev->children, link) { 1908 if (place->order > order) 1909 break; 1910 } 1911 1912 if (place) { 1913 /* 1914 * The device 'place' is the first device whose order is 1915 * greater than the new child. 1916 */ 1917 TAILQ_INSERT_BEFORE(place, child, link); 1918 } else { 1919 /* 1920 * The new child's order is greater or equal to the order of 1921 * any existing device. Add the child to the tail of the list. 1922 */ 1923 TAILQ_INSERT_TAIL(&dev->children, child, link); 1924 } 1925 1926 bus_data_generation_update(); 1927 return (child); 1928} 1929 1930/** 1931 * @brief Delete a device 1932 * 1933 * This function deletes a device along with all of its children. If 1934 * the device currently has a driver attached to it, the device is 1935 * detached first using device_detach(). 1936 * 1937 * @param dev the parent device 1938 * @param child the device to delete 1939 * 1940 * @retval 0 success 1941 * @retval non-zero a unit error code describing the error 1942 */ 1943int 1944device_delete_child(device_t dev, device_t child) 1945{ 1946 int error; 1947 device_t grandchild; 1948 1949 PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev))); 1950 1951 /* detach parent before deleting children, if any */ 1952 if ((error = device_detach(child)) != 0) 1953 return (error); 1954 1955 /* remove children second */ 1956 while ((grandchild = TAILQ_FIRST(&child->children)) != NULL) { 1957 error = device_delete_child(child, grandchild); 1958 if (error) 1959 return (error); 1960 } 1961 1962 if (child->devclass) 1963 devclass_delete_device(child->devclass, child); 1964 if (child->parent) 1965 BUS_CHILD_DELETED(dev, child); 1966 TAILQ_REMOVE(&dev->children, child, link); 1967 TAILQ_REMOVE(&bus_data_devices, child, devlink); 1968 kobj_delete((kobj_t) child, M_BUS); 1969 1970 bus_data_generation_update(); 1971 return (0); 1972} 1973 1974/** 1975 * @brief Delete all children devices of the given device, if any. 1976 * 1977 * This function deletes all children devices of the given device, if 1978 * any, using the device_delete_child() function for each device it 1979 * finds. If a child device cannot be deleted, this function will 1980 * return an error code. 1981 * 1982 * @param dev the parent device 1983 * 1984 * @retval 0 success 1985 * @retval non-zero a device would not detach 1986 */ 1987int 1988device_delete_children(device_t dev) 1989{ 1990 device_t child; 1991 int error; 1992 1993 PDEBUG(("Deleting all children of %s", DEVICENAME(dev))); 1994 1995 error = 0; 1996 1997 while ((child = TAILQ_FIRST(&dev->children)) != NULL) { 1998 error = device_delete_child(dev, child); 1999 if (error) { 2000 PDEBUG(("Failed deleting %s", DEVICENAME(child))); 2001 break; 2002 } 2003 } 2004 return (error); 2005} 2006 2007/** 2008 * @brief Find a device given a unit number 2009 * 2010 * This is similar to devclass_get_devices() but only searches for 2011 * devices which have @p dev as a parent. 2012 * 2013 * @param dev the parent device to search 2014 * @param unit the unit number to search for. If the unit is -1, 2015 * return the first child of @p dev which has name 2016 * @p classname (that is, the one with the lowest unit.) 2017 * 2018 * @returns the device with the given unit number or @c 2019 * NULL if there is no such device 2020 */ 2021device_t 2022device_find_child(device_t dev, const char *classname, int unit) 2023{ 2024 devclass_t dc; 2025 device_t child; 2026 2027 dc = devclass_find(classname); 2028 if (!dc) 2029 return (NULL); 2030 2031 if (unit != -1) { 2032 child = devclass_get_device(dc, unit); 2033 if (child && child->parent == dev) 2034 return (child); 2035 } else { 2036 for (unit = 0; unit < devclass_get_maxunit(dc); unit++) { 2037 child = devclass_get_device(dc, unit); 2038 if (child && child->parent == dev) 2039 return (child); 2040 } 2041 } 2042 return (NULL); 2043} 2044 2045/** 2046 * @internal 2047 */ 2048static driverlink_t 2049first_matching_driver(devclass_t dc, device_t dev) 2050{ 2051 if (dev->devclass) 2052 return (devclass_find_driver_internal(dc, dev->devclass->name)); 2053 return (TAILQ_FIRST(&dc->drivers)); 2054} 2055 2056/** 2057 * @internal 2058 */ 2059static driverlink_t 2060next_matching_driver(devclass_t dc, device_t dev, driverlink_t last) 2061{ 2062 if (dev->devclass) { 2063 driverlink_t dl; 2064 for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link)) 2065 if (!strcmp(dev->devclass->name, dl->driver->name)) 2066 return (dl); 2067 return (NULL); 2068 } 2069 return (TAILQ_NEXT(last, link)); 2070} 2071 2072/** 2073 * @internal 2074 */ 2075int 2076device_probe_child(device_t dev, device_t child) 2077{ 2078 devclass_t dc; 2079 driverlink_t best = NULL; 2080 driverlink_t dl; 2081 int result, pri = 0; 2082 int hasclass = (child->devclass != NULL); 2083 2084 GIANT_REQUIRED; 2085 2086 dc = dev->devclass; 2087 if (!dc) 2088 panic("device_probe_child: parent device has no devclass"); 2089 2090 /* 2091 * If the state is already probed, then return. However, don't 2092 * return if we can rebid this object. 2093 */ 2094 if (child->state == DS_ALIVE && (child->flags & DF_REBID) == 0) 2095 return (0); 2096 2097 for (; dc; dc = dc->parent) { 2098 for (dl = first_matching_driver(dc, child); 2099 dl; 2100 dl = next_matching_driver(dc, child, dl)) { 2101 /* If this driver's pass is too high, then ignore it. */ 2102 if (dl->pass > bus_current_pass) 2103 continue; 2104 2105 PDEBUG(("Trying %s", DRIVERNAME(dl->driver))); 2106 result = device_set_driver(child, dl->driver); 2107 if (result == ENOMEM) 2108 return (result); 2109 else if (result != 0) 2110 continue; 2111 if (!hasclass) { 2112 if (device_set_devclass(child, 2113 dl->driver->name) != 0) { 2114 char const * devname = 2115 device_get_name(child); 2116 if (devname == NULL) 2117 devname = "(unknown)"; 2118 printf("driver bug: Unable to set " 2119 "devclass (class: %s " 2120 "devname: %s)\n", 2121 dl->driver->name, 2122 devname); 2123 (void)device_set_driver(child, NULL); 2124 continue; 2125 } 2126 } 2127 2128 /* Fetch any flags for the device before probing. */ 2129 resource_int_value(dl->driver->name, child->unit, 2130 "flags", &child->devflags); 2131 2132 result = DEVICE_PROBE(child); 2133 2134 /* Reset flags and devclass before the next probe. */ 2135 child->devflags = 0; 2136 if (!hasclass) 2137 (void)device_set_devclass(child, NULL); 2138 2139 /* 2140 * If the driver returns SUCCESS, there can be 2141 * no higher match for this device. 2142 */ 2143 if (result == 0) { 2144 best = dl; 2145 pri = 0; 2146 break; 2147 } 2148 2149 /* 2150 * Reset DF_QUIET in case this driver doesn't 2151 * end up as the best driver. 2152 */ 2153 device_verbose(child); 2154 2155 /* 2156 * Probes that return BUS_PROBE_NOWILDCARD or lower 2157 * only match on devices whose driver was explicitly 2158 * specified. 2159 */ 2160 if (result <= BUS_PROBE_NOWILDCARD && 2161 !(child->flags & DF_FIXEDCLASS)) { 2162 result = ENXIO; 2163 } 2164 2165 /* 2166 * The driver returned an error so it 2167 * certainly doesn't match. 2168 */ 2169 if (result > 0) { 2170 (void)device_set_driver(child, NULL); 2171 continue; 2172 } 2173 2174 /* 2175 * A priority lower than SUCCESS, remember the 2176 * best matching driver. Initialise the value 2177 * of pri for the first match. 2178 */ 2179 if (best == NULL || result > pri) { 2180 best = dl; 2181 pri = result; 2182 continue; 2183 } 2184 } 2185 /* 2186 * If we have an unambiguous match in this devclass, 2187 * don't look in the parent. 2188 */ 2189 if (best && pri == 0) 2190 break; 2191 } 2192 2193 /* 2194 * If we found a driver, change state and initialise the devclass. 2195 */ 2196 /* XXX What happens if we rebid and got no best? */ 2197 if (best) { 2198 /* 2199 * If this device was attached, and we were asked to 2200 * rescan, and it is a different driver, then we have 2201 * to detach the old driver and reattach this new one. 2202 * Note, we don't have to check for DF_REBID here 2203 * because if the state is > DS_ALIVE, we know it must 2204 * be. 2205 * 2206 * This assumes that all DF_REBID drivers can have 2207 * their probe routine called at any time and that 2208 * they are idempotent as well as completely benign in 2209 * normal operations. 2210 * 2211 * We also have to make sure that the detach 2212 * succeeded, otherwise we fail the operation (or 2213 * maybe it should just fail silently? I'm torn). 2214 */ 2215 if (child->state > DS_ALIVE && best->driver != child->driver) 2216 if ((result = device_detach(dev)) != 0) 2217 return (result); 2218 2219 /* Set the winning driver, devclass, and flags. */ 2220 if (!child->devclass) { 2221 result = device_set_devclass(child, best->driver->name); 2222 if (result != 0) 2223 return (result); 2224 } 2225 result = device_set_driver(child, best->driver); 2226 if (result != 0) 2227 return (result); 2228 resource_int_value(best->driver->name, child->unit, 2229 "flags", &child->devflags); 2230 2231 if (pri < 0) { 2232 /* 2233 * A bit bogus. Call the probe method again to make 2234 * sure that we have the right description. 2235 */ 2236 DEVICE_PROBE(child); 2237#if 0 2238 child->flags |= DF_REBID; 2239#endif 2240 } else 2241 child->flags &= ~DF_REBID; 2242 child->state = DS_ALIVE; 2243 2244 bus_data_generation_update(); 2245 return (0); 2246 } 2247 2248 return (ENXIO); 2249} 2250 2251/** 2252 * @brief Return the parent of a device 2253 */ 2254device_t 2255device_get_parent(device_t dev) 2256{ 2257 return (dev->parent); 2258} 2259 2260/** 2261 * @brief Get a list of children of a device 2262 * 2263 * An array containing a list of all the children of the given device 2264 * is allocated and returned in @p *devlistp. The number of devices 2265 * in the array is returned in @p *devcountp. The caller should free 2266 * the array using @c free(p, M_TEMP). 2267 * 2268 * @param dev the device to examine 2269 * @param devlistp points at location for array pointer return 2270 * value 2271 * @param devcountp points at location for array size return value 2272 * 2273 * @retval 0 success 2274 * @retval ENOMEM the array allocation failed 2275 */ 2276int 2277device_get_children(device_t dev, device_t **devlistp, int *devcountp) 2278{ 2279 int count; 2280 device_t child; 2281 device_t *list; 2282 2283 count = 0; 2284 TAILQ_FOREACH(child, &dev->children, link) { 2285 count++; 2286 } 2287 if (count == 0) { 2288 *devlistp = NULL; 2289 *devcountp = 0; 2290 return (0); 2291 } 2292 2293 list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT|M_ZERO); 2294 if (!list) 2295 return (ENOMEM); 2296 2297 count = 0; 2298 TAILQ_FOREACH(child, &dev->children, link) { 2299 list[count] = child; 2300 count++; 2301 } 2302 2303 *devlistp = list; 2304 *devcountp = count; 2305 2306 return (0); 2307} 2308 2309/** 2310 * @brief Return the current driver for the device or @c NULL if there 2311 * is no driver currently attached 2312 */ 2313driver_t * 2314device_get_driver(device_t dev) 2315{ 2316 return (dev->driver); 2317} 2318 2319/** 2320 * @brief Return the current devclass for the device or @c NULL if 2321 * there is none. 2322 */ 2323devclass_t 2324device_get_devclass(device_t dev) 2325{ 2326 return (dev->devclass); 2327} 2328 2329/** 2330 * @brief Return the name of the device's devclass or @c NULL if there 2331 * is none. 2332 */ 2333const char * 2334device_get_name(device_t dev) 2335{ 2336 if (dev != NULL && dev->devclass) 2337 return (devclass_get_name(dev->devclass)); 2338 return (NULL); 2339} 2340 2341/** 2342 * @brief Return a string containing the device's devclass name 2343 * followed by an ascii representation of the device's unit number 2344 * (e.g. @c "foo2"). 2345 */ 2346const char * 2347device_get_nameunit(device_t dev) 2348{ 2349 return (dev->nameunit); 2350} 2351 2352/** 2353 * @brief Return the device's unit number. 2354 */ 2355int 2356device_get_unit(device_t dev) 2357{ 2358 return (dev->unit); 2359} 2360 2361/** 2362 * @brief Return the device's description string 2363 */ 2364const char * 2365device_get_desc(device_t dev) 2366{ 2367 return (dev->desc); 2368} 2369 2370/** 2371 * @brief Return the device's flags 2372 */ 2373uint32_t 2374device_get_flags(device_t dev) 2375{ 2376 return (dev->devflags); 2377} 2378 2379struct sysctl_ctx_list * 2380device_get_sysctl_ctx(device_t dev) 2381{ 2382 return (&dev->sysctl_ctx); 2383} 2384 2385struct sysctl_oid * 2386device_get_sysctl_tree(device_t dev) 2387{ 2388 return (dev->sysctl_tree); 2389} 2390 2391/** 2392 * @brief Print the name of the device followed by a colon and a space 2393 * 2394 * @returns the number of characters printed 2395 */ 2396int 2397device_print_prettyname(device_t dev) 2398{ 2399 const char *name = device_get_name(dev); 2400 2401 if (name == NULL) 2402 return (printf("unknown: ")); 2403 return (printf("%s%d: ", name, device_get_unit(dev))); 2404} 2405 2406/** 2407 * @brief Print the name of the device followed by a colon, a space 2408 * and the result of calling vprintf() with the value of @p fmt and 2409 * the following arguments. 2410 * 2411 * @returns the number of characters printed 2412 */ 2413int 2414device_printf(device_t dev, const char * fmt, ...) 2415{ 2416 va_list ap; 2417 int retval; 2418 2419 retval = device_print_prettyname(dev); 2420 va_start(ap, fmt); 2421 retval += vprintf(fmt, ap); 2422 va_end(ap); 2423 return (retval); 2424} 2425 2426/** 2427 * @internal 2428 */ 2429static void 2430device_set_desc_internal(device_t dev, const char* desc, int copy) 2431{ 2432 if (dev->desc && (dev->flags & DF_DESCMALLOCED)) { 2433 free(dev->desc, M_BUS); 2434 dev->flags &= ~DF_DESCMALLOCED; 2435 dev->desc = NULL; 2436 } 2437 2438 if (copy && desc) { 2439 dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT); 2440 if (dev->desc) { 2441 strcpy(dev->desc, desc); 2442 dev->flags |= DF_DESCMALLOCED; 2443 } 2444 } else { 2445 /* Avoid a -Wcast-qual warning */ 2446 dev->desc = (char *)(uintptr_t) desc; 2447 } 2448 2449 bus_data_generation_update(); 2450} 2451 2452/** 2453 * @brief Set the device's description 2454 * 2455 * The value of @c desc should be a string constant that will not 2456 * change (at least until the description is changed in a subsequent 2457 * call to device_set_desc() or device_set_desc_copy()). 2458 */ 2459void 2460device_set_desc(device_t dev, const char* desc) 2461{ 2462 device_set_desc_internal(dev, desc, FALSE); 2463} 2464 2465/** 2466 * @brief Set the device's description 2467 * 2468 * The string pointed to by @c desc is copied. Use this function if 2469 * the device description is generated, (e.g. with sprintf()). 2470 */ 2471void 2472device_set_desc_copy(device_t dev, const char* desc) 2473{ 2474 device_set_desc_internal(dev, desc, TRUE); 2475} 2476 2477/** 2478 * @brief Set the device's flags 2479 */ 2480void 2481device_set_flags(device_t dev, uint32_t flags) 2482{ 2483 dev->devflags = flags; 2484} 2485 2486/** 2487 * @brief Return the device's softc field 2488 * 2489 * The softc is allocated and zeroed when a driver is attached, based 2490 * on the size field of the driver. 2491 */ 2492void * 2493device_get_softc(device_t dev) 2494{ 2495 return (dev->softc); 2496} 2497 2498/** 2499 * @brief Set the device's softc field 2500 * 2501 * Most drivers do not need to use this since the softc is allocated 2502 * automatically when the driver is attached. 2503 */ 2504void 2505device_set_softc(device_t dev, void *softc) 2506{ 2507 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) 2508 free(dev->softc, M_BUS_SC); 2509 dev->softc = softc; 2510 if (dev->softc) 2511 dev->flags |= DF_EXTERNALSOFTC; 2512 else 2513 dev->flags &= ~DF_EXTERNALSOFTC; 2514} 2515 2516/** 2517 * @brief Free claimed softc 2518 * 2519 * Most drivers do not need to use this since the softc is freed 2520 * automatically when the driver is detached. 2521 */ 2522void 2523device_free_softc(void *softc) 2524{ 2525 free(softc, M_BUS_SC); 2526} 2527 2528/** 2529 * @brief Claim softc 2530 * 2531 * This function can be used to let the driver free the automatically 2532 * allocated softc using "device_free_softc()". This function is 2533 * useful when the driver is refcounting the softc and the softc 2534 * cannot be freed when the "device_detach" method is called. 2535 */ 2536void 2537device_claim_softc(device_t dev) 2538{ 2539 if (dev->softc) 2540 dev->flags |= DF_EXTERNALSOFTC; 2541 else 2542 dev->flags &= ~DF_EXTERNALSOFTC; 2543} 2544 2545/** 2546 * @brief Get the device's ivars field 2547 * 2548 * The ivars field is used by the parent device to store per-device 2549 * state (e.g. the physical location of the device or a list of 2550 * resources). 2551 */ 2552void * 2553device_get_ivars(device_t dev) 2554{ 2555 2556 KASSERT(dev != NULL, ("device_get_ivars(NULL, ...)")); 2557 return (dev->ivars); 2558} 2559 2560/** 2561 * @brief Set the device's ivars field 2562 */ 2563void 2564device_set_ivars(device_t dev, void * ivars) 2565{ 2566 2567 KASSERT(dev != NULL, ("device_set_ivars(NULL, ...)")); 2568 dev->ivars = ivars; 2569} 2570 2571/** 2572 * @brief Return the device's state 2573 */ 2574device_state_t 2575device_get_state(device_t dev) 2576{ 2577 return (dev->state); 2578} 2579 2580/** 2581 * @brief Set the DF_ENABLED flag for the device 2582 */ 2583void 2584device_enable(device_t dev) 2585{ 2586 dev->flags |= DF_ENABLED; 2587} 2588 2589/** 2590 * @brief Clear the DF_ENABLED flag for the device 2591 */ 2592void 2593device_disable(device_t dev) 2594{ 2595 dev->flags &= ~DF_ENABLED; 2596} 2597 2598/** 2599 * @brief Increment the busy counter for the device 2600 */ 2601void 2602device_busy(device_t dev) 2603{ 2604 if (dev->state < DS_ATTACHING) 2605 panic("device_busy: called for unattached device"); 2606 if (dev->busy == 0 && dev->parent) 2607 device_busy(dev->parent); 2608 dev->busy++; 2609 if (dev->state == DS_ATTACHED) 2610 dev->state = DS_BUSY; 2611} 2612 2613/** 2614 * @brief Decrement the busy counter for the device 2615 */ 2616void 2617device_unbusy(device_t dev) 2618{ 2619 if (dev->busy != 0 && dev->state != DS_BUSY && 2620 dev->state != DS_ATTACHING) 2621 panic("device_unbusy: called for non-busy device %s", 2622 device_get_nameunit(dev)); 2623 dev->busy--; 2624 if (dev->busy == 0) { 2625 if (dev->parent) 2626 device_unbusy(dev->parent); 2627 if (dev->state == DS_BUSY) 2628 dev->state = DS_ATTACHED; 2629 } 2630} 2631 2632/** 2633 * @brief Set the DF_QUIET flag for the device 2634 */ 2635void 2636device_quiet(device_t dev) 2637{ 2638 dev->flags |= DF_QUIET; 2639} 2640 2641/** 2642 * @brief Clear the DF_QUIET flag for the device 2643 */ 2644void 2645device_verbose(device_t dev) 2646{ 2647 dev->flags &= ~DF_QUIET; 2648} 2649 2650/** 2651 * @brief Return non-zero if the DF_QUIET flag is set on the device 2652 */ 2653int 2654device_is_quiet(device_t dev) 2655{ 2656 return ((dev->flags & DF_QUIET) != 0); 2657} 2658 2659/** 2660 * @brief Return non-zero if the DF_ENABLED flag is set on the device 2661 */ 2662int 2663device_is_enabled(device_t dev) 2664{ 2665 return ((dev->flags & DF_ENABLED) != 0); 2666} 2667 2668/** 2669 * @brief Return non-zero if the device was successfully probed 2670 */ 2671int 2672device_is_alive(device_t dev) 2673{ 2674 return (dev->state >= DS_ALIVE); 2675} 2676 2677/** 2678 * @brief Return non-zero if the device currently has a driver 2679 * attached to it 2680 */ 2681int 2682device_is_attached(device_t dev) 2683{ 2684 return (dev->state >= DS_ATTACHED); 2685} 2686 2687/** 2688 * @brief Return non-zero if the device is currently suspended. 2689 */ 2690int 2691device_is_suspended(device_t dev) 2692{ 2693 return ((dev->flags & DF_SUSPENDED) != 0); 2694} 2695 2696/** 2697 * @brief Set the devclass of a device 2698 * @see devclass_add_device(). 2699 */ 2700int 2701device_set_devclass(device_t dev, const char *classname) 2702{ 2703 devclass_t dc; 2704 int error; 2705 2706 if (!classname) { 2707 if (dev->devclass) 2708 devclass_delete_device(dev->devclass, dev); 2709 return (0); 2710 } 2711 2712 if (dev->devclass) { 2713 printf("device_set_devclass: device class already set\n"); 2714 return (EINVAL); 2715 } 2716 2717 dc = devclass_find_internal(classname, NULL, TRUE); 2718 if (!dc) 2719 return (ENOMEM); 2720 2721 error = devclass_add_device(dc, dev); 2722 2723 bus_data_generation_update(); 2724 return (error); 2725} 2726 2727/** 2728 * @brief Set the devclass of a device and mark the devclass fixed. 2729 * @see device_set_devclass() 2730 */ 2731int 2732device_set_devclass_fixed(device_t dev, const char *classname) 2733{ 2734 int error; 2735 2736 if (classname == NULL) 2737 return (EINVAL); 2738 2739 error = device_set_devclass(dev, classname); 2740 if (error) 2741 return (error); 2742 dev->flags |= DF_FIXEDCLASS; 2743 return (0); 2744} 2745 2746/** 2747 * @brief Set the driver of a device 2748 * 2749 * @retval 0 success 2750 * @retval EBUSY the device already has a driver attached 2751 * @retval ENOMEM a memory allocation failure occurred 2752 */ 2753int 2754device_set_driver(device_t dev, driver_t *driver) 2755{ 2756 if (dev->state >= DS_ATTACHED) 2757 return (EBUSY); 2758 2759 if (dev->driver == driver) 2760 return (0); 2761 2762 if (dev->softc && !(dev->flags & DF_EXTERNALSOFTC)) { 2763 free(dev->softc, M_BUS_SC); 2764 dev->softc = NULL; 2765 } 2766 device_set_desc(dev, NULL); 2767 kobj_delete((kobj_t) dev, NULL); 2768 dev->driver = driver; 2769 if (driver) { 2770 kobj_init((kobj_t) dev, (kobj_class_t) driver); 2771 if (!(dev->flags & DF_EXTERNALSOFTC) && driver->size > 0) { 2772 dev->softc = malloc(driver->size, M_BUS_SC, 2773 M_NOWAIT | M_ZERO); 2774 if (!dev->softc) { 2775 kobj_delete((kobj_t) dev, NULL); 2776 kobj_init((kobj_t) dev, &null_class); 2777 dev->driver = NULL; 2778 return (ENOMEM); 2779 } 2780 } 2781 } else { 2782 kobj_init((kobj_t) dev, &null_class); 2783 } 2784 2785 bus_data_generation_update(); 2786 return (0); 2787} 2788 2789/** 2790 * @brief Probe a device, and return this status. 2791 * 2792 * This function is the core of the device autoconfiguration 2793 * system. Its purpose is to select a suitable driver for a device and 2794 * then call that driver to initialise the hardware appropriately. The 2795 * driver is selected by calling the DEVICE_PROBE() method of a set of 2796 * candidate drivers and then choosing the driver which returned the 2797 * best value. This driver is then attached to the device using 2798 * device_attach(). 2799 * 2800 * The set of suitable drivers is taken from the list of drivers in 2801 * the parent device's devclass. If the device was originally created 2802 * with a specific class name (see device_add_child()), only drivers 2803 * with that name are probed, otherwise all drivers in the devclass 2804 * are probed. If no drivers return successful probe values in the 2805 * parent devclass, the search continues in the parent of that 2806 * devclass (see devclass_get_parent()) if any. 2807 * 2808 * @param dev the device to initialise 2809 * 2810 * @retval 0 success 2811 * @retval ENXIO no driver was found 2812 * @retval ENOMEM memory allocation failure 2813 * @retval non-zero some other unix error code 2814 * @retval -1 Device already attached 2815 */ 2816int 2817device_probe(device_t dev) 2818{ 2819 int error; 2820 2821 GIANT_REQUIRED; 2822 2823 if (dev->state >= DS_ALIVE && (dev->flags & DF_REBID) == 0) 2824 return (-1); 2825 2826 if (!(dev->flags & DF_ENABLED)) { 2827 if (bootverbose && device_get_name(dev) != NULL) { 2828 device_print_prettyname(dev); 2829 printf("not probed (disabled)\n"); 2830 } 2831 return (-1); 2832 } 2833 if ((error = device_probe_child(dev->parent, dev)) != 0) { 2834 if (bus_current_pass == BUS_PASS_DEFAULT && 2835 !(dev->flags & DF_DONENOMATCH)) { 2836 BUS_PROBE_NOMATCH(dev->parent, dev); 2837 devnomatch(dev); 2838 dev->flags |= DF_DONENOMATCH; 2839 } 2840 return (error); 2841 } 2842 return (0); 2843} 2844 2845/** 2846 * @brief Probe a device and attach a driver if possible 2847 * 2848 * calls device_probe() and attaches if that was successful. 2849 */ 2850int 2851device_probe_and_attach(device_t dev) 2852{ 2853 int error; 2854 2855 GIANT_REQUIRED; 2856 2857 error = device_probe(dev); 2858 if (error == -1) 2859 return (0); 2860 else if (error != 0) 2861 return (error); 2862 2863 CURVNET_SET_QUIET(vnet0); 2864 error = device_attach(dev); 2865 CURVNET_RESTORE(); 2866 return error; 2867} 2868 2869/** 2870 * @brief Attach a device driver to a device 2871 * 2872 * This function is a wrapper around the DEVICE_ATTACH() driver 2873 * method. In addition to calling DEVICE_ATTACH(), it initialises the 2874 * device's sysctl tree, optionally prints a description of the device 2875 * and queues a notification event for user-based device management 2876 * services. 2877 * 2878 * Normally this function is only called internally from 2879 * device_probe_and_attach(). 2880 * 2881 * @param dev the device to initialise 2882 * 2883 * @retval 0 success 2884 * @retval ENXIO no driver was found 2885 * @retval ENOMEM memory allocation failure 2886 * @retval non-zero some other unix error code 2887 */ 2888int 2889device_attach(device_t dev) 2890{ 2891 uint64_t attachtime; 2892 int error; 2893 2894 if (resource_disabled(dev->driver->name, dev->unit)) { 2895 device_disable(dev); 2896 if (bootverbose) 2897 device_printf(dev, "disabled via hints entry\n"); 2898 return (ENXIO); 2899 } 2900 2901 device_sysctl_init(dev); 2902 if (!device_is_quiet(dev)) 2903 device_print_child(dev->parent, dev); 2904 attachtime = get_cyclecount(); 2905 dev->state = DS_ATTACHING; 2906 if ((error = DEVICE_ATTACH(dev)) != 0) { 2907 printf("device_attach: %s%d attach returned %d\n", 2908 dev->driver->name, dev->unit, error); 2909 if (!(dev->flags & DF_FIXEDCLASS)) 2910 devclass_delete_device(dev->devclass, dev); 2911 (void)device_set_driver(dev, NULL); 2912 device_sysctl_fini(dev); 2913 KASSERT(dev->busy == 0, ("attach failed but busy")); 2914 dev->state = DS_NOTPRESENT; 2915 return (error); 2916 } 2917 attachtime = get_cyclecount() - attachtime; 2918 /* 2919 * 4 bits per device is a reasonable value for desktop and server 2920 * hardware with good get_cyclecount() implementations, but WILL 2921 * need to be adjusted on other platforms. 2922 */ 2923#define RANDOM_PROBE_BIT_GUESS 4 2924 if (bootverbose) 2925 printf("random: harvesting attach, %zu bytes (%d bits) from %s%d\n", 2926 sizeof(attachtime), RANDOM_PROBE_BIT_GUESS, 2927 dev->driver->name, dev->unit); 2928 random_harvest_direct(&attachtime, sizeof(attachtime), 2929 RANDOM_PROBE_BIT_GUESS, RANDOM_ATTACH); 2930 device_sysctl_update(dev); 2931 if (dev->busy) 2932 dev->state = DS_BUSY; 2933 else 2934 dev->state = DS_ATTACHED; 2935 dev->flags &= ~DF_DONENOMATCH; 2936 EVENTHANDLER_INVOKE(device_attach, dev); 2937 devadded(dev); 2938 return (0); 2939} 2940 2941/** 2942 * @brief Detach a driver from a device 2943 * 2944 * This function is a wrapper around the DEVICE_DETACH() driver 2945 * method. If the call to DEVICE_DETACH() succeeds, it calls 2946 * BUS_CHILD_DETACHED() for the parent of @p dev, queues a 2947 * notification event for user-based device management services and 2948 * cleans up the device's sysctl tree. 2949 * 2950 * @param dev the device to un-initialise 2951 * 2952 * @retval 0 success 2953 * @retval ENXIO no driver was found 2954 * @retval ENOMEM memory allocation failure 2955 * @retval non-zero some other unix error code 2956 */ 2957int 2958device_detach(device_t dev) 2959{ 2960 int error; 2961 2962 GIANT_REQUIRED; 2963 2964 PDEBUG(("%s", DEVICENAME(dev))); 2965 if (dev->state == DS_BUSY) 2966 return (EBUSY); 2967 if (dev->state == DS_ATTACHING) { 2968 device_printf(dev, "device in attaching state! Deferring detach.\n"); 2969 return (EBUSY); 2970 } 2971 if (dev->state != DS_ATTACHED) 2972 return (0); 2973 2974 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_BEGIN); 2975 if ((error = DEVICE_DETACH(dev)) != 0) { 2976 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_FAILED); 2977 return (error); 2978 } else { 2979 EVENTHANDLER_INVOKE(device_detach, dev, EVHDEV_DETACH_COMPLETE); 2980 } 2981 devremoved(dev); 2982 if (!device_is_quiet(dev)) 2983 device_printf(dev, "detached\n"); 2984 if (dev->parent) 2985 BUS_CHILD_DETACHED(dev->parent, dev); 2986 2987 if (!(dev->flags & DF_FIXEDCLASS)) 2988 devclass_delete_device(dev->devclass, dev); 2989 2990 device_verbose(dev); 2991 dev->state = DS_NOTPRESENT; 2992 (void)device_set_driver(dev, NULL); 2993 device_sysctl_fini(dev); 2994 2995 return (0); 2996} 2997 2998/** 2999 * @brief Tells a driver to quiesce itself. 3000 * 3001 * This function is a wrapper around the DEVICE_QUIESCE() driver 3002 * method. If the call to DEVICE_QUIESCE() succeeds. 3003 * 3004 * @param dev the device to quiesce 3005 * 3006 * @retval 0 success 3007 * @retval ENXIO no driver was found 3008 * @retval ENOMEM memory allocation failure 3009 * @retval non-zero some other unix error code 3010 */ 3011int 3012device_quiesce(device_t dev) 3013{ 3014 3015 PDEBUG(("%s", DEVICENAME(dev))); 3016 if (dev->state == DS_BUSY) 3017 return (EBUSY); 3018 if (dev->state != DS_ATTACHED) 3019 return (0); 3020 3021 return (DEVICE_QUIESCE(dev)); 3022} 3023 3024/** 3025 * @brief Notify a device of system shutdown 3026 * 3027 * This function calls the DEVICE_SHUTDOWN() driver method if the 3028 * device currently has an attached driver. 3029 * 3030 * @returns the value returned by DEVICE_SHUTDOWN() 3031 */ 3032int 3033device_shutdown(device_t dev) 3034{ 3035 if (dev->state < DS_ATTACHED) 3036 return (0); 3037 return (DEVICE_SHUTDOWN(dev)); 3038} 3039 3040/** 3041 * @brief Set the unit number of a device 3042 * 3043 * This function can be used to override the unit number used for a 3044 * device (e.g. to wire a device to a pre-configured unit number). 3045 */ 3046int 3047device_set_unit(device_t dev, int unit) 3048{ 3049 devclass_t dc; 3050 int err; 3051 3052 dc = device_get_devclass(dev); 3053 if (unit < dc->maxunit && dc->devices[unit]) 3054 return (EBUSY); 3055 err = devclass_delete_device(dc, dev); 3056 if (err) 3057 return (err); 3058 dev->unit = unit; 3059 err = devclass_add_device(dc, dev); 3060 if (err) 3061 return (err); 3062 3063 bus_data_generation_update(); 3064 return (0); 3065} 3066 3067/*======================================*/ 3068/* 3069 * Some useful method implementations to make life easier for bus drivers. 3070 */ 3071 3072void 3073resource_init_map_request_impl(struct resource_map_request *args, size_t sz) 3074{ 3075 3076 bzero(args, sz); 3077 args->size = sz; 3078 args->memattr = VM_MEMATTR_UNCACHEABLE; 3079} 3080 3081/** 3082 * @brief Initialise a resource list. 3083 * 3084 * @param rl the resource list to initialise 3085 */ 3086void 3087resource_list_init(struct resource_list *rl) 3088{ 3089 STAILQ_INIT(rl); 3090} 3091 3092/** 3093 * @brief Reclaim memory used by a resource list. 3094 * 3095 * This function frees the memory for all resource entries on the list 3096 * (if any). 3097 * 3098 * @param rl the resource list to free 3099 */ 3100void 3101resource_list_free(struct resource_list *rl) 3102{ 3103 struct resource_list_entry *rle; 3104 3105 while ((rle = STAILQ_FIRST(rl)) != NULL) { 3106 if (rle->res) 3107 panic("resource_list_free: resource entry is busy"); 3108 STAILQ_REMOVE_HEAD(rl, link); 3109 free(rle, M_BUS); 3110 } 3111} 3112 3113/** 3114 * @brief Add a resource entry. 3115 * 3116 * This function adds a resource entry using the given @p type, @p 3117 * start, @p end and @p count values. A rid value is chosen by 3118 * searching sequentially for the first unused rid starting at zero. 3119 * 3120 * @param rl the resource list to edit 3121 * @param type the resource entry type (e.g. SYS_RES_MEMORY) 3122 * @param start the start address of the resource 3123 * @param end the end address of the resource 3124 * @param count XXX end-start+1 3125 */ 3126int 3127resource_list_add_next(struct resource_list *rl, int type, rman_res_t start, 3128 rman_res_t end, rman_res_t count) 3129{ 3130 int rid; 3131 3132 rid = 0; 3133 while (resource_list_find(rl, type, rid) != NULL) 3134 rid++; 3135 resource_list_add(rl, type, rid, start, end, count); 3136 return (rid); 3137} 3138 3139/** 3140 * @brief Add or modify a resource entry. 3141 * 3142 * If an existing entry exists with the same type and rid, it will be 3143 * modified using the given values of @p start, @p end and @p 3144 * count. If no entry exists, a new one will be created using the 3145 * given values. The resource list entry that matches is then returned. 3146 * 3147 * @param rl the resource list to edit 3148 * @param type the resource entry type (e.g. SYS_RES_MEMORY) 3149 * @param rid the resource identifier 3150 * @param start the start address of the resource 3151 * @param end the end address of the resource 3152 * @param count XXX end-start+1 3153 */ 3154struct resource_list_entry * 3155resource_list_add(struct resource_list *rl, int type, int rid, 3156 rman_res_t start, rman_res_t end, rman_res_t count) 3157{ 3158 struct resource_list_entry *rle; 3159 3160 rle = resource_list_find(rl, type, rid); 3161 if (!rle) { 3162 rle = malloc(sizeof(struct resource_list_entry), M_BUS, 3163 M_NOWAIT); 3164 if (!rle) 3165 panic("resource_list_add: can't record entry"); 3166 STAILQ_INSERT_TAIL(rl, rle, link); 3167 rle->type = type; 3168 rle->rid = rid; 3169 rle->res = NULL; 3170 rle->flags = 0; 3171 } 3172 3173 if (rle->res) 3174 panic("resource_list_add: resource entry is busy"); 3175 3176 rle->start = start; 3177 rle->end = end; 3178 rle->count = count; 3179 return (rle); 3180} 3181 3182/** 3183 * @brief Determine if a resource entry is busy. 3184 * 3185 * Returns true if a resource entry is busy meaning that it has an 3186 * associated resource that is not an unallocated "reserved" resource. 3187 * 3188 * @param rl the resource list to search 3189 * @param type the resource entry type (e.g. SYS_RES_MEMORY) 3190 * @param rid the resource identifier 3191 * 3192 * @returns Non-zero if the entry is busy, zero otherwise. 3193 */ 3194int 3195resource_list_busy(struct resource_list *rl, int type, int rid) 3196{ 3197 struct resource_list_entry *rle; 3198 3199 rle = resource_list_find(rl, type, rid); 3200 if (rle == NULL || rle->res == NULL) 3201 return (0); 3202 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == RLE_RESERVED) { 3203 KASSERT(!(rman_get_flags(rle->res) & RF_ACTIVE), 3204 ("reserved resource is active")); 3205 return (0); 3206 } 3207 return (1); 3208} 3209 3210/** 3211 * @brief Determine if a resource entry is reserved. 3212 * 3213 * Returns true if a resource entry is reserved meaning that it has an 3214 * associated "reserved" resource. The resource can either be 3215 * allocated or unallocated. 3216 * 3217 * @param rl the resource list to search 3218 * @param type the resource entry type (e.g. SYS_RES_MEMORY) 3219 * @param rid the resource identifier 3220 * 3221 * @returns Non-zero if the entry is reserved, zero otherwise. 3222 */ 3223int 3224resource_list_reserved(struct resource_list *rl, int type, int rid) 3225{ 3226 struct resource_list_entry *rle; 3227 3228 rle = resource_list_find(rl, type, rid); 3229 if (rle != NULL && rle->flags & RLE_RESERVED) 3230 return (1); 3231 return (0); 3232} 3233 3234/** 3235 * @brief Find a resource entry by type and rid. 3236 * 3237 * @param rl the resource list to search 3238 * @param type the resource entry type (e.g. SYS_RES_MEMORY) 3239 * @param rid the resource identifier 3240 * 3241 * @returns the resource entry pointer or NULL if there is no such 3242 * entry. 3243 */ 3244struct resource_list_entry * 3245resource_list_find(struct resource_list *rl, int type, int rid) 3246{ 3247 struct resource_list_entry *rle; 3248 3249 STAILQ_FOREACH(rle, rl, link) { 3250 if (rle->type == type && rle->rid == rid) 3251 return (rle); 3252 } 3253 return (NULL); 3254} 3255 3256/** 3257 * @brief Delete a resource entry. 3258 * 3259 * @param rl the resource list to edit 3260 * @param type the resource entry type (e.g. SYS_RES_MEMORY) 3261 * @param rid the resource identifier 3262 */ 3263void 3264resource_list_delete(struct resource_list *rl, int type, int rid) 3265{ 3266 struct resource_list_entry *rle = resource_list_find(rl, type, rid); 3267 3268 if (rle) { 3269 if (rle->res != NULL) 3270 panic("resource_list_delete: resource has not been released"); 3271 STAILQ_REMOVE(rl, rle, resource_list_entry, link); 3272 free(rle, M_BUS); 3273 } 3274} 3275 3276/** 3277 * @brief Allocate a reserved resource 3278 * 3279 * This can be used by busses to force the allocation of resources 3280 * that are always active in the system even if they are not allocated 3281 * by a driver (e.g. PCI BARs). This function is usually called when 3282 * adding a new child to the bus. The resource is allocated from the 3283 * parent bus when it is reserved. The resource list entry is marked 3284 * with RLE_RESERVED to note that it is a reserved resource. 3285 * 3286 * Subsequent attempts to allocate the resource with 3287 * resource_list_alloc() will succeed the first time and will set 3288 * RLE_ALLOCATED to note that it has been allocated. When a reserved 3289 * resource that has been allocated is released with 3290 * resource_list_release() the resource RLE_ALLOCATED is cleared, but 3291 * the actual resource remains allocated. The resource can be released to 3292 * the parent bus by calling resource_list_unreserve(). 3293 * 3294 * @param rl the resource list to allocate from 3295 * @param bus the parent device of @p child 3296 * @param child the device for which the resource is being reserved 3297 * @param type the type of resource to allocate 3298 * @param rid a pointer to the resource identifier 3299 * @param start hint at the start of the resource range - pass 3300 * @c 0 for any start address 3301 * @param end hint at the end of the resource range - pass 3302 * @c ~0 for any end address 3303 * @param count hint at the size of range required - pass @c 1 3304 * for any size 3305 * @param flags any extra flags to control the resource 3306 * allocation - see @c RF_XXX flags in 3307 * <sys/rman.h> for details 3308 * 3309 * @returns the resource which was allocated or @c NULL if no 3310 * resource could be allocated 3311 */ 3312struct resource * 3313resource_list_reserve(struct resource_list *rl, device_t bus, device_t child, 3314 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 3315{ 3316 struct resource_list_entry *rle = NULL; 3317 int passthrough = (device_get_parent(child) != bus); 3318 struct resource *r; 3319 3320 if (passthrough) 3321 panic( 3322 "resource_list_reserve() should only be called for direct children"); 3323 if (flags & RF_ACTIVE) 3324 panic( 3325 "resource_list_reserve() should only reserve inactive resources"); 3326 3327 r = resource_list_alloc(rl, bus, child, type, rid, start, end, count, 3328 flags); 3329 if (r != NULL) { 3330 rle = resource_list_find(rl, type, *rid); 3331 rle->flags |= RLE_RESERVED; 3332 } 3333 return (r); 3334} 3335 3336/** 3337 * @brief Helper function for implementing BUS_ALLOC_RESOURCE() 3338 * 3339 * Implement BUS_ALLOC_RESOURCE() by looking up a resource from the list 3340 * and passing the allocation up to the parent of @p bus. This assumes 3341 * that the first entry of @c device_get_ivars(child) is a struct 3342 * resource_list. This also handles 'passthrough' allocations where a 3343 * child is a remote descendant of bus by passing the allocation up to 3344 * the parent of bus. 3345 * 3346 * Typically, a bus driver would store a list of child resources 3347 * somewhere in the child device's ivars (see device_get_ivars()) and 3348 * its implementation of BUS_ALLOC_RESOURCE() would find that list and 3349 * then call resource_list_alloc() to perform the allocation. 3350 * 3351 * @param rl the resource list to allocate from 3352 * @param bus the parent device of @p child 3353 * @param child the device which is requesting an allocation 3354 * @param type the type of resource to allocate 3355 * @param rid a pointer to the resource identifier 3356 * @param start hint at the start of the resource range - pass 3357 * @c 0 for any start address 3358 * @param end hint at the end of the resource range - pass 3359 * @c ~0 for any end address 3360 * @param count hint at the size of range required - pass @c 1 3361 * for any size 3362 * @param flags any extra flags to control the resource 3363 * allocation - see @c RF_XXX flags in 3364 * <sys/rman.h> for details 3365 * 3366 * @returns the resource which was allocated or @c NULL if no 3367 * resource could be allocated 3368 */ 3369struct resource * 3370resource_list_alloc(struct resource_list *rl, device_t bus, device_t child, 3371 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 3372{ 3373 struct resource_list_entry *rle = NULL; 3374 int passthrough = (device_get_parent(child) != bus); 3375 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end); 3376 3377 if (passthrough) { 3378 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child, 3379 type, rid, start, end, count, flags)); 3380 } 3381 3382 rle = resource_list_find(rl, type, *rid); 3383 3384 if (!rle) 3385 return (NULL); /* no resource of that type/rid */ 3386 3387 if (rle->res) { 3388 if (rle->flags & RLE_RESERVED) { 3389 if (rle->flags & RLE_ALLOCATED) 3390 return (NULL); 3391 if ((flags & RF_ACTIVE) && 3392 bus_activate_resource(child, type, *rid, 3393 rle->res) != 0) 3394 return (NULL); 3395 rle->flags |= RLE_ALLOCATED; 3396 return (rle->res); 3397 } 3398 device_printf(bus, 3399 "resource entry %#x type %d for child %s is busy\n", *rid, 3400 type, device_get_nameunit(child)); 3401 return (NULL); 3402 } 3403 3404 if (isdefault) { 3405 start = rle->start; 3406 count = ulmax(count, rle->count); 3407 end = ulmax(rle->end, start + count - 1); 3408 } 3409 3410 rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, 3411 type, rid, start, end, count, flags); 3412 3413 /* 3414 * Record the new range. 3415 */ 3416 if (rle->res) { 3417 rle->start = rman_get_start(rle->res); 3418 rle->end = rman_get_end(rle->res); 3419 rle->count = count; 3420 } 3421 3422 return (rle->res); 3423} 3424 3425/** 3426 * @brief Helper function for implementing BUS_RELEASE_RESOURCE() 3427 * 3428 * Implement BUS_RELEASE_RESOURCE() using a resource list. Normally 3429 * used with resource_list_alloc(). 3430 * 3431 * @param rl the resource list which was allocated from 3432 * @param bus the parent device of @p child 3433 * @param child the device which is requesting a release 3434 * @param type the type of resource to release 3435 * @param rid the resource identifier 3436 * @param res the resource to release 3437 * 3438 * @retval 0 success 3439 * @retval non-zero a standard unix error code indicating what 3440 * error condition prevented the operation 3441 */ 3442int 3443resource_list_release(struct resource_list *rl, device_t bus, device_t child, 3444 int type, int rid, struct resource *res) 3445{ 3446 struct resource_list_entry *rle = NULL; 3447 int passthrough = (device_get_parent(child) != bus); 3448 int error; 3449 3450 if (passthrough) { 3451 return (BUS_RELEASE_RESOURCE(device_get_parent(bus), child, 3452 type, rid, res)); 3453 } 3454 3455 rle = resource_list_find(rl, type, rid); 3456 3457 if (!rle) 3458 panic("resource_list_release: can't find resource"); 3459 if (!rle->res) 3460 panic("resource_list_release: resource entry is not busy"); 3461 if (rle->flags & RLE_RESERVED) { 3462 if (rle->flags & RLE_ALLOCATED) { 3463 if (rman_get_flags(res) & RF_ACTIVE) { 3464 error = bus_deactivate_resource(child, type, 3465 rid, res); 3466 if (error) 3467 return (error); 3468 } 3469 rle->flags &= ~RLE_ALLOCATED; 3470 return (0); 3471 } 3472 return (EINVAL); 3473 } 3474 3475 error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, 3476 type, rid, res); 3477 if (error) 3478 return (error); 3479 3480 rle->res = NULL; 3481 return (0); 3482} 3483 3484/** 3485 * @brief Release all active resources of a given type 3486 * 3487 * Release all active resources of a specified type. This is intended 3488 * to be used to cleanup resources leaked by a driver after detach or 3489 * a failed attach. 3490 * 3491 * @param rl the resource list which was allocated from 3492 * @param bus the parent device of @p child 3493 * @param child the device whose active resources are being released 3494 * @param type the type of resources to release 3495 * 3496 * @retval 0 success 3497 * @retval EBUSY at least one resource was active 3498 */ 3499int 3500resource_list_release_active(struct resource_list *rl, device_t bus, 3501 device_t child, int type) 3502{ 3503 struct resource_list_entry *rle; 3504 int error, retval; 3505 3506 retval = 0; 3507 STAILQ_FOREACH(rle, rl, link) { 3508 if (rle->type != type) 3509 continue; 3510 if (rle->res == NULL) 3511 continue; 3512 if ((rle->flags & (RLE_RESERVED | RLE_ALLOCATED)) == 3513 RLE_RESERVED) 3514 continue; 3515 retval = EBUSY; 3516 error = resource_list_release(rl, bus, child, type, 3517 rman_get_rid(rle->res), rle->res); 3518 if (error != 0) 3519 device_printf(bus, 3520 "Failed to release active resource: %d\n", error); 3521 } 3522 return (retval); 3523} 3524 3525 3526/** 3527 * @brief Fully release a reserved resource 3528 * 3529 * Fully releases a resource reserved via resource_list_reserve(). 3530 * 3531 * @param rl the resource list which was allocated from 3532 * @param bus the parent device of @p child 3533 * @param child the device whose reserved resource is being released 3534 * @param type the type of resource to release 3535 * @param rid the resource identifier 3536 * @param res the resource to release 3537 * 3538 * @retval 0 success 3539 * @retval non-zero a standard unix error code indicating what 3540 * error condition prevented the operation 3541 */ 3542int 3543resource_list_unreserve(struct resource_list *rl, device_t bus, device_t child, 3544 int type, int rid) 3545{ 3546 struct resource_list_entry *rle = NULL; 3547 int passthrough = (device_get_parent(child) != bus); 3548 3549 if (passthrough) 3550 panic( 3551 "resource_list_unreserve() should only be called for direct children"); 3552 3553 rle = resource_list_find(rl, type, rid); 3554 3555 if (!rle) 3556 panic("resource_list_unreserve: can't find resource"); 3557 if (!(rle->flags & RLE_RESERVED)) 3558 return (EINVAL); 3559 if (rle->flags & RLE_ALLOCATED) 3560 return (EBUSY); 3561 rle->flags &= ~RLE_RESERVED; 3562 return (resource_list_release(rl, bus, child, type, rid, rle->res)); 3563} 3564 3565/** 3566 * @brief Print a description of resources in a resource list 3567 * 3568 * Print all resources of a specified type, for use in BUS_PRINT_CHILD(). 3569 * The name is printed if at least one resource of the given type is available. 3570 * The format is used to print resource start and end. 3571 * 3572 * @param rl the resource list to print 3573 * @param name the name of @p type, e.g. @c "memory" 3574 * @param type type type of resource entry to print 3575 * @param format printf(9) format string to print resource 3576 * start and end values 3577 * 3578 * @returns the number of characters printed 3579 */ 3580int 3581resource_list_print_type(struct resource_list *rl, const char *name, int type, 3582 const char *format) 3583{ 3584 struct resource_list_entry *rle; 3585 int printed, retval; 3586 3587 printed = 0; 3588 retval = 0; 3589 /* Yes, this is kinda cheating */ 3590 STAILQ_FOREACH(rle, rl, link) { 3591 if (rle->type == type) { 3592 if (printed == 0) 3593 retval += printf(" %s ", name); 3594 else 3595 retval += printf(","); 3596 printed++; 3597 retval += printf(format, rle->start); 3598 if (rle->count > 1) { 3599 retval += printf("-"); 3600 retval += printf(format, rle->start + 3601 rle->count - 1); 3602 } 3603 } 3604 } 3605 return (retval); 3606} 3607 3608/** 3609 * @brief Releases all the resources in a list. 3610 * 3611 * @param rl The resource list to purge. 3612 * 3613 * @returns nothing 3614 */ 3615void 3616resource_list_purge(struct resource_list *rl) 3617{ 3618 struct resource_list_entry *rle; 3619 3620 while ((rle = STAILQ_FIRST(rl)) != NULL) { 3621 if (rle->res) 3622 bus_release_resource(rman_get_device(rle->res), 3623 rle->type, rle->rid, rle->res); 3624 STAILQ_REMOVE_HEAD(rl, link); 3625 free(rle, M_BUS); 3626 } 3627} 3628 3629device_t 3630bus_generic_add_child(device_t dev, u_int order, const char *name, int unit) 3631{ 3632 3633 return (device_add_child_ordered(dev, order, name, unit)); 3634} 3635 3636/** 3637 * @brief Helper function for implementing DEVICE_PROBE() 3638 * 3639 * This function can be used to help implement the DEVICE_PROBE() for 3640 * a bus (i.e. a device which has other devices attached to it). It 3641 * calls the DEVICE_IDENTIFY() method of each driver in the device's 3642 * devclass. 3643 */ 3644int 3645bus_generic_probe(device_t dev) 3646{ 3647 devclass_t dc = dev->devclass; 3648 driverlink_t dl; 3649 3650 TAILQ_FOREACH(dl, &dc->drivers, link) { 3651 /* 3652 * If this driver's pass is too high, then ignore it. 3653 * For most drivers in the default pass, this will 3654 * never be true. For early-pass drivers they will 3655 * only call the identify routines of eligible drivers 3656 * when this routine is called. Drivers for later 3657 * passes should have their identify routines called 3658 * on early-pass busses during BUS_NEW_PASS(). 3659 */ 3660 if (dl->pass > bus_current_pass) 3661 continue; 3662 DEVICE_IDENTIFY(dl->driver, dev); 3663 } 3664 3665 return (0); 3666} 3667 3668/** 3669 * @brief Helper function for implementing DEVICE_ATTACH() 3670 * 3671 * This function can be used to help implement the DEVICE_ATTACH() for 3672 * a bus. It calls device_probe_and_attach() for each of the device's 3673 * children. 3674 */ 3675int 3676bus_generic_attach(device_t dev) 3677{ 3678 device_t child; 3679 3680 TAILQ_FOREACH(child, &dev->children, link) { 3681 device_probe_and_attach(child); 3682 } 3683 3684 return (0); 3685} 3686 3687/** 3688 * @brief Helper function for implementing DEVICE_DETACH() 3689 * 3690 * This function can be used to help implement the DEVICE_DETACH() for 3691 * a bus. It calls device_detach() for each of the device's 3692 * children. 3693 */ 3694int 3695bus_generic_detach(device_t dev) 3696{ 3697 device_t child; 3698 int error; 3699 3700 if (dev->state != DS_ATTACHED) 3701 return (EBUSY); 3702 3703 /* 3704 * Detach children in the reverse order. 3705 * See bus_generic_suspend for details. 3706 */ 3707 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) { 3708 if ((error = device_detach(child)) != 0) 3709 return (error); 3710 } 3711 3712 return (0); 3713} 3714 3715/** 3716 * @brief Helper function for implementing DEVICE_SHUTDOWN() 3717 * 3718 * This function can be used to help implement the DEVICE_SHUTDOWN() 3719 * for a bus. It calls device_shutdown() for each of the device's 3720 * children. 3721 */ 3722int 3723bus_generic_shutdown(device_t dev) 3724{ 3725 device_t child; 3726 3727 /* 3728 * Shut down children in the reverse order. 3729 * See bus_generic_suspend for details. 3730 */ 3731 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) { 3732 device_shutdown(child); 3733 } 3734 3735 return (0); 3736} 3737 3738/** 3739 * @brief Default function for suspending a child device. 3740 * 3741 * This function is to be used by a bus's DEVICE_SUSPEND_CHILD(). 3742 */ 3743int 3744bus_generic_suspend_child(device_t dev, device_t child) 3745{ 3746 int error; 3747 3748 error = DEVICE_SUSPEND(child); 3749 3750 if (error == 0) 3751 child->flags |= DF_SUSPENDED; 3752 3753 return (error); 3754} 3755 3756/** 3757 * @brief Default function for resuming a child device. 3758 * 3759 * This function is to be used by a bus's DEVICE_RESUME_CHILD(). 3760 */ 3761int 3762bus_generic_resume_child(device_t dev, device_t child) 3763{ 3764 3765 DEVICE_RESUME(child); 3766 child->flags &= ~DF_SUSPENDED; 3767 3768 return (0); 3769} 3770 3771/** 3772 * @brief Helper function for implementing DEVICE_SUSPEND() 3773 * 3774 * This function can be used to help implement the DEVICE_SUSPEND() 3775 * for a bus. It calls DEVICE_SUSPEND() for each of the device's 3776 * children. If any call to DEVICE_SUSPEND() fails, the suspend 3777 * operation is aborted and any devices which were suspended are 3778 * resumed immediately by calling their DEVICE_RESUME() methods. 3779 */ 3780int 3781bus_generic_suspend(device_t dev) 3782{ 3783 int error; 3784 device_t child; 3785 3786 /* 3787 * Suspend children in the reverse order. 3788 * For most buses all children are equal, so the order does not matter. 3789 * Other buses, such as acpi, carefully order their child devices to 3790 * express implicit dependencies between them. For such buses it is 3791 * safer to bring down devices in the reverse order. 3792 */ 3793 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) { 3794 error = BUS_SUSPEND_CHILD(dev, child); 3795 if (error != 0) { 3796 child = TAILQ_NEXT(child, link); 3797 if (child != NULL) { 3798 TAILQ_FOREACH_FROM(child, &dev->children, link) 3799 BUS_RESUME_CHILD(dev, child); 3800 } 3801 return (error); 3802 } 3803 } 3804 return (0); 3805} 3806 3807/** 3808 * @brief Helper function for implementing DEVICE_RESUME() 3809 * 3810 * This function can be used to help implement the DEVICE_RESUME() for 3811 * a bus. It calls DEVICE_RESUME() on each of the device's children. 3812 */ 3813int 3814bus_generic_resume(device_t dev) 3815{ 3816 device_t child; 3817 3818 TAILQ_FOREACH(child, &dev->children, link) { 3819 BUS_RESUME_CHILD(dev, child); 3820 /* if resume fails, there's nothing we can usefully do... */ 3821 } 3822 return (0); 3823} 3824 3825 3826/** 3827 * @brief Helper function for implementing BUS_RESET_POST 3828 * 3829 * Bus can use this function to implement common operations of 3830 * re-attaching or resuming the children after the bus itself was 3831 * reset, and after restoring bus-unique state of children. 3832 * 3833 * @param dev The bus 3834 * #param flags DEVF_RESET_* 3835 */ 3836int 3837bus_helper_reset_post(device_t dev, int flags) 3838{ 3839 device_t child; 3840 int error, error1; 3841 3842 error = 0; 3843 TAILQ_FOREACH(child, &dev->children,link) { 3844 BUS_RESET_POST(dev, child); 3845 error1 = (flags & DEVF_RESET_DETACH) != 0 ? 3846 device_probe_and_attach(child) : 3847 BUS_RESUME_CHILD(dev, child); 3848 if (error == 0 && error1 != 0) 3849 error = error1; 3850 } 3851 return (error); 3852} 3853 3854static void 3855bus_helper_reset_prepare_rollback(device_t dev, device_t child, int flags) 3856{ 3857 3858 child = TAILQ_NEXT(child, link); 3859 if (child == NULL) 3860 return; 3861 TAILQ_FOREACH_FROM(child, &dev->children,link) { 3862 BUS_RESET_POST(dev, child); 3863 if ((flags & DEVF_RESET_DETACH) != 0) 3864 device_probe_and_attach(child); 3865 else 3866 BUS_RESUME_CHILD(dev, child); 3867 } 3868} 3869 3870/** 3871 * @brief Helper function for implementing BUS_RESET_PREPARE 3872 * 3873 * Bus can use this function to implement common operations of 3874 * detaching or suspending the children before the bus itself is 3875 * reset, and then save bus-unique state of children that must 3876 * persists around reset. 3877 * 3878 * @param dev The bus 3879 * #param flags DEVF_RESET_* 3880 */ 3881int 3882bus_helper_reset_prepare(device_t dev, int flags) 3883{ 3884 device_t child; 3885 int error; 3886 3887 if (dev->state != DS_ATTACHED) 3888 return (EBUSY); 3889 3890 TAILQ_FOREACH_REVERSE(child, &dev->children, device_list, link) { 3891 if ((flags & DEVF_RESET_DETACH) != 0) { 3892 error = device_get_state(child) == DS_ATTACHED ? 3893 device_detach(child) : 0; 3894 } else { 3895 error = BUS_SUSPEND_CHILD(dev, child); 3896 } 3897 if (error == 0) { 3898 error = BUS_RESET_PREPARE(dev, child); 3899 if (error != 0) { 3900 if ((flags & DEVF_RESET_DETACH) != 0) 3901 device_probe_and_attach(child); 3902 else 3903 BUS_RESUME_CHILD(dev, child); 3904 } 3905 } 3906 if (error != 0) { 3907 bus_helper_reset_prepare_rollback(dev, child, flags); 3908 return (error); 3909 } 3910 } 3911 return (0); 3912} 3913 3914 3915/** 3916 * @brief Helper function for implementing BUS_PRINT_CHILD(). 3917 * 3918 * This function prints the first part of the ascii representation of 3919 * @p child, including its name, unit and description (if any - see 3920 * device_set_desc()). 3921 * 3922 * @returns the number of characters printed 3923 */ 3924int 3925bus_print_child_header(device_t dev, device_t child) 3926{ 3927 int retval = 0; 3928 3929 if (device_get_desc(child)) { 3930 retval += device_printf(child, "<%s>", device_get_desc(child)); 3931 } else { 3932 retval += printf("%s", device_get_nameunit(child)); 3933 } 3934 3935 return (retval); 3936} 3937 3938/** 3939 * @brief Helper function for implementing BUS_PRINT_CHILD(). 3940 * 3941 * This function prints the last part of the ascii representation of 3942 * @p child, which consists of the string @c " on " followed by the 3943 * name and unit of the @p dev. 3944 * 3945 * @returns the number of characters printed 3946 */ 3947int 3948bus_print_child_footer(device_t dev, device_t child) 3949{ 3950 return (printf(" on %s\n", device_get_nameunit(dev))); 3951} 3952 3953/** 3954 * @brief Helper function for implementing BUS_PRINT_CHILD(). 3955 * 3956 * This function prints out the VM domain for the given device. 3957 * 3958 * @returns the number of characters printed 3959 */ 3960int 3961bus_print_child_domain(device_t dev, device_t child) 3962{ 3963 int domain; 3964 3965 /* No domain? Don't print anything */ 3966 if (BUS_GET_DOMAIN(dev, child, &domain) != 0) 3967 return (0); 3968 3969 return (printf(" numa-domain %d", domain)); 3970} 3971 3972/** 3973 * @brief Helper function for implementing BUS_PRINT_CHILD(). 3974 * 3975 * This function simply calls bus_print_child_header() followed by 3976 * bus_print_child_footer(). 3977 * 3978 * @returns the number of characters printed 3979 */ 3980int 3981bus_generic_print_child(device_t dev, device_t child) 3982{ 3983 int retval = 0; 3984 3985 retval += bus_print_child_header(dev, child); 3986 retval += bus_print_child_domain(dev, child); 3987 retval += bus_print_child_footer(dev, child); 3988 3989 return (retval); 3990} 3991 3992/** 3993 * @brief Stub function for implementing BUS_READ_IVAR(). 3994 * 3995 * @returns ENOENT 3996 */ 3997int 3998bus_generic_read_ivar(device_t dev, device_t child, int index, 3999 uintptr_t * result) 4000{ 4001 return (ENOENT); 4002} 4003 4004/** 4005 * @brief Stub function for implementing BUS_WRITE_IVAR(). 4006 * 4007 * @returns ENOENT 4008 */ 4009int 4010bus_generic_write_ivar(device_t dev, device_t child, int index, 4011 uintptr_t value) 4012{ 4013 return (ENOENT); 4014} 4015 4016/** 4017 * @brief Stub function for implementing BUS_GET_RESOURCE_LIST(). 4018 * 4019 * @returns NULL 4020 */ 4021struct resource_list * 4022bus_generic_get_resource_list(device_t dev, device_t child) 4023{ 4024 return (NULL); 4025} 4026 4027/** 4028 * @brief Helper function for implementing BUS_DRIVER_ADDED(). 4029 * 4030 * This implementation of BUS_DRIVER_ADDED() simply calls the driver's 4031 * DEVICE_IDENTIFY() method to allow it to add new children to the bus 4032 * and then calls device_probe_and_attach() for each unattached child. 4033 */ 4034void 4035bus_generic_driver_added(device_t dev, driver_t *driver) 4036{ 4037 device_t child; 4038 4039 DEVICE_IDENTIFY(driver, dev); 4040 TAILQ_FOREACH(child, &dev->children, link) { 4041 if (child->state == DS_NOTPRESENT || 4042 (child->flags & DF_REBID)) 4043 device_probe_and_attach(child); 4044 } 4045} 4046 4047/** 4048 * @brief Helper function for implementing BUS_NEW_PASS(). 4049 * 4050 * This implementing of BUS_NEW_PASS() first calls the identify 4051 * routines for any drivers that probe at the current pass. Then it 4052 * walks the list of devices for this bus. If a device is already 4053 * attached, then it calls BUS_NEW_PASS() on that device. If the 4054 * device is not already attached, it attempts to attach a driver to 4055 * it. 4056 */ 4057void 4058bus_generic_new_pass(device_t dev) 4059{ 4060 driverlink_t dl; 4061 devclass_t dc; 4062 device_t child; 4063 4064 dc = dev->devclass; 4065 TAILQ_FOREACH(dl, &dc->drivers, link) { 4066 if (dl->pass == bus_current_pass) 4067 DEVICE_IDENTIFY(dl->driver, dev); 4068 } 4069 TAILQ_FOREACH(child, &dev->children, link) { 4070 if (child->state >= DS_ATTACHED) 4071 BUS_NEW_PASS(child); 4072 else if (child->state == DS_NOTPRESENT) 4073 device_probe_and_attach(child); 4074 } 4075} 4076 4077/** 4078 * @brief Helper function for implementing BUS_SETUP_INTR(). 4079 * 4080 * This simple implementation of BUS_SETUP_INTR() simply calls the 4081 * BUS_SETUP_INTR() method of the parent of @p dev. 4082 */ 4083int 4084bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq, 4085 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg, 4086 void **cookiep) 4087{ 4088 /* Propagate up the bus hierarchy until someone handles it. */ 4089 if (dev->parent) 4090 return (BUS_SETUP_INTR(dev->parent, child, irq, flags, 4091 filter, intr, arg, cookiep)); 4092 return (EINVAL); 4093} 4094 4095/** 4096 * @brief Helper function for implementing BUS_TEARDOWN_INTR(). 4097 * 4098 * This simple implementation of BUS_TEARDOWN_INTR() simply calls the 4099 * BUS_TEARDOWN_INTR() method of the parent of @p dev. 4100 */ 4101int 4102bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq, 4103 void *cookie) 4104{ 4105 /* Propagate up the bus hierarchy until someone handles it. */ 4106 if (dev->parent) 4107 return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie)); 4108 return (EINVAL); 4109} 4110 4111/** 4112 * @brief Helper function for implementing BUS_ADJUST_RESOURCE(). 4113 * 4114 * This simple implementation of BUS_ADJUST_RESOURCE() simply calls the 4115 * BUS_ADJUST_RESOURCE() method of the parent of @p dev. 4116 */ 4117int 4118bus_generic_adjust_resource(device_t dev, device_t child, int type, 4119 struct resource *r, rman_res_t start, rman_res_t end) 4120{ 4121 /* Propagate up the bus hierarchy until someone handles it. */ 4122 if (dev->parent) 4123 return (BUS_ADJUST_RESOURCE(dev->parent, child, type, r, start, 4124 end)); 4125 return (EINVAL); 4126} 4127 4128/** 4129 * @brief Helper function for implementing BUS_ALLOC_RESOURCE(). 4130 * 4131 * This simple implementation of BUS_ALLOC_RESOURCE() simply calls the 4132 * BUS_ALLOC_RESOURCE() method of the parent of @p dev. 4133 */ 4134struct resource * 4135bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid, 4136 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 4137{ 4138 /* Propagate up the bus hierarchy until someone handles it. */ 4139 if (dev->parent) 4140 return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid, 4141 start, end, count, flags)); 4142 return (NULL); 4143} 4144 4145/** 4146 * @brief Helper function for implementing BUS_RELEASE_RESOURCE(). 4147 * 4148 * This simple implementation of BUS_RELEASE_RESOURCE() simply calls the 4149 * BUS_RELEASE_RESOURCE() method of the parent of @p dev. 4150 */ 4151int 4152bus_generic_release_resource(device_t dev, device_t child, int type, int rid, 4153 struct resource *r) 4154{ 4155 /* Propagate up the bus hierarchy until someone handles it. */ 4156 if (dev->parent) 4157 return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, 4158 r)); 4159 return (EINVAL); 4160} 4161 4162/** 4163 * @brief Helper function for implementing BUS_ACTIVATE_RESOURCE(). 4164 * 4165 * This simple implementation of BUS_ACTIVATE_RESOURCE() simply calls the 4166 * BUS_ACTIVATE_RESOURCE() method of the parent of @p dev. 4167 */ 4168int 4169bus_generic_activate_resource(device_t dev, device_t child, int type, int rid, 4170 struct resource *r) 4171{ 4172 /* Propagate up the bus hierarchy until someone handles it. */ 4173 if (dev->parent) 4174 return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, 4175 r)); 4176 return (EINVAL); 4177} 4178 4179/** 4180 * @brief Helper function for implementing BUS_DEACTIVATE_RESOURCE(). 4181 * 4182 * This simple implementation of BUS_DEACTIVATE_RESOURCE() simply calls the 4183 * BUS_DEACTIVATE_RESOURCE() method of the parent of @p dev. 4184 */ 4185int 4186bus_generic_deactivate_resource(device_t dev, device_t child, int type, 4187 int rid, struct resource *r) 4188{ 4189 /* Propagate up the bus hierarchy until someone handles it. */ 4190 if (dev->parent) 4191 return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid, 4192 r)); 4193 return (EINVAL); 4194} 4195 4196/** 4197 * @brief Helper function for implementing BUS_MAP_RESOURCE(). 4198 * 4199 * This simple implementation of BUS_MAP_RESOURCE() simply calls the 4200 * BUS_MAP_RESOURCE() method of the parent of @p dev. 4201 */ 4202int 4203bus_generic_map_resource(device_t dev, device_t child, int type, 4204 struct resource *r, struct resource_map_request *args, 4205 struct resource_map *map) 4206{ 4207 /* Propagate up the bus hierarchy until someone handles it. */ 4208 if (dev->parent) 4209 return (BUS_MAP_RESOURCE(dev->parent, child, type, r, args, 4210 map)); 4211 return (EINVAL); 4212} 4213 4214/** 4215 * @brief Helper function for implementing BUS_UNMAP_RESOURCE(). 4216 * 4217 * This simple implementation of BUS_UNMAP_RESOURCE() simply calls the 4218 * BUS_UNMAP_RESOURCE() method of the parent of @p dev. 4219 */ 4220int 4221bus_generic_unmap_resource(device_t dev, device_t child, int type, 4222 struct resource *r, struct resource_map *map) 4223{ 4224 /* Propagate up the bus hierarchy until someone handles it. */ 4225 if (dev->parent) 4226 return (BUS_UNMAP_RESOURCE(dev->parent, child, type, r, map)); 4227 return (EINVAL); 4228} 4229 4230/** 4231 * @brief Helper function for implementing BUS_BIND_INTR(). 4232 * 4233 * This simple implementation of BUS_BIND_INTR() simply calls the 4234 * BUS_BIND_INTR() method of the parent of @p dev. 4235 */ 4236int 4237bus_generic_bind_intr(device_t dev, device_t child, struct resource *irq, 4238 int cpu) 4239{ 4240 4241 /* Propagate up the bus hierarchy until someone handles it. */ 4242 if (dev->parent) 4243 return (BUS_BIND_INTR(dev->parent, child, irq, cpu)); 4244 return (EINVAL); 4245} 4246 4247/** 4248 * @brief Helper function for implementing BUS_CONFIG_INTR(). 4249 * 4250 * This simple implementation of BUS_CONFIG_INTR() simply calls the 4251 * BUS_CONFIG_INTR() method of the parent of @p dev. 4252 */ 4253int 4254bus_generic_config_intr(device_t dev, int irq, enum intr_trigger trig, 4255 enum intr_polarity pol) 4256{ 4257 4258 /* Propagate up the bus hierarchy until someone handles it. */ 4259 if (dev->parent) 4260 return (BUS_CONFIG_INTR(dev->parent, irq, trig, pol)); 4261 return (EINVAL); 4262} 4263 4264/** 4265 * @brief Helper function for implementing BUS_DESCRIBE_INTR(). 4266 * 4267 * This simple implementation of BUS_DESCRIBE_INTR() simply calls the 4268 * BUS_DESCRIBE_INTR() method of the parent of @p dev. 4269 */ 4270int 4271bus_generic_describe_intr(device_t dev, device_t child, struct resource *irq, 4272 void *cookie, const char *descr) 4273{ 4274 4275 /* Propagate up the bus hierarchy until someone handles it. */ 4276 if (dev->parent) 4277 return (BUS_DESCRIBE_INTR(dev->parent, child, irq, cookie, 4278 descr)); 4279 return (EINVAL); 4280} 4281 4282/** 4283 * @brief Helper function for implementing BUS_GET_CPUS(). 4284 * 4285 * This simple implementation of BUS_GET_CPUS() simply calls the 4286 * BUS_GET_CPUS() method of the parent of @p dev. 4287 */ 4288int 4289bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op, 4290 size_t setsize, cpuset_t *cpuset) 4291{ 4292 4293 /* Propagate up the bus hierarchy until someone handles it. */ 4294 if (dev->parent != NULL) 4295 return (BUS_GET_CPUS(dev->parent, child, op, setsize, cpuset)); 4296 return (EINVAL); 4297} 4298 4299/** 4300 * @brief Helper function for implementing BUS_GET_DMA_TAG(). 4301 * 4302 * This simple implementation of BUS_GET_DMA_TAG() simply calls the 4303 * BUS_GET_DMA_TAG() method of the parent of @p dev. 4304 */ 4305bus_dma_tag_t 4306bus_generic_get_dma_tag(device_t dev, device_t child) 4307{ 4308 4309 /* Propagate up the bus hierarchy until someone handles it. */ 4310 if (dev->parent != NULL) 4311 return (BUS_GET_DMA_TAG(dev->parent, child)); 4312 return (NULL); 4313} 4314 4315/** 4316 * @brief Helper function for implementing BUS_GET_BUS_TAG(). 4317 * 4318 * This simple implementation of BUS_GET_BUS_TAG() simply calls the 4319 * BUS_GET_BUS_TAG() method of the parent of @p dev. 4320 */ 4321bus_space_tag_t 4322bus_generic_get_bus_tag(device_t dev, device_t child) 4323{ 4324 4325 /* Propagate up the bus hierarchy until someone handles it. */ 4326 if (dev->parent != NULL) 4327 return (BUS_GET_BUS_TAG(dev->parent, child)); 4328 return ((bus_space_tag_t)0); 4329} 4330 4331/** 4332 * @brief Helper function for implementing BUS_GET_RESOURCE(). 4333 * 4334 * This implementation of BUS_GET_RESOURCE() uses the 4335 * resource_list_find() function to do most of the work. It calls 4336 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to 4337 * search. 4338 */ 4339int 4340bus_generic_rl_get_resource(device_t dev, device_t child, int type, int rid, 4341 rman_res_t *startp, rman_res_t *countp) 4342{ 4343 struct resource_list * rl = NULL; 4344 struct resource_list_entry * rle = NULL; 4345 4346 rl = BUS_GET_RESOURCE_LIST(dev, child); 4347 if (!rl) 4348 return (EINVAL); 4349 4350 rle = resource_list_find(rl, type, rid); 4351 if (!rle) 4352 return (ENOENT); 4353 4354 if (startp) 4355 *startp = rle->start; 4356 if (countp) 4357 *countp = rle->count; 4358 4359 return (0); 4360} 4361 4362/** 4363 * @brief Helper function for implementing BUS_SET_RESOURCE(). 4364 * 4365 * This implementation of BUS_SET_RESOURCE() uses the 4366 * resource_list_add() function to do most of the work. It calls 4367 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to 4368 * edit. 4369 */ 4370int 4371bus_generic_rl_set_resource(device_t dev, device_t child, int type, int rid, 4372 rman_res_t start, rman_res_t count) 4373{ 4374 struct resource_list * rl = NULL; 4375 4376 rl = BUS_GET_RESOURCE_LIST(dev, child); 4377 if (!rl) 4378 return (EINVAL); 4379 4380 resource_list_add(rl, type, rid, start, (start + count - 1), count); 4381 4382 return (0); 4383} 4384 4385/** 4386 * @brief Helper function for implementing BUS_DELETE_RESOURCE(). 4387 * 4388 * This implementation of BUS_DELETE_RESOURCE() uses the 4389 * resource_list_delete() function to do most of the work. It calls 4390 * BUS_GET_RESOURCE_LIST() to find a suitable resource list to 4391 * edit. 4392 */ 4393void 4394bus_generic_rl_delete_resource(device_t dev, device_t child, int type, int rid) 4395{ 4396 struct resource_list * rl = NULL; 4397 4398 rl = BUS_GET_RESOURCE_LIST(dev, child); 4399 if (!rl) 4400 return; 4401 4402 resource_list_delete(rl, type, rid); 4403 4404 return; 4405} 4406 4407/** 4408 * @brief Helper function for implementing BUS_RELEASE_RESOURCE(). 4409 * 4410 * This implementation of BUS_RELEASE_RESOURCE() uses the 4411 * resource_list_release() function to do most of the work. It calls 4412 * BUS_GET_RESOURCE_LIST() to find a suitable resource list. 4413 */ 4414int 4415bus_generic_rl_release_resource(device_t dev, device_t child, int type, 4416 int rid, struct resource *r) 4417{ 4418 struct resource_list * rl = NULL; 4419 4420 if (device_get_parent(child) != dev) 4421 return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child, 4422 type, rid, r)); 4423 4424 rl = BUS_GET_RESOURCE_LIST(dev, child); 4425 if (!rl) 4426 return (EINVAL); 4427 4428 return (resource_list_release(rl, dev, child, type, rid, r)); 4429} 4430 4431/** 4432 * @brief Helper function for implementing BUS_ALLOC_RESOURCE(). 4433 * 4434 * This implementation of BUS_ALLOC_RESOURCE() uses the 4435 * resource_list_alloc() function to do most of the work. It calls 4436 * BUS_GET_RESOURCE_LIST() to find a suitable resource list. 4437 */ 4438struct resource * 4439bus_generic_rl_alloc_resource(device_t dev, device_t child, int type, 4440 int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 4441{ 4442 struct resource_list * rl = NULL; 4443 4444 if (device_get_parent(child) != dev) 4445 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child, 4446 type, rid, start, end, count, flags)); 4447 4448 rl = BUS_GET_RESOURCE_LIST(dev, child); 4449 if (!rl) 4450 return (NULL); 4451 4452 return (resource_list_alloc(rl, dev, child, type, rid, 4453 start, end, count, flags)); 4454} 4455 4456/** 4457 * @brief Helper function for implementing BUS_CHILD_PRESENT(). 4458 * 4459 * This simple implementation of BUS_CHILD_PRESENT() simply calls the 4460 * BUS_CHILD_PRESENT() method of the parent of @p dev. 4461 */ 4462int 4463bus_generic_child_present(device_t dev, device_t child) 4464{ 4465 return (BUS_CHILD_PRESENT(device_get_parent(dev), dev)); 4466} 4467 4468int 4469bus_generic_get_domain(device_t dev, device_t child, int *domain) 4470{ 4471 4472 if (dev->parent) 4473 return (BUS_GET_DOMAIN(dev->parent, dev, domain)); 4474 4475 return (ENOENT); 4476} 4477 4478/** 4479 * @brief Helper function for implementing BUS_RESCAN(). 4480 * 4481 * This null implementation of BUS_RESCAN() always fails to indicate 4482 * the bus does not support rescanning. 4483 */ 4484int 4485bus_null_rescan(device_t dev) 4486{ 4487 4488 return (ENXIO); 4489} 4490 4491/* 4492 * Some convenience functions to make it easier for drivers to use the 4493 * resource-management functions. All these really do is hide the 4494 * indirection through the parent's method table, making for slightly 4495 * less-wordy code. In the future, it might make sense for this code 4496 * to maintain some sort of a list of resources allocated by each device. 4497 */ 4498 4499int 4500bus_alloc_resources(device_t dev, struct resource_spec *rs, 4501 struct resource **res) 4502{ 4503 int i; 4504 4505 for (i = 0; rs[i].type != -1; i++) 4506 res[i] = NULL; 4507 for (i = 0; rs[i].type != -1; i++) { 4508 res[i] = bus_alloc_resource_any(dev, 4509 rs[i].type, &rs[i].rid, rs[i].flags); 4510 if (res[i] == NULL && !(rs[i].flags & RF_OPTIONAL)) { 4511 bus_release_resources(dev, rs, res); 4512 return (ENXIO); 4513 } 4514 } 4515 return (0); 4516} 4517 4518void 4519bus_release_resources(device_t dev, const struct resource_spec *rs, 4520 struct resource **res) 4521{ 4522 int i; 4523 4524 for (i = 0; rs[i].type != -1; i++) 4525 if (res[i] != NULL) { 4526 bus_release_resource( 4527 dev, rs[i].type, rs[i].rid, res[i]); 4528 res[i] = NULL; 4529 } 4530} 4531 4532/** 4533 * @brief Wrapper function for BUS_ALLOC_RESOURCE(). 4534 * 4535 * This function simply calls the BUS_ALLOC_RESOURCE() method of the 4536 * parent of @p dev. 4537 */ 4538struct resource * 4539bus_alloc_resource(device_t dev, int type, int *rid, rman_res_t start, 4540 rman_res_t end, rman_res_t count, u_int flags) 4541{ 4542 struct resource *res; 4543 4544 if (dev->parent == NULL) 4545 return (NULL); 4546 res = BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end, 4547 count, flags); 4548 return (res); 4549} 4550 4551/** 4552 * @brief Wrapper function for BUS_ADJUST_RESOURCE(). 4553 * 4554 * This function simply calls the BUS_ADJUST_RESOURCE() method of the 4555 * parent of @p dev. 4556 */ 4557int 4558bus_adjust_resource(device_t dev, int type, struct resource *r, rman_res_t start, 4559 rman_res_t end) 4560{ 4561 if (dev->parent == NULL) 4562 return (EINVAL); 4563 return (BUS_ADJUST_RESOURCE(dev->parent, dev, type, r, start, end)); 4564} 4565 4566/** 4567 * @brief Wrapper function for BUS_ACTIVATE_RESOURCE(). 4568 * 4569 * This function simply calls the BUS_ACTIVATE_RESOURCE() method of the 4570 * parent of @p dev. 4571 */ 4572int 4573bus_activate_resource(device_t dev, int type, int rid, struct resource *r) 4574{ 4575 if (dev->parent == NULL) 4576 return (EINVAL); 4577 return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r)); 4578} 4579 4580/** 4581 * @brief Wrapper function for BUS_DEACTIVATE_RESOURCE(). 4582 * 4583 * This function simply calls the BUS_DEACTIVATE_RESOURCE() method of the 4584 * parent of @p dev. 4585 */ 4586int 4587bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r) 4588{ 4589 if (dev->parent == NULL) 4590 return (EINVAL); 4591 return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r)); 4592} 4593 4594/** 4595 * @brief Wrapper function for BUS_MAP_RESOURCE(). 4596 * 4597 * This function simply calls the BUS_MAP_RESOURCE() method of the 4598 * parent of @p dev. 4599 */ 4600int 4601bus_map_resource(device_t dev, int type, struct resource *r, 4602 struct resource_map_request *args, struct resource_map *map) 4603{ 4604 if (dev->parent == NULL) 4605 return (EINVAL); 4606 return (BUS_MAP_RESOURCE(dev->parent, dev, type, r, args, map)); 4607} 4608 4609/** 4610 * @brief Wrapper function for BUS_UNMAP_RESOURCE(). 4611 * 4612 * This function simply calls the BUS_UNMAP_RESOURCE() method of the 4613 * parent of @p dev. 4614 */ 4615int 4616bus_unmap_resource(device_t dev, int type, struct resource *r, 4617 struct resource_map *map) 4618{ 4619 if (dev->parent == NULL) 4620 return (EINVAL); 4621 return (BUS_UNMAP_RESOURCE(dev->parent, dev, type, r, map)); 4622} 4623 4624/** 4625 * @brief Wrapper function for BUS_RELEASE_RESOURCE(). 4626 * 4627 * This function simply calls the BUS_RELEASE_RESOURCE() method of the 4628 * parent of @p dev. 4629 */ 4630int 4631bus_release_resource(device_t dev, int type, int rid, struct resource *r) 4632{ 4633 int rv; 4634 4635 if (dev->parent == NULL) 4636 return (EINVAL); 4637 rv = BUS_RELEASE_RESOURCE(dev->parent, dev, type, rid, r); 4638 return (rv); 4639} 4640 4641/** 4642 * @brief Wrapper function for BUS_SETUP_INTR(). 4643 * 4644 * This function simply calls the BUS_SETUP_INTR() method of the 4645 * parent of @p dev. 4646 */ 4647int 4648bus_setup_intr(device_t dev, struct resource *r, int flags, 4649 driver_filter_t filter, driver_intr_t handler, void *arg, void **cookiep) 4650{ 4651 int error; 4652 4653 if (dev->parent == NULL) 4654 return (EINVAL); 4655 error = BUS_SETUP_INTR(dev->parent, dev, r, flags, filter, handler, 4656 arg, cookiep); 4657 if (error != 0) 4658 return (error); 4659 if (handler != NULL && !(flags & INTR_MPSAFE)) 4660 device_printf(dev, "[GIANT-LOCKED]\n"); 4661 return (0); 4662} 4663 4664/** 4665 * @brief Wrapper function for BUS_TEARDOWN_INTR(). 4666 * 4667 * This function simply calls the BUS_TEARDOWN_INTR() method of the 4668 * parent of @p dev. 4669 */ 4670int 4671bus_teardown_intr(device_t dev, struct resource *r, void *cookie) 4672{ 4673 if (dev->parent == NULL) 4674 return (EINVAL); 4675 return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie)); 4676} 4677 4678/** 4679 * @brief Wrapper function for BUS_BIND_INTR(). 4680 * 4681 * This function simply calls the BUS_BIND_INTR() method of the 4682 * parent of @p dev. 4683 */ 4684int 4685bus_bind_intr(device_t dev, struct resource *r, int cpu) 4686{ 4687 if (dev->parent == NULL) 4688 return (EINVAL); 4689 return (BUS_BIND_INTR(dev->parent, dev, r, cpu)); 4690} 4691 4692/** 4693 * @brief Wrapper function for BUS_DESCRIBE_INTR(). 4694 * 4695 * This function first formats the requested description into a 4696 * temporary buffer and then calls the BUS_DESCRIBE_INTR() method of 4697 * the parent of @p dev. 4698 */ 4699int 4700bus_describe_intr(device_t dev, struct resource *irq, void *cookie, 4701 const char *fmt, ...) 4702{ 4703 va_list ap; 4704 char descr[MAXCOMLEN + 1]; 4705 4706 if (dev->parent == NULL) 4707 return (EINVAL); 4708 va_start(ap, fmt); 4709 vsnprintf(descr, sizeof(descr), fmt, ap); 4710 va_end(ap); 4711 return (BUS_DESCRIBE_INTR(dev->parent, dev, irq, cookie, descr)); 4712} 4713 4714/** 4715 * @brief Wrapper function for BUS_SET_RESOURCE(). 4716 * 4717 * This function simply calls the BUS_SET_RESOURCE() method of the 4718 * parent of @p dev. 4719 */ 4720int 4721bus_set_resource(device_t dev, int type, int rid, 4722 rman_res_t start, rman_res_t count) 4723{ 4724 return (BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid, 4725 start, count)); 4726} 4727 4728/** 4729 * @brief Wrapper function for BUS_GET_RESOURCE(). 4730 * 4731 * This function simply calls the BUS_GET_RESOURCE() method of the 4732 * parent of @p dev. 4733 */ 4734int 4735bus_get_resource(device_t dev, int type, int rid, 4736 rman_res_t *startp, rman_res_t *countp) 4737{ 4738 return (BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid, 4739 startp, countp)); 4740} 4741 4742/** 4743 * @brief Wrapper function for BUS_GET_RESOURCE(). 4744 * 4745 * This function simply calls the BUS_GET_RESOURCE() method of the 4746 * parent of @p dev and returns the start value. 4747 */ 4748rman_res_t 4749bus_get_resource_start(device_t dev, int type, int rid) 4750{ 4751 rman_res_t start; 4752 rman_res_t count; 4753 int error; 4754 4755 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid, 4756 &start, &count); 4757 if (error) 4758 return (0); 4759 return (start); 4760} 4761 4762/** 4763 * @brief Wrapper function for BUS_GET_RESOURCE(). 4764 * 4765 * This function simply calls the BUS_GET_RESOURCE() method of the 4766 * parent of @p dev and returns the count value. 4767 */ 4768rman_res_t 4769bus_get_resource_count(device_t dev, int type, int rid) 4770{ 4771 rman_res_t start; 4772 rman_res_t count; 4773 int error; 4774 4775 error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid, 4776 &start, &count); 4777 if (error) 4778 return (0); 4779 return (count); 4780} 4781 4782/** 4783 * @brief Wrapper function for BUS_DELETE_RESOURCE(). 4784 * 4785 * This function simply calls the BUS_DELETE_RESOURCE() method of the 4786 * parent of @p dev. 4787 */ 4788void 4789bus_delete_resource(device_t dev, int type, int rid) 4790{ 4791 BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid); 4792} 4793 4794/** 4795 * @brief Wrapper function for BUS_CHILD_PRESENT(). 4796 * 4797 * This function simply calls the BUS_CHILD_PRESENT() method of the 4798 * parent of @p dev. 4799 */ 4800int 4801bus_child_present(device_t child) 4802{ 4803 return (BUS_CHILD_PRESENT(device_get_parent(child), child)); 4804} 4805 4806/** 4807 * @brief Wrapper function for BUS_CHILD_PNPINFO_STR(). 4808 * 4809 * This function simply calls the BUS_CHILD_PNPINFO_STR() method of the 4810 * parent of @p dev. 4811 */ 4812int 4813bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen) 4814{ 4815 device_t parent; 4816 4817 parent = device_get_parent(child); 4818 if (parent == NULL) { 4819 *buf = '\0'; 4820 return (0); 4821 } 4822 return (BUS_CHILD_PNPINFO_STR(parent, child, buf, buflen)); 4823} 4824 4825/** 4826 * @brief Wrapper function for BUS_CHILD_LOCATION_STR(). 4827 * 4828 * This function simply calls the BUS_CHILD_LOCATION_STR() method of the 4829 * parent of @p dev. 4830 */ 4831int 4832bus_child_location_str(device_t child, char *buf, size_t buflen) 4833{ 4834 device_t parent; 4835 4836 parent = device_get_parent(child); 4837 if (parent == NULL) { 4838 *buf = '\0'; 4839 return (0); 4840 } 4841 return (BUS_CHILD_LOCATION_STR(parent, child, buf, buflen)); 4842} 4843 4844/** 4845 * @brief Wrapper function for BUS_GET_CPUS(). 4846 * 4847 * This function simply calls the BUS_GET_CPUS() method of the 4848 * parent of @p dev. 4849 */ 4850int 4851bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, cpuset_t *cpuset) 4852{ 4853 device_t parent; 4854 4855 parent = device_get_parent(dev); 4856 if (parent == NULL) 4857 return (EINVAL); 4858 return (BUS_GET_CPUS(parent, dev, op, setsize, cpuset)); 4859} 4860 4861/** 4862 * @brief Wrapper function for BUS_GET_DMA_TAG(). 4863 * 4864 * This function simply calls the BUS_GET_DMA_TAG() method of the 4865 * parent of @p dev. 4866 */ 4867bus_dma_tag_t 4868bus_get_dma_tag(device_t dev) 4869{ 4870 device_t parent; 4871 4872 parent = device_get_parent(dev); 4873 if (parent == NULL) 4874 return (NULL); 4875 return (BUS_GET_DMA_TAG(parent, dev)); 4876} 4877 4878/** 4879 * @brief Wrapper function for BUS_GET_BUS_TAG(). 4880 * 4881 * This function simply calls the BUS_GET_BUS_TAG() method of the 4882 * parent of @p dev. 4883 */ 4884bus_space_tag_t 4885bus_get_bus_tag(device_t dev) 4886{ 4887 device_t parent; 4888 4889 parent = device_get_parent(dev); 4890 if (parent == NULL) 4891 return ((bus_space_tag_t)0); 4892 return (BUS_GET_BUS_TAG(parent, dev)); 4893} 4894 4895/** 4896 * @brief Wrapper function for BUS_GET_DOMAIN(). 4897 * 4898 * This function simply calls the BUS_GET_DOMAIN() method of the 4899 * parent of @p dev. 4900 */ 4901int 4902bus_get_domain(device_t dev, int *domain) 4903{ 4904 return (BUS_GET_DOMAIN(device_get_parent(dev), dev, domain)); 4905} 4906 4907/* Resume all devices and then notify userland that we're up again. */ 4908static int 4909root_resume(device_t dev) 4910{ 4911 int error; 4912 4913 error = bus_generic_resume(dev); 4914 if (error == 0) 4915 devctl_notify("kern", "power", "resume", NULL); 4916 return (error); 4917} 4918 4919static int 4920root_print_child(device_t dev, device_t child) 4921{ 4922 int retval = 0; 4923 4924 retval += bus_print_child_header(dev, child); 4925 retval += printf("\n"); 4926 4927 return (retval); 4928} 4929 4930static int 4931root_setup_intr(device_t dev, device_t child, struct resource *irq, int flags, 4932 driver_filter_t *filter, driver_intr_t *intr, void *arg, void **cookiep) 4933{ 4934 /* 4935 * If an interrupt mapping gets to here something bad has happened. 4936 */ 4937 panic("root_setup_intr"); 4938} 4939 4940/* 4941 * If we get here, assume that the device is permanent and really is 4942 * present in the system. Removable bus drivers are expected to intercept 4943 * this call long before it gets here. We return -1 so that drivers that 4944 * really care can check vs -1 or some ERRNO returned higher in the food 4945 * chain. 4946 */ 4947static int 4948root_child_present(device_t dev, device_t child) 4949{ 4950 return (-1); 4951} 4952 4953static int 4954root_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize, 4955 cpuset_t *cpuset) 4956{ 4957 4958 switch (op) { 4959 case INTR_CPUS: 4960 /* Default to returning the set of all CPUs. */ 4961 if (setsize != sizeof(cpuset_t)) 4962 return (EINVAL); 4963 *cpuset = all_cpus; 4964 return (0); 4965 default: 4966 return (EINVAL); 4967 } 4968} 4969 4970static kobj_method_t root_methods[] = { 4971 /* Device interface */ 4972 KOBJMETHOD(device_shutdown, bus_generic_shutdown), 4973 KOBJMETHOD(device_suspend, bus_generic_suspend), 4974 KOBJMETHOD(device_resume, root_resume), 4975 4976 /* Bus interface */ 4977 KOBJMETHOD(bus_print_child, root_print_child), 4978 KOBJMETHOD(bus_read_ivar, bus_generic_read_ivar), 4979 KOBJMETHOD(bus_write_ivar, bus_generic_write_ivar), 4980 KOBJMETHOD(bus_setup_intr, root_setup_intr), 4981 KOBJMETHOD(bus_child_present, root_child_present), 4982 KOBJMETHOD(bus_get_cpus, root_get_cpus), 4983 4984 KOBJMETHOD_END 4985}; 4986 4987static driver_t root_driver = { 4988 "root", 4989 root_methods, 4990 1, /* no softc */ 4991}; 4992 4993device_t root_bus; 4994devclass_t root_devclass; 4995 4996static int 4997root_bus_module_handler(module_t mod, int what, void* arg) 4998{ 4999 switch (what) { 5000 case MOD_LOAD: 5001 TAILQ_INIT(&bus_data_devices); 5002 kobj_class_compile((kobj_class_t) &root_driver); 5003 root_bus = make_device(NULL, "root", 0); 5004 root_bus->desc = "System root bus"; 5005 kobj_init((kobj_t) root_bus, (kobj_class_t) &root_driver); 5006 root_bus->driver = &root_driver; 5007 root_bus->state = DS_ATTACHED; 5008 root_devclass = devclass_find_internal("root", NULL, FALSE); 5009 devinit(); 5010 return (0); 5011 5012 case MOD_SHUTDOWN: 5013 device_shutdown(root_bus); 5014 return (0); 5015 default: 5016 return (EOPNOTSUPP); 5017 } 5018 5019 return (0); 5020} 5021 5022static moduledata_t root_bus_mod = { 5023 "rootbus", 5024 root_bus_module_handler, 5025 NULL 5026}; 5027DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); 5028 5029/** 5030 * @brief Automatically configure devices 5031 * 5032 * This function begins the autoconfiguration process by calling 5033 * device_probe_and_attach() for each child of the @c root0 device. 5034 */ 5035void 5036root_bus_configure(void) 5037{ 5038 5039 PDEBUG((".")); 5040 5041 /* Eventually this will be split up, but this is sufficient for now. */ 5042 bus_set_pass(BUS_PASS_DEFAULT); 5043} 5044 5045/** 5046 * @brief Module handler for registering device drivers 5047 * 5048 * This module handler is used to automatically register device 5049 * drivers when modules are loaded. If @p what is MOD_LOAD, it calls 5050 * devclass_add_driver() for the driver described by the 5051 * driver_module_data structure pointed to by @p arg 5052 */ 5053int 5054driver_module_handler(module_t mod, int what, void *arg) 5055{ 5056 struct driver_module_data *dmd; 5057 devclass_t bus_devclass; 5058 kobj_class_t driver; 5059 int error, pass; 5060 5061 dmd = (struct driver_module_data *)arg; 5062 bus_devclass = devclass_find_internal(dmd->dmd_busname, NULL, TRUE); 5063 error = 0; 5064 5065 switch (what) { 5066 case MOD_LOAD: 5067 if (dmd->dmd_chainevh) 5068 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg); 5069 5070 pass = dmd->dmd_pass; 5071 driver = dmd->dmd_driver; 5072 PDEBUG(("Loading module: driver %s on bus %s (pass %d)", 5073 DRIVERNAME(driver), dmd->dmd_busname, pass)); 5074 error = devclass_add_driver(bus_devclass, driver, pass, 5075 dmd->dmd_devclass); 5076 break; 5077 5078 case MOD_UNLOAD: 5079 PDEBUG(("Unloading module: driver %s from bus %s", 5080 DRIVERNAME(dmd->dmd_driver), 5081 dmd->dmd_busname)); 5082 error = devclass_delete_driver(bus_devclass, 5083 dmd->dmd_driver); 5084 5085 if (!error && dmd->dmd_chainevh) 5086 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg); 5087 break; 5088 case MOD_QUIESCE: 5089 PDEBUG(("Quiesce module: driver %s from bus %s", 5090 DRIVERNAME(dmd->dmd_driver), 5091 dmd->dmd_busname)); 5092 error = devclass_quiesce_driver(bus_devclass, 5093 dmd->dmd_driver); 5094 5095 if (!error && dmd->dmd_chainevh) 5096 error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg); 5097 break; 5098 default: 5099 error = EOPNOTSUPP; 5100 break; 5101 } 5102 5103 return (error); 5104} 5105 5106/** 5107 * @brief Enumerate all hinted devices for this bus. 5108 * 5109 * Walks through the hints for this bus and calls the bus_hinted_child 5110 * routine for each one it fines. It searches first for the specific 5111 * bus that's being probed for hinted children (eg isa0), and then for 5112 * generic children (eg isa). 5113 * 5114 * @param dev bus device to enumerate 5115 */ 5116void 5117bus_enumerate_hinted_children(device_t bus) 5118{ 5119 int i; 5120 const char *dname, *busname; 5121 int dunit; 5122 5123 /* 5124 * enumerate all devices on the specific bus 5125 */ 5126 busname = device_get_nameunit(bus); 5127 i = 0; 5128 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0) 5129 BUS_HINTED_CHILD(bus, dname, dunit); 5130 5131 /* 5132 * and all the generic ones. 5133 */ 5134 busname = device_get_name(bus); 5135 i = 0; 5136 while (resource_find_match(&i, &dname, &dunit, "at", busname) == 0) 5137 BUS_HINTED_CHILD(bus, dname, dunit); 5138} 5139 5140#ifdef BUS_DEBUG 5141 5142/* the _short versions avoid iteration by not calling anything that prints 5143 * more than oneliners. I love oneliners. 5144 */ 5145 5146static void 5147print_device_short(device_t dev, int indent) 5148{ 5149 if (!dev) 5150 return; 5151 5152 indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s%s,%sivars,%ssoftc,busy=%d\n", 5153 dev->unit, dev->desc, 5154 (dev->parent? "":"no "), 5155 (TAILQ_EMPTY(&dev->children)? "no ":""), 5156 (dev->flags&DF_ENABLED? "enabled,":"disabled,"), 5157 (dev->flags&DF_FIXEDCLASS? "fixed,":""), 5158 (dev->flags&DF_WILDCARD? "wildcard,":""), 5159 (dev->flags&DF_DESCMALLOCED? "descmalloced,":""), 5160 (dev->flags&DF_REBID? "rebiddable,":""), 5161 (dev->ivars? "":"no "), 5162 (dev->softc? "":"no "), 5163 dev->busy)); 5164} 5165 5166static void 5167print_device(device_t dev, int indent) 5168{ 5169 if (!dev) 5170 return; 5171 5172 print_device_short(dev, indent); 5173 5174 indentprintf(("Parent:\n")); 5175 print_device_short(dev->parent, indent+1); 5176 indentprintf(("Driver:\n")); 5177 print_driver_short(dev->driver, indent+1); 5178 indentprintf(("Devclass:\n")); 5179 print_devclass_short(dev->devclass, indent+1); 5180} 5181 5182void 5183print_device_tree_short(device_t dev, int indent) 5184/* print the device and all its children (indented) */ 5185{ 5186 device_t child; 5187 5188 if (!dev) 5189 return; 5190 5191 print_device_short(dev, indent); 5192 5193 TAILQ_FOREACH(child, &dev->children, link) { 5194 print_device_tree_short(child, indent+1); 5195 } 5196} 5197 5198void 5199print_device_tree(device_t dev, int indent) 5200/* print the device and all its children (indented) */ 5201{ 5202 device_t child; 5203 5204 if (!dev) 5205 return; 5206 5207 print_device(dev, indent); 5208 5209 TAILQ_FOREACH(child, &dev->children, link) { 5210 print_device_tree(child, indent+1); 5211 } 5212} 5213 5214static void 5215print_driver_short(driver_t *driver, int indent) 5216{ 5217 if (!driver) 5218 return; 5219 5220 indentprintf(("driver %s: softc size = %zd\n", 5221 driver->name, driver->size)); 5222} 5223 5224static void 5225print_driver(driver_t *driver, int indent) 5226{ 5227 if (!driver) 5228 return; 5229 5230 print_driver_short(driver, indent); 5231} 5232 5233static void 5234print_driver_list(driver_list_t drivers, int indent) 5235{ 5236 driverlink_t driver; 5237 5238 TAILQ_FOREACH(driver, &drivers, link) { 5239 print_driver(driver->driver, indent); 5240 } 5241} 5242 5243static void 5244print_devclass_short(devclass_t dc, int indent) 5245{ 5246 if ( !dc ) 5247 return; 5248 5249 indentprintf(("devclass %s: max units = %d\n", dc->name, dc->maxunit)); 5250} 5251 5252static void 5253print_devclass(devclass_t dc, int indent) 5254{ 5255 int i; 5256 5257 if ( !dc ) 5258 return; 5259 5260 print_devclass_short(dc, indent); 5261 indentprintf(("Drivers:\n")); 5262 print_driver_list(dc->drivers, indent+1); 5263 5264 indentprintf(("Devices:\n")); 5265 for (i = 0; i < dc->maxunit; i++) 5266 if (dc->devices[i]) 5267 print_device(dc->devices[i], indent+1); 5268} 5269 5270void 5271print_devclass_list_short(void) 5272{ 5273 devclass_t dc; 5274 5275 printf("Short listing of devclasses, drivers & devices:\n"); 5276 TAILQ_FOREACH(dc, &devclasses, link) { 5277 print_devclass_short(dc, 0); 5278 } 5279} 5280 5281void 5282print_devclass_list(void) 5283{ 5284 devclass_t dc; 5285 5286 printf("Full listing of devclasses, drivers & devices:\n"); 5287 TAILQ_FOREACH(dc, &devclasses, link) { 5288 print_devclass(dc, 0); 5289 } 5290} 5291 5292#endif 5293 5294/* 5295 * User-space access to the device tree. 5296 * 5297 * We implement a small set of nodes: 5298 * 5299 * hw.bus Single integer read method to obtain the 5300 * current generation count. 5301 * hw.bus.devices Reads the entire device tree in flat space. 5302 * hw.bus.rman Resource manager interface 5303 * 5304 * We might like to add the ability to scan devclasses and/or drivers to 5305 * determine what else is currently loaded/available. 5306 */ 5307 5308static int 5309sysctl_bus(SYSCTL_HANDLER_ARGS) 5310{ 5311 struct u_businfo ubus; 5312 5313 ubus.ub_version = BUS_USER_VERSION; 5314 ubus.ub_generation = bus_data_generation; 5315 5316 return (SYSCTL_OUT(req, &ubus, sizeof(ubus))); 5317} 5318SYSCTL_NODE(_hw_bus, OID_AUTO, info, CTLFLAG_RW, sysctl_bus, 5319 "bus-related data"); 5320 5321static int 5322sysctl_devices(SYSCTL_HANDLER_ARGS) 5323{ 5324 int *name = (int *)arg1; 5325 u_int namelen = arg2; 5326 int index; 5327 struct device *dev; 5328 struct u_device udev; /* XXX this is a bit big */ 5329 int error; 5330 5331 if (namelen != 2) 5332 return (EINVAL); 5333 5334 if (bus_data_generation_check(name[0])) 5335 return (EINVAL); 5336 5337 index = name[1]; 5338 5339 /* 5340 * Scan the list of devices, looking for the requested index. 5341 */ 5342 TAILQ_FOREACH(dev, &bus_data_devices, devlink) { 5343 if (index-- == 0) 5344 break; 5345 } 5346 if (dev == NULL) 5347 return (ENOENT); 5348 5349 /* 5350 * Populate the return array. 5351 */ 5352 bzero(&udev, sizeof(udev)); 5353 udev.dv_handle = (uintptr_t)dev; 5354 udev.dv_parent = (uintptr_t)dev->parent; 5355 if (dev->nameunit != NULL) 5356 strlcpy(udev.dv_name, dev->nameunit, sizeof(udev.dv_name)); 5357 if (dev->desc != NULL) 5358 strlcpy(udev.dv_desc, dev->desc, sizeof(udev.dv_desc)); 5359 if (dev->driver != NULL && dev->driver->name != NULL) 5360 strlcpy(udev.dv_drivername, dev->driver->name, 5361 sizeof(udev.dv_drivername)); 5362 bus_child_pnpinfo_str(dev, udev.dv_pnpinfo, sizeof(udev.dv_pnpinfo)); 5363 bus_child_location_str(dev, udev.dv_location, sizeof(udev.dv_location)); 5364 udev.dv_devflags = dev->devflags; 5365 udev.dv_flags = dev->flags; 5366 udev.dv_state = dev->state; 5367 error = SYSCTL_OUT(req, &udev, sizeof(udev)); 5368 return (error); 5369} 5370 5371SYSCTL_NODE(_hw_bus, OID_AUTO, devices, CTLFLAG_RD, sysctl_devices, 5372 "system device tree"); 5373 5374int 5375bus_data_generation_check(int generation) 5376{ 5377 if (generation != bus_data_generation) 5378 return (1); 5379 5380 /* XXX generate optimised lists here? */ 5381 return (0); 5382} 5383 5384void 5385bus_data_generation_update(void) 5386{ 5387 bus_data_generation++; 5388} 5389 5390int 5391bus_free_resource(device_t dev, int type, struct resource *r) 5392{ 5393 if (r == NULL) 5394 return (0); 5395 return (bus_release_resource(dev, type, rman_get_rid(r), r)); 5396} 5397 5398device_t 5399device_lookup_by_name(const char *name) 5400{ 5401 device_t dev; 5402 5403 TAILQ_FOREACH(dev, &bus_data_devices, devlink) { 5404 if (dev->nameunit != NULL && strcmp(dev->nameunit, name) == 0) 5405 return (dev); 5406 } 5407 return (NULL); 5408} 5409 5410/* 5411 * /dev/devctl2 implementation. The existing /dev/devctl device has 5412 * implicit semantics on open, so it could not be reused for this. 5413 * Another option would be to call this /dev/bus? 5414 */ 5415static int 5416find_device(struct devreq *req, device_t *devp) 5417{ 5418 device_t dev; 5419 5420 /* 5421 * First, ensure that the name is nul terminated. 5422 */ 5423 if (memchr(req->dr_name, '\0', sizeof(req->dr_name)) == NULL) 5424 return (EINVAL); 5425 5426 /* 5427 * Second, try to find an attached device whose name matches 5428 * 'name'. 5429 */ 5430 dev = device_lookup_by_name(req->dr_name); 5431 if (dev != NULL) { 5432 *devp = dev; 5433 return (0); 5434 } 5435 5436 /* Finally, give device enumerators a chance. */ 5437 dev = NULL; 5438 EVENTHANDLER_INVOKE(dev_lookup, req->dr_name, &dev); 5439 if (dev == NULL) 5440 return (ENOENT); 5441 *devp = dev; 5442 return (0); 5443} 5444 5445static bool 5446driver_exists(device_t bus, const char *driver) 5447{ 5448 devclass_t dc; 5449 5450 for (dc = bus->devclass; dc != NULL; dc = dc->parent) { 5451 if (devclass_find_driver_internal(dc, driver) != NULL) 5452 return (true); 5453 } 5454 return (false); 5455} 5456 5457static int 5458devctl2_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag, 5459 struct thread *td) 5460{ 5461 struct devreq *req; 5462 device_t dev; 5463 int error, old; 5464 5465 /* Locate the device to control. */ 5466 mtx_lock(&Giant); 5467 req = (struct devreq *)data; 5468 switch (cmd) { 5469 case DEV_ATTACH: 5470 case DEV_DETACH: 5471 case DEV_ENABLE: 5472 case DEV_DISABLE: 5473 case DEV_SUSPEND: 5474 case DEV_RESUME: 5475 case DEV_SET_DRIVER: 5476 case DEV_CLEAR_DRIVER: 5477 case DEV_RESCAN: 5478 case DEV_DELETE: 5479 case DEV_RESET: 5480 error = priv_check(td, PRIV_DRIVER); 5481 if (error == 0) 5482 error = find_device(req, &dev); 5483 break; 5484 default: 5485 error = ENOTTY; 5486 break; 5487 } 5488 if (error) { 5489 mtx_unlock(&Giant); 5490 return (error); 5491 } 5492 5493 /* Perform the requested operation. */ 5494 switch (cmd) { 5495 case DEV_ATTACH: 5496 if (device_is_attached(dev) && (dev->flags & DF_REBID) == 0) 5497 error = EBUSY; 5498 else if (!device_is_enabled(dev)) 5499 error = ENXIO; 5500 else 5501 error = device_probe_and_attach(dev); 5502 break; 5503 case DEV_DETACH: 5504 if (!device_is_attached(dev)) { 5505 error = ENXIO; 5506 break; 5507 } 5508 if (!(req->dr_flags & DEVF_FORCE_DETACH)) { 5509 error = device_quiesce(dev); 5510 if (error) 5511 break; 5512 } 5513 error = device_detach(dev); 5514 break; 5515 case DEV_ENABLE: 5516 if (device_is_enabled(dev)) { 5517 error = EBUSY; 5518 break; 5519 } 5520 5521 /* 5522 * If the device has been probed but not attached (e.g. 5523 * when it has been disabled by a loader hint), just 5524 * attach the device rather than doing a full probe. 5525 */ 5526 device_enable(dev); 5527 if (device_is_alive(dev)) { 5528 /* 5529 * If the device was disabled via a hint, clear 5530 * the hint. 5531 */ 5532 if (resource_disabled(dev->driver->name, dev->unit)) 5533 resource_unset_value(dev->driver->name, 5534 dev->unit, "disabled"); 5535 error = device_attach(dev); 5536 } else 5537 error = device_probe_and_attach(dev); 5538 break; 5539 case DEV_DISABLE: 5540 if (!device_is_enabled(dev)) { 5541 error = ENXIO; 5542 break; 5543 } 5544 5545 if (!(req->dr_flags & DEVF_FORCE_DETACH)) { 5546 error = device_quiesce(dev); 5547 if (error) 5548 break; 5549 } 5550 5551 /* 5552 * Force DF_FIXEDCLASS on around detach to preserve 5553 * the existing name. 5554 */ 5555 old = dev->flags; 5556 dev->flags |= DF_FIXEDCLASS; 5557 error = device_detach(dev); 5558 if (!(old & DF_FIXEDCLASS)) 5559 dev->flags &= ~DF_FIXEDCLASS; 5560 if (error == 0) 5561 device_disable(dev); 5562 break; 5563 case DEV_SUSPEND: 5564 if (device_is_suspended(dev)) { 5565 error = EBUSY; 5566 break; 5567 } 5568 if (device_get_parent(dev) == NULL) { 5569 error = EINVAL; 5570 break; 5571 } 5572 error = BUS_SUSPEND_CHILD(device_get_parent(dev), dev); 5573 break; 5574 case DEV_RESUME: 5575 if (!device_is_suspended(dev)) { 5576 error = EINVAL; 5577 break; 5578 } 5579 if (device_get_parent(dev) == NULL) { 5580 error = EINVAL; 5581 break; 5582 } 5583 error = BUS_RESUME_CHILD(device_get_parent(dev), dev); 5584 break; 5585 case DEV_SET_DRIVER: { 5586 devclass_t dc; 5587 char driver[128]; 5588 5589 error = copyinstr(req->dr_data, driver, sizeof(driver), NULL); 5590 if (error) 5591 break; 5592 if (driver[0] == '\0') { 5593 error = EINVAL; 5594 break; 5595 } 5596 if (dev->devclass != NULL && 5597 strcmp(driver, dev->devclass->name) == 0) 5598 /* XXX: Could possibly force DF_FIXEDCLASS on? */ 5599 break; 5600 5601 /* 5602 * Scan drivers for this device's bus looking for at 5603 * least one matching driver. 5604 */ 5605 if (dev->parent == NULL) { 5606 error = EINVAL; 5607 break; 5608 } 5609 if (!driver_exists(dev->parent, driver)) { 5610 error = ENOENT; 5611 break; 5612 } 5613 dc = devclass_create(driver); 5614 if (dc == NULL) { 5615 error = ENOMEM; 5616 break; 5617 } 5618 5619 /* Detach device if necessary. */ 5620 if (device_is_attached(dev)) { 5621 if (req->dr_flags & DEVF_SET_DRIVER_DETACH) 5622 error = device_detach(dev); 5623 else 5624 error = EBUSY; 5625 if (error) 5626 break; 5627 } 5628 5629 /* Clear any previously-fixed device class and unit. */ 5630 if (dev->flags & DF_FIXEDCLASS) 5631 devclass_delete_device(dev->devclass, dev); 5632 dev->flags |= DF_WILDCARD; 5633 dev->unit = -1; 5634 5635 /* Force the new device class. */ 5636 error = devclass_add_device(dc, dev); 5637 if (error) 5638 break; 5639 dev->flags |= DF_FIXEDCLASS; 5640 error = device_probe_and_attach(dev); 5641 break; 5642 } 5643 case DEV_CLEAR_DRIVER: 5644 if (!(dev->flags & DF_FIXEDCLASS)) { 5645 error = 0; 5646 break; 5647 } 5648 if (device_is_attached(dev)) { 5649 if (req->dr_flags & DEVF_CLEAR_DRIVER_DETACH) 5650 error = device_detach(dev); 5651 else 5652 error = EBUSY; 5653 if (error) 5654 break; 5655 } 5656 5657 dev->flags &= ~DF_FIXEDCLASS; 5658 dev->flags |= DF_WILDCARD; 5659 devclass_delete_device(dev->devclass, dev); 5660 error = device_probe_and_attach(dev); 5661 break; 5662 case DEV_RESCAN: 5663 if (!device_is_attached(dev)) { 5664 error = ENXIO; 5665 break; 5666 } 5667 error = BUS_RESCAN(dev); 5668 break; 5669 case DEV_DELETE: { 5670 device_t parent; 5671 5672 parent = device_get_parent(dev); 5673 if (parent == NULL) { 5674 error = EINVAL; 5675 break; 5676 } 5677 if (!(req->dr_flags & DEVF_FORCE_DELETE)) { 5678 if (bus_child_present(dev) != 0) { 5679 error = EBUSY; 5680 break; 5681 } 5682 } 5683 5684 error = device_delete_child(parent, dev); 5685 break; 5686 } 5687 case DEV_RESET: 5688 if ((req->dr_flags & ~(DEVF_RESET_DETACH)) != 0) { 5689 error = EINVAL; 5690 break; 5691 } 5692 error = BUS_RESET_CHILD(device_get_parent(dev), dev, 5693 req->dr_flags); 5694 break; 5695 } 5696 mtx_unlock(&Giant); 5697 return (error); 5698} 5699 5700static struct cdevsw devctl2_cdevsw = { 5701 .d_version = D_VERSION, 5702 .d_ioctl = devctl2_ioctl, 5703 .d_name = "devctl2", 5704}; 5705 5706static void 5707devctl2_init(void) 5708{ 5709 5710 make_dev_credf(MAKEDEV_ETERNAL, &devctl2_cdevsw, 0, NULL, 5711 UID_ROOT, GID_WHEEL, 0600, "devctl2"); 5712} 5713 5714/* 5715 * APIs to manage deprecation and obsolescence. 5716 */ 5717static int obsolete_panic = 0; 5718SYSCTL_INT(_debug, OID_AUTO, obsolete_panic, CTLFLAG_RWTUN, &obsolete_panic, 0, 5719 "Panic when obsolete features are used (0 = never, 1 = if osbolete, " 5720 "2 = if deprecated)"); 5721 5722static void 5723gone_panic(int major, int running, const char *msg) 5724{ 5725 5726 switch (obsolete_panic) 5727 { 5728 case 0: 5729 return; 5730 case 1: 5731 if (running < major) 5732 return; 5733 /* FALLTHROUGH */ 5734 default: 5735 panic("%s", msg); 5736 } 5737} 5738 5739void 5740_gone_in(int major, const char *msg) 5741{ 5742 5743 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg); 5744 if (P_OSREL_MAJOR(__FreeBSD_version) >= major) 5745 printf("Obsolete code will removed soon: %s\n", msg); 5746 else 5747 printf("Deprecated code (to be removed in FreeBSD %d): %s\n", 5748 major, msg); 5749} 5750 5751void 5752_gone_in_dev(device_t dev, int major, const char *msg) 5753{ 5754 5755 gone_panic(major, P_OSREL_MAJOR(__FreeBSD_version), msg); 5756 if (P_OSREL_MAJOR(__FreeBSD_version) >= major) 5757 device_printf(dev, 5758 "Obsolete code will removed soon: %s\n", msg); 5759 else 5760 device_printf(dev, 5761 "Deprecated code (to be removed in FreeBSD %d): %s\n", 5762 major, msg); 5763} 5764