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/8.2/sys/sys/bus.h 212892 2010-09-20 07:31:08Z avg $
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_FAST = 128,
195 INTR_EXCL = 256, /* exclusive interrupt */
196 INTR_MPSAFE = 512, /* this interrupt is SMP safe */
197 INTR_ENTROPY = 1024 /* this interrupt provides entropy */
198 };
199
200 enum intr_trigger {
201 INTR_TRIGGER_CONFORM = 0,
202 INTR_TRIGGER_EDGE = 1,
203 INTR_TRIGGER_LEVEL = 2
204 };
205
206 enum intr_polarity {
207 INTR_POLARITY_CONFORM = 0,
208 INTR_POLARITY_HIGH = 1,
209 INTR_POLARITY_LOW = 2
210 };
211
212 typedef int (*devop_t)(void);
213
214 /**
215 * @brief This structure is deprecated.
216 *
217 * Use the kobj(9) macro DEFINE_CLASS to
218 * declare classes which implement device drivers.
219 */
220 struct driver {
221 KOBJ_CLASS_FIELDS;
222 };
223
224 /*
225 * Definitions for drivers which need to keep simple lists of resources
226 * for their child devices.
227 */
228 struct resource;
229
230 /**
231 * @brief An entry for a single resource in a resource list.
232 */
233 struct resource_list_entry {
234 STAILQ_ENTRY(resource_list_entry) link;
235 int type; /**< @brief type argument to alloc_resource */
236 int rid; /**< @brief resource identifier */
237 struct resource *res; /**< @brief the real resource when allocated */
238 u_long start; /**< @brief start of resource range */
239 u_long end; /**< @brief end of resource range */
240 u_long count; /**< @brief count within range */
241 };
242 STAILQ_HEAD(resource_list, resource_list_entry);
243
244 void resource_list_init(struct resource_list *rl);
245 void resource_list_free(struct resource_list *rl);
246 struct resource_list_entry *
247 resource_list_add(struct resource_list *rl,
248 int type, int rid,
249 u_long start, u_long end, u_long count);
250 int resource_list_add_next(struct resource_list *rl,
251 int type,
252 u_long start, u_long end, u_long count);
253 struct resource_list_entry*
254 resource_list_find(struct resource_list *rl,
255 int type, int rid);
256 void resource_list_delete(struct resource_list *rl,
257 int type, int rid);
258 struct resource *
259 resource_list_alloc(struct resource_list *rl,
260 device_t bus, device_t child,
261 int type, int *rid,
262 u_long start, u_long end,
263 u_long count, u_int flags);
264 int resource_list_release(struct resource_list *rl,
265 device_t bus, device_t child,
266 int type, int rid, struct resource *res);
267 void resource_list_purge(struct resource_list *rl);
268 int resource_list_print_type(struct resource_list *rl,
269 const char *name, int type,
270 const char *format);
271
272 /*
273 * The root bus, to which all top-level busses are attached.
274 */
275 extern device_t root_bus;
276 extern devclass_t root_devclass;
277 void root_bus_configure(void);
278
279 /*
280 * Useful functions for implementing busses.
281 */
282
283 int bus_generic_activate_resource(device_t dev, device_t child, int type,
284 int rid, struct resource *r);
285 device_t
286 bus_generic_add_child(device_t dev, u_int order, const char *name,
287 int unit);
288 struct resource *
289 bus_generic_alloc_resource(device_t bus, device_t child, int type,
290 int *rid, u_long start, u_long end,
291 u_long count, u_int flags);
292 int bus_generic_attach(device_t dev);
293 int bus_generic_bind_intr(device_t dev, device_t child,
294 struct resource *irq, int cpu);
295 int bus_generic_child_present(device_t dev, device_t child);
296 int bus_generic_config_intr(device_t, int, enum intr_trigger,
297 enum intr_polarity);
298 int bus_generic_describe_intr(device_t dev, device_t child,
299 struct resource *irq, void *cookie,
300 const char *descr);
301 int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
302 int rid, struct resource *r);
303 int bus_generic_detach(device_t dev);
304 void bus_generic_driver_added(device_t dev, driver_t *driver);
305 bus_dma_tag_t
306 bus_generic_get_dma_tag(device_t dev, device_t child);
307 struct resource_list *
308 bus_generic_get_resource_list (device_t, device_t);
309 void bus_generic_new_pass(device_t dev);
310 int bus_print_child_header(device_t dev, device_t child);
311 int bus_print_child_footer(device_t dev, device_t child);
312 int bus_generic_print_child(device_t dev, device_t child);
313 int bus_generic_probe(device_t dev);
314 int bus_generic_read_ivar(device_t dev, device_t child, int which,
315 uintptr_t *result);
316 int bus_generic_release_resource(device_t bus, device_t child,
317 int type, int rid, struct resource *r);
318 int bus_generic_resume(device_t dev);
319 int bus_generic_setup_intr(device_t dev, device_t child,
320 struct resource *irq, int flags,
321 driver_filter_t *filter, driver_intr_t *intr,
322 void *arg, void **cookiep);
323
324 struct resource *
325 bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
326 u_long, u_long, u_long, u_int);
327 void bus_generic_rl_delete_resource (device_t, device_t, int, int);
328 int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
329 u_long *);
330 int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
331 u_long);
332 int bus_generic_rl_release_resource (device_t, device_t, int, int,
333 struct resource *);
334
335 int bus_generic_shutdown(device_t dev);
336 int bus_generic_suspend(device_t dev);
337 int bus_generic_teardown_intr(device_t dev, device_t child,
338 struct resource *irq, void *cookie);
339 int bus_generic_write_ivar(device_t dev, device_t child, int which,
340 uintptr_t value);
341
342 /*
343 * Wrapper functions for the BUS_*_RESOURCE methods to make client code
344 * a little simpler.
345 */
346
347 struct resource_spec {
348 int type;
349 int rid;
350 int flags;
351 };
352
353 int bus_alloc_resources(device_t dev, struct resource_spec *rs, struct resource **res);
354 void bus_release_resources(device_t dev, const struct resource_spec *rs, struct resource **res);
355
356 struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
357 u_long start, u_long end, u_long count,
358 u_int flags);
359 int bus_activate_resource(device_t dev, int type, int rid,
360 struct resource *r);
361 int bus_deactivate_resource(device_t dev, int type, int rid,
362 struct resource *r);
363 bus_dma_tag_t bus_get_dma_tag(device_t dev);
364 int bus_release_resource(device_t dev, int type, int rid,
365 struct resource *r);
366 int bus_free_resource(device_t dev, int type, struct resource *r);
367 int bus_setup_intr(device_t dev, struct resource *r, int flags,
368 driver_filter_t filter, driver_intr_t handler,
369 void *arg, void **cookiep);
370 int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
371 int bus_bind_intr(device_t dev, struct resource *r, int cpu);
372 int bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
373 const char *fmt, ...);
374 int bus_set_resource(device_t dev, int type, int rid,
375 u_long start, u_long count);
376 int bus_get_resource(device_t dev, int type, int rid,
377 u_long *startp, u_long *countp);
378 u_long bus_get_resource_start(device_t dev, int type, int rid);
379 u_long bus_get_resource_count(device_t dev, int type, int rid);
380 void bus_delete_resource(device_t dev, int type, int rid);
381 int bus_child_present(device_t child);
382 int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
383 int bus_child_location_str(device_t child, char *buf, size_t buflen);
384 void bus_enumerate_hinted_children(device_t bus);
385
386 static __inline struct resource *
387 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
388 {
389 return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
390 }
391
392 /*
393 * Access functions for device.
394 */
395 device_t device_add_child(device_t dev, const char *name, int unit);
396 device_t device_add_child_ordered(device_t dev, u_int order,
397 const char *name, int unit);
398 void device_busy(device_t dev);
399 int device_delete_child(device_t dev, device_t child);
400 int device_attach(device_t dev);
401 int device_detach(device_t dev);
402 void device_disable(device_t dev);
403 void device_enable(device_t dev);
404 device_t device_find_child(device_t dev, const char *classname,
405 int unit);
406 const char *device_get_desc(device_t dev);
407 devclass_t device_get_devclass(device_t dev);
408 driver_t *device_get_driver(device_t dev);
409 u_int32_t device_get_flags(device_t dev);
410 device_t device_get_parent(device_t dev);
411 int device_get_children(device_t dev, device_t **listp, int *countp);
412 void *device_get_ivars(device_t dev);
413 void device_set_ivars(device_t dev, void *ivars);
414 const char *device_get_name(device_t dev);
415 const char *device_get_nameunit(device_t dev);
416 void *device_get_softc(device_t dev);
417 device_state_t device_get_state(device_t dev);
418 int device_get_unit(device_t dev);
419 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
420 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
421 int device_is_alive(device_t dev); /* did probe succeed? */
422 int device_is_attached(device_t dev); /* did attach succeed? */
423 int device_is_enabled(device_t dev);
424 int device_is_quiet(device_t dev);
425 int device_print_prettyname(device_t dev);
426 int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
427 int device_probe(device_t dev);
428 int device_probe_and_attach(device_t dev);
429 int device_probe_child(device_t bus, device_t dev);
430 int device_quiesce(device_t dev);
431 void device_quiet(device_t dev);
432 void device_set_desc(device_t dev, const char* desc);
433 void device_set_desc_copy(device_t dev, const char* desc);
434 int device_set_devclass(device_t dev, const char *classname);
435 int device_set_driver(device_t dev, driver_t *driver);
436 void device_set_flags(device_t dev, u_int32_t flags);
437 void device_set_softc(device_t dev, void *softc);
438 int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
439 int device_shutdown(device_t dev);
440 void device_unbusy(device_t dev);
441 void device_verbose(device_t dev);
442
443 /*
444 * Access functions for devclass.
445 */
446 devclass_t devclass_create(const char *classname);
447 devclass_t devclass_find(const char *classname);
448 const char *devclass_get_name(devclass_t dc);
449 device_t devclass_get_device(devclass_t dc, int unit);
450 void *devclass_get_softc(devclass_t dc, int unit);
451 int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
452 int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
453 int devclass_get_count(devclass_t dc);
454 int devclass_get_maxunit(devclass_t dc);
455 int devclass_find_free_unit(devclass_t dc, int unit);
456 void devclass_set_parent(devclass_t dc, devclass_t pdc);
457 devclass_t devclass_get_parent(devclass_t dc);
458 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
459 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
460
461 /*
462 * Access functions for device resources.
463 */
464
465 int resource_int_value(const char *name, int unit, const char *resname,
466 int *result);
467 int resource_long_value(const char *name, int unit, const char *resname,
468 long *result);
469 int resource_string_value(const char *name, int unit, const char *resname,
470 const char **result);
471 int resource_disabled(const char *name, int unit);
472 int resource_find_match(int *anchor, const char **name, int *unit,
473 const char *resname, const char *value);
474 int resource_find_dev(int *anchor, const char *name, int *unit,
475 const char *resname, const char *value);
476 int resource_set_int(const char *name, int unit, const char *resname,
477 int value);
478 int resource_set_long(const char *name, int unit, const char *resname,
479 long value);
480 int resource_set_string(const char *name, int unit, const char *resname,
481 const char *value);
482 /*
483 * Functions for maintaining and checking consistency of
484 * bus information exported to userspace.
485 */
486 int bus_data_generation_check(int generation);
487 void bus_data_generation_update(void);
488
489 /**
490 * Some convenience defines for probe routines to return. These are just
491 * suggested values, and there's nothing magical about them.
492 * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
493 * possible other driver may exist (typically legacy drivers who don't fallow
494 * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the
495 * suggested value that vendor supplied drivers use. This is for source or
496 * binary drivers that are not yet integrated into the FreeBSD tree. Its use
497 * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value
498 * for drivers to use. It is intended that nearly all of the drivers in the
499 * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that
500 * have special requirements like when there are two drivers that support
501 * overlapping series of hardware devices. In this case the one that supports
502 * the older part of the line would return this value, while the one that
503 * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC
504 * is for drivers that wish to have a generic form and a specialized form,
505 * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is
506 * for those busses that implement a generic device place-holder for devices on
507 * the bus that have no more specific river for them (aka ugen).
508 * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding
509 * for a device node, but accepts only devices that its parent has told it
510 * use this driver.
511 */
512 #define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */
513 #define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */
514 #define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */
515 #define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */
516 #define BUS_PROBE_GENERIC (-100) /* generic driver for dev */
517 #define BUS_PROBE_HOOVER (-500) /* Generic dev for all devs on bus */
518 #define BUS_PROBE_NOWILDCARD (-2000000000) /* No wildcard device matches */
519
520 /**
521 * During boot, the device tree is scanned multiple times. Each scan,
522 * or pass, drivers may be attached to devices. Each driver
523 * attachment is assigned a pass number. Drivers may only probe and
524 * attach to devices if their pass number is less than or equal to the
525 * current system-wide pass number. The default pass is the last pass
526 * and is used by most drivers. Drivers needed by the scheduler are
527 * probed in earlier passes.
528 */
529 #define BUS_PASS_ROOT 0 /* Used to attach root0. */
530 #define BUS_PASS_BUS 10 /* Busses and bridges. */
531 #define BUS_PASS_CPU 20 /* CPU devices. */
532 #define BUS_PASS_RESOURCE 30 /* Resource discovery. */
533 #define BUS_PASS_INTERRUPT 40 /* Interrupt controllers. */
534 #define BUS_PASS_TIMER 50 /* Timers and clocks. */
535 #define BUS_PASS_SCHEDULER 60 /* Start scheduler. */
536 #define BUS_PASS_DEFAULT __INT_MAX /* Everything else. */
537
538 extern int bus_current_pass;
539
540 void bus_set_pass(int pass);
541
542 /**
543 * Shorthand for constructing method tables.
544 */
545 #define DEVMETHOD KOBJMETHOD
546
547 /*
548 * Some common device interfaces.
549 */
550 #include "device_if.h"
551 #include "bus_if.h"
552
553 struct module;
554
555 int driver_module_handler(struct module *, int, void *);
556
557 /**
558 * Module support for automatically adding drivers to busses.
559 */
560 struct driver_module_data {
561 int (*dmd_chainevh)(struct module *, int, void *);
562 void *dmd_chainarg;
563 const char *dmd_busname;
564 kobj_class_t dmd_driver;
565 devclass_t *dmd_devclass;
566 int dmd_pass;
567 };
568
569 #define EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, pass) \
570 \
571 static struct driver_module_data name##_##busname##_driver_mod = { \
572 evh, arg, \
573 #busname, \
574 (kobj_class_t) &driver, \
575 &devclass, \
576 pass \
577 }; \
578 \
579 static moduledata_t name##_##busname##_mod = { \
580 #busname "/" #name, \
581 driver_module_handler, \
582 &name##_##busname##_driver_mod \
583 }; \
584 DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \
585 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
586
587 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \
588 EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, \
589 BUS_PASS_DEFAULT)
590
591 /**
592 * Generic ivar accessor generation macros for bus drivers
593 */
594 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
595 \
596 static __inline type varp ## _get_ ## var(device_t dev) \
597 { \
598 uintptr_t v; \
599 BUS_READ_IVAR(device_get_parent(dev), dev, \
600 ivarp ## _IVAR_ ## ivar, &v); \
601 return ((type) v); \
602 } \
603 \
604 static __inline void varp ## _set_ ## var(device_t dev, type t) \
605 { \
606 uintptr_t v = (uintptr_t) t; \
607 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
608 ivarp ## _IVAR_ ## ivar, v); \
609 }
610
611 /**
612 * Shorthand macros, taking resource argument
613 * Generated with sys/tools/bus_macro.sh
614 */
615
616 #define bus_barrier(r, o, l, f) \
617 bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
618 #define bus_read_1(r, o) \
619 bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
620 #define bus_read_multi_1(r, o, d, c) \
621 bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
622 #define bus_read_region_1(r, o, d, c) \
623 bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
624 #define bus_set_multi_1(r, o, v, c) \
625 bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
626 #define bus_set_region_1(r, o, v, c) \
627 bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
628 #define bus_write_1(r, o, v) \
629 bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
630 #define bus_write_multi_1(r, o, d, c) \
631 bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
632 #define bus_write_region_1(r, o, d, c) \
633 bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
634 #define bus_read_stream_1(r, o) \
635 bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
636 #define bus_read_multi_stream_1(r, o, d, c) \
637 bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
638 #define bus_read_region_stream_1(r, o, d, c) \
639 bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
640 #define bus_set_multi_stream_1(r, o, v, c) \
641 bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
642 #define bus_set_region_stream_1(r, o, v, c) \
643 bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
644 #define bus_write_stream_1(r, o, v) \
645 bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
646 #define bus_write_multi_stream_1(r, o, d, c) \
647 bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
648 #define bus_write_region_stream_1(r, o, d, c) \
649 bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
650 #define bus_read_2(r, o) \
651 bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
652 #define bus_read_multi_2(r, o, d, c) \
653 bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
654 #define bus_read_region_2(r, o, d, c) \
655 bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
656 #define bus_set_multi_2(r, o, v, c) \
657 bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
658 #define bus_set_region_2(r, o, v, c) \
659 bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
660 #define bus_write_2(r, o, v) \
661 bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
662 #define bus_write_multi_2(r, o, d, c) \
663 bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
664 #define bus_write_region_2(r, o, d, c) \
665 bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
666 #define bus_read_stream_2(r, o) \
667 bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
668 #define bus_read_multi_stream_2(r, o, d, c) \
669 bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
670 #define bus_read_region_stream_2(r, o, d, c) \
671 bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
672 #define bus_set_multi_stream_2(r, o, v, c) \
673 bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
674 #define bus_set_region_stream_2(r, o, v, c) \
675 bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
676 #define bus_write_stream_2(r, o, v) \
677 bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
678 #define bus_write_multi_stream_2(r, o, d, c) \
679 bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
680 #define bus_write_region_stream_2(r, o, d, c) \
681 bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
682 #define bus_read_4(r, o) \
683 bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
684 #define bus_read_multi_4(r, o, d, c) \
685 bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
686 #define bus_read_region_4(r, o, d, c) \
687 bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
688 #define bus_set_multi_4(r, o, v, c) \
689 bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
690 #define bus_set_region_4(r, o, v, c) \
691 bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
692 #define bus_write_4(r, o, v) \
693 bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
694 #define bus_write_multi_4(r, o, d, c) \
695 bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
696 #define bus_write_region_4(r, o, d, c) \
697 bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
698 #define bus_read_stream_4(r, o) \
699 bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
700 #define bus_read_multi_stream_4(r, o, d, c) \
701 bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
702 #define bus_read_region_stream_4(r, o, d, c) \
703 bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
704 #define bus_set_multi_stream_4(r, o, v, c) \
705 bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
706 #define bus_set_region_stream_4(r, o, v, c) \
707 bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
708 #define bus_write_stream_4(r, o, v) \
709 bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
710 #define bus_write_multi_stream_4(r, o, d, c) \
711 bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
712 #define bus_write_region_stream_4(r, o, d, c) \
713 bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
714 #define bus_read_8(r, o) \
715 bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
716 #define bus_read_multi_8(r, o, d, c) \
717 bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
718 #define bus_read_region_8(r, o, d, c) \
719 bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
720 #define bus_set_multi_8(r, o, v, c) \
721 bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
722 #define bus_set_region_8(r, o, v, c) \
723 bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
724 #define bus_write_8(r, o, v) \
725 bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
726 #define bus_write_multi_8(r, o, d, c) \
727 bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
728 #define bus_write_region_8(r, o, d, c) \
729 bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
730 #define bus_read_stream_8(r, o) \
731 bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
732 #define bus_read_multi_stream_8(r, o, d, c) \
733 bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
734 #define bus_read_region_stream_8(r, o, d, c) \
735 bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
736 #define bus_set_multi_stream_8(r, o, v, c) \
737 bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
738 #define bus_set_region_stream_8(r, o, v, c) \
739 bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
740 #define bus_write_stream_8(r, o, v) \
741 bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
742 #define bus_write_multi_stream_8(r, o, d, c) \
743 bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
744 #define bus_write_region_stream_8(r, o, d, c) \
745 bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
746 #endif /* _KERNEL */
747
748 #endif /* !_SYS_BUS_H_ */
Cache object: 70749a8c31ac8c2b2aa6ce72c43c5e96
|