Fix comment to show the munlockall function, and not the mlockall one.
[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 $
e126caf1 27 * $DragonFly: src/sys/sys/bus.h,v 1.7 2004/02/21 06:37:01 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
69enum intr_trigger {
70 INTR_TRIGGER_CONFORM = 0,
71 INTR_TRIGGER_EDGE = 1,
72 INTR_TRIGGER_LEVEL = 2
73};
74
75enum intr_polarity {
76 INTR_POLARITY_CONFORM = 0,
77 INTR_POLARITY_HIGH = 1,
78 INTR_POLARITY_LOW = 2
984263bc 79};
984263bc
MD
80
81typedef int (*devop_t)(void);
82
984263bc 83struct driver {
80eff43d 84 KOBJ_CLASS_FIELDS;
984263bc 85 void *priv; /* driver private data */
984263bc
MD
86};
87
88typedef enum device_state {
89 DS_NOTPRESENT, /* not probed or probe failed */
90 DS_ALIVE, /* probe succeeded */
91 DS_ATTACHED, /* attach method called */
92 DS_BUSY /* device is open */
93} device_state_t;
94
95/*
96 * Definitions for drivers which need to keep simple lists of resources
97 * for their child devices.
98 */
99struct resource;
100
101struct resource_list_entry {
102 SLIST_ENTRY(resource_list_entry) link;
103 int type; /* type argument to alloc_resource */
104 int rid; /* resource identifier */
105 struct resource *res; /* the real resource when allocated */
106 u_long start; /* start of resource range */
107 u_long end; /* end of resource range */
108 u_long count; /* count within range */
109};
110SLIST_HEAD(resource_list, resource_list_entry);
111
112/*
113 * Initialise a resource list.
114 */
115void resource_list_init(struct resource_list *rl);
116
117/*
118 * Reclaim memory used by a resource list.
119 */
120void resource_list_free(struct resource_list *rl);
121
122/*
123 * Add a resource entry or modify an existing entry if one exists with
124 * the same type and rid.
125 */
126void resource_list_add(struct resource_list *rl,
127 int type, int rid,
128 u_long start, u_long end, u_long count);
129
130/*
131 * Find a resource entry by type and rid.
132 */
133struct resource_list_entry*
134 resource_list_find(struct resource_list *rl,
135 int type, int rid);
136
137/*
138 * Delete a resource entry.
139 */
140void resource_list_delete(struct resource_list *rl,
141 int type, int rid);
142
143/*
144 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
145 * and passing the allocation up to the parent of bus. This assumes
146 * that the first entry of device_get_ivars(child) is a struct
147 * resource_list. This also handles 'passthrough' allocations where a
148 * child is a remote descendant of bus by passing the allocation up to
149 * the parent of bus.
150 */
151struct resource *
152 resource_list_alloc(struct resource_list *rl,
153 device_t bus, device_t child,
154 int type, int *rid,
155 u_long start, u_long end,
156 u_long count, u_int flags);
157
158/*
159 * Implement BUS_RELEASE_RESOURCE.
160 */
161int resource_list_release(struct resource_list *rl,
162 device_t bus, device_t child,
163 int type, int rid, struct resource *res);
164
165/*
166 * Print all resources of a specified type, for use in bus_print_child.
167 * The name is printed if at least one resource of the given type is available.
168 * The format ist used to print resource start and end.
169 */
170int resource_list_print_type(struct resource_list *rl,
171 const char *name, int type,
172 const char *format);
173
174/*
175 * The root bus, to which all top-level busses are attached.
176 */
177extern device_t root_bus;
178extern devclass_t root_devclass;
179void root_bus_configure(void);
180
181/*
182 * Useful functions for implementing busses.
183 */
184
185int bus_generic_activate_resource(device_t dev, device_t child, int type,
186 int rid, struct resource *r);
e126caf1
MD
187struct resource *
188 bus_generic_alloc_resource(device_t bus, device_t child,
189 int type, int *rid,
190 u_long start, u_long end,
191 u_long count, u_int flags);
192struct resource_list *
193 bus_generic_get_resource_list (device_t, device_t);
194
195int bus_generic_config_intr(device_t, int, enum intr_trigger,
196 enum intr_polarity);
984263bc 197int bus_generic_attach(device_t dev);
22457186 198int bus_generic_child_present(device_t dev, device_t child);
984263bc
MD
199int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
200 int rid, struct resource *r);
201int bus_generic_detach(device_t dev);
202void bus_generic_driver_added(device_t dev, driver_t *driver);
203int bus_print_child_header(device_t dev, device_t child);
204int bus_print_child_footer(device_t dev, device_t child);
205int bus_generic_print_child(device_t dev, device_t child);
206int bus_generic_probe(device_t dev);
207int bus_generic_read_ivar(device_t dev, device_t child, int which,
208 uintptr_t *result);
209int bus_generic_release_resource(device_t bus, device_t child,
210 int type, int rid, struct resource *r);
211int bus_generic_resume(device_t dev);
212int bus_generic_setup_intr(device_t dev, device_t child,
213 struct resource *irq, int flags,
214 driver_intr_t *intr, void *arg, void **cookiep);
215int bus_generic_shutdown(device_t dev);
216int bus_generic_suspend(device_t dev);
217int bus_generic_teardown_intr(device_t dev, device_t child,
218 struct resource *irq, void *cookie);
219int bus_generic_write_ivar(device_t dev, device_t child, int which,
220 uintptr_t value);
221
e126caf1
MD
222struct resource *
223 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
224 u_long, u_long, u_long, u_int);
225void bus_generic_rl_delete_resource (device_t, device_t, int, int);
226int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
227 u_long *);
228int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
229 u_long);
230int bus_generic_rl_release_resource (device_t, device_t, int, int,
231 struct resource *);
232
984263bc
MD
233/*
234 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
235 * a little simpler.
236 */
237struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
238 u_long start, u_long end, u_long count,
239 u_int flags);
240int bus_activate_resource(device_t dev, int type, int rid,
241 struct resource *r);
242int bus_deactivate_resource(device_t dev, int type, int rid,
243 struct resource *r);
244int bus_release_resource(device_t dev, int type, int rid,
245 struct resource *r);
246int bus_setup_intr(device_t dev, struct resource *r, int flags,
247 driver_intr_t handler, void *arg, void **cookiep);
248int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
249int bus_set_resource(device_t dev, int type, int rid,
250 u_long start, u_long count);
251int bus_get_resource(device_t dev, int type, int rid,
252 u_long *startp, u_long *countp);
253u_long bus_get_resource_start(device_t dev, int type, int rid);
254u_long bus_get_resource_count(device_t dev, int type, int rid);
255void bus_delete_resource(device_t dev, int type, int rid);
256
257/*
258 * Access functions for device.
259 */
260device_t device_add_child(device_t dev, const char *name, int unit);
261device_t device_add_child_ordered(device_t dev, int order,
262 const char *name, int unit);
263void device_busy(device_t dev);
264int device_delete_child(device_t dev, device_t child);
265int device_detach(device_t dev);
266void device_disable(device_t dev);
267void device_enable(device_t dev);
268device_t device_find_child(device_t dev, const char *classname,
269 int unit);
270const char *device_get_desc(device_t dev);
271devclass_t device_get_devclass(device_t dev);
272driver_t *device_get_driver(device_t dev);
273u_int32_t device_get_flags(device_t dev);
274device_t device_get_parent(device_t dev);
275int device_get_children(device_t dev, device_t **listp, int *countp);
276void *device_get_ivars(device_t dev);
277void device_set_ivars(device_t dev, void *ivars);
278const char *device_get_name(device_t dev);
279const char *device_get_nameunit(device_t dev);
280void *device_get_softc(device_t dev);
281device_state_t device_get_state(device_t dev);
282int device_get_unit(device_t dev);
283int device_is_alive(device_t dev); /* did probe succeed? */
2140e77f 284int device_is_attached(device_t dev); /* did attach succeed? */
984263bc
MD
285int device_is_enabled(device_t dev);
286int device_is_quiet(device_t dev);
287int device_print_prettyname(device_t dev);
288int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
289int device_probe_and_attach(device_t dev);
290void device_quiet(device_t dev);
291void device_set_desc(device_t dev, const char* desc);
292void device_set_desc_copy(device_t dev, const char* desc);
293int device_set_devclass(device_t dev, const char *classname);
294int device_set_driver(device_t dev, driver_t *driver);
295void device_set_flags(device_t dev, u_int32_t flags);
296void device_set_softc(device_t dev, void *softc);
297int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
298int device_shutdown(device_t dev);
299void device_unbusy(device_t dev);
300void device_verbose(device_t dev);
301
302/*
303 * Access functions for devclass.
304 */
305int devclass_add_driver(devclass_t dc, driver_t *driver);
306int devclass_delete_driver(devclass_t dc, driver_t *driver);
307devclass_t devclass_create(const char *classname);
308devclass_t devclass_find(const char *classname);
309driver_t *devclass_find_driver(devclass_t dc, const char *classname);
310const char *devclass_get_name(devclass_t dc);
311device_t devclass_get_device(devclass_t dc, int unit);
312void *devclass_get_softc(devclass_t dc, int unit);
313int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
314int devclass_get_maxunit(devclass_t dc);
315
316/*
317 * Access functions for device resources.
318 */
319
320int resource_int_value(const char *name, int unit, const char *resname,
321 int *result);
322int resource_long_value(const char *name, int unit, const char *resname,
323 long *result);
324int resource_string_value(const char *name, int unit, const char *resname,
325 char **result);
e126caf1 326int resource_disabled(const char *name, int unit);
984263bc
MD
327int resource_query_string(int i, const char *resname, const char *value);
328char *resource_query_name(int i);
329int resource_query_unit(int i);
330int resource_locate(int i, const char *resname);
331int resource_set_int(const char *name, int unit, const char *resname,
332 int value);
333int resource_set_long(const char *name, int unit, const char *resname,
334 long value);
335int resource_set_string(const char *name, int unit, const char *resname,
336 const char *value);
337int resource_count(void);
338
339/*
340 * Shorthand for constructing method tables.
341 */
80eff43d 342#define DEVMETHOD KOBJMETHOD
984263bc
MD
343
344/*
345 * Some common device interfaces.
346 */
347#include "device_if.h"
348#include "bus_if.h"
349
350struct module;
351
352int driver_module_handler(struct module *, int, void *);
353
354/*
355 * Module support for automatically adding drivers to busses.
356 */
357struct driver_module_data {
358 int (*dmd_chainevh)(struct module *, int, void *);
359 void *dmd_chainarg;
360 const char *dmd_busname;
361 driver_t **dmd_drivers;
362 int dmd_ndrivers;
363 devclass_t *dmd_devclass;
364};
365
366#define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
367 \
368static driver_t *name##_##busname##_driver_list[] = { &driver }; \
369static struct driver_module_data name##_##busname##_driver_mod = { \
370 evh, arg, \
371 #busname, \
372 name##_##busname##_driver_list, \
373 (sizeof name##_##busname##_driver_list) / \
374 (sizeof name##_##busname##_driver_list[0]), \
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#define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \
387 \
388static driver_t name##_##busname##_driver_list[] = drivers; \
389static struct driver_module_data name##_##busname##_driver_mod = { \
390 evh, arg, \
391 #busname, \
392 name##_##busname##_driver_list, \
393 (sizeof name##_##busname##_driver_list) / \
394 (sizeof name##_##busname##_driver_list[0]), \
395 &devclass \
396}; \
397 \
398static moduledata_t name##_##busname##_mod = { \
399 #busname "/" #name, \
400 driver_module_handler, \
401 &name##_##busname##_driver_mod \
402}; \
403DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
404 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
405
406#endif /* _KERNEL */
407
408#endif /* !_SYS_BUS_H_ */