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