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