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