The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/bus.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 810c4d8c91579711f27321a9f01b6872


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.