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
33 * Interface information structure.
36 int ub_version; /* interface version */
37 #define BUS_USER_VERSION 1
38 int ub_generation; /* generation count */
42 * Device information exported to userspace.
50 char dv_drivername[32];
51 /* XXX more driver info? */
56 #include <sys/queue.h>
60 * Forward declarations
62 typedef struct device *device_t;
63 typedef struct driver driver_t;
64 typedef struct devclass *devclass_t;
65 #define device_method_t kobj_method_t
67 typedef void driver_intr_t(void*);
70 * Interrupt type bits. These flags are used both by newbus interrupt
71 * registration (nexus.c) and also in struct intrec, which defines
72 * interrupt properties.
74 * XXX We should probably revisit this and remove the vestiges of the
75 * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't
76 * confuse things by renaming them (Grog, 18 July 2000).
78 * We define this in terms of bits because some devices may belong
79 * to multiple classes (and therefore need to be included in
80 * multiple interrupt masks, which is what this really serves to
81 * indicate. Buses which do interrupt remapping will want to
82 * change their type to reflect what sort of devices are underneath.
90 INTR_HEAVY = 32, /* heavyweight interrupt process */
91 INTR_LIGHT = 64, /* light weight interrupt thread */
92 INTR_THREADED = INTR_LIGHT | INTR_HEAVY, /* any kind of interrupt thread */
94 INTR_EXCL = 256, /* exclusive interrupt */
95 INTR_MPSAFE = 512 /* this interrupt is SMP safe */
98 typedef int (*devop_t)(void);
102 void *priv; /* driver private data */
105 typedef enum device_state {
106 DS_NOTPRESENT, /* not probed or probe failed */
107 DS_ALIVE, /* probe succeeded */
108 DS_ATTACHED, /* attach method called */
109 DS_BUSY /* device is open */
113 * Definitions for drivers which need to keep simple lists of resources
114 * for their child devices.
118 struct resource_list_entry {
119 SLIST_ENTRY(resource_list_entry) link;
120 int type; /* type argument to alloc_resource */
121 int rid; /* resource identifier */
122 struct resource *res; /* the real resource when allocated */
123 u_long start; /* start of resource range */
124 u_long end; /* end of resource range */
125 u_long count; /* count within range */
127 SLIST_HEAD(resource_list, resource_list_entry);
130 * Initialise a resource list.
132 void resource_list_init(struct resource_list *rl);
135 * Reclaim memory used by a resource list.
137 void resource_list_free(struct resource_list *rl);
140 * Add a resource entry or modify an existing entry if one exists with
141 * the same type and rid.
143 void resource_list_add(struct resource_list *rl,
145 u_long start, u_long end, u_long count);
148 * Find a resource entry by type and rid.
150 struct resource_list_entry*
151 resource_list_find(struct resource_list *rl,
155 * Delete a resource entry.
157 void resource_list_delete(struct resource_list *rl,
161 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
162 * and passing the allocation up to the parent of bus. This assumes
163 * that the first entry of device_get_ivars(child) is a struct
164 * resource_list. This also handles 'passthrough' allocations where a
165 * child is a remote descendant of bus by passing the allocation up to
169 resource_list_alloc(struct resource_list *rl,
170 device_t bus, device_t child,
172 u_long start, u_long end,
173 u_long count, u_int flags);
176 * Implement BUS_RELEASE_RESOURCE.
178 int resource_list_release(struct resource_list *rl,
179 device_t bus, device_t child,
180 int type, int rid, struct resource *res);
183 * The root bus, to which all top-level busses are attached.
185 extern device_t root_bus;
186 extern devclass_t root_devclass;
187 void root_bus_configure(void);
190 * Useful functions for implementing busses.
193 int bus_generic_activate_resource(device_t dev, device_t child, int type,
194 int rid, struct resource *r);
196 bus_generic_alloc_resource(device_t bus, device_t child,
198 u_long start, u_long end,
199 u_long count, u_int flags);
200 int bus_generic_attach(device_t dev);
201 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
202 int rid, struct resource *r);
203 int bus_generic_detach(device_t dev);
204 void bus_generic_driver_added(device_t dev, driver_t *driver);
205 struct resource_list *
206 bus_generic_get_resource_list (device_t, device_t);
207 int bus_print_child_header(device_t dev, device_t child);
208 int bus_print_child_footer(device_t dev, device_t child);
209 int bus_generic_print_child(device_t dev, device_t child);
210 int bus_generic_probe(device_t dev);
211 int bus_generic_read_ivar(device_t dev, device_t child, int which,
213 int bus_generic_release_resource(device_t bus, device_t child,
214 int type, int rid, struct resource *r);
215 int bus_generic_resume(device_t dev);
216 int bus_generic_setup_intr(device_t dev, device_t child,
217 struct resource *irq, int flags,
218 driver_intr_t *intr, void *arg, void **cookiep);
221 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
222 u_long, u_long, u_long, u_int);
223 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
224 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
226 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
228 int bus_generic_rl_release_resource (device_t, device_t, int, int,
231 int bus_generic_shutdown(device_t dev);
232 int bus_generic_suspend(device_t dev);
233 int bus_generic_teardown_intr(device_t dev, device_t child,
234 struct resource *irq, void *cookie);
235 int bus_generic_write_ivar(device_t dev, device_t child, int which,
239 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
242 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
243 u_long start, u_long end, u_long count,
245 int bus_activate_resource(device_t dev, int type, int rid,
247 int bus_deactivate_resource(device_t dev, int type, int rid,
249 int bus_release_resource(device_t dev, int type, int rid,
251 int bus_setup_intr(device_t dev, struct resource *r, int flags,
252 driver_intr_t handler, void *arg, void **cookiep);
253 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
254 int bus_set_resource(device_t dev, int type, int rid,
255 u_long start, u_long count);
256 int bus_get_resource(device_t dev, int type, int rid,
257 u_long *startp, u_long *countp);
258 u_long bus_get_resource_start(device_t dev, int type, int rid);
259 u_long bus_get_resource_count(device_t dev, int type, int rid);
260 void bus_delete_resource(device_t dev, int type, int rid);
263 * Access functions for device.
265 device_t device_add_child(device_t dev, const char *name, int unit);
266 device_t device_add_child_ordered(device_t dev, int order,
267 const char *name, int unit);
268 void device_busy(device_t dev);
269 int device_delete_child(device_t dev, device_t child);
270 int device_detach(device_t dev);
271 void device_disable(device_t dev);
272 void device_enable(device_t dev);
273 device_t device_find_child(device_t dev, const char *classname,
275 const char *device_get_desc(device_t dev);
276 devclass_t device_get_devclass(device_t dev);
277 driver_t *device_get_driver(device_t dev);
278 u_int32_t device_get_flags(device_t dev);
279 device_t device_get_parent(device_t dev);
280 int device_get_children(device_t dev, device_t **listp, int *countp);
281 void *device_get_ivars(device_t dev);
282 void device_set_ivars(device_t dev, void *ivars);
283 const char *device_get_name(device_t dev);
284 const char *device_get_nameunit(device_t dev);
285 void *device_get_softc(device_t dev);
286 device_state_t device_get_state(device_t dev);
287 int device_get_unit(device_t dev);
288 int device_is_alive(device_t dev); /* did probe succeed? */
289 int device_is_enabled(device_t dev);
290 int device_is_quiet(device_t dev);
291 int device_print_prettyname(device_t dev);
292 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
293 int device_probe_and_attach(device_t dev);
294 void device_quiet(device_t dev);
295 void device_set_desc(device_t dev, const char* desc);
296 void device_set_desc_copy(device_t dev, const char* desc);
297 int device_set_devclass(device_t dev, const char *classname);
298 int device_set_driver(device_t dev, driver_t *driver);
299 void device_set_flags(device_t dev, u_int32_t flags);
300 void device_set_softc(device_t dev, void *softc);
301 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
302 int device_shutdown(device_t dev);
303 void device_unbusy(device_t dev);
304 void device_verbose(device_t dev);
307 * Access functions for devclass.
309 int devclass_add_driver(devclass_t dc, driver_t *driver);
310 int devclass_delete_driver(devclass_t dc, driver_t *driver);
311 devclass_t devclass_create(const char *classname);
312 devclass_t devclass_find(const char *classname);
313 driver_t *devclass_find_driver(devclass_t dc, const char *classname);
314 const char *devclass_get_name(devclass_t dc);
315 device_t devclass_get_device(devclass_t dc, int unit);
316 void *devclass_get_softc(devclass_t dc, int unit);
317 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
318 int devclass_get_maxunit(devclass_t dc);
321 * Access functions for device resources.
324 int resource_int_value(const char *name, int unit, const char *resname,
326 int resource_long_value(const char *name, int unit, const char *resname,
328 int resource_string_value(const char *name, int unit, const char *resname,
330 int resource_query_string(int i, const char *resname, const char *value);
331 char *resource_query_name(int i);
332 int resource_query_unit(int i);
333 int resource_locate(int i, const char *resname);
334 int resource_set_int(const char *name, int unit, const char *resname,
336 int resource_set_long(const char *name, int unit, const char *resname,
338 int resource_set_string(const char *name, int unit, const char *resname,
340 int resource_count(void);
343 * Functions for maintaining and checking consistency of
344 * bus information exported to userspace.
346 extern int bus_data_generation_check(int generation);
347 extern void bus_data_generation_update(void);
350 * Shorthand for constructing method tables.
352 #define DEVMETHOD KOBJMETHOD
355 * Some common device interfaces.
357 #include "device_if.h"
362 int driver_module_handler(struct module *, int, void *);
365 * Module support for automatically adding drivers to busses.
367 struct driver_module_data {
368 int (*dmd_chainevh)(struct module *, int, void *);
370 const char *dmd_busname;
371 driver_t **dmd_drivers;
373 devclass_t *dmd_devclass;
376 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
378 static driver_t *name##_##busname##_driver_list[] = { &driver }; \
379 static struct driver_module_data name##_##busname##_driver_mod = { \
382 name##_##busname##_driver_list, \
383 (sizeof name##_##busname##_driver_list) / \
384 (sizeof name##_##busname##_driver_list[0]), \
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)
396 #define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \
398 static driver_t name##_##busname##_driver_list[] = drivers; \
399 static struct driver_module_data name##_##busname##_driver_mod = { \
402 name##_##busname##_driver_list, \
403 (sizeof name##_##busname##_driver_list) / \
404 (sizeof name##_##busname##_driver_list[0]), \
408 static moduledata_t name##_##busname##_mod = { \
409 #busname "/" #name, \
410 driver_module_handler, \
411 &name##_##busname##_driver_mod \
413 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
414 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
418 #endif /* !_SYS_BUS_H_ */