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