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