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
34 #include <sys/queue.h>
37 * Forward declarations
39 typedef struct device *device_t;
40 typedef struct driver driver_t;
41 typedef struct device_method device_method_t;
42 typedef struct devclass *devclass_t;
43 typedef struct device_ops *device_ops_t;
44 typedef struct device_op_desc *device_op_desc_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.
64 typedef int (*devop_t)(void);
66 struct device_method {
67 device_op_desc_t desc;
72 const char *name; /* driver name */
73 device_method_t *methods; /* method table */
74 size_t softc; /* size of device softc struct */
75 void *priv; /* driver private data */
76 device_ops_t ops; /* compiled method table */
77 int refs; /* # devclasses containing driver */
80 typedef enum device_state {
81 DS_NOTPRESENT, /* not probed or probe failed */
82 DS_ALIVE, /* probe succeeded */
83 DS_ATTACHED, /* attach method called */
84 DS_BUSY /* device is open */
88 * Definitions for drivers which need to keep simple lists of resources
89 * for their child devices.
93 struct resource_list_entry {
94 SLIST_ENTRY(resource_list_entry) link;
95 int type; /* type argument to alloc_resource */
96 int rid; /* resource identifier */
97 struct resource *res; /* the real resource when allocated */
98 u_long start; /* start of resource range */
99 u_long end; /* end of resource range */
100 u_long count; /* count within range */
102 SLIST_HEAD(resource_list, resource_list_entry);
105 * Initialise a resource list.
107 void resource_list_init(struct resource_list *rl);
110 * Reclaim memory used by a resource list.
112 void resource_list_free(struct resource_list *rl);
115 * Add a resource entry or modify an existing entry if one exists with
116 * the same type and rid.
118 void resource_list_add(struct resource_list *rl,
120 u_long start, u_long end, u_long count);
123 * Find a resource entry by type and rid.
125 struct resource_list_entry*
126 resource_list_find(struct resource_list *rl,
130 * Delete a resource entry.
132 void resource_list_delete(struct resource_list *rl,
136 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
137 * and passing the allocation up to the parent of bus. This assumes
138 * that the first entry of device_get_ivars(child) is a struct
139 * resource_list. This also handles 'passthrough' allocations where a
140 * child is a remote descendant of bus by passing the allocation up to
144 resource_list_alloc(struct resource_list *rl,
145 device_t bus, device_t child,
147 u_long start, u_long end,
148 u_long count, u_int flags);
151 * Implement BUS_RELEASE_RESOURCE.
153 int resource_list_release(struct resource_list *rl,
154 device_t bus, device_t child,
155 int type, int rid, struct resource *res);
158 * The root bus, to which all top-level busses are attached.
160 extern device_t root_bus;
161 extern devclass_t root_devclass;
162 void root_bus_configure(void);
165 * Useful functions for implementing busses.
168 int bus_generic_activate_resource(device_t dev, device_t child, int type,
169 int rid, struct resource *r);
170 struct resource *bus_generic_alloc_resource(device_t bus, device_t child,
172 u_long start, u_long end,
173 u_long count, u_int flags);
174 int bus_generic_attach(device_t dev);
175 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
176 int rid, struct resource *r);
177 int bus_generic_detach(device_t dev);
178 void bus_generic_driver_added(device_t dev, driver_t *driver);
179 int bus_print_child_header(device_t dev, device_t child);
180 int bus_print_child_footer(device_t dev, device_t child);
181 int bus_generic_print_child(device_t dev, device_t child);
182 int bus_generic_probe(device_t dev);
183 int bus_generic_read_ivar(device_t dev, device_t child, int which,
185 int bus_generic_release_resource(device_t bus, device_t child,
186 int type, int rid, struct resource *r);
187 int bus_generic_resume(device_t dev);
188 int bus_generic_setup_intr(device_t dev, device_t child,
189 struct resource *irq, int flags,
190 driver_intr_t *intr, void *arg, void **cookiep);
191 int bus_generic_shutdown(device_t dev);
192 int bus_generic_suspend(device_t dev);
193 int bus_generic_teardown_intr(device_t dev, device_t child,
194 struct resource *irq, void *cookie);
195 int bus_generic_write_ivar(device_t dev, device_t child, int which,
199 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
202 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
203 u_long start, u_long end, u_long count,
205 int bus_activate_resource(device_t dev, int type, int rid,
207 int bus_deactivate_resource(device_t dev, int type, int rid,
209 int bus_release_resource(device_t dev, int type, int rid,
211 int bus_setup_intr(device_t dev, struct resource *r, int flags,
212 driver_intr_t handler, void *arg, void **cookiep);
213 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
214 int bus_set_resource(device_t dev, int type, int rid,
215 u_long start, u_long count);
216 int bus_get_resource(device_t dev, int type, int rid,
217 u_long *startp, u_long *countp);
218 u_long bus_get_resource_start(device_t dev, int type, int rid);
219 u_long bus_get_resource_count(device_t dev, int type, int rid);
220 void bus_delete_resource(device_t dev, int type, int rid);
223 * Access functions for device.
225 device_t device_add_child(device_t dev, const char *name, int unit);
226 device_t device_add_child_ordered(device_t dev, int order,
227 const char *name, int unit);
228 void device_busy(device_t dev);
229 int device_delete_child(device_t dev, device_t child);
230 int device_detach(device_t dev);
231 void device_disable(device_t dev);
232 void device_enable(device_t dev);
233 device_t device_find_child(device_t dev, const char *classname,
235 const char *device_get_desc(device_t dev);
236 devclass_t device_get_devclass(device_t dev);
237 driver_t *device_get_driver(device_t dev);
238 u_int32_t device_get_flags(device_t dev);
239 device_t device_get_parent(device_t dev);
240 int device_get_children(device_t dev, device_t **listp, int *countp);
241 void *device_get_ivars(device_t dev);
242 void device_set_ivars(device_t dev, void *ivars);
243 const char *device_get_name(device_t dev);
244 const char *device_get_nameunit(device_t dev);
245 void *device_get_softc(device_t dev);
246 device_state_t device_get_state(device_t dev);
247 int device_get_unit(device_t dev);
248 int device_is_alive(device_t dev); /* did probe succeed? */
249 int device_is_enabled(device_t dev);
250 int device_is_quiet(device_t dev);
251 int device_print_prettyname(device_t dev);
252 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
253 int device_probe_and_attach(device_t dev);
254 void device_quiet(device_t dev);
255 void device_set_desc(device_t dev, const char* desc);
256 void device_set_desc_copy(device_t dev, const char* desc);
257 int device_set_devclass(device_t dev, const char *classname);
258 int device_set_driver(device_t dev, driver_t *driver);
259 void device_set_flags(device_t dev, u_int32_t flags);
260 int device_shutdown(device_t dev);
261 void device_unbusy(device_t dev);
262 void device_verbose(device_t dev);
265 * Access functions for devclass.
267 int devclass_add_driver(devclass_t dc, driver_t *driver);
268 int devclass_delete_driver(devclass_t dc, driver_t *driver);
269 devclass_t devclass_create(const char *classname);
270 devclass_t devclass_find(const char *classname);
271 driver_t *devclass_find_driver(devclass_t dc, const char *classname);
272 const char *devclass_get_name(devclass_t dc);
273 device_t devclass_get_device(devclass_t dc, int unit);
274 void *devclass_get_softc(devclass_t dc, int unit);
275 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
276 int devclass_get_maxunit(devclass_t dc);
279 * Access functions for device resources.
282 int resource_int_value(const char *name, int unit, const char *resname,
284 int resource_long_value(const char *name, int unit, const char *resname,
286 int resource_string_value(const char *name, int unit, const char *resname,
288 int resource_query_string(int i, const char *resname, const char *value);
289 char *resource_query_name(int i);
290 int resource_query_unit(int i);
291 int resource_locate(int i, const char *resname);
292 int resource_set_int(const char *name, int unit, const char *resname,
294 int resource_set_long(const char *name, int unit, const char *resname,
296 int resource_set_string(const char *name, int unit, const char *resname,
298 int resource_count(void);
301 * Shorthand for constructing method tables.
303 #define DEVMETHOD(NAME, FUNC) { &NAME##_desc, (devop_t) FUNC }
306 * Some common device interfaces.
308 #include "device_if.h"
313 int driver_module_handler(struct module *, int, void *);
316 * Module support for automatically adding drivers to busses.
318 struct driver_module_data {
319 int (*dmd_chainevh)(struct module *, int, void *);
321 const char *dmd_busname;
322 driver_t **dmd_drivers;
324 devclass_t *dmd_devclass;
327 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
329 static driver_t *name##_##busname##_driver_list[] = { &driver }; \
330 static struct driver_module_data name##_##busname##_driver_mod = { \
333 name##_##busname##_driver_list, \
334 (sizeof name##_##busname##_driver_list) / \
335 (sizeof name##_##busname##_driver_list[0]), \
339 static moduledata_t name##_##busname##_mod = { \
340 #busname "/" #name, \
341 driver_module_handler, \
342 &name##_##busname##_driver_mod \
344 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
345 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
347 #define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \
349 static driver_t name##_##busname##_driver_list[] = drivers; \
350 static struct driver_module_data name##_##busname##_driver_mod = { \
353 name##_##busname##_driver_list, \
354 (sizeof name##_##busname##_driver_list) / \
355 (sizeof name##_##busname##_driver_list[0]), \
359 static moduledata_t name##_##busname##_mod = { \
360 #busname "/" #name, \
361 driver_module_handler, \
362 &name##_##busname##_driver_mod \
364 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
365 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
369 #endif /* !_SYS_BUS_H_ */