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