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: src/sys/sys/bus.h,v 1.30.2.5 2004/03/17 17:54:25 njl Exp $ 27 * $DragonFly: src/sys/sys/bus.h,v 1.22 2006/05/20 02:42:13 dillon Exp $ 28 */ 29 30 #ifndef _SYS_BUS_H_ 31 #define _SYS_BUS_H_ 32 33 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 34 35 #ifndef _SYS_TYPES_H_ 36 #include <sys/types.h> 37 #endif 38 #ifndef _SYS_QUEUE_H_ 39 #include <sys/queue.h> 40 #endif 41 #ifndef _SYS_KOBJ_H_ 42 #include <sys/kobj.h> 43 #endif 44 #ifdef _KERNEL 45 #include <sys/serialize.h> 46 #endif 47 48 /* 49 * Forward declarations 50 */ 51 typedef struct device *device_t; 52 typedef struct kobj_class driver_t; 53 typedef struct devclass *devclass_t; 54 #define device_method_t kobj_method_t 55 56 typedef void driver_intr_t(void*); 57 58 /* 59 * Interrupt features mask. Note that DragonFly no longer implements 60 * INTR_TYPE_* flags. 61 */ 62 #define INTR_FAST 0x0080 63 #define INTR_EXCL 0x0100 64 #define INTR_MPSAFE 0x0200 65 #define INTR_NOENTROPY 0x0400 66 #define INTR_NOPOLL 0x0800 /* interrupt cannot be polled (e.g. ata) */ 67 68 #define INTR_NETSAFE INTR_MPSAFE 69 70 enum intr_trigger { 71 INTR_TRIGGER_CONFORM = 0, 72 INTR_TRIGGER_EDGE = 1, 73 INTR_TRIGGER_LEVEL = 2 74 }; 75 76 enum intr_polarity { 77 INTR_POLARITY_CONFORM = 0, 78 INTR_POLARITY_HIGH = 1, 79 INTR_POLARITY_LOW = 2 80 }; 81 82 typedef int (*devop_t)(void); 83 84 typedef enum device_state { 85 DS_NOTPRESENT, /* not probed or probe failed */ 86 DS_ALIVE, /* probe succeeded */ 87 DS_ATTACHED, /* attach method called */ 88 DS_BUSY /* device is open */ 89 } device_state_t; 90 91 /* 92 * Definitions for drivers which need to keep simple lists of resources 93 * for their child devices. 94 */ 95 struct resource; 96 97 struct resource_list_entry { 98 SLIST_ENTRY(resource_list_entry) link; 99 int type; /* type argument to alloc_resource */ 100 int rid; /* resource identifier */ 101 struct resource *res; /* the real resource when allocated */ 102 u_long start; /* start of resource range */ 103 u_long end; /* end of resource range */ 104 u_long count; /* count within range */ 105 }; 106 SLIST_HEAD(resource_list, resource_list_entry); 107 108 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 109 #ifdef _KERNEL 110 111 /* 112 * Initialise a resource list. 113 */ 114 void resource_list_init(struct resource_list *rl); 115 116 /* 117 * Reclaim memory used by a resource list. 118 */ 119 void resource_list_free(struct resource_list *rl); 120 121 /* 122 * Add a resource entry or modify an existing entry if one exists with 123 * the same type and rid. 124 */ 125 void resource_list_add(struct resource_list *rl, 126 int type, int rid, 127 u_long start, u_long end, u_long count); 128 129 /* 130 * Find a resource entry by type and rid. 131 */ 132 struct resource_list_entry* 133 resource_list_find(struct resource_list *rl, 134 int type, int rid); 135 136 /* 137 * Delete a resource entry. 138 */ 139 void resource_list_delete(struct resource_list *rl, 140 int type, int rid); 141 142 /* 143 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list 144 * and passing the allocation up to the parent of bus. This assumes 145 * that the first entry of device_get_ivars(child) is a struct 146 * resource_list. This also handles 'passthrough' allocations where a 147 * child is a remote descendant of bus by passing the allocation up to 148 * the parent of bus. 149 */ 150 struct resource * 151 resource_list_alloc(struct resource_list *rl, 152 device_t bus, device_t child, 153 int type, int *rid, 154 u_long start, u_long end, 155 u_long count, u_int flags); 156 157 /* 158 * Implement BUS_RELEASE_RESOURCE. 159 */ 160 int resource_list_release(struct resource_list *rl, 161 device_t bus, device_t child, 162 int type, int rid, struct resource *res); 163 164 /* 165 * Print all resources of a specified type, for use in bus_print_child. 166 * The name is printed if at least one resource of the given type is available. 167 * The format ist used to print resource start and end. 168 */ 169 int resource_list_print_type(struct resource_list *rl, 170 const char *name, int type, 171 const char *format); 172 173 /* 174 * The root bus, to which all top-level busses are attached. 175 */ 176 extern device_t root_bus; 177 void root_bus_configure(void); 178 179 /* 180 * Useful functions for implementing busses. 181 */ 182 183 int bus_generic_activate_resource(device_t dev, device_t child, int type, 184 int rid, struct resource *r); 185 struct resource * 186 bus_generic_alloc_resource(device_t bus, device_t child, 187 int type, int *rid, 188 u_long start, u_long end, 189 u_long count, u_int flags); 190 struct resource_list * 191 bus_generic_get_resource_list (device_t, device_t); 192 193 int bus_generic_config_intr(device_t, int, enum intr_trigger, 194 enum intr_polarity); 195 int bus_generic_attach(device_t dev); 196 int bus_generic_child_present(device_t dev, device_t child); 197 int bus_generic_deactivate_resource(device_t dev, device_t child, int type, 198 int rid, struct resource *r); 199 int bus_generic_detach(device_t dev); 200 int bus_generic_disable_intr(device_t dev, device_t child, void *cookie); 201 void bus_generic_driver_added(device_t dev, driver_t *driver); 202 void bus_generic_enable_intr(device_t dev, device_t child, void *cookie); 203 int bus_print_child_header(device_t dev, device_t child); 204 int bus_print_child_footer(device_t dev, device_t child); 205 int bus_generic_print_child(device_t dev, device_t child); 206 int bus_generic_identify(driver_t *driver, device_t parent); 207 int bus_generic_identify_sameunit(driver_t *driver, device_t parent); 208 int bus_generic_probe(device_t dev); 209 int bus_generic_probe_hack(device_t dev); 210 device_t bus_generic_add_child(device_t, device_t, int, const char *, int); 211 int bus_generic_read_ivar(device_t dev, device_t child, int which, 212 uintptr_t *result); 213 int bus_generic_release_resource(device_t bus, device_t child, 214 int type, int rid, struct resource *r); 215 int bus_generic_get_resource(device_t dev, device_t child, int type, 216 int rid, u_long *startp, u_long *countp); 217 int bus_generic_set_resource(device_t dev, device_t child, int type, 218 int rid, u_long start, u_long count); 219 void bus_generic_delete_resource(device_t dev, device_t child, 220 int type, int rid); 221 int bus_generic_resume(device_t dev); 222 int bus_generic_setup_intr(device_t dev, device_t child, 223 struct resource *irq, int flags, 224 driver_intr_t *intr, void *arg, 225 void **cookiep, lwkt_serialize_t serializer); 226 int bus_generic_shutdown(device_t dev); 227 int bus_generic_suspend(device_t dev); 228 int bus_generic_teardown_intr(device_t dev, device_t child, 229 struct resource *irq, void *cookie); 230 int bus_generic_write_ivar(device_t dev, device_t child, int which, 231 uintptr_t value); 232 233 struct resource * 234 bus_generic_rl_alloc_resource (device_t, device_t, int, int *, 235 u_long, u_long, u_long, u_int); 236 void bus_generic_rl_delete_resource (device_t, device_t, int, int); 237 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *, 238 u_long *); 239 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long, 240 u_long); 241 int bus_generic_rl_release_resource (device_t, device_t, int, int, 242 struct resource *); 243 244 /* 245 * Wrapper functions for the BUS_*_RESOURCE methods to make client code 246 * a little simpler. 247 */ 248 struct resource *bus_alloc_resource(device_t dev, int type, int *rid, 249 u_long start, u_long end, u_long count, 250 u_int flags); 251 int bus_activate_resource(device_t dev, int type, int rid, 252 struct resource *r); 253 int bus_deactivate_resource(device_t dev, int type, int rid, 254 struct resource *r); 255 int bus_disable_intr(device_t dev, void *cookie); 256 void bus_enable_intr(device_t dev, void *cookie); 257 int bus_release_resource(device_t dev, int type, int rid, 258 struct resource *r); 259 int bus_setup_intr(device_t dev, struct resource *r, int flags, 260 driver_intr_t handler, void *arg, 261 void **cookiep, lwkt_serialize_t serializer); 262 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie); 263 int bus_set_resource(device_t dev, int type, int rid, 264 u_long start, u_long count); 265 int bus_get_resource(device_t dev, int type, int rid, 266 u_long *startp, u_long *countp); 267 u_long bus_get_resource_start(device_t dev, int type, int rid); 268 u_long bus_get_resource_count(device_t dev, int type, int rid); 269 void bus_delete_resource(device_t dev, int type, int rid); 270 int bus_child_present(device_t child); 271 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen); 272 int bus_child_location_str(device_t child, char *buf, size_t buflen); 273 274 static __inline struct resource * 275 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags) 276 { 277 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags)); 278 } 279 280 /* 281 * Access functions for device. 282 */ 283 device_t device_add_child(device_t dev, const char *name, int unit); 284 device_t device_add_child_ordered(device_t dev, int order, 285 const char *name, int unit); 286 void device_busy(device_t dev); 287 int device_delete_child(device_t dev, device_t child); 288 int device_detach(device_t dev); 289 void device_disable(device_t dev); 290 void device_enable(device_t dev); 291 device_t device_find_child(device_t dev, const char *classname, 292 int unit); 293 const char *device_get_desc(device_t dev); 294 devclass_t device_get_devclass(device_t dev); 295 driver_t *device_get_driver(device_t dev); 296 u_int32_t device_get_flags(device_t dev); 297 device_t device_get_parent(device_t dev); 298 int device_get_children(device_t dev, device_t **listp, int *countp); 299 void *device_get_ivars(device_t dev); 300 void device_set_ivars(device_t dev, void *ivars); 301 const char *device_get_name(device_t dev); 302 const char *device_get_nameunit(device_t dev); 303 void *device_get_softc(device_t dev); 304 device_state_t device_get_state(device_t dev); 305 int device_get_unit(device_t dev); 306 int device_is_alive(device_t dev); /* did probe succeed? */ 307 int device_is_attached(device_t dev); /* did attach succeed? */ 308 int device_is_enabled(device_t dev); 309 int device_is_quiet(device_t dev); 310 int device_print_prettyname(device_t dev); 311 int device_printf(device_t dev, const char *, ...) __printflike(2, 3); 312 int device_probe_and_attach(device_t dev); 313 void device_quiet(device_t dev); 314 void device_set_desc(device_t dev, const char* desc); 315 void device_set_desc_copy(device_t dev, const char* desc); 316 int device_set_devclass(device_t dev, const char *classname); 317 int device_set_driver(device_t dev, driver_t *driver); 318 void device_set_flags(device_t dev, u_int32_t flags); 319 void device_set_softc(device_t dev, void *softc); 320 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */ 321 int device_shutdown(device_t dev); 322 void device_unbusy(device_t dev); 323 void device_verbose(device_t dev); 324 325 /* 326 * Access functions for devclass. 327 */ 328 int devclass_add_driver(devclass_t dc, kobj_class_t driver); 329 int devclass_delete_driver(devclass_t dc, kobj_class_t driver); 330 devclass_t devclass_create(const char *classname); 331 devclass_t devclass_find(const char *classname); 332 device_t devclass_find_unit(const char *classname, int unit); 333 kobj_class_t devclass_find_driver(devclass_t dc, const char *classname); 334 const char *devclass_get_name(devclass_t dc); 335 device_t devclass_get_device(devclass_t dc, int unit); 336 void *devclass_get_softc(devclass_t dc, int unit); 337 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp); 338 int devclass_get_maxunit(devclass_t dc); 339 void devclass_set_parent(devclass_t dc, devclass_t pdc); 340 devclass_t devclass_get_parent(devclass_t dc); 341 342 /* 343 * Access functions for device resources. 344 */ 345 346 int resource_int_value(const char *name, int unit, const char *resname, 347 int *result); 348 int resource_long_value(const char *name, int unit, const char *resname, 349 long *result); 350 int resource_string_value(const char *name, int unit, const char *resname, 351 char **result); 352 int resource_disabled(const char *name, int unit); 353 int resource_query_string(int i, const char *resname, const char *value); 354 char *resource_query_name(int i); 355 int resource_query_unit(int i); 356 int resource_locate(int i, const char *resname); 357 int resource_set_int(const char *name, int unit, const char *resname, 358 int value); 359 int resource_set_long(const char *name, int unit, const char *resname, 360 long value); 361 int resource_set_string(const char *name, int unit, const char *resname, 362 const char *value); 363 int resource_count(void); 364 365 /* 366 * Shorthand for constructing method tables. 367 */ 368 #define DEVMETHOD KOBJMETHOD 369 370 /* 371 * Some common device interfaces. 372 */ 373 #include "device_if.h" 374 #include "bus_if.h" 375 376 struct module; 377 378 int driver_module_handler(struct module *, int, void *); 379 380 /* 381 * Module support for automatically adding drivers to busses. 382 */ 383 struct driver_module_data { 384 int (*dmd_chainevh)(struct module *, int, void *); 385 void *dmd_chainarg; 386 const char *dmd_busname; 387 kobj_class_t dmd_driver; 388 devclass_t *dmd_devclass; 389 }; 390 391 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \ 392 \ 393 static struct driver_module_data name##_##busname##_driver_mod = { \ 394 evh, arg, \ 395 #busname, \ 396 (kobj_class_t) &driver, \ 397 &devclass \ 398 }; \ 399 \ 400 static moduledata_t name##_##busname##_mod = { \ 401 #busname "/" #name, \ 402 driver_module_handler, \ 403 &name##_##busname##_driver_mod \ 404 }; \ 405 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ 406 SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 407 408 #endif /* _KERNEL */ 409 410 #endif /* !_SYS_BUS_H_ */ 411