sys/sys/bus.h

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