2 * Copyright (c) 1997,1998 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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.8 2004/02/23 21:23:41 dillon Exp $
35 #include <sys/queue.h>
39 * Forward declarations
41 typedef struct device *device_t;
42 typedef struct driver driver_t;
43 typedef struct devclass *devclass_t;
44 #define device_method_t kobj_method_t
46 typedef void driver_intr_t(void*);
49 * We define this in terms of bits because some devices may belong
50 * to multiple classes (and therefore need to be included in
51 * multiple interrupt masks, which is what this really serves to
52 * indicate. Buses which do interrupt remapping will want to
53 * change their type to reflect what sort of devices are underneath.
69 #define INTR_TYPE_MASK (INTR_TYPE_TTY|INTR_TYPE_BIO|INTR_TYPE_NET|\
70 INTR_TYPE_CAM|INTR_TYPE_MISC|INTR_TYPE_CLK|\
74 INTR_TRIGGER_CONFORM = 0,
75 INTR_TRIGGER_EDGE = 1,
76 INTR_TRIGGER_LEVEL = 2
80 INTR_POLARITY_CONFORM = 0,
81 INTR_POLARITY_HIGH = 1,
85 typedef int (*devop_t)(void);
89 void *priv; /* driver private data */
92 typedef enum device_state {
93 DS_NOTPRESENT, /* not probed or probe failed */
94 DS_ALIVE, /* probe succeeded */
95 DS_ATTACHED, /* attach method called */
96 DS_BUSY /* device is open */
100 * Definitions for drivers which need to keep simple lists of resources
101 * for their child devices.
105 struct resource_list_entry {
106 SLIST_ENTRY(resource_list_entry) link;
107 int type; /* type argument to alloc_resource */
108 int rid; /* resource identifier */
109 struct resource *res; /* the real resource when allocated */
110 u_long start; /* start of resource range */
111 u_long end; /* end of resource range */
112 u_long count; /* count within range */
114 SLIST_HEAD(resource_list, resource_list_entry);
117 * Initialise a resource list.
119 void resource_list_init(struct resource_list *rl);
122 * Reclaim memory used by a resource list.
124 void resource_list_free(struct resource_list *rl);
127 * Add a resource entry or modify an existing entry if one exists with
128 * the same type and rid.
130 void resource_list_add(struct resource_list *rl,
132 u_long start, u_long end, u_long count);
135 * Find a resource entry by type and rid.
137 struct resource_list_entry*
138 resource_list_find(struct resource_list *rl,
142 * Delete a resource entry.
144 void resource_list_delete(struct resource_list *rl,
148 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
149 * and passing the allocation up to the parent of bus. This assumes
150 * that the first entry of device_get_ivars(child) is a struct
151 * resource_list. This also handles 'passthrough' allocations where a
152 * child is a remote descendant of bus by passing the allocation up to
156 resource_list_alloc(struct resource_list *rl,
157 device_t bus, device_t child,
159 u_long start, u_long end,
160 u_long count, u_int flags);
163 * Implement BUS_RELEASE_RESOURCE.
165 int resource_list_release(struct resource_list *rl,
166 device_t bus, device_t child,
167 int type, int rid, struct resource *res);
170 * Print all resources of a specified type, for use in bus_print_child.
171 * The name is printed if at least one resource of the given type is available.
172 * The format ist used to print resource start and end.
174 int resource_list_print_type(struct resource_list *rl,
175 const char *name, int type,
179 * The root bus, to which all top-level busses are attached.
181 extern device_t root_bus;
182 extern devclass_t root_devclass;
183 void root_bus_configure(void);
186 * Useful functions for implementing busses.
189 int bus_generic_activate_resource(device_t dev, device_t child, int type,
190 int rid, struct resource *r);
192 bus_generic_alloc_resource(device_t bus, device_t child,
194 u_long start, u_long end,
195 u_long count, u_int flags);
196 struct resource_list *
197 bus_generic_get_resource_list (device_t, device_t);
199 int bus_generic_config_intr(device_t, int, enum intr_trigger,
201 int bus_generic_attach(device_t dev);
202 int bus_generic_child_present(device_t dev, device_t child);
203 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
204 int rid, struct resource *r);
205 int bus_generic_detach(device_t dev);
206 void bus_generic_driver_added(device_t dev, driver_t *driver);
207 int bus_print_child_header(device_t dev, device_t child);
208 int bus_print_child_footer(device_t dev, device_t child);
209 int bus_generic_print_child(device_t dev, device_t child);
210 int bus_generic_probe(device_t dev);
211 int bus_generic_read_ivar(device_t dev, device_t child, int which,
213 int bus_generic_release_resource(device_t bus, device_t child,
214 int type, int rid, struct resource *r);
215 int bus_generic_resume(device_t dev);
216 int bus_generic_setup_intr(device_t dev, device_t child,
217 struct resource *irq, int flags,
218 driver_intr_t *intr, void *arg, void **cookiep);
219 int bus_generic_shutdown(device_t dev);
220 int bus_generic_suspend(device_t dev);
221 int bus_generic_teardown_intr(device_t dev, device_t child,
222 struct resource *irq, void *cookie);
223 int bus_generic_write_ivar(device_t dev, device_t child, int which,
227 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
228 u_long, u_long, u_long, u_int);
229 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
230 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
232 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
234 int bus_generic_rl_release_resource (device_t, device_t, int, int,
238 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
241 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
242 u_long start, u_long end, u_long count,
244 int bus_activate_resource(device_t dev, int type, int rid,
246 int bus_deactivate_resource(device_t dev, int type, int rid,
248 int bus_release_resource(device_t dev, int type, int rid,
250 int bus_setup_intr(device_t dev, struct resource *r, int flags,
251 driver_intr_t handler, void *arg, void **cookiep);
252 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
253 int bus_set_resource(device_t dev, int type, int rid,
254 u_long start, u_long count);
255 int bus_get_resource(device_t dev, int type, int rid,
256 u_long *startp, u_long *countp);
257 u_long bus_get_resource_start(device_t dev, int type, int rid);
258 u_long bus_get_resource_count(device_t dev, int type, int rid);
259 void bus_delete_resource(device_t dev, int type, int rid);
262 * Access functions for device.
264 device_t device_add_child(device_t dev, const char *name, int unit);
265 device_t device_add_child_ordered(device_t dev, int order,
266 const char *name, int unit);
267 void device_busy(device_t dev);
268 int device_delete_child(device_t dev, device_t child);
269 int device_detach(device_t dev);
270 void device_disable(device_t dev);
271 void device_enable(device_t dev);
272 device_t device_find_child(device_t dev, const char *classname,
274 const char *device_get_desc(device_t dev);
275 devclass_t device_get_devclass(device_t dev);
276 driver_t *device_get_driver(device_t dev);
277 u_int32_t device_get_flags(device_t dev);
278 device_t device_get_parent(device_t dev);
279 int device_get_children(device_t dev, device_t **listp, int *countp);
280 void *device_get_ivars(device_t dev);
281 void device_set_ivars(device_t dev, void *ivars);
282 const char *device_get_name(device_t dev);
283 const char *device_get_nameunit(device_t dev);
284 void *device_get_softc(device_t dev);
285 device_state_t device_get_state(device_t dev);
286 int device_get_unit(device_t dev);
287 int device_is_alive(device_t dev); /* did probe succeed? */
288 int device_is_attached(device_t dev); /* did attach succeed? */
289 int device_is_enabled(device_t dev);
290 int device_is_quiet(device_t dev);
291 int device_print_prettyname(device_t dev);
292 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
293 int device_probe_and_attach(device_t dev);
294 void device_quiet(device_t dev);
295 void device_set_desc(device_t dev, const char* desc);
296 void device_set_desc_copy(device_t dev, const char* desc);
297 int device_set_devclass(device_t dev, const char *classname);
298 int device_set_driver(device_t dev, driver_t *driver);
299 void device_set_flags(device_t dev, u_int32_t flags);
300 void device_set_softc(device_t dev, void *softc);
301 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
302 int device_shutdown(device_t dev);
303 void device_unbusy(device_t dev);
304 void device_verbose(device_t dev);
307 * Access functions for devclass.
309 int devclass_add_driver(devclass_t dc, driver_t *driver);
310 int devclass_delete_driver(devclass_t dc, driver_t *driver);
311 devclass_t devclass_create(const char *classname);
312 devclass_t devclass_find(const char *classname);
313 driver_t *devclass_find_driver(devclass_t dc, const char *classname);
314 const char *devclass_get_name(devclass_t dc);
315 device_t devclass_get_device(devclass_t dc, int unit);
316 void *devclass_get_softc(devclass_t dc, int unit);
317 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
318 int devclass_get_maxunit(devclass_t dc);
321 * Access functions for device resources.
324 int resource_int_value(const char *name, int unit, const char *resname,
326 int resource_long_value(const char *name, int unit, const char *resname,
328 int resource_string_value(const char *name, int unit, const char *resname,
330 int resource_disabled(const char *name, int unit);
331 int resource_query_string(int i, const char *resname, const char *value);
332 char *resource_query_name(int i);
333 int resource_query_unit(int i);
334 int resource_locate(int i, const char *resname);
335 int resource_set_int(const char *name, int unit, const char *resname,
337 int resource_set_long(const char *name, int unit, const char *resname,
339 int resource_set_string(const char *name, int unit, const char *resname,
341 int resource_count(void);
344 * Shorthand for constructing method tables.
346 #define DEVMETHOD KOBJMETHOD
349 * Some common device interfaces.
351 #include "device_if.h"
356 int driver_module_handler(struct module *, int, void *);
359 * Module support for automatically adding drivers to busses.
361 struct driver_module_data {
362 int (*dmd_chainevh)(struct module *, int, void *);
364 const char *dmd_busname;
365 driver_t **dmd_drivers;
367 devclass_t *dmd_devclass;
370 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
372 static driver_t *name##_##busname##_driver_list[] = { &driver }; \
373 static struct driver_module_data name##_##busname##_driver_mod = { \
376 name##_##busname##_driver_list, \
377 (sizeof name##_##busname##_driver_list) / \
378 (sizeof name##_##busname##_driver_list[0]), \
382 static moduledata_t name##_##busname##_mod = { \
383 #busname "/" #name, \
384 driver_module_handler, \
385 &name##_##busname##_driver_mod \
387 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
388 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
390 #define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \
392 static driver_t name##_##busname##_driver_list[] = drivers; \
393 static struct driver_module_data name##_##busname##_driver_mod = { \
396 name##_##busname##_driver_list, \
397 (sizeof name##_##busname##_driver_list) / \
398 (sizeof name##_##busname##_driver_list[0]), \
402 static moduledata_t name##_##busname##_mod = { \
403 #busname "/" #name, \
404 driver_module_handler, \
405 &name##_##busname##_driver_mod \
407 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
408 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
412 #endif /* !_SYS_BUS_H_ */