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