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.5 2004/03/17 17:54:25 njl Exp $
27 * $DragonFly: src/sys/sys/bus.h,v 1.21 2006/01/25 19:56:23 dillon Exp $
33 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
35 #include <sys/queue.h>
38 #include <sys/serialize.h>
42 * Forward declarations
44 typedef struct device
*device_t
;
45 typedef struct kobj_class driver_t
;
46 typedef struct devclass
*devclass_t
;
47 #define device_method_t kobj_method_t
49 typedef void driver_intr_t(void*);
52 * Interrupt features mask. Note that DragonFly no longer implements
55 #define INTR_FAST 0x0080
56 #define INTR_EXCL 0x0100
57 #define INTR_MPSAFE 0x0200
58 #define INTR_NOENTROPY 0x0400
59 #define INTR_NOPOLL 0x0800 /* interrupt cannot be polled (e.g. ata) */
61 #define INTR_NETSAFE INTR_MPSAFE
64 INTR_TRIGGER_CONFORM
= 0,
65 INTR_TRIGGER_EDGE
= 1,
66 INTR_TRIGGER_LEVEL
= 2
70 INTR_POLARITY_CONFORM
= 0,
71 INTR_POLARITY_HIGH
= 1,
75 typedef int (*devop_t
)(void);
77 typedef enum device_state
{
78 DS_NOTPRESENT
, /* not probed or probe failed */
79 DS_ALIVE
, /* probe succeeded */
80 DS_ATTACHED
, /* attach method called */
81 DS_BUSY
/* device is open */
85 * Definitions for drivers which need to keep simple lists of resources
86 * for their child devices.
90 struct resource_list_entry
{
91 SLIST_ENTRY(resource_list_entry
) link
;
92 int type
; /* type argument to alloc_resource */
93 int rid
; /* resource identifier */
94 struct resource
*res
; /* the real resource when allocated */
95 u_long start
; /* start of resource range */
96 u_long end
; /* end of resource range */
97 u_long count
; /* count within range */
99 SLIST_HEAD(resource_list
, resource_list_entry
);
101 #endif /* _KERNEL || _KERNEL_STRUCTURES */
105 * Initialise a resource list.
107 void resource_list_init(struct resource_list
*rl
);
110 * Reclaim memory used by a resource list.
112 void resource_list_free(struct resource_list
*rl
);
115 * Add a resource entry or modify an existing entry if one exists with
116 * the same type and rid.
118 void resource_list_add(struct resource_list
*rl
,
120 u_long start
, u_long end
, u_long count
);
123 * Find a resource entry by type and rid.
125 struct resource_list_entry
*
126 resource_list_find(struct resource_list
*rl
,
130 * Delete a resource entry.
132 void resource_list_delete(struct resource_list
*rl
,
136 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
137 * and passing the allocation up to the parent of bus. This assumes
138 * that the first entry of device_get_ivars(child) is a struct
139 * resource_list. This also handles 'passthrough' allocations where a
140 * child is a remote descendant of bus by passing the allocation up to
144 resource_list_alloc(struct resource_list
*rl
,
145 device_t bus
, device_t child
,
147 u_long start
, u_long end
,
148 u_long count
, u_int flags
);
151 * Implement BUS_RELEASE_RESOURCE.
153 int resource_list_release(struct resource_list
*rl
,
154 device_t bus
, device_t child
,
155 int type
, int rid
, struct resource
*res
);
158 * Print all resources of a specified type, for use in bus_print_child.
159 * The name is printed if at least one resource of the given type is available.
160 * The format ist used to print resource start and end.
162 int resource_list_print_type(struct resource_list
*rl
,
163 const char *name
, int type
,
167 * The root bus, to which all top-level busses are attached.
169 extern device_t root_bus
;
170 void root_bus_configure(void);
173 * Useful functions for implementing busses.
176 int bus_generic_activate_resource(device_t dev
, device_t child
, int type
,
177 int rid
, struct resource
*r
);
179 bus_generic_alloc_resource(device_t bus
, device_t child
,
181 u_long start
, u_long end
,
182 u_long count
, u_int flags
);
183 struct resource_list
*
184 bus_generic_get_resource_list (device_t
, device_t
);
186 int bus_generic_config_intr(device_t
, int, enum intr_trigger
,
188 int bus_generic_attach(device_t dev
);
189 int bus_generic_child_present(device_t dev
, device_t child
);
190 int bus_generic_deactivate_resource(device_t dev
, device_t child
, int type
,
191 int rid
, struct resource
*r
);
192 int bus_generic_detach(device_t dev
);
193 int bus_generic_disable_intr(device_t dev
, device_t child
, void *cookie
);
194 void bus_generic_driver_added(device_t dev
, driver_t
*driver
);
195 void bus_generic_enable_intr(device_t dev
, device_t child
, void *cookie
);
196 int bus_print_child_header(device_t dev
, device_t child
);
197 int bus_print_child_footer(device_t dev
, device_t child
);
198 int bus_generic_print_child(device_t dev
, device_t child
);
199 int bus_generic_identify(driver_t
*driver
, device_t parent
);
200 int bus_generic_identify_sameunit(driver_t
*driver
, device_t parent
);
201 int bus_generic_probe(device_t dev
);
202 int bus_generic_probe_hack(device_t dev
);
203 device_t
bus_generic_add_child(device_t
, device_t
, int, const char *, int);
204 int bus_generic_read_ivar(device_t dev
, device_t child
, int which
,
206 int bus_generic_release_resource(device_t bus
, device_t child
,
207 int type
, int rid
, struct resource
*r
);
208 int bus_generic_get_resource(device_t dev
, device_t child
, int type
,
209 int rid
, u_long
*startp
, u_long
*countp
);
210 int bus_generic_set_resource(device_t dev
, device_t child
, int type
,
211 int rid
, u_long start
, u_long count
);
212 void bus_generic_delete_resource(device_t dev
, device_t child
,
214 int bus_generic_resume(device_t dev
);
215 int bus_generic_setup_intr(device_t dev
, device_t child
,
216 struct resource
*irq
, int flags
,
217 driver_intr_t
*intr
, void *arg
,
218 void **cookiep
, lwkt_serialize_t serializer
);
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_disable_intr(device_t dev
, void *cookie
);
249 void bus_enable_intr(device_t dev
, void *cookie
);
250 int bus_release_resource(device_t dev
, int type
, int rid
,
252 int bus_setup_intr(device_t dev
, struct resource
*r
, int flags
,
253 driver_intr_t handler
, void *arg
,
254 void **cookiep
, lwkt_serialize_t serializer
);
255 int bus_teardown_intr(device_t dev
, struct resource
*r
, void *cookie
);
256 int bus_set_resource(device_t dev
, int type
, int rid
,
257 u_long start
, u_long count
);
258 int bus_get_resource(device_t dev
, int type
, int rid
,
259 u_long
*startp
, u_long
*countp
);
260 u_long
bus_get_resource_start(device_t dev
, int type
, int rid
);
261 u_long
bus_get_resource_count(device_t dev
, int type
, int rid
);
262 void bus_delete_resource(device_t dev
, int type
, int rid
);
263 int bus_child_present(device_t child
);
264 int bus_child_pnpinfo_str(device_t child
, char *buf
, size_t buflen
);
265 int bus_child_location_str(device_t child
, char *buf
, size_t buflen
);
267 static __inline
struct resource
*
268 bus_alloc_resource_any(device_t dev
, int type
, int *rid
, u_int flags
)
270 return (bus_alloc_resource(dev
, type
, rid
, 0ul, ~0ul, 1, flags
));
274 * Access functions for device.
276 device_t
device_add_child(device_t dev
, const char *name
, int unit
);
277 device_t
device_add_child_ordered(device_t dev
, int order
,
278 const char *name
, int unit
);
279 void device_busy(device_t dev
);
280 int device_delete_child(device_t dev
, device_t child
);
281 int device_detach(device_t dev
);
282 void device_disable(device_t dev
);
283 void device_enable(device_t dev
);
284 device_t
device_find_child(device_t dev
, const char *classname
,
286 const char *device_get_desc(device_t dev
);
287 devclass_t
device_get_devclass(device_t dev
);
288 driver_t
*device_get_driver(device_t dev
);
289 u_int32_t
device_get_flags(device_t dev
);
290 device_t
device_get_parent(device_t dev
);
291 int device_get_children(device_t dev
, device_t
**listp
, int *countp
);
292 void *device_get_ivars(device_t dev
);
293 void device_set_ivars(device_t dev
, void *ivars
);
294 const char *device_get_name(device_t dev
);
295 const char *device_get_nameunit(device_t dev
);
296 void *device_get_softc(device_t dev
);
297 device_state_t
device_get_state(device_t dev
);
298 int device_get_unit(device_t dev
);
299 int device_is_alive(device_t dev
); /* did probe succeed? */
300 int device_is_attached(device_t dev
); /* did attach succeed? */
301 int device_is_enabled(device_t dev
);
302 int device_is_quiet(device_t dev
);
303 int device_print_prettyname(device_t dev
);
304 int device_printf(device_t dev
, const char *, ...) __printflike(2, 3);
305 int device_probe_and_attach(device_t dev
);
306 void device_quiet(device_t dev
);
307 void device_set_desc(device_t dev
, const char* desc
);
308 void device_set_desc_copy(device_t dev
, const char* desc
);
309 int device_set_devclass(device_t dev
, const char *classname
);
310 int device_set_driver(device_t dev
, driver_t
*driver
);
311 void device_set_flags(device_t dev
, u_int32_t flags
);
312 void device_set_softc(device_t dev
, void *softc
);
313 int device_set_unit(device_t dev
, int unit
); /* XXX DONT USE XXX */
314 int device_shutdown(device_t dev
);
315 void device_unbusy(device_t dev
);
316 void device_verbose(device_t dev
);
319 * Access functions for devclass.
321 int devclass_add_driver(devclass_t dc
, kobj_class_t driver
);
322 int devclass_delete_driver(devclass_t dc
, kobj_class_t driver
);
323 devclass_t
devclass_create(const char *classname
);
324 devclass_t
devclass_find(const char *classname
);
325 device_t
devclass_find_unit(const char *classname
, int unit
);
326 kobj_class_t
devclass_find_driver(devclass_t dc
, const char *classname
);
327 const char *devclass_get_name(devclass_t dc
);
328 device_t
devclass_get_device(devclass_t dc
, int unit
);
329 void *devclass_get_softc(devclass_t dc
, int unit
);
330 int devclass_get_devices(devclass_t dc
, device_t
**listp
, int *countp
);
331 int devclass_get_maxunit(devclass_t dc
);
332 void devclass_set_parent(devclass_t dc
, devclass_t pdc
);
333 devclass_t
devclass_get_parent(devclass_t dc
);
336 * Access functions for device resources.
339 int resource_int_value(const char *name
, int unit
, const char *resname
,
341 int resource_long_value(const char *name
, int unit
, const char *resname
,
343 int resource_string_value(const char *name
, int unit
, const char *resname
,
345 int resource_disabled(const char *name
, int unit
);
346 int resource_query_string(int i
, const char *resname
, const char *value
);
347 char *resource_query_name(int i
);
348 int resource_query_unit(int i
);
349 int resource_locate(int i
, const char *resname
);
350 int resource_set_int(const char *name
, int unit
, const char *resname
,
352 int resource_set_long(const char *name
, int unit
, const char *resname
,
354 int resource_set_string(const char *name
, int unit
, const char *resname
,
356 int resource_count(void);
359 * Shorthand for constructing method tables.
361 #define DEVMETHOD KOBJMETHOD
364 * Some common device interfaces.
366 #include "device_if.h"
371 int driver_module_handler(struct module
*, int, void *);
374 * Module support for automatically adding drivers to busses.
376 struct driver_module_data
{
377 int (*dmd_chainevh
)(struct module
*, int, void *);
379 const char *dmd_busname
;
380 kobj_class_t dmd_driver
;
381 devclass_t
*dmd_devclass
;
384 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
386 static struct driver_module_data name##_##busname##_driver_mod = { \
389 (kobj_class_t) &driver, \
393 static moduledata_t name##_##busname##_mod = { \
394 #busname "/" #name, \
395 driver_module_handler, \
396 &name##_##busname##_driver_mod \
398 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
399 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
403 #endif /* !_SYS_BUS_H_ */