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