sys/sys/bus.h

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