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