Merge from FreeBSD 5:
[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 *
26 * $FreeBSD: src/sys/sys/bus.h,v 1.30.2.4 2002/10/10 15:13:33 jhb Exp $
bbe77fc3 27 * $DragonFly: src/sys/sys/bus.h,v 1.8 2004/02/23 21:23:41 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>
984263bc
MD
37
38/*
39 * Forward declarations
40 */
41typedef struct device *device_t;
42typedef struct driver driver_t;
984263bc 43typedef struct devclass *devclass_t;
80eff43d 44#define device_method_t kobj_method_t
984263bc
MD
45
46typedef void driver_intr_t(void*);
47
48/*
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.
54 */
55enum intr_type {
56 INTR_TYPE_TTY = 1,
57 INTR_TYPE_BIO = 2,
58 INTR_TYPE_NET = 4,
59 INTR_TYPE_CAM = 8,
60 INTR_TYPE_MISC = 16,
e126caf1
MD
61 INTR_TYPE_CLK = 32,
62 INTR_TYPE_AV = 64,
63 INTR_FAST = 128,
64 INTR_EXCL = 256,
65 INTR_MPSAFE = 512,
66 INTR_ENTROPY = 1024
67};
68
bbe77fc3
MD
69#define INTR_TYPE_MASK (INTR_TYPE_TTY|INTR_TYPE_BIO|INTR_TYPE_NET|\
70 INTR_TYPE_CAM|INTR_TYPE_MISC|INTR_TYPE_CLK|\
71 INTR_TYPE_AV)
72
e126caf1
MD
73enum intr_trigger {
74 INTR_TRIGGER_CONFORM = 0,
75 INTR_TRIGGER_EDGE = 1,
76 INTR_TRIGGER_LEVEL = 2
77};
78
79enum intr_polarity {
80 INTR_POLARITY_CONFORM = 0,
81 INTR_POLARITY_HIGH = 1,
82 INTR_POLARITY_LOW = 2
984263bc 83};
984263bc
MD
84
85typedef int (*devop_t)(void);
86
984263bc 87struct driver {
80eff43d 88 KOBJ_CLASS_FIELDS;
984263bc 89 void *priv; /* driver private data */
984263bc
MD
90};
91
92typedef enum device_state {
93 DS_NOTPRESENT, /* not probed or probe failed */
94 DS_ALIVE, /* probe succeeded */
95 DS_ATTACHED, /* attach method called */
96 DS_BUSY /* device is open */
97} device_state_t;
98
99/*
100 * Definitions for drivers which need to keep simple lists of resources
101 * for their child devices.
102 */
103struct resource;
104
105struct resource_list_entry {
106 SLIST_ENTRY(resource_list_entry) link;
107 int type; /* type argument to alloc_resource */
108 int rid; /* resource identifier */
109 struct resource *res; /* the real resource when allocated */
110 u_long start; /* start of resource range */
111 u_long end; /* end of resource range */
112 u_long count; /* count within range */
113};
114SLIST_HEAD(resource_list, resource_list_entry);
115
116/*
117 * Initialise a resource list.
118 */
119void resource_list_init(struct resource_list *rl);
120
121/*
122 * Reclaim memory used by a resource list.
123 */
124void resource_list_free(struct resource_list *rl);
125
126/*
127 * Add a resource entry or modify an existing entry if one exists with
128 * the same type and rid.
129 */
130void resource_list_add(struct resource_list *rl,
131 int type, int rid,
132 u_long start, u_long end, u_long count);
133
134/*
135 * Find a resource entry by type and rid.
136 */
137struct resource_list_entry*
138 resource_list_find(struct resource_list *rl,
139 int type, int rid);
140
141/*
142 * Delete a resource entry.
143 */
144void resource_list_delete(struct resource_list *rl,
145 int type, int rid);
146
147/*
148 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
149 * and passing the allocation up to the parent of bus. This assumes
150 * that the first entry of device_get_ivars(child) is a struct
151 * resource_list. This also handles 'passthrough' allocations where a
152 * child is a remote descendant of bus by passing the allocation up to
153 * the parent of bus.
154 */
155struct resource *
156 resource_list_alloc(struct resource_list *rl,
157 device_t bus, device_t child,
158 int type, int *rid,
159 u_long start, u_long end,
160 u_long count, u_int flags);
161
162/*
163 * Implement BUS_RELEASE_RESOURCE.
164 */
165int resource_list_release(struct resource_list *rl,
166 device_t bus, device_t child,
167 int type, int rid, struct resource *res);
168
169/*
170 * Print all resources of a specified type, for use in bus_print_child.
171 * The name is printed if at least one resource of the given type is available.
172 * The format ist used to print resource start and end.
173 */
174int resource_list_print_type(struct resource_list *rl,
175 const char *name, int type,
176 const char *format);
177
178/*
179 * The root bus, to which all top-level busses are attached.
180 */
181extern device_t root_bus;
182extern devclass_t root_devclass;
183void root_bus_configure(void);
184
185/*
186 * Useful functions for implementing busses.
187 */
188
189int bus_generic_activate_resource(device_t dev, device_t child, int type,
190 int rid, struct resource *r);
e126caf1
MD
191struct resource *
192 bus_generic_alloc_resource(device_t bus, device_t child,
193 int type, int *rid,
194 u_long start, u_long end,
195 u_long count, u_int flags);
196struct resource_list *
197 bus_generic_get_resource_list (device_t, device_t);
198
199int bus_generic_config_intr(device_t, int, enum intr_trigger,
200 enum intr_polarity);
984263bc 201int bus_generic_attach(device_t dev);
22457186 202int bus_generic_child_present(device_t dev, device_t child);
984263bc
MD
203int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
204 int rid, struct resource *r);
205int bus_generic_detach(device_t dev);
206void bus_generic_driver_added(device_t dev, driver_t *driver);
207int bus_print_child_header(device_t dev, device_t child);
208int bus_print_child_footer(device_t dev, device_t child);
209int bus_generic_print_child(device_t dev, device_t child);
210int bus_generic_probe(device_t dev);
211int bus_generic_read_ivar(device_t dev, device_t child, int which,
212 uintptr_t *result);
213int bus_generic_release_resource(device_t bus, device_t child,
214 int type, int rid, struct resource *r);
215int bus_generic_resume(device_t dev);
216int 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);
219int bus_generic_shutdown(device_t dev);
220int bus_generic_suspend(device_t dev);
221int bus_generic_teardown_intr(device_t dev, device_t child,
222 struct resource *irq, void *cookie);
223int bus_generic_write_ivar(device_t dev, device_t child, int which,
224 uintptr_t value);
225
e126caf1
MD
226struct resource *
227 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
228 u_long, u_long, u_long, u_int);
229void bus_generic_rl_delete_resource (device_t, device_t, int, int);
230int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
231 u_long *);
232int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
233 u_long);
234int bus_generic_rl_release_resource (device_t, device_t, int, int,
235 struct resource *);
236
984263bc
MD
237/*
238 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
239 * a little simpler.
240 */
241struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
242 u_long start, u_long end, u_long count,
243 u_int flags);
244int bus_activate_resource(device_t dev, int type, int rid,
245 struct resource *r);
246int bus_deactivate_resource(device_t dev, int type, int rid,
247 struct resource *r);
248int bus_release_resource(device_t dev, int type, int rid,
249 struct resource *r);
250int bus_setup_intr(device_t dev, struct resource *r, int flags,
251 driver_intr_t handler, void *arg, void **cookiep);
252int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
253int bus_set_resource(device_t dev, int type, int rid,
254 u_long start, u_long count);
255int bus_get_resource(device_t dev, int type, int rid,
256 u_long *startp, u_long *countp);
257u_long bus_get_resource_start(device_t dev, int type, int rid);
258u_long bus_get_resource_count(device_t dev, int type, int rid);
259void bus_delete_resource(device_t dev, int type, int rid);
260
261/*
262 * Access functions for device.
263 */
264device_t device_add_child(device_t dev, const char *name, int unit);
265device_t device_add_child_ordered(device_t dev, int order,
266 const char *name, int unit);
267void device_busy(device_t dev);
268int device_delete_child(device_t dev, device_t child);
269int device_detach(device_t dev);
270void device_disable(device_t dev);
271void device_enable(device_t dev);
272device_t device_find_child(device_t dev, const char *classname,
273 int unit);
274const char *device_get_desc(device_t dev);
275devclass_t device_get_devclass(device_t dev);
276driver_t *device_get_driver(device_t dev);
277u_int32_t device_get_flags(device_t dev);
278device_t device_get_parent(device_t dev);
279int device_get_children(device_t dev, device_t **listp, int *countp);
280void *device_get_ivars(device_t dev);
281void device_set_ivars(device_t dev, void *ivars);
282const char *device_get_name(device_t dev);
283const char *device_get_nameunit(device_t dev);
284void *device_get_softc(device_t dev);
285device_state_t device_get_state(device_t dev);
286int device_get_unit(device_t dev);
287int device_is_alive(device_t dev); /* did probe succeed? */
2140e77f 288int device_is_attached(device_t dev); /* did attach succeed? */
984263bc
MD
289int device_is_enabled(device_t dev);
290int device_is_quiet(device_t dev);
291int device_print_prettyname(device_t dev);
292int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
293int device_probe_and_attach(device_t dev);
294void device_quiet(device_t dev);
295void device_set_desc(device_t dev, const char* desc);
296void device_set_desc_copy(device_t dev, const char* desc);
297int device_set_devclass(device_t dev, const char *classname);
298int device_set_driver(device_t dev, driver_t *driver);
299void device_set_flags(device_t dev, u_int32_t flags);
300void device_set_softc(device_t dev, void *softc);
301int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
302int device_shutdown(device_t dev);
303void device_unbusy(device_t dev);
304void device_verbose(device_t dev);
305
306/*
307 * Access functions for devclass.
308 */
309int devclass_add_driver(devclass_t dc, driver_t *driver);
310int devclass_delete_driver(devclass_t dc, driver_t *driver);
311devclass_t devclass_create(const char *classname);
312devclass_t devclass_find(const char *classname);
313driver_t *devclass_find_driver(devclass_t dc, const char *classname);
314const char *devclass_get_name(devclass_t dc);
315device_t devclass_get_device(devclass_t dc, int unit);
316void *devclass_get_softc(devclass_t dc, int unit);
317int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
318int devclass_get_maxunit(devclass_t dc);
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;
365 driver_t **dmd_drivers;
366 int dmd_ndrivers;
367 devclass_t *dmd_devclass;
368};
369
370#define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
371 \
372static driver_t *name##_##busname##_driver_list[] = { &driver }; \
373static struct driver_module_data name##_##busname##_driver_mod = { \
374 evh, arg, \
375 #busname, \
376 name##_##busname##_driver_list, \
377 (sizeof name##_##busname##_driver_list) / \
378 (sizeof name##_##busname##_driver_list[0]), \
379 &devclass \
380}; \
381 \
382static moduledata_t name##_##busname##_mod = { \
383 #busname "/" #name, \
384 driver_module_handler, \
385 &name##_##busname##_driver_mod \
386}; \
387DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
388 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
389
390#define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \
391 \
392static driver_t name##_##busname##_driver_list[] = drivers; \
393static struct driver_module_data name##_##busname##_driver_mod = { \
394 evh, arg, \
395 #busname, \
396 name##_##busname##_driver_list, \
397 (sizeof name##_##busname##_driver_list) / \
398 (sizeof name##_##busname##_driver_list[0]), \
399 &devclass \
400}; \
401 \
402static moduledata_t name##_##busname##_mod = { \
403 #busname "/" #name, \
404 driver_module_handler, \
405 &name##_##busname##_driver_mod \
406}; \
407DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
408 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
409
410#endif /* _KERNEL */
411
412#endif /* !_SYS_BUS_H_ */