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