FreeBSD/Linux Kernel Cross Reference
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: releng/5.1/sys/sys/bus.h 113808 2003-04-21 18:19:08Z imp $
27 */
28
29 #ifndef _SYS_BUS_H_
30 #define _SYS_BUS_H_
31
32 /*
33 * Interface information structure.
34 */
35 struct u_businfo {
36 int ub_version; /* interface version */
37 #define BUS_USER_VERSION 1
38 int ub_generation; /* generation count */
39 };
40
41 /*
42 * State of the device.
43 */
44 typedef enum device_state {
45 DS_NOTPRESENT, /* not probed or probe failed */
46 DS_ALIVE, /* probe succeeded */
47 DS_ATTACHED, /* attach method called */
48 DS_BUSY /* device is open */
49 } device_state_t;
50
51 /*
52 * Device information exported to userspace.
53 */
54 struct u_device {
55 uintptr_t dv_handle;
56 uintptr_t dv_parent;
57
58 char dv_name[32]; /* Name of device in tree. */
59 char dv_desc[32]; /* Driver description */
60 char dv_drivername[32]; /* Driver name */
61 char dv_pnpinfo[128]; /* Plug and play info */
62 char dv_location[128]; /* Where is the device? */
63 uint32_t dv_devflags; /* API Flags for device */
64 uint16_t dv_flags; /* flags for dev date */
65 device_state_t dv_state; /* State of attachment */
66 /* XXX more driver info? */
67 };
68
69 #ifdef _KERNEL
70
71 #include <sys/queue.h>
72 #include <sys/kobj.h>
73
74 /*
75 * Forward declarations
76 */
77 typedef struct device *device_t;
78 typedef struct driver driver_t;
79 typedef struct devclass *devclass_t;
80 #define device_method_t kobj_method_t
81
82 typedef void driver_intr_t(void*);
83
84 /*
85 * Interrupt type bits. These flags are used both by newbus interrupt
86 * registration (nexus.c) and also in struct intrec, which defines
87 * interrupt properties.
88 *
89 * XXX We should probably revisit this and remove the vestiges of the
90 * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't
91 * confuse things by renaming them (Grog, 18 July 2000).
92 *
93 * We define this in terms of bits because some devices may belong
94 * to multiple classes (and therefore need to be included in
95 * multiple interrupt masks, which is what this really serves to
96 * indicate. Buses which do interrupt remapping will want to
97 * change their type to reflect what sort of devices are underneath.
98 */
99 enum intr_type {
100 INTR_TYPE_TTY = 1,
101 INTR_TYPE_BIO = 2,
102 INTR_TYPE_NET = 4,
103 INTR_TYPE_CAM = 8,
104 INTR_TYPE_MISC = 16,
105 INTR_TYPE_CLK = 32,
106 INTR_TYPE_AV = 64,
107 INTR_FAST = 128,
108 INTR_EXCL = 256, /* exclusive interrupt */
109 INTR_MPSAFE = 512, /* this interrupt is SMP safe */
110 INTR_ENTROPY = 1024 /* this interrupt provides entropy */
111 };
112
113 typedef int (*devop_t)(void);
114
115 struct driver {
116 KOBJ_CLASS_FIELDS;
117 void *priv; /* driver private data */
118 };
119
120 /*
121 * Definitions for drivers which need to keep simple lists of resources
122 * for their child devices.
123 */
124 struct resource;
125
126 struct resource_list_entry {
127 SLIST_ENTRY(resource_list_entry) link;
128 int type; /* type argument to alloc_resource */
129 int rid; /* resource identifier */
130 struct resource *res; /* the real resource when allocated */
131 u_long start; /* start of resource range */
132 u_long end; /* end of resource range */
133 u_long count; /* count within range */
134 };
135 SLIST_HEAD(resource_list, resource_list_entry);
136
137 /*
138 * Initialise a resource list.
139 */
140 void resource_list_init(struct resource_list *rl);
141
142 /*
143 * Reclaim memory used by a resource list.
144 */
145 void resource_list_free(struct resource_list *rl);
146
147 /*
148 * Add a resource entry or modify an existing entry if one exists with
149 * the same type and rid.
150 */
151 void resource_list_add(struct resource_list *rl,
152 int type, int rid,
153 u_long start, u_long end, u_long count);
154 int resource_list_add_next(struct resource_list *rl,
155 int type,
156 u_long start, u_long end, u_long count);
157
158
159 /*
160 * Find a resource entry by type and rid.
161 */
162 struct resource_list_entry*
163 resource_list_find(struct resource_list *rl,
164 int type, int rid);
165
166 /*
167 * Delete a resource entry.
168 */
169 void resource_list_delete(struct resource_list *rl,
170 int type, int rid);
171
172 /*
173 * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
174 * and passing the allocation up to the parent of bus. This assumes
175 * that the first entry of device_get_ivars(child) is a struct
176 * resource_list. This also handles 'passthrough' allocations where a
177 * child is a remote descendant of bus by passing the allocation up to
178 * the parent of bus.
179 */
180 struct resource *
181 resource_list_alloc(struct resource_list *rl,
182 device_t bus, device_t child,
183 int type, int *rid,
184 u_long start, u_long end,
185 u_long count, u_int flags);
186
187 /*
188 * Implement BUS_RELEASE_RESOURCE.
189 */
190 int resource_list_release(struct resource_list *rl,
191 device_t bus, device_t child,
192 int type, int rid, struct resource *res);
193
194 /*
195 * Print all resources of a specified type, for use in bus_print_child.
196 * The name is printed if at least one resource of the given type is available.
197 * The format ist used to print resource start and end.
198 */
199 int resource_list_print_type(struct resource_list *rl,
200 const char *name, int type,
201 const char *format);
202
203 /*
204 * The root bus, to which all top-level busses are attached.
205 */
206 extern device_t root_bus;
207 extern devclass_t root_devclass;
208 void root_bus_configure(void);
209
210 /*
211 * Useful functions for implementing busses.
212 */
213
214 int bus_generic_activate_resource(device_t dev, device_t child, int type,
215 int rid, struct resource *r);
216 struct resource *
217 bus_generic_alloc_resource(device_t bus, device_t child, int type,
218 int *rid, u_long start, u_long end,
219 u_long count, u_int flags);
220 int bus_generic_attach(device_t dev);
221 int bus_generic_child_present(device_t dev, device_t child);
222 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
223 int rid, struct resource *r);
224 int bus_generic_detach(device_t dev);
225 void bus_generic_driver_added(device_t dev, driver_t *driver);
226 struct resource_list *
227 bus_generic_get_resource_list (device_t, device_t);
228 int bus_print_child_header(device_t dev, device_t child);
229 int bus_print_child_footer(device_t dev, device_t child);
230 int bus_generic_print_child(device_t dev, device_t child);
231 int bus_generic_probe(device_t dev);
232 int bus_generic_read_ivar(device_t dev, device_t child, int which,
233 uintptr_t *result);
234 int bus_generic_release_resource(device_t bus, device_t child,
235 int type, int rid, struct resource *r);
236 int bus_generic_resume(device_t dev);
237 int bus_generic_setup_intr(device_t dev, device_t child,
238 struct resource *irq, int flags,
239 driver_intr_t *intr, void *arg, void **cookiep);
240
241 struct resource *
242 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
243 u_long, u_long, u_long, u_int);
244 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
245 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
246 u_long *);
247 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
248 u_long);
249 int bus_generic_rl_release_resource (device_t, device_t, int, int,
250 struct resource *);
251
252 int bus_generic_shutdown(device_t dev);
253 int bus_generic_suspend(device_t dev);
254 int bus_generic_teardown_intr(device_t dev, device_t child,
255 struct resource *irq, void *cookie);
256 int bus_generic_write_ivar(device_t dev, device_t child, int which,
257 uintptr_t value);
258
259 /*
260 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
261 * a little simpler.
262 */
263 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
264 u_long start, u_long end, u_long count,
265 u_int flags);
266 int bus_activate_resource(device_t dev, int type, int rid,
267 struct resource *r);
268 int bus_deactivate_resource(device_t dev, int type, int rid,
269 struct resource *r);
270 int bus_release_resource(device_t dev, int type, int rid,
271 struct resource *r);
272 int bus_setup_intr(device_t dev, struct resource *r, int flags,
273 driver_intr_t handler, void *arg, void **cookiep);
274 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
275 int bus_set_resource(device_t dev, int type, int rid,
276 u_long start, u_long count);
277 int bus_get_resource(device_t dev, int type, int rid,
278 u_long *startp, u_long *countp);
279 u_long bus_get_resource_start(device_t dev, int type, int rid);
280 u_long bus_get_resource_count(device_t dev, int type, int rid);
281 void bus_delete_resource(device_t dev, int type, int rid);
282 int bus_child_present(device_t child);
283 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
284 int bus_child_location_str(device_t child, char *buf, size_t buflen);
285
286 /*
287 * Access functions for device.
288 */
289 device_t device_add_child(device_t dev, const char *name, int unit);
290 device_t device_add_child_ordered(device_t dev, int order,
291 const char *name, int unit);
292 void device_busy(device_t dev);
293 int device_delete_child(device_t dev, device_t child);
294 int device_detach(device_t dev);
295 void device_disable(device_t dev);
296 void device_enable(device_t dev);
297 device_t device_find_child(device_t dev, const char *classname,
298 int unit);
299 const char *device_get_desc(device_t dev);
300 devclass_t device_get_devclass(device_t dev);
301 driver_t *device_get_driver(device_t dev);
302 u_int32_t device_get_flags(device_t dev);
303 device_t device_get_parent(device_t dev);
304 int device_get_children(device_t dev, device_t **listp, int *countp);
305 void *device_get_ivars(device_t dev);
306 void device_set_ivars(device_t dev, void *ivars);
307 const char *device_get_name(device_t dev);
308 const char *device_get_nameunit(device_t dev);
309 void *device_get_softc(device_t dev);
310 device_state_t device_get_state(device_t dev);
311 int device_get_unit(device_t dev);
312 int device_is_alive(device_t dev); /* did probe succeed? */
313 int device_is_attached(device_t dev); /* did attach succeed? */
314 int device_is_enabled(device_t dev);
315 int device_is_quiet(device_t dev);
316 int device_print_prettyname(device_t dev);
317 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
318 int device_probe_and_attach(device_t dev);
319 void device_quiet(device_t dev);
320 void device_set_desc(device_t dev, const char* desc);
321 void device_set_desc_copy(device_t dev, const char* desc);
322 int device_set_devclass(device_t dev, const char *classname);
323 int device_set_driver(device_t dev, driver_t *driver);
324 void device_set_flags(device_t dev, u_int32_t flags);
325 void device_set_softc(device_t dev, void *softc);
326 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
327 int device_shutdown(device_t dev);
328 void device_unbusy(device_t dev);
329 void device_verbose(device_t dev);
330
331 /*
332 * Access functions for devclass.
333 */
334 int devclass_add_driver(devclass_t dc, driver_t *driver);
335 int devclass_delete_driver(devclass_t dc, driver_t *driver);
336 devclass_t devclass_create(const char *classname);
337 devclass_t devclass_find(const char *classname);
338 driver_t *devclass_find_driver(devclass_t dc, const char *classname);
339 const char *devclass_get_name(devclass_t dc);
340 device_t devclass_get_device(devclass_t dc, int unit);
341 void *devclass_get_softc(devclass_t dc, int unit);
342 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
343 int devclass_get_maxunit(devclass_t dc);
344 int devclass_find_free_unit(devclass_t dc, int unit);
345
346 /*
347 * Access functions for device resources.
348 */
349
350 int resource_int_value(const char *name, int unit, const char *resname,
351 int *result);
352 int resource_long_value(const char *name, int unit, const char *resname,
353 long *result);
354 int resource_string_value(const char *name, int unit, const char *resname,
355 const char **result);
356 int resource_find_match(int *anchor, const char **name, int *unit,
357 const char *resname, const char *value);
358 int resource_find_dev(int *anchor, const char *name, int *unit,
359 const char *resname, const char *value);
360 int resource_set_int(const char *name, int unit, const char *resname,
361 int value);
362 int resource_set_long(const char *name, int unit, const char *resname,
363 long value);
364 int resource_set_string(const char *name, int unit, const char *resname,
365 const char *value);
366 /*
367 * Functions for maintaining and checking consistency of
368 * bus information exported to userspace.
369 */
370 int bus_data_generation_check(int generation);
371 void bus_data_generation_update(void);
372
373 /*
374 * Shorthand for constructing method tables.
375 */
376 #define DEVMETHOD KOBJMETHOD
377
378 /*
379 * Some common device interfaces.
380 */
381 #include "device_if.h"
382 #include "bus_if.h"
383
384 struct module;
385
386 int driver_module_handler(struct module *, int, void *);
387
388 /*
389 * Module support for automatically adding drivers to busses.
390 */
391 struct driver_module_data {
392 int (*dmd_chainevh)(struct module *, int, void *);
393 void *dmd_chainarg;
394 const char *dmd_busname;
395 driver_t **dmd_drivers;
396 int dmd_ndrivers;
397 devclass_t *dmd_devclass;
398 };
399
400 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
401 \
402 static driver_t *name##_##busname##_driver_list[] = { &driver }; \
403 static struct driver_module_data name##_##busname##_driver_mod = { \
404 evh, arg, \
405 #busname, \
406 name##_##busname##_driver_list, \
407 (sizeof name##_##busname##_driver_list) / \
408 (sizeof name##_##busname##_driver_list[0]), \
409 &devclass \
410 }; \
411 \
412 static moduledata_t name##_##busname##_mod = { \
413 #busname "/" #name, \
414 driver_module_handler, \
415 &name##_##busname##_driver_mod \
416 }; \
417 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
418 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
419
420 #define MULTI_DRIVER_MODULE(name, busname, drivers, devclass, evh, arg) \
421 \
422 static driver_t name##_##busname##_driver_list[] = drivers; \
423 static struct driver_module_data name##_##busname##_driver_mod = { \
424 evh, arg, \
425 #busname, \
426 name##_##busname##_driver_list, \
427 (sizeof name##_##busname##_driver_list) / \
428 (sizeof name##_##busname##_driver_list[0]), \
429 &devclass \
430 }; \
431 \
432 static moduledata_t name##_##busname##_mod = { \
433 #busname "/" #name, \
434 driver_module_handler, \
435 &name##_##busname##_driver_mod \
436 }; \
437 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
438 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
439
440 /*
441 * Generic ivar accessor generation macros for bus drivers
442 */
443 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
444 \
445 static __inline type varp ## _get_ ## var(device_t dev) \
446 { \
447 uintptr_t v; \
448 BUS_READ_IVAR(device_get_parent(dev), dev, \
449 ivarp ## _IVAR_ ## ivar, &v); \
450 return ((type) v); \
451 } \
452 \
453 static __inline void varp ## _set_ ## var(device_t dev, type t) \
454 { \
455 uintptr_t v = (uintptr_t) t; \
456 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
457 ivarp ## _IVAR_ ## ivar, v); \
458 }
459
460 #endif /* _KERNEL */
461
462 #endif /* !_SYS_BUS_H_ */
Cache object: 9cba932bbce072525665cbefcab85664
|