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