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.13 2005/05/23 18:19:55 dillon Exp $
35 #include <sys/queue.h>
39 * Forward declarations
41 typedef struct device *device_t;
42 typedef struct kobj_class 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);
87 typedef enum device_state {
88 DS_NOTPRESENT, /* not probed or probe failed */
89 DS_ALIVE, /* probe succeeded */
90 DS_ATTACHED, /* attach method called */
91 DS_BUSY /* device is open */
95 * Definitions for drivers which need to keep simple lists of resources
96 * for their child devices.
100 struct resource_list_entry {
101 SLIST_ENTRY(resource_list_entry) link;
102 int type; /* type argument to alloc_resource */
103 int rid; /* resource identifier */
104 struct resource *res; /* the real resource when allocated */
105 u_long start; /* start of resource range */
106 u_long end; /* end of resource range */
107 u_long count; /* count within range */
109 SLIST_HEAD(resource_list, resource_list_entry);
112 * Initialise a resource list.
114 void resource_list_init(struct resource_list *rl);
117 * Reclaim memory used by a resource list.
119 void resource_list_free(struct resource_list *rl);
122 * Add a resource entry or modify an existing entry if one exists with
123 * the same type and rid.
125 void resource_list_add(struct resource_list *rl,
127 u_long start, u_long end, u_long count);
130 * Find a resource entry by type and rid.
132 struct resource_list_entry*
133 resource_list_find(struct resource_list *rl,
137 * Delete a resource entry.
139 void resource_list_delete(struct resource_list *rl,
143 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
144 * and passing the allocation up to the parent of bus. This assumes
145 * that the first entry of device_get_ivars(child) is a struct
146 * resource_list. This also handles 'passthrough' allocations where a
147 * child is a remote descendant of bus by passing the allocation up to
151 resource_list_alloc(struct resource_list *rl,
152 device_t bus, device_t child,
154 u_long start, u_long end,
155 u_long count, u_int flags);
158 * Implement BUS_RELEASE_RESOURCE.
160 int resource_list_release(struct resource_list *rl,
161 device_t bus, device_t child,
162 int type, int rid, struct resource *res);
165 * Print all resources of a specified type, for use in bus_print_child.
166 * The name is printed if at least one resource of the given type is available.
167 * The format ist used to print resource start and end.
169 int resource_list_print_type(struct resource_list *rl,
170 const char *name, int type,
174 * The root bus, to which all top-level busses are attached.
176 extern device_t root_bus;
177 extern devclass_t root_devclass;
178 void root_bus_configure(void);
181 * Useful functions for implementing busses.
184 int bus_generic_activate_resource(device_t dev, device_t child, int type,
185 int rid, struct resource *r);
187 bus_generic_alloc_resource(device_t bus, device_t child,
189 u_long start, u_long end,
190 u_long count, u_int flags);
191 struct resource_list *
192 bus_generic_get_resource_list (device_t, device_t);
194 int bus_generic_config_intr(device_t, int, enum intr_trigger,
196 int bus_generic_attach(device_t dev);
197 int bus_generic_child_present(device_t dev, device_t child);
198 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
199 int rid, struct resource *r);
200 int bus_generic_detach(device_t dev);
201 void bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
202 void bus_generic_driver_added(device_t dev, driver_t *driver);
203 void bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
204 int bus_print_child_header(device_t dev, device_t child);
205 int bus_print_child_footer(device_t dev, device_t child);
206 int bus_generic_print_child(device_t dev, device_t child);
207 int bus_generic_probe(device_t dev);
208 int bus_generic_read_ivar(device_t dev, device_t child, int which,
210 int bus_generic_release_resource(device_t bus, device_t child,
211 int type, int rid, struct resource *r);
212 int bus_generic_resume(device_t dev);
213 int bus_generic_setup_intr(device_t dev, device_t child,
214 struct resource *irq, int flags,
215 driver_intr_t *intr, void *arg, void **cookiep);
216 int bus_generic_shutdown(device_t dev);
217 int bus_generic_suspend(device_t dev);
218 int bus_generic_teardown_intr(device_t dev, device_t child,
219 struct resource *irq, void *cookie);
220 int bus_generic_write_ivar(device_t dev, device_t child, int which,
224 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
225 u_long, u_long, u_long, u_int);
226 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
227 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
229 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
231 int bus_generic_rl_release_resource (device_t, device_t, int, int,
235 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
238 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
239 u_long start, u_long end, u_long count,
241 int bus_activate_resource(device_t dev, int type, int rid,
243 int bus_deactivate_resource(device_t dev, int type, int rid,
245 void bus_disable_intr(device_t dev, void *cookie);
246 void bus_enable_intr(device_t dev, void *cookie);
247 int bus_release_resource(device_t dev, int type, int rid,
249 int bus_setup_intr(device_t dev, struct resource *r, int flags,
250 driver_intr_t handler, void *arg, void **cookiep);
251 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
252 int bus_set_resource(device_t dev, int type, int rid,
253 u_long start, u_long count);
254 int bus_get_resource(device_t dev, int type, int rid,
255 u_long *startp, u_long *countp);
256 u_long bus_get_resource_start(device_t dev, int type, int rid);
257 u_long bus_get_resource_count(device_t dev, int type, int rid);
258 void bus_delete_resource(device_t dev, int type, int rid);
259 int bus_child_present(device_t child);
260 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
261 int bus_child_location_str(device_t child, char *buf, size_t buflen);
263 static __inline struct resource *
264 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
266 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
270 * Access functions for device.
272 device_t device_add_child(device_t dev, const char *name, int unit);
273 device_t device_add_child_ordered(device_t dev, int order,
274 const char *name, int unit);
275 void device_busy(device_t dev);
276 int device_delete_child(device_t dev, device_t child);
277 int device_detach(device_t dev);
278 void device_disable(device_t dev);
279 void device_enable(device_t dev);
280 device_t device_find_child(device_t dev, const char *classname,
282 const char *device_get_desc(device_t dev);
283 devclass_t device_get_devclass(device_t dev);
284 driver_t *device_get_driver(device_t dev);
285 u_int32_t device_get_flags(device_t dev);
286 device_t device_get_parent(device_t dev);
287 int device_get_children(device_t dev, device_t **listp, int *countp);
288 void *device_get_ivars(device_t dev);
289 void device_set_ivars(device_t dev, void *ivars);
290 const char *device_get_name(device_t dev);
291 const char *device_get_nameunit(device_t dev);
292 void *device_get_softc(device_t dev);
293 device_state_t device_get_state(device_t dev);
294 int device_get_unit(device_t dev);
295 int device_is_alive(device_t dev); /* did probe succeed? */
296 int device_is_attached(device_t dev); /* did attach succeed? */
297 int device_is_enabled(device_t dev);
298 int device_is_quiet(device_t dev);
299 int device_print_prettyname(device_t dev);
300 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
301 int device_probe_and_attach(device_t dev);
302 void device_quiet(device_t dev);
303 void device_set_desc(device_t dev, const char* desc);
304 void device_set_desc_copy(device_t dev, const char* desc);
305 int device_set_devclass(device_t dev, const char *classname);
306 int device_set_driver(device_t dev, driver_t *driver);
307 void device_set_flags(device_t dev, u_int32_t flags);
308 void device_set_softc(device_t dev, void *softc);
309 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
310 int device_shutdown(device_t dev);
311 void device_unbusy(device_t dev);
312 void device_verbose(device_t dev);
315 * Access functions for devclass.
317 int devclass_add_driver(devclass_t dc, kobj_class_t driver);
318 int devclass_delete_driver(devclass_t dc, kobj_class_t driver);
319 devclass_t devclass_create(const char *classname);
320 devclass_t devclass_find(const char *classname);
321 kobj_class_t devclass_find_driver(devclass_t dc, const char *classname);
322 const char *devclass_get_name(devclass_t dc);
323 device_t devclass_get_device(devclass_t dc, int unit);
324 void *devclass_get_softc(devclass_t dc, int unit);
325 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
326 int devclass_get_maxunit(devclass_t dc);
327 void devclass_set_parent(devclass_t dc, devclass_t pdc);
328 devclass_t devclass_get_parent(devclass_t dc);
331 * Access functions for device resources.
334 int resource_int_value(const char *name, int unit, const char *resname,
336 int resource_long_value(const char *name, int unit, const char *resname,
338 int resource_string_value(const char *name, int unit, const char *resname,
340 int resource_disabled(const char *name, int unit);
341 int resource_query_string(int i, const char *resname, const char *value);
342 char *resource_query_name(int i);
343 int resource_query_unit(int i);
344 int resource_locate(int i, const char *resname);
345 int resource_set_int(const char *name, int unit, const char *resname,
347 int resource_set_long(const char *name, int unit, const char *resname,
349 int resource_set_string(const char *name, int unit, const char *resname,
351 int resource_count(void);
354 * Shorthand for constructing method tables.
356 #define DEVMETHOD KOBJMETHOD
359 * Some common device interfaces.
361 #include "device_if.h"
366 int driver_module_handler(struct module *, int, void *);
369 * Module support for automatically adding drivers to busses.
371 struct driver_module_data {
372 int (*dmd_chainevh)(struct module *, int, void *);
374 const char *dmd_busname;
375 kobj_class_t dmd_driver;
376 devclass_t *dmd_devclass;
379 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
381 static struct driver_module_data name##_##busname##_driver_mod = { \
384 (kobj_class_t) &driver, \
388 static moduledata_t name##_##busname##_mod = { \
389 #busname "/" #name, \
390 driver_module_handler, \
391 &name##_##busname##_driver_mod \
393 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
394 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
398 #endif /* !_SYS_BUS_H_ */