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