1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 1997,1998,2003 Doug Rabson 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _SYS_BUS_H_ 32 #define _SYS_BUS_H_ 33 34 #include <machine/_limits.h> 35 #include <machine/_bus.h> 36 #include <sys/_bus_dma.h> 37 #include <sys/ioccom.h> 38 39 /** 40 * @defgroup NEWBUS newbus - a generic framework for managing devices 41 * @{ 42 */ 43 44 /** 45 * @brief Interface information structure. 46 */ 47 struct u_businfo { 48 int ub_version; /**< @brief interface version */ 49 #define BUS_USER_VERSION 2 50 int ub_generation; /**< @brief generation count */ 51 }; 52 53 /** 54 * @brief State of the device. 55 */ 56 typedef enum device_state { 57 DS_NOTPRESENT = 10, /**< @brief not probed or probe failed */ 58 DS_ALIVE = 20, /**< @brief probe succeeded */ 59 DS_ATTACHING = 25, /**< @brief currently attaching */ 60 DS_ATTACHED = 30, /**< @brief attach method called */ 61 DS_BUSY = 40 /**< @brief device is open */ 62 } device_state_t; 63 64 /** 65 * @brief Device information exported to userspace. 66 * The strings are placed one after the other, separated by NUL characters. 67 * Fields should be added after the last one and order maintained for compatibility 68 */ 69 #define BUS_USER_BUFFER (3*1024) 70 struct u_device { 71 uintptr_t dv_handle; 72 uintptr_t dv_parent; 73 uint32_t dv_devflags; /**< @brief API Flags for device */ 74 uint16_t dv_flags; /**< @brief flags for dev state */ 75 device_state_t dv_state; /**< @brief State of attachment */ 76 char dv_fields[BUS_USER_BUFFER]; /**< @brief NUL terminated fields */ 77 /* name (name of the device in tree) */ 78 /* desc (driver description) */ 79 /* drivername (Name of driver without unit number) */ 80 /* pnpinfo (Plug and play information from bus) */ 81 /* location (Location of device on parent */ 82 /* NUL */ 83 }; 84 85 /* Flags exported via dv_flags. */ 86 #define DF_ENABLED 0x01 /* device should be probed/attached */ 87 #define DF_FIXEDCLASS 0x02 /* devclass specified at create time */ 88 #define DF_WILDCARD 0x04 /* unit was originally wildcard */ 89 #define DF_DESCMALLOCED 0x08 /* description was malloced */ 90 #define DF_QUIET 0x10 /* don't print verbose attach message */ 91 #define DF_DONENOMATCH 0x20 /* don't execute DEVICE_NOMATCH again */ 92 #define DF_EXTERNALSOFTC 0x40 /* softc not allocated by us */ 93 #define DF_REBID 0x80 /* Can rebid after attach */ 94 #define DF_SUSPENDED 0x100 /* Device is suspended. */ 95 #define DF_QUIET_CHILDREN 0x200 /* Default to quiet for all my children */ 96 #define DF_ATTACHED_ONCE 0x400 /* Has been attached at least once */ 97 #define DF_NEEDNOMATCH 0x800 /* Has a pending NOMATCH event */ 98 99 /** 100 * @brief Device request structure used for ioctl's. 101 * 102 * Used for ioctl's on /dev/devctl2. All device ioctl's 103 * must have parameter definitions which begin with dr_name. 104 */ 105 struct devreq_buffer { 106 void *buffer; 107 size_t length; 108 }; 109 110 struct devreq { 111 char dr_name[128]; 112 int dr_flags; /* request-specific flags */ 113 union { 114 struct devreq_buffer dru_buffer; 115 void *dru_data; 116 } dr_dru; 117 #define dr_buffer dr_dru.dru_buffer /* variable-sized buffer */ 118 #define dr_data dr_dru.dru_data /* fixed-size buffer */ 119 }; 120 121 #define DEV_ATTACH _IOW('D', 1, struct devreq) 122 #define DEV_DETACH _IOW('D', 2, struct devreq) 123 #define DEV_ENABLE _IOW('D', 3, struct devreq) 124 #define DEV_DISABLE _IOW('D', 4, struct devreq) 125 #define DEV_SUSPEND _IOW('D', 5, struct devreq) 126 #define DEV_RESUME _IOW('D', 6, struct devreq) 127 #define DEV_SET_DRIVER _IOW('D', 7, struct devreq) 128 #define DEV_CLEAR_DRIVER _IOW('D', 8, struct devreq) 129 #define DEV_RESCAN _IOW('D', 9, struct devreq) 130 #define DEV_DELETE _IOW('D', 10, struct devreq) 131 #define DEV_FREEZE _IOW('D', 11, struct devreq) 132 #define DEV_THAW _IOW('D', 12, struct devreq) 133 #define DEV_RESET _IOW('D', 13, struct devreq) 134 135 /* Flags for DEV_DETACH and DEV_DISABLE. */ 136 #define DEVF_FORCE_DETACH 0x0000001 137 138 /* Flags for DEV_SET_DRIVER. */ 139 #define DEVF_SET_DRIVER_DETACH 0x0000001 /* Detach existing driver. */ 140 141 /* Flags for DEV_CLEAR_DRIVER. */ 142 #define DEVF_CLEAR_DRIVER_DETACH 0x0000001 /* Detach existing driver. */ 143 144 /* Flags for DEV_DELETE. */ 145 #define DEVF_FORCE_DELETE 0x0000001 146 147 /* Flags for DEV_RESET */ 148 #define DEVF_RESET_DETACH 0x0000001 /* Detach drivers vs suspend 149 device */ 150 151 #ifdef _KERNEL 152 153 #include <sys/eventhandler.h> 154 #include <sys/kobj.h> 155 156 /** 157 * devctl hooks. Typically one should use the devctl_notify 158 * hook to send the message. However, devctl_queue_data is also 159 * included in case devctl_notify isn't sufficiently general. 160 */ 161 boolean_t devctl_process_running(void); 162 void devctl_notify_f(const char *__system, const char *__subsystem, 163 const char *__type, const char *__data, int __flags); 164 void devctl_notify(const char *__system, const char *__subsystem, 165 const char *__type, const char *__data); 166 void devctl_queue_data_f(char *__data, int __flags); 167 void devctl_queue_data(char *__data); 168 struct sbuf; 169 void devctl_safe_quote_sb(struct sbuf *__sb, const char *__src); 170 171 /** 172 * Device name parsers. Hook to allow device enumerators to map 173 * scheme-specific names to a device. 174 */ 175 typedef void (*dev_lookup_fn)(void *arg, const char *name, 176 device_t *result); 177 EVENTHANDLER_DECLARE(dev_lookup, dev_lookup_fn); 178 179 /** 180 * @brief A device driver (included mainly for compatibility with 181 * FreeBSD 4.x). 182 */ 183 typedef struct kobj_class driver_t; 184 185 /** 186 * @brief A device class 187 * 188 * The devclass object has two main functions in the system. The first 189 * is to manage the allocation of unit numbers for device instances 190 * and the second is to hold the list of device drivers for a 191 * particular bus type. Each devclass has a name and there cannot be 192 * two devclasses with the same name. This ensures that unique unit 193 * numbers are allocated to device instances. 194 * 195 * Drivers that support several different bus attachments (e.g. isa, 196 * pci, pccard) should all use the same devclass to ensure that unit 197 * numbers do not conflict. 198 * 199 * Each devclass may also have a parent devclass. This is used when 200 * searching for device drivers to allow a form of inheritance. When 201 * matching drivers with devices, first the driver list of the parent 202 * device's devclass is searched. If no driver is found in that list, 203 * the search continues in the parent devclass (if any). 204 */ 205 typedef struct devclass *devclass_t; 206 207 /** 208 * @brief A device method 209 */ 210 #define device_method_t kobj_method_t 211 212 /** 213 * @brief Driver interrupt filter return values 214 * 215 * If a driver provides an interrupt filter routine it must return an 216 * integer consisting of oring together zero or more of the following 217 * flags: 218 * 219 * FILTER_STRAY - this device did not trigger the interrupt 220 * FILTER_HANDLED - the interrupt has been fully handled and can be EOId 221 * FILTER_SCHEDULE_THREAD - the threaded interrupt handler should be 222 * scheduled to execute 223 * 224 * If the driver does not provide a filter, then the interrupt code will 225 * act is if the filter had returned FILTER_SCHEDULE_THREAD. Note that it 226 * is illegal to specify any other flag with FILTER_STRAY and that it is 227 * illegal to not specify either of FILTER_HANDLED or FILTER_SCHEDULE_THREAD 228 * if FILTER_STRAY is not specified. 229 */ 230 #define FILTER_STRAY 0x01 231 #define FILTER_HANDLED 0x02 232 #define FILTER_SCHEDULE_THREAD 0x04 233 234 /** 235 * @brief Driver interrupt service routines 236 * 237 * The filter routine is run in primary interrupt context and may not 238 * block or use regular mutexes. It may only use spin mutexes for 239 * synchronization. The filter may either completely handle the 240 * interrupt or it may perform some of the work and defer more 241 * expensive work to the regular interrupt handler. If a filter 242 * routine is not registered by the driver, then the regular interrupt 243 * handler is always used to handle interrupts from this device. 244 * 245 * The regular interrupt handler executes in its own thread context 246 * and may use regular mutexes. However, it is prohibited from 247 * sleeping on a sleep queue. 248 */ 249 typedef int driver_filter_t(void*); 250 typedef void driver_intr_t(void*); 251 252 /** 253 * @brief Interrupt type bits. 254 * 255 * These flags are used both by newbus interrupt 256 * registration (nexus.c) and also in struct intrec, which defines 257 * interrupt properties. 258 * 259 * XXX We should probably revisit this and remove the vestiges of the 260 * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't 261 * confuse things by renaming them (Grog, 18 July 2000). 262 * 263 * Buses which do interrupt remapping will want to change their type 264 * to reflect what sort of devices are underneath. 265 */ 266 enum intr_type { 267 INTR_TYPE_TTY = 1, 268 INTR_TYPE_BIO = 2, 269 INTR_TYPE_NET = 4, 270 INTR_TYPE_CAM = 8, 271 INTR_TYPE_MISC = 16, 272 INTR_TYPE_CLK = 32, 273 INTR_TYPE_AV = 64, 274 INTR_EXCL = 256, /* exclusive interrupt */ 275 INTR_MPSAFE = 512, /* this interrupt is SMP safe */ 276 INTR_ENTROPY = 1024, /* this interrupt provides entropy */ 277 INTR_MD1 = 4096, /* flag reserved for MD use */ 278 INTR_MD2 = 8192, /* flag reserved for MD use */ 279 INTR_MD3 = 16384, /* flag reserved for MD use */ 280 INTR_MD4 = 32768 /* flag reserved for MD use */ 281 }; 282 283 enum intr_trigger { 284 INTR_TRIGGER_INVALID = -1, 285 INTR_TRIGGER_CONFORM = 0, 286 INTR_TRIGGER_EDGE = 1, 287 INTR_TRIGGER_LEVEL = 2 288 }; 289 290 enum intr_polarity { 291 INTR_POLARITY_CONFORM = 0, 292 INTR_POLARITY_HIGH = 1, 293 INTR_POLARITY_LOW = 2 294 }; 295 296 /** 297 * CPU sets supported by bus_get_cpus(). Note that not all sets may be 298 * supported for a given device. If a request is not supported by a 299 * device (or its parents), then bus_get_cpus() will fail with EINVAL. 300 */ 301 enum cpu_sets { 302 LOCAL_CPUS = 0, 303 INTR_CPUS 304 }; 305 306 typedef int (*devop_t)(void); 307 308 /** 309 * @brief This structure is deprecated. 310 * 311 * Use the kobj(9) macro DEFINE_CLASS to 312 * declare classes which implement device drivers. 313 */ 314 struct driver { 315 KOBJ_CLASS_FIELDS; 316 }; 317 318 /** 319 * @brief A resource mapping. 320 */ 321 struct resource_map { 322 bus_space_tag_t r_bustag; 323 bus_space_handle_t r_bushandle; 324 bus_size_t r_size; 325 void *r_vaddr; 326 }; 327 328 /** 329 * @brief Optional properties of a resource mapping request. 330 */ 331 struct resource_map_request { 332 size_t size; 333 rman_res_t offset; 334 rman_res_t length; 335 vm_memattr_t memattr; 336 }; 337 338 void resource_init_map_request_impl(struct resource_map_request *_args, 339 size_t _sz); 340 #define resource_init_map_request(rmr) \ 341 resource_init_map_request_impl((rmr), sizeof(*(rmr))) 342 343 /* 344 * Definitions for drivers which need to keep simple lists of resources 345 * for their child devices. 346 */ 347 struct resource; 348 349 /** 350 * @brief An entry for a single resource in a resource list. 351 */ 352 struct resource_list_entry { 353 STAILQ_ENTRY(resource_list_entry) link; 354 int type; /**< @brief type argument to alloc_resource */ 355 int rid; /**< @brief resource identifier */ 356 int flags; /**< @brief resource flags */ 357 struct resource *res; /**< @brief the real resource when allocated */ 358 rman_res_t start; /**< @brief start of resource range */ 359 rman_res_t end; /**< @brief end of resource range */ 360 rman_res_t count; /**< @brief count within range */ 361 }; 362 STAILQ_HEAD(resource_list, resource_list_entry); 363 364 #define RLE_RESERVED 0x0001 /* Reserved by the parent bus. */ 365 #define RLE_ALLOCATED 0x0002 /* Reserved resource is allocated. */ 366 #define RLE_PREFETCH 0x0004 /* Resource is a prefetch range. */ 367 368 void resource_list_init(struct resource_list *rl); 369 void resource_list_free(struct resource_list *rl); 370 struct resource_list_entry * 371 resource_list_add(struct resource_list *rl, 372 int type, int rid, 373 rman_res_t start, rman_res_t end, rman_res_t count); 374 int resource_list_add_next(struct resource_list *rl, 375 int type, 376 rman_res_t start, rman_res_t end, rman_res_t count); 377 int resource_list_busy(struct resource_list *rl, 378 int type, int rid); 379 int resource_list_reserved(struct resource_list *rl, int type, int rid); 380 struct resource_list_entry* 381 resource_list_find(struct resource_list *rl, 382 int type, int rid); 383 void resource_list_delete(struct resource_list *rl, 384 int type, int rid); 385 struct resource * 386 resource_list_alloc(struct resource_list *rl, 387 device_t bus, device_t child, 388 int type, int *rid, 389 rman_res_t start, rman_res_t end, 390 rman_res_t count, u_int flags); 391 int resource_list_release(struct resource_list *rl, 392 device_t bus, device_t child, 393 int type, int rid, struct resource *res); 394 int resource_list_release_active(struct resource_list *rl, 395 device_t bus, device_t child, 396 int type); 397 struct resource * 398 resource_list_reserve(struct resource_list *rl, 399 device_t bus, device_t child, 400 int type, int *rid, 401 rman_res_t start, rman_res_t end, 402 rman_res_t count, u_int flags); 403 int resource_list_unreserve(struct resource_list *rl, 404 device_t bus, device_t child, 405 int type, int rid); 406 void resource_list_purge(struct resource_list *rl); 407 int resource_list_print_type(struct resource_list *rl, 408 const char *name, int type, 409 const char *format); 410 411 /* 412 * The root bus, to which all top-level buses are attached. 413 */ 414 extern device_t root_bus; 415 extern devclass_t root_devclass; 416 void root_bus_configure(void); 417 418 /* 419 * Useful functions for implementing buses. 420 */ 421 422 int bus_generic_activate_resource(device_t dev, device_t child, int type, 423 int rid, struct resource *r); 424 device_t 425 bus_generic_add_child(device_t dev, u_int order, const char *name, 426 int unit); 427 int bus_generic_adjust_resource(device_t bus, device_t child, int type, 428 struct resource *r, rman_res_t start, 429 rman_res_t end); 430 struct resource * 431 bus_generic_alloc_resource(device_t bus, device_t child, int type, 432 int *rid, rman_res_t start, rman_res_t end, 433 rman_res_t count, u_int flags); 434 int bus_generic_attach(device_t dev); 435 int bus_generic_bind_intr(device_t dev, device_t child, 436 struct resource *irq, int cpu); 437 int bus_generic_child_present(device_t dev, device_t child); 438 int bus_generic_config_intr(device_t, int, enum intr_trigger, 439 enum intr_polarity); 440 int bus_generic_describe_intr(device_t dev, device_t child, 441 struct resource *irq, void *cookie, 442 const char *descr); 443 int bus_generic_deactivate_resource(device_t dev, device_t child, int type, 444 int rid, struct resource *r); 445 int bus_generic_detach(device_t dev); 446 void bus_generic_driver_added(device_t dev, driver_t *driver); 447 int bus_generic_get_cpus(device_t dev, device_t child, enum cpu_sets op, 448 size_t setsize, struct _cpuset *cpuset); 449 bus_dma_tag_t 450 bus_generic_get_dma_tag(device_t dev, device_t child); 451 bus_space_tag_t 452 bus_generic_get_bus_tag(device_t dev, device_t child); 453 int bus_generic_get_domain(device_t dev, device_t child, int *domain); 454 struct resource_list * 455 bus_generic_get_resource_list (device_t, device_t); 456 int bus_generic_map_resource(device_t dev, device_t child, int type, 457 struct resource *r, 458 struct resource_map_request *args, 459 struct resource_map *map); 460 void bus_generic_new_pass(device_t dev); 461 int bus_print_child_header(device_t dev, device_t child); 462 int bus_print_child_domain(device_t dev, device_t child); 463 int bus_print_child_footer(device_t dev, device_t child); 464 int bus_generic_print_child(device_t dev, device_t child); 465 int bus_generic_probe(device_t dev); 466 int bus_generic_read_ivar(device_t dev, device_t child, int which, 467 uintptr_t *result); 468 int bus_generic_release_resource(device_t bus, device_t child, 469 int type, int rid, struct resource *r); 470 int bus_generic_resume(device_t dev); 471 int bus_generic_resume_child(device_t dev, device_t child); 472 int bus_generic_setup_intr(device_t dev, device_t child, 473 struct resource *irq, int flags, 474 driver_filter_t *filter, driver_intr_t *intr, 475 void *arg, void **cookiep); 476 477 struct resource * 478 bus_generic_rl_alloc_resource (device_t, device_t, int, int *, 479 rman_res_t, rman_res_t, rman_res_t, u_int); 480 void bus_generic_rl_delete_resource (device_t, device_t, int, int); 481 int bus_generic_rl_get_resource (device_t, device_t, int, int, rman_res_t *, 482 rman_res_t *); 483 int bus_generic_rl_set_resource (device_t, device_t, int, int, rman_res_t, 484 rman_res_t); 485 int bus_generic_rl_release_resource (device_t, device_t, int, int, 486 struct resource *); 487 488 int bus_generic_shutdown(device_t dev); 489 int bus_generic_suspend(device_t dev); 490 int bus_generic_suspend_child(device_t dev, device_t child); 491 int bus_generic_teardown_intr(device_t dev, device_t child, 492 struct resource *irq, void *cookie); 493 int bus_generic_suspend_intr(device_t dev, device_t child, 494 struct resource *irq); 495 int bus_generic_resume_intr(device_t dev, device_t child, 496 struct resource *irq); 497 int bus_generic_unmap_resource(device_t dev, device_t child, int type, 498 struct resource *r, 499 struct resource_map *map); 500 int bus_generic_write_ivar(device_t dev, device_t child, int which, 501 uintptr_t value); 502 int bus_helper_reset_post(device_t dev, int flags); 503 int bus_helper_reset_prepare(device_t dev, int flags); 504 int bus_null_rescan(device_t dev); 505 506 /* 507 * Wrapper functions for the BUS_*_RESOURCE methods to make client code 508 * a little simpler. 509 */ 510 511 struct resource_spec { 512 int type; 513 int rid; 514 int flags; 515 }; 516 #define RESOURCE_SPEC_END {-1, 0, 0} 517 518 int bus_alloc_resources(device_t dev, struct resource_spec *rs, 519 struct resource **res); 520 void bus_release_resources(device_t dev, const struct resource_spec *rs, 521 struct resource **res); 522 523 int bus_adjust_resource(device_t child, int type, struct resource *r, 524 rman_res_t start, rman_res_t end); 525 struct resource *bus_alloc_resource(device_t dev, int type, int *rid, 526 rman_res_t start, rman_res_t end, 527 rman_res_t count, u_int flags); 528 int bus_activate_resource(device_t dev, int type, int rid, 529 struct resource *r); 530 int bus_deactivate_resource(device_t dev, int type, int rid, 531 struct resource *r); 532 int bus_map_resource(device_t dev, int type, struct resource *r, 533 struct resource_map_request *args, 534 struct resource_map *map); 535 int bus_unmap_resource(device_t dev, int type, struct resource *r, 536 struct resource_map *map); 537 int bus_get_cpus(device_t dev, enum cpu_sets op, size_t setsize, 538 struct _cpuset *cpuset); 539 bus_dma_tag_t bus_get_dma_tag(device_t dev); 540 bus_space_tag_t bus_get_bus_tag(device_t dev); 541 int bus_get_domain(device_t dev, int *domain); 542 int bus_release_resource(device_t dev, int type, int rid, 543 struct resource *r); 544 int bus_free_resource(device_t dev, int type, struct resource *r); 545 int bus_setup_intr(device_t dev, struct resource *r, int flags, 546 driver_filter_t filter, driver_intr_t handler, 547 void *arg, void **cookiep); 548 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie); 549 int bus_suspend_intr(device_t dev, struct resource *r); 550 int bus_resume_intr(device_t dev, struct resource *r); 551 int bus_bind_intr(device_t dev, struct resource *r, int cpu); 552 int bus_describe_intr(device_t dev, struct resource *irq, void *cookie, 553 const char *fmt, ...) __printflike(4, 5); 554 int bus_set_resource(device_t dev, int type, int rid, 555 rman_res_t start, rman_res_t count); 556 int bus_get_resource(device_t dev, int type, int rid, 557 rman_res_t *startp, rman_res_t *countp); 558 rman_res_t bus_get_resource_start(device_t dev, int type, int rid); 559 rman_res_t bus_get_resource_count(device_t dev, int type, int rid); 560 void bus_delete_resource(device_t dev, int type, int rid); 561 int bus_child_present(device_t child); 562 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen); 563 int bus_child_location_str(device_t child, char *buf, size_t buflen); 564 void bus_enumerate_hinted_children(device_t bus); 565 566 static __inline struct resource * 567 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags) 568 { 569 return (bus_alloc_resource(dev, type, rid, 0, ~0, 1, flags)); 570 } 571 572 static __inline struct resource * 573 bus_alloc_resource_anywhere(device_t dev, int type, int *rid, 574 rman_res_t count, u_int flags) 575 { 576 return (bus_alloc_resource(dev, type, rid, 0, ~0, count, flags)); 577 } 578 579 /* 580 * Access functions for device. 581 */ 582 device_t device_add_child(device_t dev, const char *name, int unit); 583 device_t device_add_child_ordered(device_t dev, u_int order, 584 const char *name, int unit); 585 void device_busy(device_t dev); 586 int device_delete_child(device_t dev, device_t child); 587 int device_delete_children(device_t dev); 588 int device_attach(device_t dev); 589 int device_detach(device_t dev); 590 void device_disable(device_t dev); 591 void device_enable(device_t dev); 592 device_t device_find_child(device_t dev, const char *classname, 593 int unit); 594 const char *device_get_desc(device_t dev); 595 devclass_t device_get_devclass(device_t dev); 596 driver_t *device_get_driver(device_t dev); 597 u_int32_t device_get_flags(device_t dev); 598 device_t device_get_parent(device_t dev); 599 int device_get_children(device_t dev, device_t **listp, int *countp); 600 void *device_get_ivars(device_t dev); 601 void device_set_ivars(device_t dev, void *ivars); 602 const char *device_get_name(device_t dev); 603 const char *device_get_nameunit(device_t dev); 604 void *device_get_softc(device_t dev); 605 device_state_t device_get_state(device_t dev); 606 int device_get_unit(device_t dev); 607 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev); 608 struct sysctl_oid *device_get_sysctl_tree(device_t dev); 609 int device_has_quiet_children(device_t dev); 610 int device_is_alive(device_t dev); /* did probe succeed? */ 611 int device_is_attached(device_t dev); /* did attach succeed? */ 612 int device_is_enabled(device_t dev); 613 int device_is_suspended(device_t dev); 614 int device_is_quiet(device_t dev); 615 device_t device_lookup_by_name(const char *name); 616 int device_print_prettyname(device_t dev); 617 int device_printf(device_t dev, const char *, ...) __printflike(2, 3); 618 int device_probe(device_t dev); 619 int device_probe_and_attach(device_t dev); 620 int device_probe_child(device_t bus, device_t dev); 621 int device_quiesce(device_t dev); 622 void device_quiet(device_t dev); 623 void device_quiet_children(device_t dev); 624 void device_set_desc(device_t dev, const char* desc); 625 void device_set_desc_copy(device_t dev, const char* desc); 626 int device_set_devclass(device_t dev, const char *classname); 627 int device_set_devclass_fixed(device_t dev, const char *classname); 628 bool device_is_devclass_fixed(device_t dev); 629 int device_set_driver(device_t dev, driver_t *driver); 630 void device_set_flags(device_t dev, u_int32_t flags); 631 void device_set_softc(device_t dev, void *softc); 632 void device_free_softc(void *softc); 633 void device_claim_softc(device_t dev); 634 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */ 635 int device_shutdown(device_t dev); 636 void device_unbusy(device_t dev); 637 void device_verbose(device_t dev); 638 639 /* 640 * Access functions for devclass. 641 */ 642 int devclass_add_driver(devclass_t dc, driver_t *driver, 643 int pass, devclass_t *dcp); 644 devclass_t devclass_create(const char *classname); 645 int devclass_delete_driver(devclass_t busclass, driver_t *driver); 646 devclass_t devclass_find(const char *classname); 647 const char *devclass_get_name(devclass_t dc); 648 device_t devclass_get_device(devclass_t dc, int unit); 649 void *devclass_get_softc(devclass_t dc, int unit); 650 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp); 651 int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp); 652 int devclass_get_count(devclass_t dc); 653 int devclass_get_maxunit(devclass_t dc); 654 int devclass_find_free_unit(devclass_t dc, int unit); 655 void devclass_set_parent(devclass_t dc, devclass_t pdc); 656 devclass_t devclass_get_parent(devclass_t dc); 657 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc); 658 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc); 659 660 /* 661 * Access functions for device resources. 662 */ 663 int resource_int_value(const char *name, int unit, const char *resname, 664 int *result); 665 int resource_long_value(const char *name, int unit, const char *resname, 666 long *result); 667 int resource_string_value(const char *name, int unit, const char *resname, 668 const char **result); 669 int resource_disabled(const char *name, int unit); 670 int resource_find_match(int *anchor, const char **name, int *unit, 671 const char *resname, const char *value); 672 int resource_find_dev(int *anchor, const char *name, int *unit, 673 const char *resname, const char *value); 674 int resource_unset_value(const char *name, int unit, const char *resname); 675 676 /* 677 * Functions for maintaining and checking consistency of 678 * bus information exported to userspace. 679 */ 680 int bus_data_generation_check(int generation); 681 void bus_data_generation_update(void); 682 683 /** 684 * Some convenience defines for probe routines to return. These are just 685 * suggested values, and there's nothing magical about them. 686 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no 687 * possible other driver may exist (typically legacy drivers who don't follow 688 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the 689 * suggested value that vendor supplied drivers use. This is for source or 690 * binary drivers that are not yet integrated into the FreeBSD tree. Its use 691 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value 692 * for drivers to use. It is intended that nearly all of the drivers in the 693 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that 694 * have special requirements like when there are two drivers that support 695 * overlapping series of hardware devices. In this case the one that supports 696 * the older part of the line would return this value, while the one that 697 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC 698 * is for drivers that wish to have a generic form and a specialized form, 699 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is 700 * for those buses that implement a generic device placeholder for devices on 701 * the bus that have no more specific driver for them (aka ugen). 702 * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding 703 * for a device node, but accepts only devices that its parent has told it 704 * use this driver. 705 */ 706 #define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */ 707 #define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */ 708 #define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */ 709 #define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */ 710 #define BUS_PROBE_GENERIC (-100) /* generic driver for dev */ 711 #define BUS_PROBE_HOOVER (-1000000) /* Driver for any dev on bus */ 712 #define BUS_PROBE_NOWILDCARD (-2000000000) /* No wildcard device matches */ 713 714 /** 715 * During boot, the device tree is scanned multiple times. Each scan, 716 * or pass, drivers may be attached to devices. Each driver 717 * attachment is assigned a pass number. Drivers may only probe and 718 * attach to devices if their pass number is less than or equal to the 719 * current system-wide pass number. The default pass is the last pass 720 * and is used by most drivers. Drivers needed by the scheduler are 721 * probed in earlier passes. 722 */ 723 #define BUS_PASS_ROOT 0 /* Used to attach root0. */ 724 #define BUS_PASS_BUS 10 /* Buses and bridges. */ 725 #define BUS_PASS_CPU 20 /* CPU devices. */ 726 #define BUS_PASS_RESOURCE 30 /* Resource discovery. */ 727 #define BUS_PASS_INTERRUPT 40 /* Interrupt controllers. */ 728 #define BUS_PASS_TIMER 50 /* Timers and clocks. */ 729 #define BUS_PASS_SCHEDULER 60 /* Start scheduler. */ 730 #define BUS_PASS_SUPPORTDEV 100000 /* Drivers which support DEFAULT drivers. */ 731 #define BUS_PASS_DEFAULT __INT_MAX /* Everything else. */ 732 733 #define BUS_PASS_ORDER_FIRST 0 734 #define BUS_PASS_ORDER_EARLY 2 735 #define BUS_PASS_ORDER_MIDDLE 5 736 #define BUS_PASS_ORDER_LATE 7 737 #define BUS_PASS_ORDER_LAST 9 738 739 extern int bus_current_pass; 740 741 void bus_set_pass(int pass); 742 743 /** 744 * Shorthands for constructing method tables. 745 */ 746 #define DEVMETHOD KOBJMETHOD 747 #define DEVMETHOD_END KOBJMETHOD_END 748 749 /* 750 * Some common device interfaces. 751 */ 752 #include "device_if.h" 753 #include "bus_if.h" 754 755 struct module; 756 757 int driver_module_handler(struct module *, int, void *); 758 759 /** 760 * Module support for automatically adding drivers to buses. 761 */ 762 struct driver_module_data { 763 int (*dmd_chainevh)(struct module *, int, void *); 764 void *dmd_chainarg; 765 const char *dmd_busname; 766 kobj_class_t dmd_driver; 767 devclass_t *dmd_devclass; 768 int dmd_pass; 769 }; 770 771 #define EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ 772 evh, arg, order, pass) \ 773 \ 774 static struct driver_module_data name##_##busname##_driver_mod = { \ 775 evh, arg, \ 776 #busname, \ 777 (kobj_class_t) &driver, \ 778 &devclass, \ 779 pass \ 780 }; \ 781 \ 782 static moduledata_t name##_##busname##_mod = { \ 783 #busname "/" #name, \ 784 driver_module_handler, \ 785 &name##_##busname##_driver_mod \ 786 }; \ 787 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ 788 SI_SUB_DRIVERS, order) 789 790 #define EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, pass) \ 791 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ 792 evh, arg, SI_ORDER_MIDDLE, pass) 793 794 #define DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\ 795 order) \ 796 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ 797 evh, arg, order, BUS_PASS_DEFAULT) 798 799 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \ 800 EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, \ 801 BUS_PASS_DEFAULT) 802 803 /** 804 * Generic ivar accessor generation macros for bus drivers 805 */ 806 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \ 807 \ 808 static __inline type varp ## _get_ ## var(device_t dev) \ 809 { \ 810 uintptr_t v; \ 811 BUS_READ_IVAR(device_get_parent(dev), dev, \ 812 ivarp ## _IVAR_ ## ivar, &v); \ 813 return ((type) v); \ 814 } \ 815 \ 816 static __inline void varp ## _set_ ## var(device_t dev, type t) \ 817 { \ 818 uintptr_t v = (uintptr_t) t; \ 819 BUS_WRITE_IVAR(device_get_parent(dev), dev, \ 820 ivarp ## _IVAR_ ## ivar, v); \ 821 } 822 823 /** 824 * Shorthand macros, taking resource argument 825 * Generated with sys/tools/bus_macro.sh 826 */ 827 828 #define bus_barrier(r, o, l, f) \ 829 bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f)) 830 #define bus_read_1(r, o) \ 831 bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o)) 832 #define bus_read_multi_1(r, o, d, c) \ 833 bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 834 #define bus_read_region_1(r, o, d, c) \ 835 bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 836 #define bus_set_multi_1(r, o, v, c) \ 837 bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 838 #define bus_set_region_1(r, o, v, c) \ 839 bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 840 #define bus_write_1(r, o, v) \ 841 bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v)) 842 #define bus_write_multi_1(r, o, d, c) \ 843 bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 844 #define bus_write_region_1(r, o, d, c) \ 845 bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 846 #define bus_read_stream_1(r, o) \ 847 bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o)) 848 #define bus_read_multi_stream_1(r, o, d, c) \ 849 bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 850 #define bus_read_region_stream_1(r, o, d, c) \ 851 bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 852 #define bus_set_multi_stream_1(r, o, v, c) \ 853 bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 854 #define bus_set_region_stream_1(r, o, v, c) \ 855 bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 856 #define bus_write_stream_1(r, o, v) \ 857 bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v)) 858 #define bus_write_multi_stream_1(r, o, d, c) \ 859 bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 860 #define bus_write_region_stream_1(r, o, d, c) \ 861 bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 862 #define bus_read_2(r, o) \ 863 bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o)) 864 #define bus_read_multi_2(r, o, d, c) \ 865 bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 866 #define bus_read_region_2(r, o, d, c) \ 867 bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 868 #define bus_set_multi_2(r, o, v, c) \ 869 bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 870 #define bus_set_region_2(r, o, v, c) \ 871 bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 872 #define bus_write_2(r, o, v) \ 873 bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v)) 874 #define bus_write_multi_2(r, o, d, c) \ 875 bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 876 #define bus_write_region_2(r, o, d, c) \ 877 bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 878 #define bus_read_stream_2(r, o) \ 879 bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o)) 880 #define bus_read_multi_stream_2(r, o, d, c) \ 881 bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 882 #define bus_read_region_stream_2(r, o, d, c) \ 883 bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 884 #define bus_set_multi_stream_2(r, o, v, c) \ 885 bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 886 #define bus_set_region_stream_2(r, o, v, c) \ 887 bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 888 #define bus_write_stream_2(r, o, v) \ 889 bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v)) 890 #define bus_write_multi_stream_2(r, o, d, c) \ 891 bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 892 #define bus_write_region_stream_2(r, o, d, c) \ 893 bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 894 #define bus_read_4(r, o) \ 895 bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o)) 896 #define bus_read_multi_4(r, o, d, c) \ 897 bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 898 #define bus_read_region_4(r, o, d, c) \ 899 bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 900 #define bus_set_multi_4(r, o, v, c) \ 901 bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 902 #define bus_set_region_4(r, o, v, c) \ 903 bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 904 #define bus_write_4(r, o, v) \ 905 bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v)) 906 #define bus_write_multi_4(r, o, d, c) \ 907 bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 908 #define bus_write_region_4(r, o, d, c) \ 909 bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 910 #define bus_read_stream_4(r, o) \ 911 bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o)) 912 #define bus_read_multi_stream_4(r, o, d, c) \ 913 bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 914 #define bus_read_region_stream_4(r, o, d, c) \ 915 bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 916 #define bus_set_multi_stream_4(r, o, v, c) \ 917 bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 918 #define bus_set_region_stream_4(r, o, v, c) \ 919 bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 920 #define bus_write_stream_4(r, o, v) \ 921 bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v)) 922 #define bus_write_multi_stream_4(r, o, d, c) \ 923 bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 924 #define bus_write_region_stream_4(r, o, d, c) \ 925 bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 926 #define bus_read_8(r, o) \ 927 bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o)) 928 #define bus_read_multi_8(r, o, d, c) \ 929 bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 930 #define bus_read_region_8(r, o, d, c) \ 931 bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 932 #define bus_set_multi_8(r, o, v, c) \ 933 bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 934 #define bus_set_region_8(r, o, v, c) \ 935 bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 936 #define bus_write_8(r, o, v) \ 937 bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v)) 938 #define bus_write_multi_8(r, o, d, c) \ 939 bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 940 #define bus_write_region_8(r, o, d, c) \ 941 bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 942 #define bus_read_stream_8(r, o) \ 943 bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o)) 944 #define bus_read_multi_stream_8(r, o, d, c) \ 945 bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 946 #define bus_read_region_stream_8(r, o, d, c) \ 947 bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 948 #define bus_set_multi_stream_8(r, o, v, c) \ 949 bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 950 #define bus_set_region_stream_8(r, o, v, c) \ 951 bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 952 #define bus_write_stream_8(r, o, v) \ 953 bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v)) 954 #define bus_write_multi_stream_8(r, o, d, c) \ 955 bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 956 #define bus_write_region_stream_8(r, o, d, c) \ 957 bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 958 #endif /* _KERNEL */ 959 960 #endif /* !_SYS_BUS_H_ */ 961