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.
92 INTR_EXCL = 256, /* exclusive interrupt */
93 INTR_MPSAFE = 512, /* this interrupt is SMP safe */
94 INTR_ENTROPY = 1024 /* this interrupt provides entropy */
97 typedef int (*devop_t)(void);
101 void *priv; /* driver private data */
104 typedef enum device_state {
105 DS_NOTPRESENT, /* not probed or probe failed */
106 DS_ALIVE, /* probe succeeded */
107 DS_ATTACHED, /* attach method called */
108 DS_BUSY /* device is open */
112 * Definitions for drivers which need to keep simple lists of resources
113 * for their child devices.
117 struct resource_list_entry {
118 SLIST_ENTRY(resource_list_entry) link;
119 int type; /* type argument to alloc_resource */
120 int rid; /* resource identifier */
121 struct resource *res; /* the real resource when allocated */
122 u_long start; /* start of resource range */
123 u_long end; /* end of resource range */
124 u_long count; /* count within range */
126 SLIST_HEAD(resource_list, resource_list_entry);
129 * Initialise a resource list.
131 void resource_list_init(struct resource_list *rl);
134 * Reclaim memory used by a resource list.
136 void resource_list_free(struct resource_list *rl);
139 * Add a resource entry or modify an existing entry if one exists with
140 * the same type and rid.
142 void resource_list_add(struct resource_list *rl,
144 u_long start, u_long end, u_long count);
147 * Find a resource entry by type and rid.
149 struct resource_list_entry*
150 resource_list_find(struct resource_list *rl,
154 * Delete a resource entry.
156 void resource_list_delete(struct resource_list *rl,
160 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
161 * and passing the allocation up to the parent of bus. This assumes
162 * that the first entry of device_get_ivars(child) is a struct
163 * resource_list. This also handles 'passthrough' allocations where a
164 * child is a remote descendant of bus by passing the allocation up to
168 resource_list_alloc(struct resource_list *rl,
169 device_t bus, device_t child,
171 u_long start, u_long end,
172 u_long count, u_int flags);
175 * Implement BUS_RELEASE_RESOURCE.
177 int resource_list_release(struct resource_list *rl,
178 device_t bus, device_t child,
179 int type, int rid, struct resource *res);
182 * The root bus, to which all top-level busses are attached.
184 extern device_t root_bus;
185 extern devclass_t root_devclass;
186 void root_bus_configure(void);
189 * Useful functions for implementing busses.
192 int bus_generic_activate_resource(device_t dev, device_t child, int type,
193 int rid, struct resource *r);
195 bus_generic_alloc_resource(device_t bus, device_t child, int type,
196 int *rid, u_long start, u_long end,
197 u_long count, u_int flags);
198 int bus_generic_attach(device_t dev);
199 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
200 int rid, struct resource *r);
201 int bus_generic_detach(device_t dev);
202 void bus_generic_driver_added(device_t dev, driver_t *driver);
203 struct resource_list *
204 bus_generic_get_resource_list (device_t, device_t);
205 int bus_print_child_header(device_t dev, device_t child);
206 int bus_print_child_footer(device_t dev, device_t child);
207 int bus_generic_print_child(device_t dev, device_t child);
208 int bus_generic_probe(device_t dev);
209 int bus_generic_read_ivar(device_t dev, device_t child, int which,
211 int bus_generic_release_resource(device_t bus, device_t child,
212 int type, int rid, struct resource *r);
213 int bus_generic_resume(device_t dev);
214 int bus_generic_setup_intr(device_t dev, device_t child,
215 struct resource *irq, int flags,
216 driver_intr_t *intr, void *arg, void **cookiep);
219 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
220 u_long, u_long, u_long, u_int);
221 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
222 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
224 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
226 int bus_generic_rl_release_resource (device_t, device_t, int, int,
229 int bus_generic_shutdown(device_t dev);
230 int bus_generic_suspend(device_t dev);
231 int bus_generic_teardown_intr(device_t dev, device_t child,
232 struct resource *irq, void *cookie);
233 int bus_generic_write_ivar(device_t dev, device_t child, int which,
237 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
240 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
241 u_long start, u_long end, u_long count,
243 int bus_activate_resource(device_t dev, int type, int rid,
245 int bus_deactivate_resource(device_t dev, int type, int rid,
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);
261 * Access functions for device.
263 device_t device_add_child(device_t dev, const char *name, int unit);
264 device_t device_add_child_ordered(device_t dev, int order,
265 const char *name, int unit);
266 void device_busy(device_t dev);
267 int device_delete_child(device_t dev, device_t child);
268 int device_detach(device_t dev);
269 void device_disable(device_t dev);
270 void device_enable(device_t dev);
271 device_t device_find_child(device_t dev, const char *classname,
273 const char *device_get_desc(device_t dev);
274 devclass_t device_get_devclass(device_t dev);
275 driver_t *device_get_driver(device_t dev);
276 u_int32_t device_get_flags(device_t dev);
277 device_t device_get_parent(device_t dev);
278 int device_get_children(device_t dev, device_t **listp, int *countp);
279 void *device_get_ivars(device_t dev);
280 void device_set_ivars(device_t dev, void *ivars);
281 const char *device_get_name(device_t dev);
282 const char *device_get_nameunit(device_t dev);
283 void *device_get_softc(device_t dev);
284 device_state_t device_get_state(device_t dev);
285 int device_get_unit(device_t dev);
286 int device_is_alive(device_t dev); /* did probe succeed? */
287 int device_is_enabled(device_t dev);
288 int device_is_quiet(device_t dev);
289 int device_print_prettyname(device_t dev);
290 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
291 int device_probe_and_attach(device_t dev);
292 void device_quiet(device_t dev);
293 void device_set_desc(device_t dev, const char* desc);
294 void device_set_desc_copy(device_t dev, const char* desc);
295 int device_set_devclass(device_t dev, const char *classname);
296 int device_set_driver(device_t dev, driver_t *driver);
297 void device_set_flags(device_t dev, u_int32_t flags);
298 void device_set_softc(device_t dev, void *softc);
299 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
300 int device_shutdown(device_t dev);
301 void device_unbusy(device_t dev);
302 void device_verbose(device_t dev);
305 * Access functions for devclass.
307 int devclass_add_driver(devclass_t dc, driver_t *driver);
308 int devclass_delete_driver(devclass_t dc, driver_t *driver);
309 devclass_t devclass_create(const char *classname);
310 devclass_t devclass_find(const char *classname);
311 driver_t *devclass_find_driver(devclass_t dc, const char *classname);
312 const char *devclass_get_name(devclass_t dc);
313 device_t devclass_get_device(devclass_t dc, int unit);
314 void *devclass_get_softc(devclass_t dc, int unit);
315 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
316 int devclass_get_maxunit(devclass_t dc);
319 * Access functions for device resources.
322 int resource_int_value(const char *name, int unit, const char *resname,
324 int resource_long_value(const char *name, int unit, const char *resname,
326 int resource_string_value(const char *name, int unit, const char *resname,
327 const char **result);
328 int resource_find_match(int *anchor, const char **name, int *unit,
329 const char *resname, const char *value);
330 int resource_find_dev(int *anchor, const char *name, int *unit,
331 const char *resname, const char *value);
332 int resource_set_int(const char *name, int unit, const char *resname,
334 int resource_set_long(const char *name, int unit, const char *resname,
336 int resource_set_string(const char *name, int unit, const char *resname,
339 * Functions for maintaining and checking consistency of
340 * bus information exported to userspace.
342 int bus_data_generation_check(int generation);
343 void bus_data_generation_update(void);
346 * Shorthand for constructing method tables.
348 #define DEVMETHOD KOBJMETHOD
351 * Some common device interfaces.
353 #include "device_if.h"
358 int driver_module_handler(struct module *, int, void *);
361 * Module support for automatically adding drivers to busses.
363 struct driver_module_data {
364 int (*dmd_chainevh)(struct module *, int, void *);
366 const char *dmd_busname;
367 driver_t **dmd_drivers;
369 devclass_t *dmd_devclass;
372 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
374 static driver_t *name##_##busname##_driver_list[] = { &driver }; \
375 static struct driver_module_data name##_##busname##_driver_mod = { \
378 name##_##busname##_driver_list, \
379 (sizeof name##_##busname##_driver_list) / \
380 (sizeof name##_##busname##_driver_list[0]), \
384 static moduledata_t name##_##busname##_mod = { \
385 #busname "/" #name, \
386 driver_module_handler, \
387 &name##_##busname##_driver_mod \
389 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
390 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
392 #define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \
394 static driver_t name##_##busname##_driver_list[] = drivers; \
395 static struct driver_module_data name##_##busname##_driver_mod = { \
398 name##_##busname##_driver_list, \
399 (sizeof name##_##busname##_driver_list) / \
400 (sizeof name##_##busname##_driver_list[0]), \
404 static moduledata_t name##_##busname##_mod = { \
405 #busname "/" #name, \
406 driver_module_handler, \
407 &name##_##busname##_driver_mod \
409 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
410 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
414 #endif /* !_SYS_BUS_H_ */