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