xref: /dragonfly/sys/sys/bus.h (revision a162a738eca94f99d45d88429e86cfd0fbfbe95d)
1 /*-
2  * Copyright (c) 1997,1998 Doug Rabson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/sys/bus.h,v 1.30.2.5 2004/03/17 17:54:25 njl Exp $
27  */
28 
29 #ifndef _SYS_BUS_H_
30 #define _SYS_BUS_H_
31 
32 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
33 
34 #ifndef _SYS_TYPES_H_
35 #include <sys/types.h>
36 #endif
37 #ifndef _SYS_QUEUE_H_
38 #include <sys/queue.h>
39 #endif
40 #ifndef _SYS_KOBJ_H_
41 #include <sys/kobj.h>
42 #endif
43 #ifdef _KERNEL
44 #include <sys/serialize.h>
45 #endif
46 #ifndef _SYS_BUS_DMA_H_
47 #include <sys/bus_dma.h>
48 #endif
49 #ifndef _SYS_BUS_RESOURCE_H_
50 #include <sys/bus_resource.h>
51 #endif
52 
53 /*
54  * Forward declarations
55  */
56 typedef struct bsd_device     *device_t;
57 typedef struct kobj_class     driver_t;
58 typedef struct devclass                 *devclass_t;
59 #define   device_method_t               kobj_method_t
60 
61 typedef int driver_filter_t(void*);
62 typedef void driver_intr_t(void*);
63 
64 /*
65  * Interface information structure.
66  */
67 struct u_businfo {
68           int       ub_version;                   /* interface version */
69 #define BUS_USER_VERSION      1
70           int       ub_generation;                /* generation count */
71 };
72 
73 /*
74  * State of the device.
75  */
76 typedef enum device_state {
77           DS_NOTPRESENT,                          /* not probed or probe failed */
78           DS_ALIVE,                     /* probe succeeded */
79           DS_INPROGRESS,                          /* attach in progress */
80           DS_ATTACHED,                            /* attach method called */
81           DS_BUSY                                 /* device is open */
82 } device_state_t;
83 
84 /*
85  * Device information exported to userspace.
86  */
87 struct u_device {
88           uintptr_t dv_handle;
89           uintptr_t dv_parent;
90 
91           char                dv_name[32];                  /* Name of device in tree. */
92           char                dv_desc[32];                  /* Driver description */
93           char                dv_drivername[32];  /* Driver name */
94           char                dv_pnpinfo[128];    /* Plug and play info */
95           char                dv_location[128];   /* Where is the device? */
96           uint32_t  dv_devflags;                  /* API Flags for device */
97           uint16_t  dv_flags;           /* flags for dev date */
98           device_state_t      dv_state;           /* State of attachment */
99           /* XXX more driver info? */
100 };
101 
102 /*
103  * Interrupt features mask.  Note that DragonFly no longer implements
104  * INTR_TYPE_* flags.
105  *
106  * NOTE: INTR_FAST is no longer supported, all device interrupts are threaded
107  *         now.  Only clock interrupts are 'fast'.
108  */
109 #define   INTR_HIFREQ         0x0040    /* high frequency interrupt */
110 #define   INTR_CLOCK          0x0080    /* (was INTR_FAST) */
111 #define   INTR_EXCL 0x0100
112 #define   INTR_MPSAFE         0x0200
113 #define   INTR_NOENTROPY      0x0400
114 #define INTR_NOPOLL 0x0800    /* interrupt cannot be polled (e.g. ata) */
115 
116 enum intr_trigger {
117     INTR_TRIGGER_CONFORM = 0,
118     INTR_TRIGGER_EDGE = 1,
119     INTR_TRIGGER_LEVEL = 2
120 };
121 
122 enum intr_polarity {
123     INTR_POLARITY_CONFORM = 0,
124     INTR_POLARITY_HIGH = 1,
125     INTR_POLARITY_LOW = 2
126 };
127 
128 typedef int (*devop_t)(void);
129 
130 /*
131  * Definitions for drivers which need to keep simple lists of resources
132  * for their child devices.
133  */
134 struct    resource;
135 
136 struct resource_list_entry {
137     SLIST_ENTRY(resource_list_entry) link;
138     int                       type;               /* type argument to alloc_resource */
139     int                       rid;                /* resource identifier */
140     struct resource *res;               /* the real resource when allocated */
141     u_long                    start;              /* start of resource range */
142     u_long                    end;                /* end of resource range */
143     u_long                    count;              /* count within range */
144     int                       cpuid;              /* owner cpuid */
145 };
146 SLIST_HEAD(resource_list, resource_list_entry);
147 
148 #endif    /* _KERNEL || _KERNEL_STRUCTURES */
149 #ifdef _KERNEL
150 
151 const char          *intr_str_polarity(enum intr_polarity);
152 const char          *intr_str_trigger(enum intr_trigger);
153 
154 /**
155  * devctl hooks.  Typically one should use the devctl_notify
156  * hook to send the message.  However, devctl_queue_data is also
157  * included in case devctl_notify isn't sufficiently general.
158  */
159 boolean_t devctl_process_running(void);
160 void devctl_notify(const char *__system, const char *__subsystem,
161     const char *__type, const char *__data);
162 void devctl_queue_data(char *__data);
163 
164 /*
165  * Initialise a resource list.
166  */
167 void      resource_list_init(struct resource_list *rl);
168 
169 /*
170  * Reclaim memory used by a resource list.
171  */
172 void      resource_list_free(struct resource_list *rl);
173 
174 /*
175  * Add a resource entry or modify an existing entry if one exists with
176  * the same type and rid.
177  */
178 void      resource_list_add(struct resource_list *rl, int type, int rid,
179               u_long start, u_long end, u_long count, int cpuid);
180 
181 /*
182  * Find a resource entry by type and rid.
183  */
184 struct resource_list_entry*
185           resource_list_find(struct resource_list *rl,
186                                  int type, int rid);
187 
188 /*
189  * Delete a resource entry.
190  */
191 void      resource_list_delete(struct resource_list *rl,
192                                    int type, int rid);
193 
194 /*
195  * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
196  * and passing the allocation up to the parent of bus. This assumes
197  * that the first entry of device_get_ivars(child) is a struct
198  * resource_list. This also handles 'passthrough' allocations where a
199  * child is a remote descendant of bus by passing the allocation up to
200  * the parent of bus.
201  */
202 struct resource *
203           resource_list_alloc(struct resource_list *rl,
204                                   device_t bus, device_t child,
205                                   int type, int *rid,
206                                   u_long start, u_long end,
207                                   u_long count, u_int flags, int cpuid);
208 
209 /*
210  * Implement BUS_RELEASE_RESOURCE.
211  */
212 int       resource_list_release(struct resource_list *rl,
213                                     device_t bus, device_t child,
214                                     int type, int rid, struct resource *res);
215 
216 /*
217  * Print all resources of a specified type, for use in bus_print_child.
218  * The name is printed if at least one resource of the given type is available.
219  * The format ist used to print resource start and end.
220  */
221 int       resource_list_print_type(struct resource_list *rl,
222                                          const char *name, int type,
223                                          const char *format);
224 
225 /*
226  * The root bus, to which all top-level busses are attached.
227  */
228 extern device_t root_bus;
229 void      root_bus_configure(void);
230 
231 /*
232  * Useful functions for implementing busses.
233  */
234 
235 int       bus_generic_activate_resource(device_t dev, device_t child, int type,
236                                               int rid, struct resource *r);
237 struct resource *
238           bus_generic_alloc_resource(device_t bus, device_t child,
239                                             int type, int *rid,
240                                             u_long start, u_long end,
241                                             u_long count, u_int flags, int cpuid);
242 struct resource_list *
243           bus_generic_get_resource_list (device_t, device_t);
244 
245 int     bus_generic_config_intr(device_t, device_t, int, enum intr_trigger,
246                                                   enum intr_polarity);
247 int       bus_generic_attach(device_t dev);
248 int       bus_generic_attach_gpri(device_t dev, u_int gpri);
249 int       bus_generic_child_present(device_t dev, device_t child);
250 int       bus_generic_deactivate_resource(device_t dev, device_t child, int type,
251                                                   int rid, struct resource *r);
252 int       bus_generic_detach(device_t dev);
253 int       bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
254 void      bus_generic_driver_added(device_t dev, driver_t *driver);
255 bus_dma_tag_t
256           bus_generic_get_dma_tag(device_t dev, device_t child);
257 void      bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
258 int       bus_print_child_header(device_t dev, device_t child);
259 int       bus_print_child_footer(device_t dev, device_t child);
260 int       bus_generic_print_child(device_t dev, device_t child);
261 int       bus_generic_identify(driver_t *driver, device_t parent);
262 int       bus_generic_identify_sameunit(driver_t *driver, device_t parent);
263 int       bus_generic_probe(device_t dev);
264 int       bus_generic_probe_hack(device_t dev);
265 device_t bus_generic_add_child(device_t, device_t, int, const char *, int);
266 int       bus_generic_read_ivar(device_t dev, device_t child, int which,
267                                     uintptr_t *result);
268 int       bus_generic_release_resource(device_t bus, device_t child,
269                                              int type, int rid, struct resource *r);
270 int       bus_generic_get_resource(device_t dev, device_t child, int type,
271                                              int rid, u_long *startp, u_long *countp);
272 int       bus_generic_set_resource(device_t dev, device_t child,
273               int type, int rid, u_long start, u_long count, int cpuid);
274 void      bus_generic_delete_resource(device_t dev, device_t child,
275                                              int type, int rid);
276 int       bus_generic_resume(device_t dev);
277 int       bus_generic_setup_intr(device_t dev, device_t child,
278               struct resource *irq, int flags, driver_intr_t *intr, void *arg,
279               void **cookiep, lwkt_serialize_t serializer, const char *desc);
280 int       bus_generic_shutdown(device_t dev);
281 int       bus_generic_suspend(device_t dev);
282 int       bus_generic_teardown_intr(device_t dev, device_t child,
283                                           struct resource *irq, void *cookie);
284 int       bus_generic_write_ivar(device_t dev, device_t child, int which,
285                                      uintptr_t value);
286 
287 struct resource *
288           bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
289                                             u_long, u_long, u_long, u_int, int);
290 void      bus_generic_rl_delete_resource (device_t, device_t, int, int);
291 int       bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
292                                             u_long *);
293 int       bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
294                                             u_long, int);
295 int       bus_generic_rl_release_resource (device_t, device_t, int, int,
296                                             struct resource *);
297 
298 /*
299  * Wrapper functions for the BUS_*_RESOURCE methods to make client code
300  * a little simpler.
301  */
302 struct resource_spec {
303           int     type;
304           int     rid;
305           int     flags;
306 };
307 
308 int bus_alloc_resources(device_t dev, struct resource_spec *rs,
309                               struct resource **res);
310 void bus_release_resources(device_t dev, const struct resource_spec *rs,
311                                  struct resource **res);
312 
313 struct    resource *bus_alloc_resource(device_t dev, int type, int *rid,
314                                              u_long start, u_long end, u_long count,
315                                              u_int flags);
316 struct    resource *bus_alloc_legacy_irq_resource(device_t dev, int *rid,
317                                              u_long irq, u_int flags);
318 int       bus_activate_resource(device_t dev, int type, int rid,
319                                     struct resource *r);
320 int       bus_deactivate_resource(device_t dev, int type, int rid,
321                                         struct resource *r);
322 bus_dma_tag_t bus_get_dma_tag(device_t dev);
323 int       bus_disable_intr(device_t dev, void *cookie);
324 void      bus_enable_intr(device_t dev, void *cookie);
325 int       bus_release_resource(device_t dev, int type, int rid,
326                                    struct resource *r);
327 int       bus_setup_intr(device_t dev, struct resource *r, int flags,
328                            driver_intr_t handler, void *arg,
329                            void **cookiep, lwkt_serialize_t serializer);
330 int       bus_setup_intr_descr(device_t dev, struct resource *r, int flags,
331               driver_intr_t handler, void *arg, void **cookiep,
332               lwkt_serialize_t serializer, const char *desc);
333 int       bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
334 int       bus_set_resource(device_t dev, int type, int rid,
335                                u_long start, u_long count, int cpuid);
336 int       bus_get_resource(device_t dev, int type, int rid,
337                                u_long *startp, u_long *countp);
338 u_long    bus_get_resource_start(device_t dev, int type, int rid);
339 u_long    bus_get_resource_count(device_t dev, int type, int rid);
340 void      bus_delete_resource(device_t dev, int type, int rid);
341 int       bus_child_present(device_t child);
342 int       bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
343 int       bus_child_location_str(device_t child, char *buf, size_t buflen);
344 
345 static __inline struct resource *
bus_alloc_resource_any(device_t dev,int type,int * rid,u_int flags)346 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
347 {
348           return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
349 }
350 
351 /*
352  * Access functions for device.
353  */
354 device_t  device_add_child(device_t dev, const char *name, int unit);
355 device_t  device_add_child_ordered(device_t dev, int order,
356                                                    const char *name, int unit);
357 void      device_busy(device_t dev);
358 int       device_delete_child(device_t dev, device_t child);
359 int       device_delete_children(device_t dev);
360 int       device_detach(device_t dev);
361 void      device_disable(device_t dev);
362 void      device_enable(device_t dev);
363 device_t  device_find_child(device_t dev, const char *classname,
364                                           int unit);
365 const char          *device_get_desc(device_t dev);
366 devclass_t          device_get_devclass(device_t dev);
367 driver_t  *device_get_driver(device_t dev);
368 u_int32_t device_get_flags(device_t dev);
369 device_t  device_get_parent(device_t dev);
370 int       device_get_children(device_t dev, device_t **listp, int *countp);
371 void      *device_get_ivars(device_t dev);
372 void      device_set_ivars(device_t dev, void *ivars);
373 const     char *device_get_name(device_t dev);
374 const     char *device_get_nameunit(device_t dev);
375 void      *device_get_softc(device_t dev);
376 device_state_t      device_get_state(device_t dev);
377 int       device_get_unit(device_t dev);
378 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
379 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
380 int       device_is_alive(device_t dev); /* did probe succeed? */
381 int       device_is_attached(device_t dev);       /* did attach succeed? */
382 int       device_is_enabled(device_t dev);
383 int       device_is_quiet(device_t dev);
384 int       device_print_prettyname(device_t dev);
385 int       device_printf(device_t dev, const char *, ...) __printflike(2, 3);
386 int       device_log(device_t dev, int pri, const char *, ...) __printflike(3, 4);
387 int       device_probe_and_attach(device_t dev);
388 int       device_probe_and_attach_gpri(device_t dev, u_int gpri);
389 int       device_probe_child(device_t dev, device_t child);
390 int       device_probe_child_gpri(device_t dev, device_t child, u_int gpri);
391 void      device_quiet(device_t dev);
392 void      device_set_desc(device_t dev, const char* desc);
393 void      device_set_desc_copy(device_t dev, const char* desc);
394 int       device_set_devclass(device_t dev, const char *classname);
395 int       device_set_driver(device_t dev, driver_t *driver);
396 void      device_set_flags(device_t dev, u_int32_t flags);
397 void      device_set_softc(device_t dev, void *softc);
398 void      device_set_async_attach(device_t dev, int enable);
399 int       device_set_unit(device_t dev, int unit);          /* XXX DONT USE XXX */
400 int       device_shutdown(device_t dev);
401 void      device_unbusy(device_t dev);
402 void      device_verbose(device_t dev);
403 int       device_getenv_int(device_t dev, const char *knob, int def);
404 void      device_getenv_string(device_t dev, const char *knob,
405               char * __restrict data, int dlen, const char * __restrict def);
406 
407 /*
408  * Access functions for devclass.
409  */
410 int       devclass_add_driver(devclass_t dc, kobj_class_t driver);
411 int       devclass_delete_driver(devclass_t dc, kobj_class_t driver);
412 devclass_t          devclass_create(const char *classname);
413 devclass_t          devclass_find(const char *classname);
414 device_t  devclass_find_unit(const char *classname, int unit);
415 kobj_class_t        devclass_find_driver(devclass_t dc, const char *classname);
416 const char          *devclass_get_name(devclass_t dc);
417 device_t  devclass_get_device(devclass_t dc, int unit);
418 void      *devclass_get_softc(devclass_t dc, int unit);
419 int       devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
420 int       devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
421 int       devclass_get_count(devclass_t dc);
422 int       devclass_get_maxunit(devclass_t dc);
423 void      devclass_set_parent(devclass_t dc, devclass_t pdc);
424 devclass_t          devclass_get_parent(devclass_t dc);
425 
426 /*
427  * Access functions for device resources.
428  */
429 
430 int       resource_int_value(const char *name, int unit, const char *resname,
431                                  int *result);
432 int       resource_long_value(const char *name, int unit, const char *resname,
433                                   long *result);
434 int       resource_string_value(const char *name, int unit, const char *resname,
435                                     const char **result);
436 int     resource_disabled(const char *name, int unit);
437 int       resource_query_string(int i, const char *resname, const char *value);
438 char      *resource_query_name(int i);
439 int       resource_query_unit(int i);
440 int       resource_locate(int i, const char *resname);
441 int       resource_set_int(const char *name, int unit, const char *resname,
442                                int value);
443 int       resource_set_long(const char *name, int unit, const char *resname,
444                                 long value);
445 int       resource_set_string(const char *name, int unit, const char *resname,
446                                   const char *value);
447 int       resource_count(void);
448 
449 /*
450  * Functions for maintaining and checking consistency of
451  * bus information exported to userspace.
452  */
453 int       bus_data_generation_check(int generation);
454 void      bus_data_generation_update(void);
455 
456 /**
457  * Some convenience defines for probe routines to return.  These are just
458  * suggested values, and there's nothing magical about them.
459  * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
460  * possible other driver may exist (typically legacy drivers who don't fallow
461  * all the rules, or special needs drivers).  BUS_PROBE_VENDOR is the
462  * suggested value that vendor supplied drivers use.  This is for source or
463  * binary drivers that are not yet integrated into the FreeBSD tree.  Its use
464  * in the base OS is prohibited.  BUS_PROBE_DEFAULT is the normal return value
465  * for drivers to use.  It is intended that nearly all of the drivers in the
466  * tree should return this value.  BUS_PROBE_LOW_PRIORITY are for drivers that
467  * have special requirements like when there are two drivers that support
468  * overlapping series of hardware devices.  In this case the one that supports
469  * the older part of the line would return this value, while the one that
470  * supports the newer ones would return BUS_PROBE_DEFAULT.  BUS_PROBE_GENERIC
471  * is for drivers that wish to have a generic form and a specialized form,
472  * like is done with the pci bus and the acpi pci bus.  BUS_PROBE_HOOVER is
473  * for those busses that implement a generic device place-holder for devices on
474  * the bus that have no more specific driver for them (aka ugen).
475  */
476 #define BUS_PROBE_SPECIFIC      0       /* Only I can use this device */
477 #if 0 /* notyet */
478 #define BUS_PROBE_VENDOR        (-10)   /* Vendor supplied driver */
479 #define BUS_PROBE_DEFAULT       (-20)   /* Base OS default driver */
480 #define BUS_PROBE_LOW_PRIORITY  (-40)   /* Older, less desirable drivers */
481 #define BUS_PROBE_GENERIC       (-100)  /* generic driver for dev */
482 #define BUS_PROBE_HOOVER        (-500)  /* Generic dev for all devs on bus */
483 #else
484 #define BUS_PROBE_VENDOR        0
485 #define BUS_PROBE_DEFAULT       0
486 #define BUS_PROBE_LOW_PRIORITY  0
487 #define BUS_PROBE_GENERIC       0
488 #define BUS_PROBE_HOOVER        0
489 #endif
490 
491 /*
492  * Shorthand for constructing method tables.
493  */
494 #define DEVMETHOD   KOBJMETHOD
495 #define DEVMETHOD_END         KOBJMETHOD_END
496 
497 /*
498  * Some common device interfaces.
499  */
500 #include "device_if.h"
501 #include "bus_if.h"
502 
503 struct    module;
504 
505 int       driver_module_handler(struct module *, int, void *);
506 
507 /*
508  * Module support for automatically adding drivers to busses.
509  */
510 struct driver_module_data {
511           int                 (*dmd_chainevh)(struct module *, int, void *);
512           void                *dmd_chainarg;
513           const char          *dmd_busname;
514           kobj_class_t        dmd_driver;
515           devclass_t          *dmd_devclass;
516 };
517 
518 #define DRIVER_MODULE_ORDERED(name, busname, driver, devclassp, evh, arg,\
519                               order)                                            \
520                                                                                           \
521 static struct driver_module_data name##_##busname##_driver_mod = {    \
522           evh, arg,                                                             \
523           #busname,                                                             \
524           (kobj_class_t) &driver,                                                         \
525           devclassp                                                             \
526 };                                                                                        \
527                                                                                           \
528 static moduledata_t name##_##busname##_mod = {                                  \
529           #busname "/" #name,                                                   \
530           driver_module_handler,                                                          \
531           &name##_##busname##_driver_mod                                                  \
532 };                                                                                        \
533 DECLARE_MODULE(name##_##busname, name##_##busname##_mod,              \
534                  SI_SUB_DRIVERS, order)
535 
536 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg)      \
537           DRIVER_MODULE_ORDERED(name, busname, driver, &devclass, evh, arg,\
538                                 SI_ORDER_MIDDLE)
539 /**
540  * Generic ivar accessor generation macros for bus drivers
541  */
542 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type)                            \
543                                                                                           \
544 static __inline type varp ## _get_ ## var(device_t dev)                         \
545 {                                                                                         \
546           uintptr_t v;                                                                    \
547           BUS_READ_IVAR(device_get_parent(dev), dev,                            \
548               ivarp ## _IVAR_ ## ivar, &v);                                     \
549           return ((type) v);                                                    \
550 }                                                                                         \
551                                                                                           \
552 static __inline void varp ## _set_ ## var(device_t dev, type t)                 \
553 {                                                                                         \
554           uintptr_t v = (uintptr_t) t;                                          \
555           BUS_WRITE_IVAR(device_get_parent(dev), dev,                           \
556               ivarp ## _IVAR_ ## ivar, v);                                      \
557 }
558 
559 /**
560  * Shorthand macros, taking resource argument
561  */
562 
563 #define bus_barrier(r, o, l, f) \
564           bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
565 #define bus_read_1(r, o) \
566           bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
567 #define bus_read_multi_1(r, o, d, c) \
568           bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
569 #define bus_read_region_1(r, o, d, c) \
570           bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
571 #define bus_set_multi_1(r, o, v, c) \
572           bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
573 #define bus_set_region_1(r, o, v, c) \
574           bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
575 #define bus_write_1(r, o, v) \
576           bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
577 #define bus_write_multi_1(r, o, d, c) \
578           bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
579 #define bus_write_region_1(r, o, d, c) \
580           bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
581 #define bus_read_stream_1(r, o) \
582           bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
583 #define bus_read_multi_stream_1(r, o, d, c) \
584           bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
585 #define bus_read_region_stream_1(r, o, d, c) \
586           bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
587 #define bus_set_multi_stream_1(r, o, v, c) \
588           bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
589 #define bus_set_region_stream_1(r, o, v, c) \
590           bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
591 #define bus_write_stream_1(r, o, v) \
592           bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
593 #define bus_write_multi_stream_1(r, o, d, c) \
594           bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
595 #define bus_write_region_stream_1(r, o, d, c) \
596           bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
597 #define bus_read_2(r, o) \
598           bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
599 #define bus_read_multi_2(r, o, d, c) \
600           bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
601 #define bus_read_region_2(r, o, d, c) \
602           bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
603 #define bus_set_multi_2(r, o, v, c) \
604           bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
605 #define bus_set_region_2(r, o, v, c) \
606           bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
607 #define bus_write_2(r, o, v) \
608           bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
609 #define bus_write_multi_2(r, o, d, c) \
610           bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
611 #define bus_write_region_2(r, o, d, c) \
612           bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
613 #define bus_read_stream_2(r, o) \
614           bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
615 #define bus_read_multi_stream_2(r, o, d, c) \
616           bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
617 #define bus_read_region_stream_2(r, o, d, c) \
618           bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
619 #define bus_set_multi_stream_2(r, o, v, c) \
620           bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
621 #define bus_set_region_stream_2(r, o, v, c) \
622           bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
623 #define bus_write_stream_2(r, o, v) \
624           bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
625 #define bus_write_multi_stream_2(r, o, d, c) \
626           bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
627 #define bus_write_region_stream_2(r, o, d, c) \
628           bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
629 #define bus_read_4(r, o) \
630           bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
631 #define bus_read_multi_4(r, o, d, c) \
632           bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
633 #define bus_read_region_4(r, o, d, c) \
634           bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
635 #define bus_set_multi_4(r, o, v, c) \
636           bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
637 #define bus_set_region_4(r, o, v, c) \
638           bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
639 #define bus_write_4(r, o, v) \
640           bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
641 #define bus_write_multi_4(r, o, d, c) \
642           bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
643 #define bus_write_region_4(r, o, d, c) \
644           bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
645 #define bus_read_stream_4(r, o) \
646           bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
647 #define bus_read_multi_stream_4(r, o, d, c) \
648           bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
649 #define bus_read_region_stream_4(r, o, d, c) \
650           bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
651 #define bus_set_multi_stream_4(r, o, v, c) \
652           bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
653 #define bus_set_region_stream_4(r, o, v, c) \
654           bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
655 #define bus_write_stream_4(r, o, v) \
656           bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
657 #define bus_write_multi_stream_4(r, o, d, c) \
658           bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
659 #define bus_write_region_stream_4(r, o, d, c) \
660           bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
661 #define bus_read_8(r, o) \
662           bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
663 #define bus_read_multi_8(r, o, d, c) \
664           bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
665 #define bus_read_region_8(r, o, d, c) \
666           bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
667 #define bus_set_multi_8(r, o, v, c) \
668           bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
669 #define bus_set_region_8(r, o, v, c) \
670           bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
671 #define bus_write_8(r, o, v) \
672           bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
673 #define bus_write_multi_8(r, o, d, c) \
674           bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
675 #define bus_write_region_8(r, o, d, c) \
676           bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
677 #define bus_read_stream_8(r, o) \
678           bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
679 #define bus_read_multi_stream_8(r, o, d, c) \
680           bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
681 #define bus_read_region_stream_8(r, o, d, c) \
682           bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
683 #define bus_set_multi_stream_8(r, o, v, c) \
684           bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
685 #define bus_set_region_stream_8(r, o, v, c) \
686           bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
687 #define bus_write_stream_8(r, o, v) \
688           bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
689 #define bus_write_multi_stream_8(r, o, d, c) \
690           bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
691 #define bus_write_region_stream_8(r, o, d, c) \
692           bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
693 #endif /* _KERNEL */
694 
695 #endif /* !_SYS_BUS_H_ */
696