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

Cache object: d87db9b847e115ebb97ece9242a982f5


[ 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.