Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
FreeBSD/Linux Kernel Cross Reference
sys/sys/bus.h
Version:
- FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
SearchContext: - none - 3 - 10
1 /*- 2 * Copyright (c) 1997,1998 Doug Rabson 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD: releng/5.0/sys/sys/bus.h 104608 2002-10-07 07:08:00Z imp $ 27 */ 28 29 #ifndef _SYS_BUS_H_ 30 #define _SYS_BUS_H_ 31 32 /* 33 * Interface information structure. 34 */ 35 struct u_businfo { 36 int ub_version; /* interface version */ 37 #define BUS_USER_VERSION 1 38 int ub_generation; /* generation count */ 39 }; 40 41 /* 42 * State of the device. 43 */ 44 typedef enum device_state { 45 DS_NOTPRESENT, /* not probed or probe failed */ 46 DS_ALIVE, /* probe succeeded */ 47 DS_ATTACHED, /* attach method called */ 48 DS_BUSY /* device is open */ 49 } device_state_t; 50 51 /* 52 * Device information exported to userspace. 53 */ 54 struct u_device { 55 uintptr_t dv_handle; 56 uintptr_t dv_parent; 57 58 char dv_name[32]; /* Name of device in tree. */ 59 char dv_desc[32]; /* Driver description */ 60 char dv_drivername[32]; /* Driver name */ 61 char dv_pnpinfo[64]; /* Plug and play info */ 62 char dv_location[64]; /* Where is the device? */ 63 uint32_t dv_devflags; /* API Flags for device */ 64 uint16_t dv_flags; /* flags for dev date */ 65 device_state_t dv_state; /* State of attachment */ 66 /* XXX more driver info? */ 67 }; 68 69 #ifdef _KERNEL 70 71 #include <sys/queue.h> 72 #include <sys/kobj.h> 73 74 /* 75 * Forward declarations 76 */ 77 typedef struct device *device_t; 78 typedef struct driver driver_t; 79 typedef struct devclass *devclass_t; 80 #define device_method_t kobj_method_t 81 82 typedef void driver_intr_t(void*); 83 84 /* 85 * Interrupt type bits. These flags are used both by newbus interrupt 86 * registration (nexus.c) and also in struct intrec, which defines 87 * interrupt properties. 88 * 89 * XXX We should probably revisit this and remove the vestiges of the 90 * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't 91 * confuse things by renaming them (Grog, 18 July 2000). 92 * 93 * We define this in terms of bits because some devices may belong 94 * to multiple classes (and therefore need to be included in 95 * multiple interrupt masks, which is what this really serves to 96 * indicate. Buses which do interrupt remapping will want to 97 * change their type to reflect what sort of devices are underneath. 98 */ 99 enum intr_type { 100 INTR_TYPE_TTY = 1, 101 INTR_TYPE_BIO = 2, 102 INTR_TYPE_NET = 4, 103 INTR_TYPE_CAM = 8, 104 INTR_TYPE_MISC = 16, 105 INTR_TYPE_CLK = 32, 106 INTR_TYPE_AV = 64, 107 INTR_FAST = 128, 108 INTR_EXCL = 256, /* exclusive interrupt */ 109 INTR_MPSAFE = 512, /* this interrupt is SMP safe */ 110 INTR_ENTROPY = 1024 /* this interrupt provides entropy */ 111 }; 112 113 typedef int (*devop_t)(void); 114 115 struct driver { 116 KOBJ_CLASS_FIELDS; 117 void *priv; /* driver private data */ 118 }; 119 120 /* 121 * Definitions for drivers which need to keep simple lists of resources 122 * for their child devices. 123 */ 124 struct resource; 125 126 struct resource_list_entry { 127 SLIST_ENTRY(resource_list_entry) link; 128 int type; /* type argument to alloc_resource */ 129 int rid; /* resource identifier */ 130 struct resource *res; /* the real resource when allocated */ 131 u_long start; /* start of resource range */ 132 u_long end; /* end of resource range */ 133 u_long count; /* count within range */ 134 }; 135 SLIST_HEAD(resource_list, resource_list_entry); 136 137 /* 138 * Initialise a resource list. 139 */ 140 void resource_list_init(struct resource_list *rl); 141 142 /* 143 * Reclaim memory used by a resource list. 144 */ 145 void resource_list_free(struct resource_list *rl); 146 147 /* 148 * Add a resource entry or modify an existing entry if one exists with 149 * the same type and rid. 150 */ 151 void resource_list_add(struct resource_list *rl, 152 int type, int rid, 153 u_long start, u_long end, u_long count); 154 int resource_list_add_next(struct resource_list *rl, 155 int type, 156 u_long start, u_long end, u_long count); 157 158 159 /* 160 * Find a resource entry by type and rid. 161 */ 162 struct resource_list_entry* 163 resource_list_find(struct resource_list *rl, 164 int type, int rid); 165 166 /* 167 * Delete a resource entry. 168 */ 169 void resource_list_delete(struct resource_list *rl, 170 int type, int rid); 171 172 /* 173 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list 174 * and passing the allocation up to the parent of bus. This assumes 175 * that the first entry of device_get_ivars(child) is a struct 176 * resource_list. This also handles 'passthrough' allocations where a 177 * child is a remote descendant of bus by passing the allocation up to 178 * the parent of bus. 179 */ 180 struct resource * 181 resource_list_alloc(struct resource_list *rl, 182 device_t bus, device_t child, 183 int type, int *rid, 184 u_long start, u_long end, 185 u_long count, u_int flags); 186 187 /* 188 * Implement BUS_RELEASE_RESOURCE. 189 */ 190 int resource_list_release(struct resource_list *rl, 191 device_t bus, device_t child, 192 int type, int rid, struct resource *res); 193 194 /* 195 * Print all resources of a specified type, for use in bus_print_child. 196 * The name is printed if at least one resource of the given type is available. 197 * The format ist used to print resource start and end. 198 */ 199 int resource_list_print_type(struct resource_list *rl, 200 const char *name, int type, 201 const char *format); 202 203 /* 204 * The root bus, to which all top-level busses are attached. 205 */ 206 extern device_t root_bus; 207 extern devclass_t root_devclass; 208 void root_bus_configure(void); 209 210 /* 211 * Useful functions for implementing busses. 212 */ 213 214 int bus_generic_activate_resource(device_t dev, device_t child, int type, 215 int rid, struct resource *r); 216 struct resource * 217 bus_generic_alloc_resource(device_t bus, device_t child, int type, 218 int *rid, u_long start, u_long end, 219 u_long count, u_int flags); 220 int bus_generic_attach(device_t dev); 221 int bus_generic_child_present(device_t dev, device_t child); 222 int bus_generic_deactivate_resource(device_t dev, device_t child, int type, 223 int rid, struct resource *r); 224 int bus_generic_detach(device_t dev); 225 void bus_generic_driver_added(device_t dev, driver_t *driver); 226 struct resource_list * 227 bus_generic_get_resource_list (device_t, device_t); 228 int bus_print_child_header(device_t dev, device_t child); 229 int bus_print_child_footer(device_t dev, device_t child); 230 int bus_generic_print_child(device_t dev, device_t child); 231 int bus_generic_probe(device_t dev); 232 int bus_generic_read_ivar(device_t dev, device_t child, int which, 233 uintptr_t *result); 234 int bus_generic_release_resource(device_t bus, device_t child, 235 int type, int rid, struct resource *r); 236 int bus_generic_resume(device_t dev); 237 int bus_generic_setup_intr(device_t dev, device_t child, 238 struct resource *irq, int flags, 239 driver_intr_t *intr, void *arg, void **cookiep); 240 241 struct resource * 242 bus_generic_rl_alloc_resource (device_t, device_t, int, int *, 243 u_long, u_long, u_long, u_int); 244 void bus_generic_rl_delete_resource (device_t, device_t, int, int); 245 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *, 246 u_long *); 247 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long, 248 u_long); 249 int bus_generic_rl_release_resource (device_t, device_t, int, int, 250 struct resource *); 251 252 int bus_generic_shutdown(device_t dev); 253 int bus_generic_suspend(device_t dev); 254 int bus_generic_teardown_intr(device_t dev, device_t child, 255 struct resource *irq, void *cookie); 256 int bus_generic_write_ivar(device_t dev, device_t child, int which, 257 uintptr_t value); 258 259 /* 260 * Wrapper functions for the BUS_*_RESOURCE methods to make client code 261 * a little simpler. 262 */ 263 struct resource *bus_alloc_resource(device_t dev, int type, int *rid, 264 u_long start, u_long end, u_long count, 265 u_int flags); 266 int bus_activate_resource(device_t dev, int type, int rid, 267 struct resource *r); 268 int bus_deactivate_resource(device_t dev, int type, int rid, 269 struct resource *r); 270 int bus_release_resource(device_t dev, int type, int rid, 271 struct resource *r); 272 int bus_setup_intr(device_t dev, struct resource *r, int flags, 273 driver_intr_t handler, void *arg, void **cookiep); 274 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie); 275 int bus_set_resource(device_t dev, int type, int rid, 276 u_long start, u_long count); 277 int bus_get_resource(device_t dev, int type, int rid, 278 u_long *startp, u_long *countp); 279 u_long bus_get_resource_start(device_t dev, int type, int rid); 280 u_long bus_get_resource_count(device_t dev, int type, int rid); 281 void bus_delete_resource(device_t dev, int type, int rid); 282 int bus_child_present(device_t child); 283 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen); 284 int bus_child_location_str(device_t child, char *buf, size_t buflen); 285 286 /* 287 * Access functions for device. 288 */ 289 device_t device_add_child(device_t dev, const char *name, int unit); 290 device_t device_add_child_ordered(device_t dev, int order, 291 const char *name, int unit); 292 void device_busy(device_t dev); 293 int device_delete_child(device_t dev, device_t child); 294 int device_detach(device_t dev); 295 void device_disable(device_t dev); 296 void device_enable(device_t dev); 297 device_t device_find_child(device_t dev, const char *classname, 298 int unit); 299 const char *device_get_desc(device_t dev); 300 devclass_t device_get_devclass(device_t dev); 301 driver_t *device_get_driver(device_t dev); 302 u_int32_t device_get_flags(device_t dev); 303 device_t device_get_parent(device_t dev); 304 int device_get_children(device_t dev, device_t **listp, int *countp); 305 void *device_get_ivars(device_t dev); 306 void device_set_ivars(device_t dev, void *ivars); 307 const char *device_get_name(device_t dev); 308 const char *device_get_nameunit(device_t dev); 309 void *device_get_softc(device_t dev); 310 device_state_t device_get_state(device_t dev); 311 int device_get_unit(device_t dev); 312 int device_is_alive(device_t dev); /* did probe succeed? */ 313 int device_is_enabled(device_t dev); 314 int device_is_quiet(device_t dev); 315 int device_print_prettyname(device_t dev); 316 int device_printf(device_t dev, const char *, ...) __printflike(2, 3); 317 int device_probe_and_attach(device_t dev); 318 void device_quiet(device_t dev); 319 void device_set_desc(device_t dev, const char* desc); 320 void device_set_desc_copy(device_t dev, const char* desc); 321 int device_set_devclass(device_t dev, const char *classname); 322 int device_set_driver(device_t dev, driver_t *driver); 323 void device_set_flags(device_t dev, u_int32_t flags); 324 void device_set_softc(device_t dev, void *softc); 325 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */ 326 int device_shutdown(device_t dev); 327 void device_unbusy(device_t dev); 328 void device_verbose(device_t dev); 329 330 /* 331 * Access functions for devclass. 332 */ 333 int devclass_add_driver(devclass_t dc, driver_t *driver); 334 int devclass_delete_driver(devclass_t dc, driver_t *driver); 335 devclass_t devclass_create(const char *classname); 336 devclass_t devclass_find(const char *classname); 337 driver_t *devclass_find_driver(devclass_t dc, const char *classname); 338 const char *devclass_get_name(devclass_t dc); 339 device_t devclass_get_device(devclass_t dc, int unit); 340 void *devclass_get_softc(devclass_t dc, int unit); 341 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp); 342 int devclass_get_maxunit(devclass_t dc); 343 int devclass_find_free_unit(devclass_t dc, int unit); 344 345 /* 346 * Access functions for device resources. 347 */ 348 349 int resource_int_value(const char *name, int unit, const char *resname, 350 int *result); 351 int resource_long_value(const char *name, int unit, const char *resname, 352 long *result); 353 int resource_string_value(const char *name, int unit, const char *resname, 354 const char **result); 355 int resource_find_match(int *anchor, const char **name, int *unit, 356 const char *resname, const char *value); 357 int resource_find_dev(int *anchor, const char *name, int *unit, 358 const char *resname, const char *value); 359 int resource_set_int(const char *name, int unit, const char *resname, 360 int value); 361 int resource_set_long(const char *name, int unit, const char *resname, 362 long value); 363 int resource_set_string(const char *name, int unit, const char *resname, 364 const char *value); 365 /* 366 * Functions for maintaining and checking consistency of 367 * bus information exported to userspace. 368 */ 369 int bus_data_generation_check(int generation); 370 void bus_data_generation_update(void); 371 372 /* 373 * Shorthand for constructing method tables. 374 */ 375 #define DEVMETHOD KOBJMETHOD 376 377 /* 378 * Some common device interfaces. 379 */ 380 #include "device_if.h" 381 #include "bus_if.h" 382 383 struct module; 384 385 int driver_module_handler(struct module *, int, void *); 386 387 /* 388 * Module support for automatically adding drivers to busses. 389 */ 390 struct driver_module_data { 391 int (*dmd_chainevh)(struct module *, int, void *); 392 void *dmd_chainarg; 393 const char *dmd_busname; 394 driver_t **dmd_drivers; 395 int dmd_ndrivers; 396 devclass_t *dmd_devclass; 397 }; 398 399 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \ 400 \ 401 static driver_t *name##_##busname##_driver_list[] = { &driver }; \ 402 static struct driver_module_data name##_##busname##_driver_mod = { \ 403 evh, arg, \ 404 #busname, \ 405 name##_##busname##_driver_list, \ 406 (sizeof name##_##busname##_driver_list) / \ 407 (sizeof name##_##busname##_driver_list[0]), \ 408 &devclass \ 409 }; \ 410 \ 411 static moduledata_t name##_##busname##_mod = { \ 412 #busname "/" #name, \ 413 driver_module_handler, \ 414 &name##_##busname##_driver_mod \ 415 }; \ 416 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ 417 SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 418 419 #define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \ 420 \ 421 static driver_t name##_##busname##_driver_list[] = drivers; \ 422 static struct driver_module_data name##_##busname##_driver_mod = { \ 423 evh, arg, \ 424 #busname, \ 425 name##_##busname##_driver_list, \ 426 (sizeof name##_##busname##_driver_list) / \ 427 (sizeof name##_##busname##_driver_list[0]), \ 428 &devclass \ 429 }; \ 430 \ 431 static moduledata_t name##_##busname##_mod = { \ 432 #busname "/" #name, \ 433 driver_module_handler, \ 434 &name##_##busname##_driver_mod \ 435 }; \ 436 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ 437 SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 438 439 /* 440 * Generic ivar accessor generation macros for bus drivers 441 */ 442 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \ 443 \ 444 static __inline type varp ## _get_ ## var(device_t dev) \ 445 { \ 446 uintptr_t v; \ 447 BUS_READ_IVAR(device_get_parent(dev), dev, \ 448 ivarp ## _IVAR_ ## ivar, &v); \ 449 return ((type) v); \ 450 } \ 451 \ 452 static __inline void varp ## _set_ ## var(device_t dev, type t) \ 453 { \ 454 uintptr_t v = (uintptr_t) t; \ 455 BUS_WRITE_IVAR(device_get_parent(dev), dev, \ 456 ivarp ## _IVAR_ ## ivar, v); \ 457 } 458 459 #endif /* _KERNEL */ 460 461 #endif /* !_SYS_BUS_H_ */
Cache object: 3c0bb9f24416554cf1cb11b75cf1d22e
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]