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