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