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