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