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