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.19 2005/11/28 17:13:47 dillon Exp $
35 #include <sys/queue.h>
37 #include <sys/serialize.h>
40 * Forward declarations
42 typedef struct device *device_t;
43 typedef struct kobj_class driver_t;
44 typedef struct devclass *devclass_t;
45 #define device_method_t kobj_method_t
47 typedef void driver_intr_t(void*);
50 * Interrupt features mask. Note that DragonFly no longer implements
53 #define INTR_FAST 0x0080
54 #define INTR_EXCL 0x0100
55 #define INTR_MPSAFE 0x0200
56 #define INTR_ENTROPY 0x0400
57 #define INTR_NOPOLL 0x0800 /* interrupt cannot be polled (e.g. ata) */
59 #define INTR_NETSAFE INTR_MPSAFE
62 INTR_TRIGGER_CONFORM = 0,
63 INTR_TRIGGER_EDGE = 1,
64 INTR_TRIGGER_LEVEL = 2
68 INTR_POLARITY_CONFORM = 0,
69 INTR_POLARITY_HIGH = 1,
73 typedef int (*devop_t)(void);
75 typedef enum device_state {
76 DS_NOTPRESENT, /* not probed or probe failed */
77 DS_ALIVE, /* probe succeeded */
78 DS_ATTACHED, /* attach method called */
79 DS_BUSY /* device is open */
83 * Definitions for drivers which need to keep simple lists of resources
84 * for their child devices.
88 struct resource_list_entry {
89 SLIST_ENTRY(resource_list_entry) link;
90 int type; /* type argument to alloc_resource */
91 int rid; /* resource identifier */
92 struct resource *res; /* the real resource when allocated */
93 u_long start; /* start of resource range */
94 u_long end; /* end of resource range */
95 u_long count; /* count within range */
97 SLIST_HEAD(resource_list, resource_list_entry);
100 * Initialise a resource list.
102 void resource_list_init(struct resource_list *rl);
105 * Reclaim memory used by a resource list.
107 void resource_list_free(struct resource_list *rl);
110 * Add a resource entry or modify an existing entry if one exists with
111 * the same type and rid.
113 void resource_list_add(struct resource_list *rl,
115 u_long start, u_long end, u_long count);
118 * Find a resource entry by type and rid.
120 struct resource_list_entry*
121 resource_list_find(struct resource_list *rl,
125 * Delete a resource entry.
127 void resource_list_delete(struct resource_list *rl,
131 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
132 * and passing the allocation up to the parent of bus. This assumes
133 * that the first entry of device_get_ivars(child) is a struct
134 * resource_list. This also handles 'passthrough' allocations where a
135 * child is a remote descendant of bus by passing the allocation up to
139 resource_list_alloc(struct resource_list *rl,
140 device_t bus, device_t child,
142 u_long start, u_long end,
143 u_long count, u_int flags);
146 * Implement BUS_RELEASE_RESOURCE.
148 int resource_list_release(struct resource_list *rl,
149 device_t bus, device_t child,
150 int type, int rid, struct resource *res);
153 * Print all resources of a specified type, for use in bus_print_child.
154 * The name is printed if at least one resource of the given type is available.
155 * The format ist used to print resource start and end.
157 int resource_list_print_type(struct resource_list *rl,
158 const char *name, int type,
162 * The root bus, to which all top-level busses are attached.
164 extern device_t root_bus;
165 void root_bus_configure(void);
168 * Useful functions for implementing busses.
171 int bus_generic_activate_resource(device_t dev, device_t child, int type,
172 int rid, struct resource *r);
174 bus_generic_alloc_resource(device_t bus, device_t child,
176 u_long start, u_long end,
177 u_long count, u_int flags);
178 struct resource_list *
179 bus_generic_get_resource_list (device_t, device_t);
181 int bus_generic_config_intr(device_t, int, enum intr_trigger,
183 int bus_generic_attach(device_t dev);
184 int bus_generic_child_present(device_t dev, device_t child);
185 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
186 int rid, struct resource *r);
187 int bus_generic_detach(device_t dev);
188 int bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
189 void bus_generic_driver_added(device_t dev, driver_t *driver);
190 void bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
191 int bus_print_child_header(device_t dev, device_t child);
192 int bus_print_child_footer(device_t dev, device_t child);
193 int bus_generic_print_child(device_t dev, device_t child);
194 int bus_generic_identify(driver_t *driver, device_t parent);
195 int bus_generic_identify_sameunit(driver_t *driver, device_t parent);
196 int bus_generic_probe(device_t dev);
197 int bus_generic_probe_hack(device_t dev);
198 device_t bus_generic_add_child(device_t, device_t, int, const char *, int);
199 int bus_generic_read_ivar(device_t dev, device_t child, int which,
201 int bus_generic_release_resource(device_t bus, device_t child,
202 int type, int rid, struct resource *r);
203 int bus_generic_get_resource(device_t dev, device_t child, int type,
204 int rid, u_long *startp, u_long *countp);
205 int bus_generic_set_resource(device_t dev, device_t child, int type,
206 int rid, u_long start, u_long count);
207 void bus_generic_delete_resource(device_t dev, device_t child,
209 int bus_generic_resume(device_t dev);
210 int bus_generic_setup_intr(device_t dev, device_t child,
211 struct resource *irq, int flags,
212 driver_intr_t *intr, void *arg,
213 void **cookiep, lwkt_serialize_t serializer);
214 int bus_generic_shutdown(device_t dev);
215 int bus_generic_suspend(device_t dev);
216 int bus_generic_teardown_intr(device_t dev, device_t child,
217 struct resource *irq, void *cookie);
218 int bus_generic_write_ivar(device_t dev, device_t child, int which,
222 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
223 u_long, u_long, u_long, u_int);
224 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
225 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
227 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
229 int bus_generic_rl_release_resource (device_t, device_t, int, int,
233 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
236 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
237 u_long start, u_long end, u_long count,
239 int bus_activate_resource(device_t dev, int type, int rid,
241 int bus_deactivate_resource(device_t dev, int type, int rid,
243 int bus_disable_intr(device_t dev, void *cookie);
244 void bus_enable_intr(device_t dev, void *cookie);
245 int bus_release_resource(device_t dev, int type, int rid,
247 int bus_setup_intr(device_t dev, struct resource *r, int flags,
248 driver_intr_t handler, void *arg,
249 void **cookiep, lwkt_serialize_t serializer);
250 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
251 int bus_set_resource(device_t dev, int type, int rid,
252 u_long start, u_long count);
253 int bus_get_resource(device_t dev, int type, int rid,
254 u_long *startp, u_long *countp);
255 u_long bus_get_resource_start(device_t dev, int type, int rid);
256 u_long bus_get_resource_count(device_t dev, int type, int rid);
257 void bus_delete_resource(device_t dev, int type, int rid);
258 int bus_child_present(device_t child);
259 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
260 int bus_child_location_str(device_t child, char *buf, size_t buflen);
262 static __inline struct resource *
263 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
265 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
269 * Access functions for device.
271 device_t device_add_child(device_t dev, const char *name, int unit);
272 device_t device_add_child_ordered(device_t dev, int order,
273 const char *name, int unit);
274 void device_busy(device_t dev);
275 int device_delete_child(device_t dev, device_t child);
276 int device_detach(device_t dev);
277 void device_disable(device_t dev);
278 void device_enable(device_t dev);
279 device_t device_find_child(device_t dev, const char *classname,
281 const char *device_get_desc(device_t dev);
282 devclass_t device_get_devclass(device_t dev);
283 driver_t *device_get_driver(device_t dev);
284 u_int32_t device_get_flags(device_t dev);
285 device_t device_get_parent(device_t dev);
286 int device_get_children(device_t dev, device_t **listp, int *countp);
287 void *device_get_ivars(device_t dev);
288 void device_set_ivars(device_t dev, void *ivars);
289 const char *device_get_name(device_t dev);
290 const char *device_get_nameunit(device_t dev);
291 void *device_get_softc(device_t dev);
292 device_state_t device_get_state(device_t dev);
293 int device_get_unit(device_t dev);
294 int device_is_alive(device_t dev); /* did probe succeed? */
295 int device_is_attached(device_t dev); /* did attach succeed? */
296 int device_is_enabled(device_t dev);
297 int device_is_quiet(device_t dev);
298 int device_print_prettyname(device_t dev);
299 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
300 int device_probe_and_attach(device_t dev);
301 void device_quiet(device_t dev);
302 void device_set_desc(device_t dev, const char* desc);
303 void device_set_desc_copy(device_t dev, const char* desc);
304 int device_set_devclass(device_t dev, const char *classname);
305 int device_set_driver(device_t dev, driver_t *driver);
306 void device_set_flags(device_t dev, u_int32_t flags);
307 void device_set_softc(device_t dev, void *softc);
308 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
309 int device_shutdown(device_t dev);
310 void device_unbusy(device_t dev);
311 void device_verbose(device_t dev);
314 * Access functions for devclass.
316 int devclass_add_driver(devclass_t dc, kobj_class_t driver);
317 int devclass_delete_driver(devclass_t dc, kobj_class_t driver);
318 devclass_t devclass_create(const char *classname);
319 devclass_t devclass_find(const char *classname);
320 device_t devclass_find_unit(const char *classname, int unit);
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_ */