- kill `unused variable' warning pointed out by sephe@
[dragonfly.git] / sys / sys / bus.h
CommitLineData
984263bc
MD
1/*-
2 * Copyright (c) 1997,1998 Doug Rabson
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 *
07d2fd35 26 * $FreeBSD: src/sys/sys/bus.h,v 1.30.2.5 2004/03/17 17:54:25 njl Exp $
39b5d600 27 * $DragonFly: src/sys/sys/bus.h,v 1.17 2005/10/28 03:25:57 dillon Exp $
984263bc
MD
28 */
29
30#ifndef _SYS_BUS_H_
31#define _SYS_BUS_H_
32
33#ifdef _KERNEL
34
35#include <sys/queue.h>
80eff43d 36#include <sys/kobj.h>
e9cb6d99 37#include <sys/serialize.h>
984263bc
MD
38
39/*
40 * Forward declarations
41 */
42typedef struct device *device_t;
e1bc6fbb 43typedef struct kobj_class driver_t;
984263bc 44typedef struct devclass *devclass_t;
80eff43d 45#define device_method_t kobj_method_t
984263bc
MD
46
47typedef void driver_intr_t(void*);
48
49/*
ee61f228
MD
50 * Interrupt features mask. Note that DragonFly no longer implements
51 * INTR_TYPE_* flags.
984263bc 52 */
ee61f228
MD
53#define INTR_FAST 0x0080
54#define INTR_EXCL 0x0100
55#define INTR_MPSAFE 0x0200
56#define INTR_ENTROPY 0x0400
477d3c1c 57#define INTR_NOPOLL 0x0800 /* interrupt cannot be polled (e.g. ata) */
bbe77fc3 58
e126caf1
MD
59enum intr_trigger {
60 INTR_TRIGGER_CONFORM = 0,
61 INTR_TRIGGER_EDGE = 1,
62 INTR_TRIGGER_LEVEL = 2
63};
64
65enum intr_polarity {
66 INTR_POLARITY_CONFORM = 0,
67 INTR_POLARITY_HIGH = 1,
68 INTR_POLARITY_LOW = 2
984263bc 69};
984263bc
MD
70
71typedef int (*devop_t)(void);
72
984263bc
MD
73typedef enum device_state {
74 DS_NOTPRESENT, /* not probed or probe failed */
75 DS_ALIVE, /* probe succeeded */
76 DS_ATTACHED, /* attach method called */
77 DS_BUSY /* device is open */
78} device_state_t;
79
80/*
81 * Definitions for drivers which need to keep simple lists of resources
82 * for their child devices.
83 */
84struct resource;
85
86struct resource_list_entry {
87 SLIST_ENTRY(resource_list_entry) link;
88 int type; /* type argument to alloc_resource */
89 int rid; /* resource identifier */
90 struct resource *res; /* the real resource when allocated */
91 u_long start; /* start of resource range */
92 u_long end; /* end of resource range */
93 u_long count; /* count within range */
94};
95SLIST_HEAD(resource_list, resource_list_entry);
96
97/*
98 * Initialise a resource list.
99 */
100void resource_list_init(struct resource_list *rl);
101
102/*
103 * Reclaim memory used by a resource list.
104 */
105void resource_list_free(struct resource_list *rl);
106
107/*
108 * Add a resource entry or modify an existing entry if one exists with
109 * the same type and rid.
110 */
111void resource_list_add(struct resource_list *rl,
112 int type, int rid,
113 u_long start, u_long end, u_long count);
114
115/*
116 * Find a resource entry by type and rid.
117 */
118struct resource_list_entry*
119 resource_list_find(struct resource_list *rl,
120 int type, int rid);
121
122/*
123 * Delete a resource entry.
124 */
125void resource_list_delete(struct resource_list *rl,
126 int type, int rid);
127
128/*
129 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
130 * and passing the allocation up to the parent of bus. This assumes
131 * that the first entry of device_get_ivars(child) is a struct
132 * resource_list. This also handles 'passthrough' allocations where a
133 * child is a remote descendant of bus by passing the allocation up to
134 * the parent of bus.
135 */
136struct resource *
137 resource_list_alloc(struct resource_list *rl,
138 device_t bus, device_t child,
139 int type, int *rid,
140 u_long start, u_long end,
141 u_long count, u_int flags);
142
143/*
144 * Implement BUS_RELEASE_RESOURCE.
145 */
146int resource_list_release(struct resource_list *rl,
147 device_t bus, device_t child,
148 int type, int rid, struct resource *res);
149
150/*
151 * Print all resources of a specified type, for use in bus_print_child.
152 * The name is printed if at least one resource of the given type is available.
153 * The format ist used to print resource start and end.
154 */
155int resource_list_print_type(struct resource_list *rl,
156 const char *name, int type,
157 const char *format);
158
159/*
160 * The root bus, to which all top-level busses are attached.
161 */
162extern device_t root_bus;
984263bc
MD
163void root_bus_configure(void);
164
165/*
166 * Useful functions for implementing busses.
167 */
168
169int bus_generic_activate_resource(device_t dev, device_t child, int type,
170 int rid, struct resource *r);
e126caf1
MD
171struct resource *
172 bus_generic_alloc_resource(device_t bus, device_t child,
173 int type, int *rid,
174 u_long start, u_long end,
175 u_long count, u_int flags);
176struct resource_list *
177 bus_generic_get_resource_list (device_t, device_t);
178
179int bus_generic_config_intr(device_t, int, enum intr_trigger,
180 enum intr_polarity);
984263bc 181int bus_generic_attach(device_t dev);
22457186 182int bus_generic_child_present(device_t dev, device_t child);
984263bc
MD
183int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
184 int rid, struct resource *r);
185int bus_generic_detach(device_t dev);
e9cb6d99 186int bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
984263bc 187void bus_generic_driver_added(device_t dev, driver_t *driver);
67a2436e 188void bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
984263bc
MD
189int bus_print_child_header(device_t dev, device_t child);
190int bus_print_child_footer(device_t dev, device_t child);
191int bus_generic_print_child(device_t dev, device_t child);
39b5d600
MD
192int bus_generic_identify(driver_t *driver, device_t parent);
193int bus_generic_identify_sameunit(driver_t *driver, device_t parent);
984263bc 194int bus_generic_probe(device_t dev);
39b5d600 195int bus_generic_probe_hack(device_t dev);
984263bc
MD
196int bus_generic_read_ivar(device_t dev, device_t child, int which,
197 uintptr_t *result);
198int bus_generic_release_resource(device_t bus, device_t child,
199 int type, int rid, struct resource *r);
200int bus_generic_resume(device_t dev);
201int bus_generic_setup_intr(device_t dev, device_t child,
202 struct resource *irq, int flags,
e9cb6d99
MD
203 driver_intr_t *intr, void *arg,
204 void **cookiep, lwkt_serialize_t serializer);
984263bc
MD
205int bus_generic_shutdown(device_t dev);
206int bus_generic_suspend(device_t dev);
207int bus_generic_teardown_intr(device_t dev, device_t child,
208 struct resource *irq, void *cookie);
209int bus_generic_write_ivar(device_t dev, device_t child, int which,
210 uintptr_t value);
211
e126caf1
MD
212struct resource *
213 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
214 u_long, u_long, u_long, u_int);
215void bus_generic_rl_delete_resource (device_t, device_t, int, int);
216int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
217 u_long *);
218int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
219 u_long);
220int bus_generic_rl_release_resource (device_t, device_t, int, int,
221 struct resource *);
222
984263bc
MD
223/*
224 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
225 * a little simpler.
226 */
227struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
228 u_long start, u_long end, u_long count,
229 u_int flags);
230int bus_activate_resource(device_t dev, int type, int rid,
231 struct resource *r);
232int bus_deactivate_resource(device_t dev, int type, int rid,
233 struct resource *r);
e9cb6d99 234int bus_disable_intr(device_t dev, void *cookie);
67a2436e 235void bus_enable_intr(device_t dev, void *cookie);
984263bc
MD
236int bus_release_resource(device_t dev, int type, int rid,
237 struct resource *r);
238int bus_setup_intr(device_t dev, struct resource *r, int flags,
e9cb6d99
MD
239 driver_intr_t handler, void *arg,
240 void **cookiep, lwkt_serialize_t serializer);
984263bc
MD
241int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
242int bus_set_resource(device_t dev, int type, int rid,
243 u_long start, u_long count);
244int bus_get_resource(device_t dev, int type, int rid,
245 u_long *startp, u_long *countp);
246u_long bus_get_resource_start(device_t dev, int type, int rid);
247u_long bus_get_resource_count(device_t dev, int type, int rid);
248void bus_delete_resource(device_t dev, int type, int rid);
cac6f3da
JS
249int bus_child_present(device_t child);
250int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
251int bus_child_location_str(device_t child, char *buf, size_t buflen);
984263bc 252
07d2fd35
HP
253static __inline struct resource *
254bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
255{
256 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
257}
258
984263bc
MD
259/*
260 * Access functions for device.
261 */
262device_t device_add_child(device_t dev, const char *name, int unit);
263device_t device_add_child_ordered(device_t dev, int order,
264 const char *name, int unit);
265void device_busy(device_t dev);
266int device_delete_child(device_t dev, device_t child);
267int device_detach(device_t dev);
268void device_disable(device_t dev);
269void device_enable(device_t dev);
270device_t device_find_child(device_t dev, const char *classname,
271 int unit);
272const char *device_get_desc(device_t dev);
273devclass_t device_get_devclass(device_t dev);
274driver_t *device_get_driver(device_t dev);
275u_int32_t device_get_flags(device_t dev);
276device_t device_get_parent(device_t dev);
277int device_get_children(device_t dev, device_t **listp, int *countp);
278void *device_get_ivars(device_t dev);
279void device_set_ivars(device_t dev, void *ivars);
280const char *device_get_name(device_t dev);
281const char *device_get_nameunit(device_t dev);
282void *device_get_softc(device_t dev);
283device_state_t device_get_state(device_t dev);
284int device_get_unit(device_t dev);
285int device_is_alive(device_t dev); /* did probe succeed? */
2140e77f 286int device_is_attached(device_t dev); /* did attach succeed? */
984263bc
MD
287int device_is_enabled(device_t dev);
288int device_is_quiet(device_t dev);
289int device_print_prettyname(device_t dev);
290int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
291int device_probe_and_attach(device_t dev);
292void device_quiet(device_t dev);
293void device_set_desc(device_t dev, const char* desc);
294void device_set_desc_copy(device_t dev, const char* desc);
295int device_set_devclass(device_t dev, const char *classname);
296int device_set_driver(device_t dev, driver_t *driver);
297void device_set_flags(device_t dev, u_int32_t flags);
298void device_set_softc(device_t dev, void *softc);
299int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
300int device_shutdown(device_t dev);
301void device_unbusy(device_t dev);
302void device_verbose(device_t dev);
303
304/*
305 * Access functions for devclass.
306 */
91a0c258
JS
307int devclass_add_driver(devclass_t dc, kobj_class_t driver);
308int devclass_delete_driver(devclass_t dc, kobj_class_t driver);
984263bc
MD
309devclass_t devclass_create(const char *classname);
310devclass_t devclass_find(const char *classname);
91a0c258 311kobj_class_t devclass_find_driver(devclass_t dc, const char *classname);
984263bc
MD
312const char *devclass_get_name(devclass_t dc);
313device_t devclass_get_device(devclass_t dc, int unit);
314void *devclass_get_softc(devclass_t dc, int unit);
315int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
316int devclass_get_maxunit(devclass_t dc);
91a0c258
JS
317void devclass_set_parent(devclass_t dc, devclass_t pdc);
318devclass_t devclass_get_parent(devclass_t dc);
984263bc
MD
319
320/*
321 * Access functions for device resources.
322 */
323
324int resource_int_value(const char *name, int unit, const char *resname,
325 int *result);
326int resource_long_value(const char *name, int unit, const char *resname,
327 long *result);
328int resource_string_value(const char *name, int unit, const char *resname,
329 char **result);
e126caf1 330int resource_disabled(const char *name, int unit);
984263bc
MD
331int resource_query_string(int i, const char *resname, const char *value);
332char *resource_query_name(int i);
333int resource_query_unit(int i);
334int resource_locate(int i, const char *resname);
335int resource_set_int(const char *name, int unit, const char *resname,
336 int value);
337int resource_set_long(const char *name, int unit, const char *resname,
338 long value);
339int resource_set_string(const char *name, int unit, const char *resname,
340 const char *value);
341int resource_count(void);
342
343/*
344 * Shorthand for constructing method tables.
345 */
80eff43d 346#define DEVMETHOD KOBJMETHOD
984263bc
MD
347
348/*
349 * Some common device interfaces.
350 */
351#include "device_if.h"
352#include "bus_if.h"
353
354struct module;
355
356int driver_module_handler(struct module *, int, void *);
357
358/*
359 * Module support for automatically adding drivers to busses.
360 */
361struct driver_module_data {
362 int (*dmd_chainevh)(struct module *, int, void *);
363 void *dmd_chainarg;
364 const char *dmd_busname;
91a0c258 365 kobj_class_t dmd_driver;
984263bc
MD
366 devclass_t *dmd_devclass;
367};
368
369#define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
370 \
984263bc
MD
371static struct driver_module_data name##_##busname##_driver_mod = { \
372 evh, arg, \
373 #busname, \
91a0c258 374 (kobj_class_t) &driver, \
984263bc
MD
375 &devclass \
376}; \
377 \
378static moduledata_t name##_##busname##_mod = { \
379 #busname "/" #name, \
380 driver_module_handler, \
381 &name##_##busname##_driver_mod \
382}; \
383DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
384 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
385
386#endif /* _KERNEL */
387
388#endif /* !_SYS_BUS_H_ */