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.23 2006/10/25 20:56:03 dillon 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_ATTACHED, /* attach method called */
94 DS_BUSY /* device is open */
98 * Definitions for drivers which need to keep simple lists of resources
99 * for their child devices.
103 struct resource_list_entry {
104 SLIST_ENTRY(resource_list_entry) link;
105 int type; /* type argument to alloc_resource */
106 int rid; /* resource identifier */
107 struct resource *res; /* the real resource when allocated */
108 u_long start; /* start of resource range */
109 u_long end; /* end of resource range */
110 u_long count; /* count within range */
112 SLIST_HEAD(resource_list, resource_list_entry);
114 #endif /* _KERNEL || _KERNEL_STRUCTURES */
118 * Initialise a resource list.
120 void resource_list_init(struct resource_list *rl);
123 * Reclaim memory used by a resource list.
125 void resource_list_free(struct resource_list *rl);
128 * Add a resource entry or modify an existing entry if one exists with
129 * the same type and rid.
131 void resource_list_add(struct resource_list *rl,
133 u_long start, u_long end, u_long count);
136 * Find a resource entry by type and rid.
138 struct resource_list_entry*
139 resource_list_find(struct resource_list *rl,
143 * Delete a resource entry.
145 void resource_list_delete(struct resource_list *rl,
149 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
150 * and passing the allocation up to the parent of bus. This assumes
151 * that the first entry of device_get_ivars(child) is a struct
152 * resource_list. This also handles 'passthrough' allocations where a
153 * child is a remote descendant of bus by passing the allocation up to
157 resource_list_alloc(struct resource_list *rl,
158 device_t bus, device_t child,
160 u_long start, u_long end,
161 u_long count, u_int flags);
164 * Implement BUS_RELEASE_RESOURCE.
166 int resource_list_release(struct resource_list *rl,
167 device_t bus, device_t child,
168 int type, int rid, struct resource *res);
171 * Print all resources of a specified type, for use in bus_print_child.
172 * The name is printed if at least one resource of the given type is available.
173 * The format ist used to print resource start and end.
175 int resource_list_print_type(struct resource_list *rl,
176 const char *name, int type,
180 * The root bus, to which all top-level busses are attached.
182 extern device_t root_bus;
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 int bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
207 void bus_generic_driver_added(device_t dev, driver_t *driver);
208 void bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
209 int bus_print_child_header(device_t dev, device_t child);
210 int bus_print_child_footer(device_t dev, device_t child);
211 int bus_generic_print_child(device_t dev, device_t child);
212 int bus_generic_identify(driver_t *driver, device_t parent);
213 int bus_generic_identify_sameunit(driver_t *driver, device_t parent);
214 int bus_generic_probe(device_t dev);
215 int bus_generic_probe_hack(device_t dev);
216 device_t bus_generic_add_child(device_t, device_t, int, const char *, int);
217 int bus_generic_read_ivar(device_t dev, device_t child, int which,
219 int bus_generic_release_resource(device_t bus, device_t child,
220 int type, int rid, struct resource *r);
221 int bus_generic_get_resource(device_t dev, device_t child, int type,
222 int rid, u_long *startp, u_long *countp);
223 int bus_generic_set_resource(device_t dev, device_t child, int type,
224 int rid, u_long start, u_long count);
225 void bus_generic_delete_resource(device_t dev, device_t child,
227 int bus_generic_resume(device_t dev);
228 int bus_generic_setup_intr(device_t dev, device_t child,
229 struct resource *irq, int flags,
230 driver_intr_t *intr, void *arg,
231 void **cookiep, lwkt_serialize_t serializer);
232 int bus_generic_shutdown(device_t dev);
233 int bus_generic_suspend(device_t dev);
234 int bus_generic_teardown_intr(device_t dev, device_t child,
235 struct resource *irq, void *cookie);
236 int bus_generic_write_ivar(device_t dev, device_t child, int which,
240 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
241 u_long, u_long, u_long, u_int);
242 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
243 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
245 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
247 int bus_generic_rl_release_resource (device_t, device_t, int, int,
251 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
254 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
255 u_long start, u_long end, u_long count,
257 int bus_activate_resource(device_t dev, int type, int rid,
259 int bus_deactivate_resource(device_t dev, int type, int rid,
261 int bus_disable_intr(device_t dev, void *cookie);
262 void bus_enable_intr(device_t dev, void *cookie);
263 int bus_release_resource(device_t dev, int type, int rid,
265 int bus_setup_intr(device_t dev, struct resource *r, int flags,
266 driver_intr_t handler, void *arg,
267 void **cookiep, lwkt_serialize_t serializer);
268 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
269 int bus_set_resource(device_t dev, int type, int rid,
270 u_long start, u_long count);
271 int bus_get_resource(device_t dev, int type, int rid,
272 u_long *startp, u_long *countp);
273 u_long bus_get_resource_start(device_t dev, int type, int rid);
274 u_long bus_get_resource_count(device_t dev, int type, int rid);
275 void bus_delete_resource(device_t dev, int type, int rid);
276 int bus_child_present(device_t child);
277 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
278 int bus_child_location_str(device_t child, char *buf, size_t buflen);
280 static __inline struct resource *
281 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
283 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
287 * Access functions for device.
289 device_t device_add_child(device_t dev, const char *name, int unit);
290 device_t device_add_child_ordered(device_t dev, int order,
291 const char *name, int unit);
292 void device_busy(device_t dev);
293 int device_delete_child(device_t dev, device_t child);
294 int device_detach(device_t dev);
295 void device_disable(device_t dev);
296 void device_enable(device_t dev);
297 device_t device_find_child(device_t dev, const char *classname,
299 const char *device_get_desc(device_t dev);
300 devclass_t device_get_devclass(device_t dev);
301 driver_t *device_get_driver(device_t dev);
302 u_int32_t device_get_flags(device_t dev);
303 device_t device_get_parent(device_t dev);
304 int device_get_children(device_t dev, device_t **listp, int *countp);
305 void *device_get_ivars(device_t dev);
306 void device_set_ivars(device_t dev, void *ivars);
307 const char *device_get_name(device_t dev);
308 const char *device_get_nameunit(device_t dev);
309 void *device_get_softc(device_t dev);
310 device_state_t device_get_state(device_t dev);
311 int device_get_unit(device_t dev);
312 int device_is_alive(device_t dev); /* did probe succeed? */
313 int device_is_attached(device_t dev); /* did attach succeed? */
314 int device_is_enabled(device_t dev);
315 int device_is_quiet(device_t dev);
316 int device_print_prettyname(device_t dev);
317 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
318 int device_probe_and_attach(device_t dev);
319 void device_quiet(device_t dev);
320 void device_set_desc(device_t dev, const char* desc);
321 void device_set_desc_copy(device_t dev, const char* desc);
322 int device_set_devclass(device_t dev, const char *classname);
323 int device_set_driver(device_t dev, driver_t *driver);
324 void device_set_flags(device_t dev, u_int32_t flags);
325 void device_set_softc(device_t dev, void *softc);
326 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
327 int device_shutdown(device_t dev);
328 void device_unbusy(device_t dev);
329 void device_verbose(device_t dev);
332 * Access functions for devclass.
334 int devclass_add_driver(devclass_t dc, kobj_class_t driver);
335 int devclass_delete_driver(devclass_t dc, kobj_class_t driver);
336 devclass_t devclass_create(const char *classname);
337 devclass_t devclass_find(const char *classname);
338 device_t devclass_find_unit(const char *classname, int unit);
339 kobj_class_t devclass_find_driver(devclass_t dc, const char *classname);
340 const char *devclass_get_name(devclass_t dc);
341 device_t devclass_get_device(devclass_t dc, int unit);
342 void *devclass_get_softc(devclass_t dc, int unit);
343 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
344 int devclass_get_maxunit(devclass_t dc);
345 void devclass_set_parent(devclass_t dc, devclass_t pdc);
346 devclass_t devclass_get_parent(devclass_t dc);
349 * Access functions for device resources.
352 int resource_int_value(const char *name, int unit, const char *resname,
354 int resource_long_value(const char *name, int unit, const char *resname,
356 int resource_string_value(const char *name, int unit, const char *resname,
358 int resource_disabled(const char *name, int unit);
359 int resource_query_string(int i, const char *resname, const char *value);
360 char *resource_query_name(int i);
361 int resource_query_unit(int i);
362 int resource_locate(int i, const char *resname);
363 int resource_set_int(const char *name, int unit, const char *resname,
365 int resource_set_long(const char *name, int unit, const char *resname,
367 int resource_set_string(const char *name, int unit, const char *resname,
369 int resource_count(void);
372 * Shorthand for constructing method tables.
374 #define DEVMETHOD KOBJMETHOD
377 * Some common device interfaces.
379 #include "device_if.h"
384 int driver_module_handler(struct module *, int, void *);
387 * Module support for automatically adding drivers to busses.
389 struct driver_module_data {
390 int (*dmd_chainevh)(struct module *, int, void *);
392 const char *dmd_busname;
393 kobj_class_t dmd_driver;
394 devclass_t *dmd_devclass;
397 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
399 static struct driver_module_data name##_##busname##_driver_mod = { \
402 (kobj_class_t) &driver, \
406 static moduledata_t name##_##busname##_mod = { \
407 #busname "/" #name, \
408 driver_module_handler, \
409 &name##_##busname##_driver_mod \
411 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
412 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
416 #endif /* !_SYS_BUS_H_ */