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