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