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.4 2002/10/10 15:13:33 jhb Exp $ 27 * $DragonFly: src/sys/sys/bus.h,v 1.2 2003/06/17 04:28:58 dillon Exp $ 28 */ 29 30 #ifndef _SYS_BUS_H_ 31 #define _SYS_BUS_H_ 32 33 #ifdef _KERNEL 34 35 #include <sys/queue.h> 36 37 /* 38 * Forward declarations 39 */ 40 typedef struct device *device_t; 41 typedef struct driver driver_t; 42 typedef struct device_method device_method_t; 43 typedef struct devclass *devclass_t; 44 typedef struct device_ops *device_ops_t; 45 typedef struct device_op_desc *device_op_desc_t; 46 47 typedef void driver_intr_t(void*); 48 49 /* 50 * We define this in terms of bits because some devices may belong 51 * to multiple classes (and therefore need to be included in 52 * multiple interrupt masks, which is what this really serves to 53 * indicate. Buses which do interrupt remapping will want to 54 * change their type to reflect what sort of devices are underneath. 55 */ 56 enum intr_type { 57 INTR_TYPE_TTY = 1, 58 INTR_TYPE_BIO = 2, 59 INTR_TYPE_NET = 4, 60 INTR_TYPE_CAM = 8, 61 INTR_TYPE_MISC = 16, 62 INTR_TYPE_FAST = 128 63 }; 64 #define INTR_TYPE_AV INTR_TYPE_TTY /* for source compatability with 5.x */ 65 66 typedef int (*devop_t)(void); 67 68 struct device_method { 69 device_op_desc_t desc; 70 devop_t func; 71 }; 72 73 struct driver { 74 const char *name; /* driver name */ 75 device_method_t *methods; /* method table */ 76 size_t softc; /* size of device softc struct */ 77 void *priv; /* driver private data */ 78 device_ops_t ops; /* compiled method table */ 79 int refs; /* # devclasses containing driver */ 80 }; 81 82 typedef enum device_state { 83 DS_NOTPRESENT, /* not probed or probe failed */ 84 DS_ALIVE, /* probe succeeded */ 85 DS_ATTACHED, /* attach method called */ 86 DS_BUSY /* device is open */ 87 } device_state_t; 88 89 /* 90 * Definitions for drivers which need to keep simple lists of resources 91 * for their child devices. 92 */ 93 struct resource; 94 95 struct resource_list_entry { 96 SLIST_ENTRY(resource_list_entry) link; 97 int type; /* type argument to alloc_resource */ 98 int rid; /* resource identifier */ 99 struct resource *res; /* the real resource when allocated */ 100 u_long start; /* start of resource range */ 101 u_long end; /* end of resource range */ 102 u_long count; /* count within range */ 103 }; 104 SLIST_HEAD(resource_list, resource_list_entry); 105 106 /* 107 * Initialise a resource list. 108 */ 109 void resource_list_init(struct resource_list *rl); 110 111 /* 112 * Reclaim memory used by a resource list. 113 */ 114 void resource_list_free(struct resource_list *rl); 115 116 /* 117 * Add a resource entry or modify an existing entry if one exists with 118 * the same type and rid. 119 */ 120 void resource_list_add(struct resource_list *rl, 121 int type, int rid, 122 u_long start, u_long end, u_long count); 123 124 /* 125 * Find a resource entry by type and rid. 126 */ 127 struct resource_list_entry* 128 resource_list_find(struct resource_list *rl, 129 int type, int rid); 130 131 /* 132 * Delete a resource entry. 133 */ 134 void resource_list_delete(struct resource_list *rl, 135 int type, int rid); 136 137 /* 138 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list 139 * and passing the allocation up to the parent of bus. This assumes 140 * that the first entry of device_get_ivars(child) is a struct 141 * resource_list. This also handles 'passthrough' allocations where a 142 * child is a remote descendant of bus by passing the allocation up to 143 * the parent of bus. 144 */ 145 struct resource * 146 resource_list_alloc(struct resource_list *rl, 147 device_t bus, device_t child, 148 int type, int *rid, 149 u_long start, u_long end, 150 u_long count, u_int flags); 151 152 /* 153 * Implement BUS_RELEASE_RESOURCE. 154 */ 155 int resource_list_release(struct resource_list *rl, 156 device_t bus, device_t child, 157 int type, int rid, struct resource *res); 158 159 /* 160 * Print all resources of a specified type, for use in bus_print_child. 161 * The name is printed if at least one resource of the given type is available. 162 * The format ist used to print resource start and end. 163 */ 164 int resource_list_print_type(struct resource_list *rl, 165 const char *name, int type, 166 const char *format); 167 168 /* 169 * The root bus, to which all top-level busses are attached. 170 */ 171 extern device_t root_bus; 172 extern devclass_t root_devclass; 173 void root_bus_configure(void); 174 175 /* 176 * Useful functions for implementing busses. 177 */ 178 179 int bus_generic_activate_resource(device_t dev, device_t child, int type, 180 int rid, struct resource *r); 181 struct resource *bus_generic_alloc_resource(device_t bus, device_t child, 182 int type, int *rid, 183 u_long start, u_long end, 184 u_long count, u_int flags); 185 int bus_generic_attach(device_t dev); 186 int bus_generic_deactivate_resource(device_t dev, device_t child, int type, 187 int rid, struct resource *r); 188 int bus_generic_detach(device_t dev); 189 void bus_generic_driver_added(device_t dev, driver_t *driver); 190 int bus_print_child_header(device_t dev, device_t child); 191 int bus_print_child_footer(device_t dev, device_t child); 192 int bus_generic_print_child(device_t dev, device_t child); 193 int bus_generic_probe(device_t dev); 194 int bus_generic_read_ivar(device_t dev, device_t child, int which, 195 uintptr_t *result); 196 int bus_generic_release_resource(device_t bus, device_t child, 197 int type, int rid, struct resource *r); 198 int bus_generic_resume(device_t dev); 199 int bus_generic_setup_intr(device_t dev, device_t child, 200 struct resource *irq, int flags, 201 driver_intr_t *intr, void *arg, void **cookiep); 202 int bus_generic_shutdown(device_t dev); 203 int bus_generic_suspend(device_t dev); 204 int bus_generic_teardown_intr(device_t dev, device_t child, 205 struct resource *irq, void *cookie); 206 int bus_generic_write_ivar(device_t dev, device_t child, int which, 207 uintptr_t value); 208 209 /* 210 * Wrapper functions for the BUS_*_RESOURCE methods to make client code 211 * a little simpler. 212 */ 213 struct resource *bus_alloc_resource(device_t dev, int type, int *rid, 214 u_long start, u_long end, u_long count, 215 u_int flags); 216 int bus_activate_resource(device_t dev, int type, int rid, 217 struct resource *r); 218 int bus_deactivate_resource(device_t dev, int type, int rid, 219 struct resource *r); 220 int bus_release_resource(device_t dev, int type, int rid, 221 struct resource *r); 222 int bus_setup_intr(device_t dev, struct resource *r, int flags, 223 driver_intr_t handler, void *arg, void **cookiep); 224 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie); 225 int bus_set_resource(device_t dev, int type, int rid, 226 u_long start, u_long count); 227 int bus_get_resource(device_t dev, int type, int rid, 228 u_long *startp, u_long *countp); 229 u_long bus_get_resource_start(device_t dev, int type, int rid); 230 u_long bus_get_resource_count(device_t dev, int type, int rid); 231 void bus_delete_resource(device_t dev, int type, int rid); 232 233 /* 234 * Access functions for device. 235 */ 236 device_t device_add_child(device_t dev, const char *name, int unit); 237 device_t device_add_child_ordered(device_t dev, int order, 238 const char *name, int unit); 239 void device_busy(device_t dev); 240 int device_delete_child(device_t dev, device_t child); 241 int device_detach(device_t dev); 242 void device_disable(device_t dev); 243 void device_enable(device_t dev); 244 device_t device_find_child(device_t dev, const char *classname, 245 int unit); 246 const char *device_get_desc(device_t dev); 247 devclass_t device_get_devclass(device_t dev); 248 driver_t *device_get_driver(device_t dev); 249 u_int32_t device_get_flags(device_t dev); 250 device_t device_get_parent(device_t dev); 251 int device_get_children(device_t dev, device_t **listp, int *countp); 252 void *device_get_ivars(device_t dev); 253 void device_set_ivars(device_t dev, void *ivars); 254 const char *device_get_name(device_t dev); 255 const char *device_get_nameunit(device_t dev); 256 void *device_get_softc(device_t dev); 257 device_state_t device_get_state(device_t dev); 258 int device_get_unit(device_t dev); 259 int device_is_alive(device_t dev); /* did probe succeed? */ 260 int device_is_enabled(device_t dev); 261 int device_is_quiet(device_t dev); 262 int device_print_prettyname(device_t dev); 263 int device_printf(device_t dev, const char *, ...) __printflike(2, 3); 264 int device_probe_and_attach(device_t dev); 265 void device_quiet(device_t dev); 266 void device_set_desc(device_t dev, const char* desc); 267 void device_set_desc_copy(device_t dev, const char* desc); 268 int device_set_devclass(device_t dev, const char *classname); 269 int device_set_driver(device_t dev, driver_t *driver); 270 void device_set_flags(device_t dev, u_int32_t flags); 271 void device_set_softc(device_t dev, void *softc); 272 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */ 273 int device_shutdown(device_t dev); 274 void device_unbusy(device_t dev); 275 void device_verbose(device_t dev); 276 277 /* 278 * Access functions for devclass. 279 */ 280 int devclass_add_driver(devclass_t dc, driver_t *driver); 281 int devclass_delete_driver(devclass_t dc, driver_t *driver); 282 devclass_t devclass_create(const char *classname); 283 devclass_t devclass_find(const char *classname); 284 driver_t *devclass_find_driver(devclass_t dc, const char *classname); 285 const char *devclass_get_name(devclass_t dc); 286 device_t devclass_get_device(devclass_t dc, int unit); 287 void *devclass_get_softc(devclass_t dc, int unit); 288 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp); 289 int devclass_get_maxunit(devclass_t dc); 290 291 /* 292 * Access functions for device resources. 293 */ 294 295 int resource_int_value(const char *name, int unit, const char *resname, 296 int *result); 297 int resource_long_value(const char *name, int unit, const char *resname, 298 long *result); 299 int resource_string_value(const char *name, int unit, const char *resname, 300 char **result); 301 int resource_query_string(int i, const char *resname, const char *value); 302 char *resource_query_name(int i); 303 int resource_query_unit(int i); 304 int resource_locate(int i, const char *resname); 305 int resource_set_int(const char *name, int unit, const char *resname, 306 int value); 307 int resource_set_long(const char *name, int unit, const char *resname, 308 long value); 309 int resource_set_string(const char *name, int unit, const char *resname, 310 const char *value); 311 int resource_count(void); 312 313 /* 314 * Shorthand for constructing method tables. 315 */ 316 #define DEVMETHOD(NAME, FUNC) { &NAME##_desc, (devop_t) FUNC } 317 318 /* 319 * Some common device interfaces. 320 */ 321 #include "device_if.h" 322 #include "bus_if.h" 323 324 struct module; 325 326 int driver_module_handler(struct module *, int, void *); 327 328 /* 329 * Module support for automatically adding drivers to busses. 330 */ 331 struct driver_module_data { 332 int (*dmd_chainevh)(struct module *, int, void *); 333 void *dmd_chainarg; 334 const char *dmd_busname; 335 driver_t **dmd_drivers; 336 int dmd_ndrivers; 337 devclass_t *dmd_devclass; 338 }; 339 340 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \ 341 \ 342 static driver_t *name##_##busname##_driver_list[] = { &driver }; \ 343 static struct driver_module_data name##_##busname##_driver_mod = { \ 344 evh, arg, \ 345 #busname, \ 346 name##_##busname##_driver_list, \ 347 (sizeof name##_##busname##_driver_list) / \ 348 (sizeof name##_##busname##_driver_list[0]), \ 349 &devclass \ 350 }; \ 351 \ 352 static moduledata_t name##_##busname##_mod = { \ 353 #busname "/" #name, \ 354 driver_module_handler, \ 355 &name##_##busname##_driver_mod \ 356 }; \ 357 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ 358 SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 359 360 #define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \ 361 \ 362 static driver_t name##_##busname##_driver_list[] = drivers; \ 363 static struct driver_module_data name##_##busname##_driver_mod = { \ 364 evh, arg, \ 365 #busname, \ 366 name##_##busname##_driver_list, \ 367 (sizeof name##_##busname##_driver_list) / \ 368 (sizeof name##_##busname##_driver_list[0]), \ 369 &devclass \ 370 }; \ 371 \ 372 static moduledata_t name##_##busname##_mod = { \ 373 #busname "/" #name, \ 374 driver_module_handler, \ 375 &name##_##busname##_driver_mod \ 376 }; \ 377 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ 378 SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 379 380 #endif /* _KERNEL */ 381 382 #endif /* !_SYS_BUS_H_ */ 383