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.26 2007/09/12 07:59:31 hasso Exp $
33 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
36 #include <sys/types.h>
39 #include <sys/queue.h>
45 #include <sys/serialize.h>
47 #ifndef _SYS_BUS_DMA_H_
48 #include <sys/bus_dma.h>
50 #ifndef _SYS_BUS_RESOURCE_H_
51 #include <sys/bus_resource.h>
55 * Forward declarations
57 typedef struct device
*device_t
;
58 typedef struct kobj_class driver_t
;
59 typedef struct devclass
*devclass_t
;
60 #define device_method_t kobj_method_t
62 typedef void driver_intr_t(void*);
65 * Interrupt features mask. Note that DragonFly no longer implements
68 #define INTR_FAST 0x0080
69 #define INTR_EXCL 0x0100
70 #define INTR_MPSAFE 0x0200
71 #define INTR_NOENTROPY 0x0400
72 #define INTR_NOPOLL 0x0800 /* interrupt cannot be polled (e.g. ata) */
74 #define INTR_NETSAFE INTR_MPSAFE
77 INTR_TRIGGER_CONFORM
= 0,
78 INTR_TRIGGER_EDGE
= 1,
79 INTR_TRIGGER_LEVEL
= 2
83 INTR_POLARITY_CONFORM
= 0,
84 INTR_POLARITY_HIGH
= 1,
88 typedef int (*devop_t
)(void);
90 typedef enum device_state
{
91 DS_NOTPRESENT
, /* not probed or probe failed */
92 DS_ALIVE
, /* probe succeeded */
93 DS_INPROGRESS
, /* attach in progress */
94 DS_ATTACHED
, /* attach method called */
95 DS_BUSY
/* device is open */
99 * Definitions for drivers which need to keep simple lists of resources
100 * for their child devices.
104 struct resource_list_entry
{
105 SLIST_ENTRY(resource_list_entry
) link
;
106 int type
; /* type argument to alloc_resource */
107 int rid
; /* resource identifier */
108 struct resource
*res
; /* the real resource when allocated */
109 u_long start
; /* start of resource range */
110 u_long end
; /* end of resource range */
111 u_long count
; /* count within range */
113 SLIST_HEAD(resource_list
, resource_list_entry
);
115 #endif /* _KERNEL || _KERNEL_STRUCTURES */
119 * Initialise a resource list.
121 void resource_list_init(struct resource_list
*rl
);
124 * Reclaim memory used by a resource list.
126 void resource_list_free(struct resource_list
*rl
);
129 * Add a resource entry or modify an existing entry if one exists with
130 * the same type and rid.
132 void resource_list_add(struct resource_list
*rl
,
134 u_long start
, u_long end
, u_long count
);
137 * Find a resource entry by type and rid.
139 struct resource_list_entry
*
140 resource_list_find(struct resource_list
*rl
,
144 * Delete a resource entry.
146 void resource_list_delete(struct resource_list
*rl
,
150 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
151 * and passing the allocation up to the parent of bus. This assumes
152 * that the first entry of device_get_ivars(child) is a struct
153 * resource_list. This also handles 'passthrough' allocations where a
154 * child is a remote descendant of bus by passing the allocation up to
158 resource_list_alloc(struct resource_list
*rl
,
159 device_t bus
, device_t child
,
161 u_long start
, u_long end
,
162 u_long count
, u_int flags
);
165 * Implement BUS_RELEASE_RESOURCE.
167 int resource_list_release(struct resource_list
*rl
,
168 device_t bus
, device_t child
,
169 int type
, int rid
, struct resource
*res
);
172 * Print all resources of a specified type, for use in bus_print_child.
173 * The name is printed if at least one resource of the given type is available.
174 * The format ist used to print resource start and end.
176 int resource_list_print_type(struct resource_list
*rl
,
177 const char *name
, int type
,
181 * The root bus, to which all top-level busses are attached.
183 extern device_t root_bus
;
184 void root_bus_configure(void);
187 * Useful functions for implementing busses.
190 int bus_generic_activate_resource(device_t dev
, device_t child
, int type
,
191 int rid
, struct resource
*r
);
193 bus_generic_alloc_resource(device_t bus
, device_t child
,
195 u_long start
, u_long end
,
196 u_long count
, u_int flags
);
197 struct resource_list
*
198 bus_generic_get_resource_list (device_t
, device_t
);
200 int bus_generic_config_intr(device_t
, int, enum intr_trigger
,
202 int bus_generic_attach(device_t dev
);
203 int bus_generic_child_present(device_t dev
, device_t child
);
204 int bus_generic_deactivate_resource(device_t dev
, device_t child
, int type
,
205 int rid
, struct resource
*r
);
206 int bus_generic_detach(device_t dev
);
207 int bus_generic_disable_intr(device_t dev
, device_t child
, void *cookie
);
208 void bus_generic_driver_added(device_t dev
, driver_t
*driver
);
209 void bus_generic_enable_intr(device_t dev
, device_t child
, void *cookie
);
210 int bus_print_child_header(device_t dev
, device_t child
);
211 int bus_print_child_footer(device_t dev
, device_t child
);
212 int bus_generic_print_child(device_t dev
, device_t child
);
213 int bus_generic_identify(driver_t
*driver
, device_t parent
);
214 int bus_generic_identify_sameunit(driver_t
*driver
, device_t parent
);
215 int bus_generic_probe(device_t dev
);
216 int bus_generic_probe_hack(device_t dev
);
217 device_t
bus_generic_add_child(device_t
, device_t
, int, const char *, int);
218 int bus_generic_read_ivar(device_t dev
, device_t child
, int which
,
220 int bus_generic_release_resource(device_t bus
, device_t child
,
221 int type
, int rid
, struct resource
*r
);
222 int bus_generic_get_resource(device_t dev
, device_t child
, int type
,
223 int rid
, u_long
*startp
, u_long
*countp
);
224 int bus_generic_set_resource(device_t dev
, device_t child
, int type
,
225 int rid
, u_long start
, u_long count
);
226 void bus_generic_delete_resource(device_t dev
, device_t child
,
228 int bus_generic_resume(device_t dev
);
229 int bus_generic_setup_intr(device_t dev
, device_t child
,
230 struct resource
*irq
, int flags
,
231 driver_intr_t
*intr
, void *arg
,
232 void **cookiep
, lwkt_serialize_t serializer
);
233 int bus_generic_shutdown(device_t dev
);
234 int bus_generic_suspend(device_t dev
);
235 int bus_generic_teardown_intr(device_t dev
, device_t child
,
236 struct resource
*irq
, void *cookie
);
237 int bus_generic_write_ivar(device_t dev
, device_t child
, int which
,
241 bus_generic_rl_alloc_resource (device_t
, device_t
, int, int *,
242 u_long
, u_long
, u_long
, u_int
);
243 void bus_generic_rl_delete_resource (device_t
, device_t
, int, int);
244 int bus_generic_rl_get_resource (device_t
, device_t
, int, int, u_long
*,
246 int bus_generic_rl_set_resource (device_t
, device_t
, int, int, u_long
,
248 int bus_generic_rl_release_resource (device_t
, device_t
, int, int,
252 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
255 struct resource_spec
{
261 int bus_alloc_resources(device_t dev
, struct resource_spec
*rs
,
262 struct resource
**res
);
263 void bus_release_resources(device_t dev
, const struct resource_spec
*rs
,
264 struct resource
**res
);
266 struct resource
*bus_alloc_resource(device_t dev
, int type
, int *rid
,
267 u_long start
, u_long end
, u_long count
,
269 int bus_activate_resource(device_t dev
, int type
, int rid
,
271 int bus_deactivate_resource(device_t dev
, int type
, int rid
,
273 int bus_disable_intr(device_t dev
, void *cookie
);
274 void bus_enable_intr(device_t dev
, void *cookie
);
275 int bus_release_resource(device_t dev
, int type
, int rid
,
277 int bus_setup_intr(device_t dev
, struct resource
*r
, int flags
,
278 driver_intr_t handler
, void *arg
,
279 void **cookiep
, lwkt_serialize_t serializer
);
280 int bus_teardown_intr(device_t dev
, struct resource
*r
, void *cookie
);
281 int bus_set_resource(device_t dev
, int type
, int rid
,
282 u_long start
, u_long count
);
283 int bus_get_resource(device_t dev
, int type
, int rid
,
284 u_long
*startp
, u_long
*countp
);
285 u_long
bus_get_resource_start(device_t dev
, int type
, int rid
);
286 u_long
bus_get_resource_count(device_t dev
, int type
, int rid
);
287 void bus_delete_resource(device_t dev
, int type
, int rid
);
288 int bus_child_present(device_t child
);
289 int bus_child_pnpinfo_str(device_t child
, char *buf
, size_t buflen
);
290 int bus_child_location_str(device_t child
, char *buf
, size_t buflen
);
292 static __inline
struct resource
*
293 bus_alloc_resource_any(device_t dev
, int type
, int *rid
, u_int flags
)
295 return (bus_alloc_resource(dev
, type
, rid
, 0ul, ~0ul, 1, flags
));
299 * Access functions for device.
301 device_t
device_add_child(device_t dev
, const char *name
, int unit
);
302 device_t
device_add_child_ordered(device_t dev
, int order
,
303 const char *name
, int unit
);
304 void device_busy(device_t dev
);
305 int device_delete_child(device_t dev
, device_t child
);
306 int device_detach(device_t dev
);
307 void device_disable(device_t dev
);
308 void device_enable(device_t dev
);
309 device_t
device_find_child(device_t dev
, const char *classname
,
311 const char *device_get_desc(device_t dev
);
312 devclass_t
device_get_devclass(device_t dev
);
313 driver_t
*device_get_driver(device_t dev
);
314 u_int32_t
device_get_flags(device_t dev
);
315 device_t
device_get_parent(device_t dev
);
316 int device_get_children(device_t dev
, device_t
**listp
, int *countp
);
317 void *device_get_ivars(device_t dev
);
318 void device_set_ivars(device_t dev
, void *ivars
);
319 const char *device_get_name(device_t dev
);
320 const char *device_get_nameunit(device_t dev
);
321 void *device_get_softc(device_t dev
);
322 device_state_t
device_get_state(device_t dev
);
323 int device_get_unit(device_t dev
);
324 int device_is_alive(device_t dev
); /* did probe succeed? */
325 int device_is_attached(device_t dev
); /* did attach succeed? */
326 int device_is_enabled(device_t dev
);
327 int device_is_quiet(device_t dev
);
328 int device_print_prettyname(device_t dev
);
329 int device_printf(device_t dev
, const char *, ...) __printflike(2, 3);
330 int device_probe_and_attach(device_t dev
);
331 void device_quiet(device_t dev
);
332 void device_set_desc(device_t dev
, const char* desc
);
333 void device_set_desc_copy(device_t dev
, const char* desc
);
334 int device_set_devclass(device_t dev
, const char *classname
);
335 int device_set_driver(device_t dev
, driver_t
*driver
);
336 void device_set_flags(device_t dev
, u_int32_t flags
);
337 void device_set_softc(device_t dev
, void *softc
);
338 void device_set_async_attach(device_t dev
, int enable
);
339 int device_set_unit(device_t dev
, int unit
); /* XXX DONT USE XXX */
340 int device_shutdown(device_t dev
);
341 void device_unbusy(device_t dev
);
342 void device_verbose(device_t dev
);
345 * Access functions for devclass.
347 int devclass_add_driver(devclass_t dc
, kobj_class_t driver
);
348 int devclass_delete_driver(devclass_t dc
, kobj_class_t driver
);
349 devclass_t
devclass_create(const char *classname
);
350 devclass_t
devclass_find(const char *classname
);
351 device_t
devclass_find_unit(const char *classname
, int unit
);
352 kobj_class_t
devclass_find_driver(devclass_t dc
, const char *classname
);
353 const char *devclass_get_name(devclass_t dc
);
354 device_t
devclass_get_device(devclass_t dc
, int unit
);
355 void *devclass_get_softc(devclass_t dc
, int unit
);
356 int devclass_get_devices(devclass_t dc
, device_t
**listp
, int *countp
);
357 int devclass_get_maxunit(devclass_t dc
);
358 void devclass_set_parent(devclass_t dc
, devclass_t pdc
);
359 devclass_t
devclass_get_parent(devclass_t dc
);
362 * Access functions for device resources.
365 int resource_int_value(const char *name
, int unit
, const char *resname
,
367 int resource_long_value(const char *name
, int unit
, const char *resname
,
369 int resource_string_value(const char *name
, int unit
, const char *resname
,
371 int resource_disabled(const char *name
, int unit
);
372 int resource_query_string(int i
, const char *resname
, const char *value
);
373 char *resource_query_name(int i
);
374 int resource_query_unit(int i
);
375 int resource_locate(int i
, const char *resname
);
376 int resource_set_int(const char *name
, int unit
, const char *resname
,
378 int resource_set_long(const char *name
, int unit
, const char *resname
,
380 int resource_set_string(const char *name
, int unit
, const char *resname
,
382 int resource_count(void);
385 * Some convenience defines for probe routines to return. These are just
386 * suggested values, and there's nothing magical about them.
387 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
388 * possible other driver may exist (typically legacy drivers who don't fallow
389 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the
390 * suggested value that vendor supplied drivers use. This is for source or
391 * binary drivers that are not yet integrated into the FreeBSD tree. Its use
392 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value
393 * for drivers to use. It is intended that nearly all of the drivers in the
394 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that
395 * have special requirements like when there are two drivers that support
396 * overlapping series of hardware devices. In this case the one that supports
397 * the older part of the line would return this value, while the one that
398 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC
399 * is for drivers that wish to have a generic form and a specialized form,
400 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is
401 * for those busses that implement a generic device place-holder for devices on
402 * the bus that have no more specific driver for them (aka ugen).
404 #define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */
406 #define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */
407 #define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */
408 #define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */
409 #define BUS_PROBE_GENERIC (-100) /* generic driver for dev */
410 #define BUS_PROBE_HOOVER (-500) /* Generic dev for all devs on bus */
412 #define BUS_PROBE_VENDOR 0
413 #define BUS_PROBE_DEFAULT 0
414 #define BUS_PROBE_LOW_PRIORITY 0
415 #define BUS_PROBE_GENERIC 0
416 #define BUS_PROBE_HOOVER 0
420 * Shorthand for constructing method tables.
422 #define DEVMETHOD KOBJMETHOD
425 * Some common device interfaces.
427 #include "device_if.h"
432 int driver_module_handler(struct module
*, int, void *);
435 * Module support for automatically adding drivers to busses.
437 struct driver_module_data
{
438 int (*dmd_chainevh
)(struct module
*, int, void *);
440 const char *dmd_busname
;
441 kobj_class_t dmd_driver
;
442 devclass_t
*dmd_devclass
;
445 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
447 static struct driver_module_data name##_##busname##_driver_mod = { \
450 (kobj_class_t) &driver, \
454 static moduledata_t name##_##busname##_mod = { \
455 #busname "/" #name, \
456 driver_module_handler, \
457 &name##_##busname##_driver_mod \
459 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
460 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
464 #endif /* !_SYS_BUS_H_ */