FreeBSD/Linux Kernel Cross Reference
sys/sys/bus.h
1 /*-
2 * Copyright (c) 1997,1998,2003 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/9.0/sys/sys/bus.h 227977 2011-11-25 17:07:27Z marius $
27 */
28
29 #ifndef _SYS_BUS_H_
30 #define _SYS_BUS_H_
31
32 #include <machine/_limits.h>
33 #include <sys/_bus_dma.h>
34
35 /**
36 * @defgroup NEWBUS newbus - a generic framework for managing devices
37 * @{
38 */
39
40 /**
41 * @brief Interface information structure.
42 */
43 struct u_businfo {
44 int ub_version; /**< @brief interface version */
45 #define BUS_USER_VERSION 1
46 int ub_generation; /**< @brief generation count */
47 };
48
49 /**
50 * @brief State of the device.
51 */
52 typedef enum device_state {
53 DS_NOTPRESENT = 10, /**< @brief not probed or probe failed */
54 DS_ALIVE = 20, /**< @brief probe succeeded */
55 DS_ATTACHED = 30, /**< @brief attach method called */
56 DS_BUSY = 40 /**< @brief device is open */
57 } device_state_t;
58
59 /**
60 * @brief Device information exported to userspace.
61 */
62 struct u_device {
63 uintptr_t dv_handle;
64 uintptr_t dv_parent;
65
66 char dv_name[32]; /**< @brief Name of device in tree. */
67 char dv_desc[32]; /**< @brief Driver description */
68 char dv_drivername[32]; /**< @brief Driver name */
69 char dv_pnpinfo[128]; /**< @brief Plug and play info */
70 char dv_location[128]; /**< @brief Where is the device? */
71 uint32_t dv_devflags; /**< @brief API Flags for device */
72 uint16_t dv_flags; /**< @brief flags for dev date */
73 device_state_t dv_state; /**< @brief State of attachment */
74 /* XXX more driver info? */
75 };
76
77 #ifdef _KERNEL
78
79 #include <sys/queue.h>
80 #include <sys/kobj.h>
81
82 /**
83 * devctl hooks. Typically one should use the devctl_notify
84 * hook to send the message. However, devctl_queue_data is also
85 * included in case devctl_notify isn't sufficiently general.
86 */
87 boolean_t devctl_process_running(void);
88 void devctl_notify_f(const char *__system, const char *__subsystem,
89 const char *__type, const char *__data, int __flags);
90 void devctl_notify(const char *__system, const char *__subsystem,
91 const char *__type, const char *__data);
92 void devctl_queue_data_f(char *__data, int __flags);
93 void devctl_queue_data(char *__data);
94
95 /**
96 * @brief A device driver (included mainly for compatibility with
97 * FreeBSD 4.x).
98 */
99 typedef struct kobj_class driver_t;
100
101 /**
102 * @brief A device class
103 *
104 * The devclass object has two main functions in the system. The first
105 * is to manage the allocation of unit numbers for device instances
106 * and the second is to hold the list of device drivers for a
107 * particular bus type. Each devclass has a name and there cannot be
108 * two devclasses with the same name. This ensures that unique unit
109 * numbers are allocated to device instances.
110 *
111 * Drivers that support several different bus attachments (e.g. isa,
112 * pci, pccard) should all use the same devclass to ensure that unit
113 * numbers do not conflict.
114 *
115 * Each devclass may also have a parent devclass. This is used when
116 * searching for device drivers to allow a form of inheritance. When
117 * matching drivers with devices, first the driver list of the parent
118 * device's devclass is searched. If no driver is found in that list,
119 * the search continues in the parent devclass (if any).
120 */
121 typedef struct devclass *devclass_t;
122
123 /**
124 * @brief A device method (included mainly for compatibility with
125 * FreeBSD 4.x).
126 */
127 #define device_method_t kobj_method_t
128
129 /**
130 * @brief Driver interrupt filter return values
131 *
132 * If a driver provides an interrupt filter routine it must return an
133 * integer consisting of oring together zero or more of the following
134 * flags:
135 *
136 * FILTER_STRAY - this device did not trigger the interrupt
137 * FILTER_HANDLED - the interrupt has been fully handled and can be EOId
138 * FILTER_SCHEDULE_THREAD - the threaded interrupt handler should be
139 * scheduled to execute
140 *
141 * If the driver does not provide a filter, then the interrupt code will
142 * act is if the filter had returned FILTER_SCHEDULE_THREAD. Note that it
143 * is illegal to specify any other flag with FILTER_STRAY and that it is
144 * illegal to not specify either of FILTER_HANDLED or FILTER_SCHEDULE_THREAD
145 * if FILTER_STRAY is not specified.
146 */
147 #define FILTER_STRAY 0x01
148 #define FILTER_HANDLED 0x02
149 #define FILTER_SCHEDULE_THREAD 0x04
150
151 /**
152 * @brief Driver interrupt service routines
153 *
154 * The filter routine is run in primary interrupt context and may not
155 * block or use regular mutexes. It may only use spin mutexes for
156 * synchronization. The filter may either completely handle the
157 * interrupt or it may perform some of the work and defer more
158 * expensive work to the regular interrupt handler. If a filter
159 * routine is not registered by the driver, then the regular interrupt
160 * handler is always used to handle interrupts from this device.
161 *
162 * The regular interrupt handler executes in its own thread context
163 * and may use regular mutexes. However, it is prohibited from
164 * sleeping on a sleep queue.
165 */
166 typedef int driver_filter_t(void*);
167 typedef void driver_intr_t(void*);
168
169 /**
170 * @brief Interrupt type bits.
171 *
172 * These flags are used both by newbus interrupt
173 * registration (nexus.c) and also in struct intrec, which defines
174 * interrupt properties.
175 *
176 * XXX We should probably revisit this and remove the vestiges of the
177 * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't
178 * confuse things by renaming them (Grog, 18 July 2000).
179 *
180 * We define this in terms of bits because some devices may belong
181 * to multiple classes (and therefore need to be included in
182 * multiple interrupt masks, which is what this really serves to
183 * indicate. Buses which do interrupt remapping will want to
184 * change their type to reflect what sort of devices are underneath.
185 */
186 enum intr_type {
187 INTR_TYPE_TTY = 1,
188 INTR_TYPE_BIO = 2,
189 INTR_TYPE_NET = 4,
190 INTR_TYPE_CAM = 8,
191 INTR_TYPE_MISC = 16,
192 INTR_TYPE_CLK = 32,
193 INTR_TYPE_AV = 64,
194 INTR_EXCL = 256, /* exclusive interrupt */
195 INTR_MPSAFE = 512, /* this interrupt is SMP safe */
196 INTR_ENTROPY = 1024, /* this interrupt provides entropy */
197 INTR_MD1 = 4096, /* flag reserved for MD use */
198 INTR_MD2 = 8192, /* flag reserved for MD use */
199 INTR_MD3 = 16384, /* flag reserved for MD use */
200 INTR_MD4 = 32768 /* flag reserved for MD use */
201 };
202
203 enum intr_trigger {
204 INTR_TRIGGER_CONFORM = 0,
205 INTR_TRIGGER_EDGE = 1,
206 INTR_TRIGGER_LEVEL = 2
207 };
208
209 enum intr_polarity {
210 INTR_POLARITY_CONFORM = 0,
211 INTR_POLARITY_HIGH = 1,
212 INTR_POLARITY_LOW = 2
213 };
214
215 typedef int (*devop_t)(void);
216
217 /**
218 * @brief This structure is deprecated.
219 *
220 * Use the kobj(9) macro DEFINE_CLASS to
221 * declare classes which implement device drivers.
222 */
223 struct driver {
224 KOBJ_CLASS_FIELDS;
225 };
226
227 /*
228 * Definitions for drivers which need to keep simple lists of resources
229 * for their child devices.
230 */
231 struct resource;
232
233 /**
234 * @brief An entry for a single resource in a resource list.
235 */
236 struct resource_list_entry {
237 STAILQ_ENTRY(resource_list_entry) link;
238 int type; /**< @brief type argument to alloc_resource */
239 int rid; /**< @brief resource identifier */
240 int flags; /**< @brief resource flags */
241 struct resource *res; /**< @brief the real resource when allocated */
242 u_long start; /**< @brief start of resource range */
243 u_long end; /**< @brief end of resource range */
244 u_long count; /**< @brief count within range */
245 };
246 STAILQ_HEAD(resource_list, resource_list_entry);
247
248 #define RLE_RESERVED 0x0001 /* Reserved by the parent bus. */
249 #define RLE_ALLOCATED 0x0002 /* Reserved resource is allocated. */
250 #define RLE_PREFETCH 0x0004 /* Resource is a prefetch range. */
251
252 void resource_list_init(struct resource_list *rl);
253 void resource_list_free(struct resource_list *rl);
254 struct resource_list_entry *
255 resource_list_add(struct resource_list *rl,
256 int type, int rid,
257 u_long start, u_long end, u_long count);
258 int resource_list_add_next(struct resource_list *rl,
259 int type,
260 u_long start, u_long end, u_long count);
261 int resource_list_busy(struct resource_list *rl,
262 int type, int rid);
263 int resource_list_reserved(struct resource_list *rl, int type, int rid);
264 struct resource_list_entry*
265 resource_list_find(struct resource_list *rl,
266 int type, int rid);
267 void resource_list_delete(struct resource_list *rl,
268 int type, int rid);
269 struct resource *
270 resource_list_alloc(struct resource_list *rl,
271 device_t bus, device_t child,
272 int type, int *rid,
273 u_long start, u_long end,
274 u_long count, u_int flags);
275 int resource_list_release(struct resource_list *rl,
276 device_t bus, device_t child,
277 int type, int rid, struct resource *res);
278 struct resource *
279 resource_list_reserve(struct resource_list *rl,
280 device_t bus, device_t child,
281 int type, int *rid,
282 u_long start, u_long end,
283 u_long count, u_int flags);
284 int resource_list_unreserve(struct resource_list *rl,
285 device_t bus, device_t child,
286 int type, int rid);
287 void resource_list_purge(struct resource_list *rl);
288 int resource_list_print_type(struct resource_list *rl,
289 const char *name, int type,
290 const char *format);
291
292 /*
293 * The root bus, to which all top-level busses are attached.
294 */
295 extern device_t root_bus;
296 extern devclass_t root_devclass;
297 void root_bus_configure(void);
298
299 /*
300 * Useful functions for implementing busses.
301 */
302
303 int bus_generic_activate_resource(device_t dev, device_t child, int type,
304 int rid, struct resource *r);
305 device_t
306 bus_generic_add_child(device_t dev, u_int order, const char *name,
307 int unit);
308 int bus_generic_adjust_resource(device_t bus, device_t child, int type,
309 struct resource *r, u_long start,
310 u_long end);
311 struct resource *
312 bus_generic_alloc_resource(device_t bus, device_t child, int type,
313 int *rid, u_long start, u_long end,
314 u_long count, u_int flags);
315 int bus_generic_attach(device_t dev);
316 int bus_generic_bind_intr(device_t dev, device_t child,
317 struct resource *irq, int cpu);
318 int bus_generic_child_present(device_t dev, device_t child);
319 int bus_generic_config_intr(device_t, int, enum intr_trigger,
320 enum intr_polarity);
321 int bus_generic_describe_intr(device_t dev, device_t child,
322 struct resource *irq, void *cookie,
323 const char *descr);
324 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
325 int rid, struct resource *r);
326 int bus_generic_detach(device_t dev);
327 void bus_generic_driver_added(device_t dev, driver_t *driver);
328 bus_dma_tag_t
329 bus_generic_get_dma_tag(device_t dev, device_t child);
330 struct resource_list *
331 bus_generic_get_resource_list (device_t, device_t);
332 void bus_generic_new_pass(device_t dev);
333 int bus_print_child_header(device_t dev, device_t child);
334 int bus_print_child_footer(device_t dev, device_t child);
335 int bus_generic_print_child(device_t dev, device_t child);
336 int bus_generic_probe(device_t dev);
337 int bus_generic_read_ivar(device_t dev, device_t child, int which,
338 uintptr_t *result);
339 int bus_generic_release_resource(device_t bus, device_t child,
340 int type, int rid, struct resource *r);
341 int bus_generic_resume(device_t dev);
342 int bus_generic_setup_intr(device_t dev, device_t child,
343 struct resource *irq, int flags,
344 driver_filter_t *filter, driver_intr_t *intr,
345 void *arg, void **cookiep);
346
347 struct resource *
348 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
349 u_long, u_long, u_long, u_int);
350 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
351 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
352 u_long *);
353 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
354 u_long);
355 int bus_generic_rl_release_resource (device_t, device_t, int, int,
356 struct resource *);
357
358 int bus_generic_shutdown(device_t dev);
359 int bus_generic_suspend(device_t dev);
360 int bus_generic_teardown_intr(device_t dev, device_t child,
361 struct resource *irq, void *cookie);
362 int bus_generic_write_ivar(device_t dev, device_t child, int which,
363 uintptr_t value);
364
365 /*
366 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
367 * a little simpler.
368 */
369
370 struct resource_spec {
371 int type;
372 int rid;
373 int flags;
374 };
375
376 int bus_alloc_resources(device_t dev, struct resource_spec *rs,
377 struct resource **res);
378 void bus_release_resources(device_t dev, const struct resource_spec *rs,
379 struct resource **res);
380
381 int bus_adjust_resource(device_t child, int type, struct resource *r,
382 u_long start, u_long end);
383 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
384 u_long start, u_long end, u_long count,
385 u_int flags);
386 int bus_activate_resource(device_t dev, int type, int rid,
387 struct resource *r);
388 int bus_deactivate_resource(device_t dev, int type, int rid,
389 struct resource *r);
390 bus_dma_tag_t bus_get_dma_tag(device_t dev);
391 int bus_release_resource(device_t dev, int type, int rid,
392 struct resource *r);
393 int bus_free_resource(device_t dev, int type, struct resource *r);
394 int bus_setup_intr(device_t dev, struct resource *r, int flags,
395 driver_filter_t filter, driver_intr_t handler,
396 void *arg, void **cookiep);
397 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
398 int bus_bind_intr(device_t dev, struct resource *r, int cpu);
399 int bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
400 const char *fmt, ...);
401 int bus_set_resource(device_t dev, int type, int rid,
402 u_long start, u_long count);
403 int bus_get_resource(device_t dev, int type, int rid,
404 u_long *startp, u_long *countp);
405 u_long bus_get_resource_start(device_t dev, int type, int rid);
406 u_long bus_get_resource_count(device_t dev, int type, int rid);
407 void bus_delete_resource(device_t dev, int type, int rid);
408 int bus_child_present(device_t child);
409 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
410 int bus_child_location_str(device_t child, char *buf, size_t buflen);
411 void bus_enumerate_hinted_children(device_t bus);
412
413 static __inline struct resource *
414 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
415 {
416 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
417 }
418
419 /*
420 * Access functions for device.
421 */
422 device_t device_add_child(device_t dev, const char *name, int unit);
423 device_t device_add_child_ordered(device_t dev, u_int order,
424 const char *name, int unit);
425 void device_busy(device_t dev);
426 int device_delete_child(device_t dev, device_t child);
427 int device_attach(device_t dev);
428 int device_detach(device_t dev);
429 void device_disable(device_t dev);
430 void device_enable(device_t dev);
431 device_t device_find_child(device_t dev, const char *classname,
432 int unit);
433 const char *device_get_desc(device_t dev);
434 devclass_t device_get_devclass(device_t dev);
435 driver_t *device_get_driver(device_t dev);
436 u_int32_t device_get_flags(device_t dev);
437 device_t device_get_parent(device_t dev);
438 int device_get_children(device_t dev, device_t **listp, int *countp);
439 void *device_get_ivars(device_t dev);
440 void device_set_ivars(device_t dev, void *ivars);
441 const char *device_get_name(device_t dev);
442 const char *device_get_nameunit(device_t dev);
443 void *device_get_softc(device_t dev);
444 device_state_t device_get_state(device_t dev);
445 int device_get_unit(device_t dev);
446 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
447 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
448 int device_is_alive(device_t dev); /* did probe succeed? */
449 int device_is_attached(device_t dev); /* did attach succeed? */
450 int device_is_enabled(device_t dev);
451 int device_is_quiet(device_t dev);
452 int device_print_prettyname(device_t dev);
453 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
454 int device_probe(device_t dev);
455 int device_probe_and_attach(device_t dev);
456 int device_probe_child(device_t bus, device_t dev);
457 int device_quiesce(device_t dev);
458 void device_quiet(device_t dev);
459 void device_set_desc(device_t dev, const char* desc);
460 void device_set_desc_copy(device_t dev, const char* desc);
461 int device_set_devclass(device_t dev, const char *classname);
462 int device_set_driver(device_t dev, driver_t *driver);
463 void device_set_flags(device_t dev, u_int32_t flags);
464 void device_set_softc(device_t dev, void *softc);
465 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
466 int device_shutdown(device_t dev);
467 void device_unbusy(device_t dev);
468 void device_verbose(device_t dev);
469
470 /*
471 * Access functions for devclass.
472 */
473 int devclass_add_driver(devclass_t dc, driver_t *driver,
474 int pass, devclass_t *dcp);
475 devclass_t devclass_create(const char *classname);
476 int devclass_delete_driver(devclass_t busclass, driver_t *driver);
477 devclass_t devclass_find(const char *classname);
478 const char *devclass_get_name(devclass_t dc);
479 device_t devclass_get_device(devclass_t dc, int unit);
480 void *devclass_get_softc(devclass_t dc, int unit);
481 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
482 int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
483 int devclass_get_count(devclass_t dc);
484 int devclass_get_maxunit(devclass_t dc);
485 int devclass_find_free_unit(devclass_t dc, int unit);
486 void devclass_set_parent(devclass_t dc, devclass_t pdc);
487 devclass_t devclass_get_parent(devclass_t dc);
488 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
489 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
490
491 /*
492 * Access functions for device resources.
493 */
494
495 int resource_int_value(const char *name, int unit, const char *resname,
496 int *result);
497 int resource_long_value(const char *name, int unit, const char *resname,
498 long *result);
499 int resource_string_value(const char *name, int unit, const char *resname,
500 const char **result);
501 int resource_disabled(const char *name, int unit);
502 int resource_find_match(int *anchor, const char **name, int *unit,
503 const char *resname, const char *value);
504 int resource_find_dev(int *anchor, const char *name, int *unit,
505 const char *resname, const char *value);
506 int resource_set_int(const char *name, int unit, const char *resname,
507 int value);
508 int resource_set_long(const char *name, int unit, const char *resname,
509 long value);
510 int resource_set_string(const char *name, int unit, const char *resname,
511 const char *value);
512 /*
513 * Functions for maintaining and checking consistency of
514 * bus information exported to userspace.
515 */
516 int bus_data_generation_check(int generation);
517 void bus_data_generation_update(void);
518
519 /**
520 * Some convenience defines for probe routines to return. These are just
521 * suggested values, and there's nothing magical about them.
522 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
523 * possible other driver may exist (typically legacy drivers who don't fallow
524 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the
525 * suggested value that vendor supplied drivers use. This is for source or
526 * binary drivers that are not yet integrated into the FreeBSD tree. Its use
527 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value
528 * for drivers to use. It is intended that nearly all of the drivers in the
529 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that
530 * have special requirements like when there are two drivers that support
531 * overlapping series of hardware devices. In this case the one that supports
532 * the older part of the line would return this value, while the one that
533 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC
534 * is for drivers that wish to have a generic form and a specialized form,
535 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is
536 * for those busses that implement a generic device place-holder for devices on
537 * the bus that have no more specific river for them (aka ugen).
538 * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding
539 * for a device node, but accepts only devices that its parent has told it
540 * use this driver.
541 */
542 #define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */
543 #define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */
544 #define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */
545 #define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */
546 #define BUS_PROBE_GENERIC (-100) /* generic driver for dev */
547 #define BUS_PROBE_HOOVER (-500) /* Generic dev for all devs on bus */
548 #define BUS_PROBE_NOWILDCARD (-2000000000) /* No wildcard device matches */
549
550 /**
551 * During boot, the device tree is scanned multiple times. Each scan,
552 * or pass, drivers may be attached to devices. Each driver
553 * attachment is assigned a pass number. Drivers may only probe and
554 * attach to devices if their pass number is less than or equal to the
555 * current system-wide pass number. The default pass is the last pass
556 * and is used by most drivers. Drivers needed by the scheduler are
557 * probed in earlier passes.
558 */
559 #define BUS_PASS_ROOT 0 /* Used to attach root0. */
560 #define BUS_PASS_BUS 10 /* Busses and bridges. */
561 #define BUS_PASS_CPU 20 /* CPU devices. */
562 #define BUS_PASS_RESOURCE 30 /* Resource discovery. */
563 #define BUS_PASS_INTERRUPT 40 /* Interrupt controllers. */
564 #define BUS_PASS_TIMER 50 /* Timers and clocks. */
565 #define BUS_PASS_SCHEDULER 60 /* Start scheduler. */
566 #define BUS_PASS_DEFAULT __INT_MAX /* Everything else. */
567
568 extern int bus_current_pass;
569
570 void bus_set_pass(int pass);
571
572 /**
573 * Shorthands for constructing method tables.
574 */
575 #define DEVMETHOD KOBJMETHOD
576 #define DEVMETHOD_END KOBJMETHOD_END
577
578 /*
579 * Some common device interfaces.
580 */
581 #include "device_if.h"
582 #include "bus_if.h"
583
584 struct module;
585
586 int driver_module_handler(struct module *, int, void *);
587
588 /**
589 * Module support for automatically adding drivers to busses.
590 */
591 struct driver_module_data {
592 int (*dmd_chainevh)(struct module *, int, void *);
593 void *dmd_chainarg;
594 const char *dmd_busname;
595 kobj_class_t dmd_driver;
596 devclass_t *dmd_devclass;
597 int dmd_pass;
598 };
599
600 #define EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \
601 evh, arg, order, pass) \
602 \
603 static struct driver_module_data name##_##busname##_driver_mod = { \
604 evh, arg, \
605 #busname, \
606 (kobj_class_t) &driver, \
607 &devclass, \
608 pass \
609 }; \
610 \
611 static moduledata_t name##_##busname##_mod = { \
612 #busname "/" #name, \
613 driver_module_handler, \
614 &name##_##busname##_driver_mod \
615 }; \
616 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
617 SI_SUB_DRIVERS, order)
618
619 #define EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, pass) \
620 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \
621 evh, arg, SI_ORDER_MIDDLE, pass)
622
623 #define DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\
624 order) \
625 EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \
626 evh, arg, order, BUS_PASS_DEFAULT)
627
628 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
629 EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, \
630 BUS_PASS_DEFAULT)
631
632 /**
633 * Generic ivar accessor generation macros for bus drivers
634 */
635 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
636 \
637 static __inline type varp ## _get_ ## var(device_t dev) \
638 { \
639 uintptr_t v; \
640 BUS_READ_IVAR(device_get_parent(dev), dev, \
641 ivarp ## _IVAR_ ## ivar, &v); \
642 return ((type) v); \
643 } \
644 \
645 static __inline void varp ## _set_ ## var(device_t dev, type t) \
646 { \
647 uintptr_t v = (uintptr_t) t; \
648 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
649 ivarp ## _IVAR_ ## ivar, v); \
650 }
651
652 /**
653 * Shorthand macros, taking resource argument
654 * Generated with sys/tools/bus_macro.sh
655 */
656
657 #define bus_barrier(r, o, l, f) \
658 bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
659 #define bus_read_1(r, o) \
660 bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
661 #define bus_read_multi_1(r, o, d, c) \
662 bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
663 #define bus_read_region_1(r, o, d, c) \
664 bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
665 #define bus_set_multi_1(r, o, v, c) \
666 bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
667 #define bus_set_region_1(r, o, v, c) \
668 bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
669 #define bus_write_1(r, o, v) \
670 bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
671 #define bus_write_multi_1(r, o, d, c) \
672 bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
673 #define bus_write_region_1(r, o, d, c) \
674 bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
675 #define bus_read_stream_1(r, o) \
676 bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
677 #define bus_read_multi_stream_1(r, o, d, c) \
678 bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
679 #define bus_read_region_stream_1(r, o, d, c) \
680 bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
681 #define bus_set_multi_stream_1(r, o, v, c) \
682 bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
683 #define bus_set_region_stream_1(r, o, v, c) \
684 bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
685 #define bus_write_stream_1(r, o, v) \
686 bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
687 #define bus_write_multi_stream_1(r, o, d, c) \
688 bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
689 #define bus_write_region_stream_1(r, o, d, c) \
690 bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
691 #define bus_read_2(r, o) \
692 bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
693 #define bus_read_multi_2(r, o, d, c) \
694 bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
695 #define bus_read_region_2(r, o, d, c) \
696 bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
697 #define bus_set_multi_2(r, o, v, c) \
698 bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
699 #define bus_set_region_2(r, o, v, c) \
700 bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
701 #define bus_write_2(r, o, v) \
702 bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
703 #define bus_write_multi_2(r, o, d, c) \
704 bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
705 #define bus_write_region_2(r, o, d, c) \
706 bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
707 #define bus_read_stream_2(r, o) \
708 bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
709 #define bus_read_multi_stream_2(r, o, d, c) \
710 bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
711 #define bus_read_region_stream_2(r, o, d, c) \
712 bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
713 #define bus_set_multi_stream_2(r, o, v, c) \
714 bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
715 #define bus_set_region_stream_2(r, o, v, c) \
716 bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
717 #define bus_write_stream_2(r, o, v) \
718 bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
719 #define bus_write_multi_stream_2(r, o, d, c) \
720 bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
721 #define bus_write_region_stream_2(r, o, d, c) \
722 bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
723 #define bus_read_4(r, o) \
724 bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
725 #define bus_read_multi_4(r, o, d, c) \
726 bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
727 #define bus_read_region_4(r, o, d, c) \
728 bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
729 #define bus_set_multi_4(r, o, v, c) \
730 bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
731 #define bus_set_region_4(r, o, v, c) \
732 bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
733 #define bus_write_4(r, o, v) \
734 bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
735 #define bus_write_multi_4(r, o, d, c) \
736 bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
737 #define bus_write_region_4(r, o, d, c) \
738 bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
739 #define bus_read_stream_4(r, o) \
740 bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
741 #define bus_read_multi_stream_4(r, o, d, c) \
742 bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
743 #define bus_read_region_stream_4(r, o, d, c) \
744 bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
745 #define bus_set_multi_stream_4(r, o, v, c) \
746 bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
747 #define bus_set_region_stream_4(r, o, v, c) \
748 bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
749 #define bus_write_stream_4(r, o, v) \
750 bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
751 #define bus_write_multi_stream_4(r, o, d, c) \
752 bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
753 #define bus_write_region_stream_4(r, o, d, c) \
754 bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
755 #define bus_read_8(r, o) \
756 bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
757 #define bus_read_multi_8(r, o, d, c) \
758 bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
759 #define bus_read_region_8(r, o, d, c) \
760 bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
761 #define bus_set_multi_8(r, o, v, c) \
762 bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
763 #define bus_set_region_8(r, o, v, c) \
764 bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
765 #define bus_write_8(r, o, v) \
766 bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
767 #define bus_write_multi_8(r, o, d, c) \
768 bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
769 #define bus_write_region_8(r, o, d, c) \
770 bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
771 #define bus_read_stream_8(r, o) \
772 bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
773 #define bus_read_multi_stream_8(r, o, d, c) \
774 bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
775 #define bus_read_region_stream_8(r, o, d, c) \
776 bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
777 #define bus_set_multi_stream_8(r, o, v, c) \
778 bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
779 #define bus_set_region_stream_8(r, o, v, c) \
780 bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
781 #define bus_write_stream_8(r, o, v) \
782 bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
783 #define bus_write_multi_stream_8(r, o, d, c) \
784 bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
785 #define bus_write_region_stream_8(r, o, d, c) \
786 bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
787 #endif /* _KERNEL */
788
789 #endif /* !_SYS_BUS_H_ */
Cache object: 313020a35aa81376d3f0dd4a57a71c9f
|