bus.h revision 279904
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: stable/10/sys/sys/bus.h 279904 2015-03-12 07:07:41Z scottl $ 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 */ 43struct 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 */ 52typedef 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 */ 63struct 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 */ 88boolean_t devctl_process_running(void); 89void devctl_notify_f(const char *__system, const char *__subsystem, 90 const char *__type, const char *__data, int __flags); 91void devctl_notify(const char *__system, const char *__subsystem, 92 const char *__type, const char *__data); 93void devctl_queue_data_f(char *__data, int __flags); 94void devctl_queue_data(char *__data); 95 96/** 97 * @brief A device driver (included mainly for compatibility with 98 * FreeBSD 4.x). 99 */ 100typedef 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 */ 122typedef 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 */ 167typedef int driver_filter_t(void*); 168typedef 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 * Buses which do interrupt remapping will want to change their type 182 * to reflect what sort of devices are underneath. 183 */ 184enum intr_type { 185 INTR_TYPE_TTY = 1, 186 INTR_TYPE_BIO = 2, 187 INTR_TYPE_NET = 4, 188 INTR_TYPE_CAM = 8, 189 INTR_TYPE_MISC = 16, 190 INTR_TYPE_CLK = 32, 191 INTR_TYPE_AV = 64, 192 INTR_EXCL = 256, /* exclusive interrupt */ 193 INTR_MPSAFE = 512, /* this interrupt is SMP safe */ 194 INTR_ENTROPY = 1024, /* this interrupt provides entropy */ 195 INTR_MD1 = 4096, /* flag reserved for MD use */ 196 INTR_MD2 = 8192, /* flag reserved for MD use */ 197 INTR_MD3 = 16384, /* flag reserved for MD use */ 198 INTR_MD4 = 32768 /* flag reserved for MD use */ 199}; 200 201enum intr_trigger { 202 INTR_TRIGGER_CONFORM = 0, 203 INTR_TRIGGER_EDGE = 1, 204 INTR_TRIGGER_LEVEL = 2 205}; 206 207enum intr_polarity { 208 INTR_POLARITY_CONFORM = 0, 209 INTR_POLARITY_HIGH = 1, 210 INTR_POLARITY_LOW = 2 211}; 212 213typedef int (*devop_t)(void); 214 215/** 216 * @brief This structure is deprecated. 217 * 218 * Use the kobj(9) macro DEFINE_CLASS to 219 * declare classes which implement device drivers. 220 */ 221struct driver { 222 KOBJ_CLASS_FIELDS; 223}; 224 225/* 226 * Definitions for drivers which need to keep simple lists of resources 227 * for their child devices. 228 */ 229struct resource; 230 231/** 232 * @brief An entry for a single resource in a resource list. 233 */ 234struct resource_list_entry { 235 STAILQ_ENTRY(resource_list_entry) link; 236 int type; /**< @brief type argument to alloc_resource */ 237 int rid; /**< @brief resource identifier */ 238 int flags; /**< @brief resource flags */ 239 struct resource *res; /**< @brief the real resource when allocated */ 240 u_long start; /**< @brief start of resource range */ 241 u_long end; /**< @brief end of resource range */ 242 u_long count; /**< @brief count within range */ 243}; 244STAILQ_HEAD(resource_list, resource_list_entry); 245 246#define RLE_RESERVED 0x0001 /* Reserved by the parent bus. */ 247#define RLE_ALLOCATED 0x0002 /* Reserved resource is allocated. */ 248#define RLE_PREFETCH 0x0004 /* Resource is a prefetch range. */ 249 250void resource_list_init(struct resource_list *rl); 251void resource_list_free(struct resource_list *rl); 252struct resource_list_entry * 253 resource_list_add(struct resource_list *rl, 254 int type, int rid, 255 u_long start, u_long end, u_long count); 256int resource_list_add_next(struct resource_list *rl, 257 int type, 258 u_long start, u_long end, u_long count); 259int resource_list_busy(struct resource_list *rl, 260 int type, int rid); 261int resource_list_reserved(struct resource_list *rl, int type, int rid); 262struct resource_list_entry* 263 resource_list_find(struct resource_list *rl, 264 int type, int rid); 265void resource_list_delete(struct resource_list *rl, 266 int type, int rid); 267struct resource * 268 resource_list_alloc(struct resource_list *rl, 269 device_t bus, device_t child, 270 int type, int *rid, 271 u_long start, u_long end, 272 u_long count, u_int flags); 273int resource_list_release(struct resource_list *rl, 274 device_t bus, device_t child, 275 int type, int rid, struct resource *res); 276int resource_list_release_active(struct resource_list *rl, 277 device_t bus, device_t child, 278 int type); 279struct resource * 280 resource_list_reserve(struct resource_list *rl, 281 device_t bus, device_t child, 282 int type, int *rid, 283 u_long start, u_long end, 284 u_long count, u_int flags); 285int resource_list_unreserve(struct resource_list *rl, 286 device_t bus, device_t child, 287 int type, int rid); 288void resource_list_purge(struct resource_list *rl); 289int resource_list_print_type(struct resource_list *rl, 290 const char *name, int type, 291 const char *format); 292 293/* 294 * The root bus, to which all top-level busses are attached. 295 */ 296extern device_t root_bus; 297extern devclass_t root_devclass; 298void root_bus_configure(void); 299 300/* 301 * Useful functions for implementing busses. 302 */ 303 304int bus_generic_activate_resource(device_t dev, device_t child, int type, 305 int rid, struct resource *r); 306device_t 307 bus_generic_add_child(device_t dev, u_int order, const char *name, 308 int unit); 309int bus_generic_adjust_resource(device_t bus, device_t child, int type, 310 struct resource *r, u_long start, 311 u_long end); 312struct resource * 313 bus_generic_alloc_resource(device_t bus, device_t child, int type, 314 int *rid, u_long start, u_long end, 315 u_long count, u_int flags); 316int bus_generic_attach(device_t dev); 317int bus_generic_bind_intr(device_t dev, device_t child, 318 struct resource *irq, int cpu); 319int bus_generic_child_present(device_t dev, device_t child); 320int bus_generic_config_intr(device_t, int, enum intr_trigger, 321 enum intr_polarity); 322int bus_generic_describe_intr(device_t dev, device_t child, 323 struct resource *irq, void *cookie, 324 const char *descr); 325int bus_generic_deactivate_resource(device_t dev, device_t child, int type, 326 int rid, struct resource *r); 327int bus_generic_detach(device_t dev); 328void bus_generic_driver_added(device_t dev, driver_t *driver); 329bus_dma_tag_t 330 bus_generic_get_dma_tag(device_t dev, device_t child); 331struct resource_list * 332 bus_generic_get_resource_list (device_t, device_t); 333void bus_generic_new_pass(device_t dev); 334int bus_print_child_header(device_t dev, device_t child); 335int bus_print_child_domain(device_t dev, device_t child); 336int bus_print_child_footer(device_t dev, device_t child); 337int bus_generic_print_child(device_t dev, device_t child); 338int bus_generic_probe(device_t dev); 339int bus_generic_read_ivar(device_t dev, device_t child, int which, 340 uintptr_t *result); 341int bus_generic_release_resource(device_t bus, device_t child, 342 int type, int rid, struct resource *r); 343int bus_generic_resume(device_t dev); 344int bus_generic_setup_intr(device_t dev, device_t child, 345 struct resource *irq, int flags, 346 driver_filter_t *filter, driver_intr_t *intr, 347 void *arg, void **cookiep); 348 349struct resource * 350 bus_generic_rl_alloc_resource (device_t, device_t, int, int *, 351 u_long, u_long, u_long, u_int); 352void bus_generic_rl_delete_resource (device_t, device_t, int, int); 353int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *, 354 u_long *); 355int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long, 356 u_long); 357int bus_generic_rl_release_resource (device_t, device_t, int, int, 358 struct resource *); 359 360int bus_generic_shutdown(device_t dev); 361int bus_generic_suspend(device_t dev); 362int bus_generic_teardown_intr(device_t dev, device_t child, 363 struct resource *irq, void *cookie); 364int bus_generic_write_ivar(device_t dev, device_t child, int which, 365 uintptr_t value); 366 367int bus_generic_get_domain(device_t dev, device_t child, int *domain); 368 369/* 370 * Wrapper functions for the BUS_*_RESOURCE methods to make client code 371 * a little simpler. 372 */ 373 374struct resource_spec { 375 int type; 376 int rid; 377 int flags; 378}; 379 380int bus_alloc_resources(device_t dev, struct resource_spec *rs, 381 struct resource **res); 382void bus_release_resources(device_t dev, const struct resource_spec *rs, 383 struct resource **res); 384 385int bus_adjust_resource(device_t child, int type, struct resource *r, 386 u_long start, u_long end); 387struct resource *bus_alloc_resource(device_t dev, int type, int *rid, 388 u_long start, u_long end, u_long count, 389 u_int flags); 390int bus_activate_resource(device_t dev, int type, int rid, 391 struct resource *r); 392int bus_deactivate_resource(device_t dev, int type, int rid, 393 struct resource *r); 394bus_dma_tag_t bus_get_dma_tag(device_t dev); 395int bus_get_domain(device_t dev, int *domain); 396int bus_release_resource(device_t dev, int type, int rid, 397 struct resource *r); 398int bus_free_resource(device_t dev, int type, struct resource *r); 399int bus_setup_intr(device_t dev, struct resource *r, int flags, 400 driver_filter_t filter, driver_intr_t handler, 401 void *arg, void **cookiep); 402int bus_teardown_intr(device_t dev, struct resource *r, void *cookie); 403int bus_bind_intr(device_t dev, struct resource *r, int cpu); 404int bus_describe_intr(device_t dev, struct resource *irq, void *cookie, 405 const char *fmt, ...); 406int bus_set_resource(device_t dev, int type, int rid, 407 u_long start, u_long count); 408int bus_get_resource(device_t dev, int type, int rid, 409 u_long *startp, u_long *countp); 410u_long bus_get_resource_start(device_t dev, int type, int rid); 411u_long bus_get_resource_count(device_t dev, int type, int rid); 412void bus_delete_resource(device_t dev, int type, int rid); 413int bus_child_present(device_t child); 414int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen); 415int bus_child_location_str(device_t child, char *buf, size_t buflen); 416void bus_enumerate_hinted_children(device_t bus); 417 418static __inline struct resource * 419bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags) 420{ 421 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags)); 422} 423 424/* 425 * Access functions for device. 426 */ 427device_t device_add_child(device_t dev, const char *name, int unit); 428device_t device_add_child_ordered(device_t dev, u_int order, 429 const char *name, int unit); 430void device_busy(device_t dev); 431int device_delete_child(device_t dev, device_t child); 432int device_delete_children(device_t dev); 433int device_attach(device_t dev); 434int device_detach(device_t dev); 435void device_disable(device_t dev); 436void device_enable(device_t dev); 437device_t device_find_child(device_t dev, const char *classname, 438 int unit); 439const char *device_get_desc(device_t dev); 440devclass_t device_get_devclass(device_t dev); 441driver_t *device_get_driver(device_t dev); 442u_int32_t device_get_flags(device_t dev); 443device_t device_get_parent(device_t dev); 444int device_get_children(device_t dev, device_t **listp, int *countp); 445void *device_get_ivars(device_t dev); 446void device_set_ivars(device_t dev, void *ivars); 447const char *device_get_name(device_t dev); 448const char *device_get_nameunit(device_t dev); 449void *device_get_softc(device_t dev); 450device_state_t device_get_state(device_t dev); 451int device_get_unit(device_t dev); 452struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev); 453struct sysctl_oid *device_get_sysctl_tree(device_t dev); 454int device_is_alive(device_t dev); /* did probe succeed? */ 455int device_is_attached(device_t dev); /* did attach succeed? */ 456int device_is_enabled(device_t dev); 457int device_is_quiet(device_t dev); 458int device_print_prettyname(device_t dev); 459int device_printf(device_t dev, const char *, ...) __printflike(2, 3); 460int device_probe(device_t dev); 461int device_probe_and_attach(device_t dev); 462int device_probe_child(device_t bus, device_t dev); 463int device_quiesce(device_t dev); 464void device_quiet(device_t dev); 465void device_set_desc(device_t dev, const char* desc); 466void device_set_desc_copy(device_t dev, const char* desc); 467int device_set_devclass(device_t dev, const char *classname); 468int device_set_driver(device_t dev, driver_t *driver); 469void device_set_flags(device_t dev, u_int32_t flags); 470void device_set_softc(device_t dev, void *softc); 471void device_free_softc(void *softc); 472void device_claim_softc(device_t dev); 473int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */ 474int device_shutdown(device_t dev); 475void device_unbusy(device_t dev); 476void device_verbose(device_t dev); 477 478/* 479 * Access functions for devclass. 480 */ 481int devclass_add_driver(devclass_t dc, driver_t *driver, 482 int pass, devclass_t *dcp); 483devclass_t devclass_create(const char *classname); 484int devclass_delete_driver(devclass_t busclass, driver_t *driver); 485devclass_t devclass_find(const char *classname); 486const char *devclass_get_name(devclass_t dc); 487device_t devclass_get_device(devclass_t dc, int unit); 488void *devclass_get_softc(devclass_t dc, int unit); 489int devclass_get_devices(devclass_t dc, device_t **listp, int *countp); 490int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp); 491int devclass_get_count(devclass_t dc); 492int devclass_get_maxunit(devclass_t dc); 493int devclass_find_free_unit(devclass_t dc, int unit); 494void devclass_set_parent(devclass_t dc, devclass_t pdc); 495devclass_t devclass_get_parent(devclass_t dc); 496struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc); 497struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc); 498 499/* 500 * Access functions for device resources. 501 */ 502 503int resource_int_value(const char *name, int unit, const char *resname, 504 int *result); 505int resource_long_value(const char *name, int unit, const char *resname, 506 long *result); 507int resource_string_value(const char *name, int unit, const char *resname, 508 const char **result); 509int resource_disabled(const char *name, int unit); 510int resource_find_match(int *anchor, const char **name, int *unit, 511 const char *resname, const char *value); 512int resource_find_dev(int *anchor, const char *name, int *unit, 513 const char *resname, const char *value); 514int resource_set_int(const char *name, int unit, const char *resname, 515 int value); 516int resource_set_long(const char *name, int unit, const char *resname, 517 long value); 518int resource_set_string(const char *name, int unit, const char *resname, 519 const char *value); 520/* 521 * Functions for maintaining and checking consistency of 522 * bus information exported to userspace. 523 */ 524int bus_data_generation_check(int generation); 525void bus_data_generation_update(void); 526 527/** 528 * Some convenience defines for probe routines to return. These are just 529 * suggested values, and there's nothing magical about them. 530 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no 531 * possible other driver may exist (typically legacy drivers who don't fallow 532 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the 533 * suggested value that vendor supplied drivers use. This is for source or 534 * binary drivers that are not yet integrated into the FreeBSD tree. Its use 535 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value 536 * for drivers to use. It is intended that nearly all of the drivers in the 537 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that 538 * have special requirements like when there are two drivers that support 539 * overlapping series of hardware devices. In this case the one that supports 540 * the older part of the line would return this value, while the one that 541 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC 542 * is for drivers that wish to have a generic form and a specialized form, 543 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is 544 * for those busses that implement a generic device place-holder for devices on 545 * the bus that have no more specific driver for them (aka ugen). 546 * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding 547 * for a device node, but accepts only devices that its parent has told it 548 * use this driver. 549 */ 550#define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */ 551#define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */ 552#define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */ 553#define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */ 554#define BUS_PROBE_GENERIC (-100) /* generic driver for dev */ 555#define BUS_PROBE_HOOVER (-500) /* Generic dev for all devs on bus */ 556#define BUS_PROBE_NOWILDCARD (-2000000000) /* No wildcard device matches */ 557 558/** 559 * During boot, the device tree is scanned multiple times. Each scan, 560 * or pass, drivers may be attached to devices. Each driver 561 * attachment is assigned a pass number. Drivers may only probe and 562 * attach to devices if their pass number is less than or equal to the 563 * current system-wide pass number. The default pass is the last pass 564 * and is used by most drivers. Drivers needed by the scheduler are 565 * probed in earlier passes. 566 */ 567#define BUS_PASS_ROOT 0 /* Used to attach root0. */ 568#define BUS_PASS_BUS 10 /* Busses and bridges. */ 569#define BUS_PASS_CPU 20 /* CPU devices. */ 570#define BUS_PASS_RESOURCE 30 /* Resource discovery. */ 571#define BUS_PASS_INTERRUPT 40 /* Interrupt controllers. */ 572#define BUS_PASS_TIMER 50 /* Timers and clocks. */ 573#define BUS_PASS_SCHEDULER 60 /* Start scheduler. */ 574#define BUS_PASS_DEFAULT __INT_MAX /* Everything else. */ 575 576#define BUS_PASS_ORDER_FIRST 0 577#define BUS_PASS_ORDER_EARLY 2 578#define BUS_PASS_ORDER_MIDDLE 5 579#define BUS_PASS_ORDER_LATE 7 580#define BUS_PASS_ORDER_LAST 9 581 582extern int bus_current_pass; 583 584void bus_set_pass(int pass); 585 586/** 587 * Shorthands for constructing method tables. 588 */ 589#define DEVMETHOD KOBJMETHOD 590#define DEVMETHOD_END KOBJMETHOD_END 591 592/* 593 * Some common device interfaces. 594 */ 595#include "device_if.h" 596#include "bus_if.h" 597 598struct module; 599 600int driver_module_handler(struct module *, int, void *); 601 602/** 603 * Module support for automatically adding drivers to busses. 604 */ 605struct driver_module_data { 606 int (*dmd_chainevh)(struct module *, int, void *); 607 void *dmd_chainarg; 608 const char *dmd_busname; 609 kobj_class_t dmd_driver; 610 devclass_t *dmd_devclass; 611 int dmd_pass; 612}; 613 614#define EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ 615 evh, arg, order, pass) \ 616 \ 617static struct driver_module_data name##_##busname##_driver_mod = { \ 618 evh, arg, \ 619 #busname, \ 620 (kobj_class_t) &driver, \ 621 &devclass, \ 622 pass \ 623}; \ 624 \ 625static moduledata_t name##_##busname##_mod = { \ 626 #busname "/" #name, \ 627 driver_module_handler, \ 628 &name##_##busname##_driver_mod \ 629}; \ 630DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ 631 SI_SUB_DRIVERS, order) 632 633#define EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, pass) \ 634 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ 635 evh, arg, SI_ORDER_MIDDLE, pass) 636 637#define DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\ 638 order) \ 639 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ 640 evh, arg, order, BUS_PASS_DEFAULT) 641 642#define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \ 643 EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, \ 644 BUS_PASS_DEFAULT) 645 646/** 647 * Generic ivar accessor generation macros for bus drivers 648 */ 649#define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \ 650 \ 651static __inline type varp ## _get_ ## var(device_t dev) \ 652{ \ 653 uintptr_t v; \ 654 BUS_READ_IVAR(device_get_parent(dev), dev, \ 655 ivarp ## _IVAR_ ## ivar, &v); \ 656 return ((type) v); \ 657} \ 658 \ 659static __inline void varp ## _set_ ## var(device_t dev, type t) \ 660{ \ 661 uintptr_t v = (uintptr_t) t; \ 662 BUS_WRITE_IVAR(device_get_parent(dev), dev, \ 663 ivarp ## _IVAR_ ## ivar, v); \ 664} 665 666/** 667 * Shorthand macros, taking resource argument 668 * Generated with sys/tools/bus_macro.sh 669 */ 670 671#define bus_barrier(r, o, l, f) \ 672 bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f)) 673#define bus_read_1(r, o) \ 674 bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o)) 675#define bus_read_multi_1(r, o, d, c) \ 676 bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 677#define bus_read_region_1(r, o, d, c) \ 678 bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 679#define bus_set_multi_1(r, o, v, c) \ 680 bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 681#define bus_set_region_1(r, o, v, c) \ 682 bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 683#define bus_write_1(r, o, v) \ 684 bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v)) 685#define bus_write_multi_1(r, o, d, c) \ 686 bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 687#define bus_write_region_1(r, o, d, c) \ 688 bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 689#define bus_read_stream_1(r, o) \ 690 bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o)) 691#define bus_read_multi_stream_1(r, o, d, c) \ 692 bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 693#define bus_read_region_stream_1(r, o, d, c) \ 694 bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 695#define bus_set_multi_stream_1(r, o, v, c) \ 696 bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 697#define bus_set_region_stream_1(r, o, v, c) \ 698 bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 699#define bus_write_stream_1(r, o, v) \ 700 bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v)) 701#define bus_write_multi_stream_1(r, o, d, c) \ 702 bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 703#define bus_write_region_stream_1(r, o, d, c) \ 704 bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 705#define bus_read_2(r, o) \ 706 bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o)) 707#define bus_read_multi_2(r, o, d, c) \ 708 bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 709#define bus_read_region_2(r, o, d, c) \ 710 bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 711#define bus_set_multi_2(r, o, v, c) \ 712 bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 713#define bus_set_region_2(r, o, v, c) \ 714 bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 715#define bus_write_2(r, o, v) \ 716 bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v)) 717#define bus_write_multi_2(r, o, d, c) \ 718 bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 719#define bus_write_region_2(r, o, d, c) \ 720 bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 721#define bus_read_stream_2(r, o) \ 722 bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o)) 723#define bus_read_multi_stream_2(r, o, d, c) \ 724 bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 725#define bus_read_region_stream_2(r, o, d, c) \ 726 bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 727#define bus_set_multi_stream_2(r, o, v, c) \ 728 bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 729#define bus_set_region_stream_2(r, o, v, c) \ 730 bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 731#define bus_write_stream_2(r, o, v) \ 732 bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v)) 733#define bus_write_multi_stream_2(r, o, d, c) \ 734 bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 735#define bus_write_region_stream_2(r, o, d, c) \ 736 bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 737#define bus_read_4(r, o) \ 738 bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o)) 739#define bus_read_multi_4(r, o, d, c) \ 740 bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 741#define bus_read_region_4(r, o, d, c) \ 742 bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 743#define bus_set_multi_4(r, o, v, c) \ 744 bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 745#define bus_set_region_4(r, o, v, c) \ 746 bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 747#define bus_write_4(r, o, v) \ 748 bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v)) 749#define bus_write_multi_4(r, o, d, c) \ 750 bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 751#define bus_write_region_4(r, o, d, c) \ 752 bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 753#define bus_read_stream_4(r, o) \ 754 bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o)) 755#define bus_read_multi_stream_4(r, o, d, c) \ 756 bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 757#define bus_read_region_stream_4(r, o, d, c) \ 758 bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 759#define bus_set_multi_stream_4(r, o, v, c) \ 760 bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 761#define bus_set_region_stream_4(r, o, v, c) \ 762 bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 763#define bus_write_stream_4(r, o, v) \ 764 bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v)) 765#define bus_write_multi_stream_4(r, o, d, c) \ 766 bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 767#define bus_write_region_stream_4(r, o, d, c) \ 768 bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 769#define bus_read_8(r, o) \ 770 bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o)) 771#define bus_read_multi_8(r, o, d, c) \ 772 bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 773#define bus_read_region_8(r, o, d, c) \ 774 bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 775#define bus_set_multi_8(r, o, v, c) \ 776 bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 777#define bus_set_region_8(r, o, v, c) \ 778 bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 779#define bus_write_8(r, o, v) \ 780 bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v)) 781#define bus_write_multi_8(r, o, d, c) \ 782 bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 783#define bus_write_region_8(r, o, d, c) \ 784 bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 785#define bus_read_stream_8(r, o) \ 786 bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o)) 787#define bus_read_multi_stream_8(r, o, d, c) \ 788 bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 789#define bus_read_region_stream_8(r, o, d, c) \ 790 bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 791#define bus_set_multi_stream_8(r, o, v, c) \ 792 bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 793#define bus_set_region_stream_8(r, o, v, c) \ 794 bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c)) 795#define bus_write_stream_8(r, o, v) \ 796 bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v)) 797#define bus_write_multi_stream_8(r, o, d, c) \ 798 bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 799#define bus_write_region_stream_8(r, o, d, c) \ 800 bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c)) 801#endif /* _KERNEL */ 802 803#endif /* !_SYS_BUS_H_ */ 804