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/7.4/sys/sys/bus.h 215537 2010-11-19 17:24:03Z marius $
   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 };
  195 
  196 enum intr_trigger {
  197         INTR_TRIGGER_CONFORM = 0,
  198         INTR_TRIGGER_EDGE = 1,
  199         INTR_TRIGGER_LEVEL = 2
  200 };
  201 
  202 enum intr_polarity {
  203         INTR_POLARITY_CONFORM = 0,
  204         INTR_POLARITY_HIGH = 1,
  205         INTR_POLARITY_LOW = 2
  206 };
  207 
  208 typedef int (*devop_t)(void);
  209 
  210 /**
  211  * @brief This structure is deprecated.
  212  *
  213  * Use the kobj(9) macro DEFINE_CLASS to
  214  * declare classes which implement device drivers.
  215  */
  216 struct driver {
  217         KOBJ_CLASS_FIELDS;
  218 };
  219 
  220 /*
  221  * Definitions for drivers which need to keep simple lists of resources
  222  * for their child devices.
  223  */
  224 struct  resource;
  225 
  226 /**
  227  * @brief An entry for a single resource in a resource list.
  228  */
  229 struct resource_list_entry {
  230         STAILQ_ENTRY(resource_list_entry) link;
  231         int     type;                   /**< @brief type argument to alloc_resource */
  232         int     rid;                    /**< @brief resource identifier */
  233         struct  resource *res;          /**< @brief the real resource when allocated */
  234         u_long  start;                  /**< @brief start of resource range */
  235         u_long  end;                    /**< @brief end of resource range */
  236         u_long  count;                  /**< @brief count within range */
  237 };
  238 STAILQ_HEAD(resource_list, resource_list_entry);
  239 
  240 void    resource_list_init(struct resource_list *rl);
  241 void    resource_list_free(struct resource_list *rl);
  242 struct resource_list_entry *
  243         resource_list_add(struct resource_list *rl,
  244                           int type, int rid,
  245                           u_long start, u_long end, u_long count);
  246 int     resource_list_add_next(struct resource_list *rl,
  247                           int type,
  248                           u_long start, u_long end, u_long count);
  249 struct resource_list_entry*
  250         resource_list_find(struct resource_list *rl,
  251                            int type, int rid);
  252 void    resource_list_delete(struct resource_list *rl,
  253                              int type, int rid);
  254 struct resource *
  255         resource_list_alloc(struct resource_list *rl,
  256                             device_t bus, device_t child,
  257                             int type, int *rid,
  258                             u_long start, u_long end,
  259                             u_long count, u_int flags);
  260 int     resource_list_release(struct resource_list *rl,
  261                               device_t bus, device_t child,
  262                               int type, int rid, struct resource *res);
  263 void    resource_list_purge(struct resource_list *rl);
  264 int     resource_list_print_type(struct resource_list *rl,
  265                                  const char *name, int type,
  266                                  const char *format);
  267 
  268 /*
  269  * The root bus, to which all top-level busses are attached.
  270  */
  271 extern device_t root_bus;
  272 extern devclass_t root_devclass;
  273 void    root_bus_configure(void);
  274 
  275 /*
  276  * Useful functions for implementing busses.
  277  */
  278 
  279 int     bus_generic_activate_resource(device_t dev, device_t child, int type,
  280                                       int rid, struct resource *r);
  281 device_t
  282         bus_generic_add_child(device_t dev, u_int order, const char *name,
  283                               int unit);
  284 struct resource *
  285         bus_generic_alloc_resource(device_t bus, device_t child, int type,
  286                                    int *rid, u_long start, u_long end,
  287                                    u_long count, u_int flags);
  288 int     bus_generic_attach(device_t dev);
  289 int     bus_generic_bind_intr(device_t dev, device_t child,
  290                               struct resource *irq, int cpu);
  291 int     bus_generic_child_present(device_t dev, device_t child);
  292 int     bus_generic_config_intr(device_t, int, enum intr_trigger,
  293                                 enum intr_polarity);
  294 int     bus_generic_describe_intr(device_t dev, device_t child,
  295                                   struct resource *irq, void *cookie,
  296                                   const char *descr);
  297 int     bus_generic_deactivate_resource(device_t dev, device_t child, int type,
  298                                         int rid, struct resource *r);
  299 int     bus_generic_detach(device_t dev);
  300 void    bus_generic_driver_added(device_t dev, driver_t *driver);
  301 bus_dma_tag_t
  302         bus_generic_get_dma_tag(device_t dev, device_t child);
  303 struct resource_list *
  304         bus_generic_get_resource_list (device_t, device_t);
  305 int     bus_print_child_header(device_t dev, device_t child);
  306 int     bus_print_child_footer(device_t dev, device_t child);
  307 int     bus_generic_print_child(device_t dev, device_t child);
  308 int     bus_generic_probe(device_t dev);
  309 int     bus_generic_read_ivar(device_t dev, device_t child, int which,
  310                               uintptr_t *result);
  311 int     bus_generic_release_resource(device_t bus, device_t child,
  312                                      int type, int rid, struct resource *r);
  313 int     bus_generic_resume(device_t dev);
  314 int     bus_generic_setup_intr(device_t dev, device_t child,
  315                                struct resource *irq, int flags,
  316                                driver_filter_t *filter, driver_intr_t *intr, 
  317                                void *arg, void **cookiep);
  318 
  319 struct resource *
  320         bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
  321                                        u_long, u_long, u_long, u_int);
  322 void    bus_generic_rl_delete_resource (device_t, device_t, int, int);
  323 int     bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
  324                                      u_long *);
  325 int     bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
  326                                      u_long);
  327 int     bus_generic_rl_release_resource (device_t, device_t, int, int,
  328                                          struct resource *);
  329 
  330 int     bus_generic_shutdown(device_t dev);
  331 int     bus_generic_suspend(device_t dev);
  332 int     bus_generic_teardown_intr(device_t dev, device_t child,
  333                                   struct resource *irq, void *cookie);
  334 int     bus_generic_write_ivar(device_t dev, device_t child, int which,
  335                                uintptr_t value);
  336 
  337 /*
  338  * Wrapper functions for the BUS_*_RESOURCE methods to make client code
  339  * a little simpler.
  340  */
  341 
  342 struct resource_spec {
  343         int     type;
  344         int     rid;
  345         int     flags;
  346 };
  347 
  348 int bus_alloc_resources(device_t dev, struct resource_spec *rs, struct resource **res);
  349 void bus_release_resources(device_t dev, const struct resource_spec *rs, struct resource **res);
  350 
  351 struct  resource *bus_alloc_resource(device_t dev, int type, int *rid,
  352                                      u_long start, u_long end, u_long count,
  353                                      u_int flags);
  354 int     bus_activate_resource(device_t dev, int type, int rid,
  355                               struct resource *r);
  356 int     bus_deactivate_resource(device_t dev, int type, int rid,
  357                                 struct resource *r);
  358 bus_dma_tag_t bus_get_dma_tag(device_t dev);
  359 int     bus_release_resource(device_t dev, int type, int rid,
  360                              struct resource *r);
  361 int     bus_free_resource(device_t dev, int type, struct resource *r);
  362 int     bus_setup_intr(device_t dev, struct resource *r, int flags,
  363                        driver_filter_t filter, driver_intr_t handler, 
  364                        void *arg, void **cookiep);
  365 int     bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
  366 int     bus_bind_intr(device_t dev, struct resource *r, int cpu);
  367 int     bus_describe_intr(device_t dev, struct resource *irq, void *cookie,
  368                           const char *fmt, ...);
  369 int     bus_set_resource(device_t dev, int type, int rid,
  370                          u_long start, u_long count);
  371 int     bus_get_resource(device_t dev, int type, int rid,
  372                          u_long *startp, u_long *countp);
  373 u_long  bus_get_resource_start(device_t dev, int type, int rid);
  374 u_long  bus_get_resource_count(device_t dev, int type, int rid);
  375 void    bus_delete_resource(device_t dev, int type, int rid);
  376 int     bus_child_present(device_t child);
  377 int     bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
  378 int     bus_child_location_str(device_t child, char *buf, size_t buflen);
  379 void    bus_enumerate_hinted_children(device_t bus);
  380 
  381 static __inline struct resource *
  382 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
  383 {
  384         return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
  385 }
  386 
  387 /*
  388  * Access functions for device.
  389  */
  390 device_t        device_add_child(device_t dev, const char *name, int unit);
  391 device_t        device_add_child_ordered(device_t dev, u_int order,
  392                                          const char *name, int unit);
  393 void    device_busy(device_t dev);
  394 int     device_delete_child(device_t dev, device_t child);
  395 int     device_attach(device_t dev);
  396 int     device_detach(device_t dev);
  397 void    device_disable(device_t dev);
  398 void    device_enable(device_t dev);
  399 device_t        device_find_child(device_t dev, const char *classname,
  400                                   int unit);
  401 const char      *device_get_desc(device_t dev);
  402 devclass_t      device_get_devclass(device_t dev);
  403 driver_t        *device_get_driver(device_t dev);
  404 u_int32_t       device_get_flags(device_t dev);
  405 device_t        device_get_parent(device_t dev);
  406 int     device_get_children(device_t dev, device_t **listp, int *countp);
  407 void    *device_get_ivars(device_t dev);
  408 void    device_set_ivars(device_t dev, void *ivars);
  409 const   char *device_get_name(device_t dev);
  410 const   char *device_get_nameunit(device_t dev);
  411 void    *device_get_softc(device_t dev);
  412 device_state_t  device_get_state(device_t dev);
  413 int     device_get_unit(device_t dev);
  414 struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
  415 struct sysctl_oid *device_get_sysctl_tree(device_t dev);
  416 int     device_is_alive(device_t dev);  /* did probe succeed? */
  417 int     device_is_attached(device_t dev);       /* did attach succeed? */
  418 int     device_is_enabled(device_t dev);
  419 int     device_is_quiet(device_t dev);
  420 int     device_print_prettyname(device_t dev);
  421 int     device_printf(device_t dev, const char *, ...) __printflike(2, 3);
  422 int     device_probe_and_attach(device_t dev);
  423 int     device_probe_child(device_t bus, device_t dev);
  424 int     device_quiesce(device_t dev);
  425 void    device_quiet(device_t dev);
  426 void    device_set_desc(device_t dev, const char* desc);
  427 void    device_set_desc_copy(device_t dev, const char* desc);
  428 int     device_set_devclass(device_t dev, const char *classname);
  429 int     device_set_driver(device_t dev, driver_t *driver);
  430 void    device_set_flags(device_t dev, u_int32_t flags);
  431 void    device_set_softc(device_t dev, void *softc);
  432 int     device_set_unit(device_t dev, int unit);        /* XXX DONT USE XXX */
  433 int     device_shutdown(device_t dev);
  434 void    device_unbusy(device_t dev);
  435 void    device_verbose(device_t dev);
  436 
  437 /*
  438  * Access functions for devclass.
  439  */
  440 int     devclass_add_driver(devclass_t dc, kobj_class_t driver,
  441                             devclass_t *dcp);
  442 int     devclass_delete_driver(devclass_t dc, kobj_class_t driver);
  443 devclass_t      devclass_create(const char *classname);
  444 devclass_t      devclass_find(const char *classname);
  445 kobj_class_t    devclass_find_driver(devclass_t dc, const char *classname);
  446 const char      *devclass_get_name(devclass_t dc);
  447 device_t        devclass_get_device(devclass_t dc, int unit);
  448 void    *devclass_get_softc(devclass_t dc, int unit);
  449 int     devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
  450 int     devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
  451 int     devclass_get_count(devclass_t dc);
  452 int     devclass_get_maxunit(devclass_t dc);
  453 int     devclass_find_free_unit(devclass_t dc, int unit);
  454 void    devclass_set_parent(devclass_t dc, devclass_t pdc);
  455 devclass_t      devclass_get_parent(devclass_t dc);
  456 struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
  457 struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
  458 int     devclass_quiesce_driver(devclass_t dc, kobj_class_t driver);
  459 
  460 /*
  461  * Access functions for device resources.
  462  */
  463 
  464 int     resource_int_value(const char *name, int unit, const char *resname,
  465                            int *result);
  466 int     resource_long_value(const char *name, int unit, const char *resname,
  467                             long *result);
  468 int     resource_string_value(const char *name, int unit, const char *resname,
  469                               const char **result);
  470 int     resource_disabled(const char *name, int unit);
  471 int     resource_find_match(int *anchor, const char **name, int *unit,
  472                             const char *resname, const char *value);
  473 int     resource_find_dev(int *anchor, const char *name, int *unit,
  474                           const char *resname, const char *value);
  475 int     resource_set_int(const char *name, int unit, const char *resname,
  476                          int value);
  477 int     resource_set_long(const char *name, int unit, const char *resname,
  478                           long value);
  479 int     resource_set_string(const char *name, int unit, const char *resname,
  480                             const char *value);
  481 /*
  482  * Functions for maintaining and checking consistency of
  483  * bus information exported to userspace.
  484  */
  485 int     bus_data_generation_check(int generation);
  486 void    bus_data_generation_update(void);
  487 
  488 /**
  489  * Some convenience defines for probe routines to return.  These are just
  490  * suggested values, and there's nothing magical about them.
  491  * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
  492  * possible other driver may exist (typically legacy drivers who don't fallow
  493  * all the rules, or special needs drivers).  BUS_PROBE_VENDOR is the
  494  * suggested value that vendor supplied drivers use.  This is for source or
  495  * binary drivers that are not yet integrated into the FreeBSD tree.  Its use
  496  * in the base OS is prohibited.  BUS_PROBE_DEFAULT is the normal return value
  497  * for drivers to use.  It is intended that nearly all of the drivers in the
  498  * tree should return this value.  BUS_PROBE_LOW_PRIORITY are for drivers that
  499  * have special requirements like when there are two drivers that support
  500  * overlapping series of hardware devices.  In this case the one that supports
  501  * the older part of the line would return this value, while the one that
  502  * supports the newer ones would return BUS_PROBE_DEFAULT.  BUS_PROBE_GENERIC
  503  * is for drivers that wish to have a generic form and a specialized form,
  504  * like is done with the pci bus and the acpi pci bus.  BUS_PROBE_HOOVER is
  505  * for those busses that implement a generic device place-holder for devices on
  506  * the bus that have no more specific river for them (aka ugen).
  507  * BUS_PROBE_NOWILDCARD or lower means that the device isn't really bidding
  508  * for a device node, but accepts only devices that its parent has told it
  509  * use this driver.
  510  */
  511 #define BUS_PROBE_SPECIFIC      0       /* Only I can use this device */
  512 #define BUS_PROBE_VENDOR        (-10)   /* Vendor supplied driver */
  513 #define BUS_PROBE_DEFAULT       (-20)   /* Base OS default driver */
  514 #define BUS_PROBE_LOW_PRIORITY  (-40)   /* Older, less desirable drivers */
  515 #define BUS_PROBE_GENERIC       (-100)  /* generic driver for dev */
  516 #define BUS_PROBE_HOOVER        (-500)  /* Generic dev for all devs on bus */
  517 #define BUS_PROBE_NOWILDCARD    (-2000000000) /* No wildcard device matches */
  518 
  519 /**
  520  * Shorthand for constructing method tables.
  521  */
  522 #define DEVMETHOD       KOBJMETHOD
  523 
  524 /*
  525  * Some common device interfaces.
  526  */
  527 #include "device_if.h"
  528 #include "bus_if.h"
  529 
  530 struct  module;
  531 
  532 int     driver_module_handler(struct module *, int, void *);
  533 
  534 /**
  535  * Module support for automatically adding drivers to busses.
  536  */
  537 struct driver_module_data {
  538         int             (*dmd_chainevh)(struct module *, int, void *);
  539         void            *dmd_chainarg;
  540         const char      *dmd_busname;
  541         kobj_class_t    dmd_driver;
  542         devclass_t      *dmd_devclass;
  543 };
  544 
  545 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg)        \
  546                                                                         \
  547 static struct driver_module_data name##_##busname##_driver_mod = {      \
  548         evh, arg,                                                       \
  549         #busname,                                                       \
  550         (kobj_class_t) &driver,                                         \
  551         &devclass                                                       \
  552 };                                                                      \
  553                                                                         \
  554 static moduledata_t name##_##busname##_mod = {                          \
  555         #busname "/" #name,                                             \
  556         driver_module_handler,                                          \
  557         &name##_##busname##_driver_mod                                  \
  558 };                                                                      \
  559 DECLARE_MODULE(name##_##busname, name##_##busname##_mod,                \
  560                SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
  561 
  562 /**
  563  * Generic ivar accessor generation macros for bus drivers
  564  */
  565 #define __BUS_ACCESSOR(varp, var, ivarp, ivar, type)                    \
  566                                                                         \
  567 static __inline type varp ## _get_ ## var(device_t dev)                 \
  568 {                                                                       \
  569         uintptr_t v;                                                    \
  570         BUS_READ_IVAR(device_get_parent(dev), dev,                      \
  571             ivarp ## _IVAR_ ## ivar, &v);                               \
  572         return ((type) v);                                              \
  573 }                                                                       \
  574                                                                         \
  575 static __inline void varp ## _set_ ## var(device_t dev, type t)         \
  576 {                                                                       \
  577         uintptr_t v = (uintptr_t) t;                                    \
  578         BUS_WRITE_IVAR(device_get_parent(dev), dev,                     \
  579             ivarp ## _IVAR_ ## ivar, v);                                \
  580 }
  581 
  582 /**
  583  * Shorthand macros, taking resource argument
  584  * Generated with sys/tools/bus_macro.sh
  585  */
  586 
  587 #define bus_barrier(r, o, l, f) \
  588         bus_space_barrier((r)->r_bustag, (r)->r_bushandle, (o), (l), (f))
  589 #define bus_read_1(r, o) \
  590         bus_space_read_1((r)->r_bustag, (r)->r_bushandle, (o))
  591 #define bus_read_multi_1(r, o, d, c) \
  592         bus_space_read_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  593 #define bus_read_region_1(r, o, d, c) \
  594         bus_space_read_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  595 #define bus_set_multi_1(r, o, v, c) \
  596         bus_space_set_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  597 #define bus_set_region_1(r, o, v, c) \
  598         bus_space_set_region_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  599 #define bus_write_1(r, o, v) \
  600         bus_space_write_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
  601 #define bus_write_multi_1(r, o, d, c) \
  602         bus_space_write_multi_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  603 #define bus_write_region_1(r, o, d, c) \
  604         bus_space_write_region_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  605 #define bus_read_stream_1(r, o) \
  606         bus_space_read_stream_1((r)->r_bustag, (r)->r_bushandle, (o))
  607 #define bus_read_multi_stream_1(r, o, d, c) \
  608         bus_space_read_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  609 #define bus_read_region_stream_1(r, o, d, c) \
  610         bus_space_read_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  611 #define bus_set_multi_stream_1(r, o, v, c) \
  612         bus_space_set_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  613 #define bus_set_region_stream_1(r, o, v, c) \
  614         bus_space_set_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  615 #define bus_write_stream_1(r, o, v) \
  616         bus_space_write_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (v))
  617 #define bus_write_multi_stream_1(r, o, d, c) \
  618         bus_space_write_multi_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  619 #define bus_write_region_stream_1(r, o, d, c) \
  620         bus_space_write_region_stream_1((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  621 #define bus_read_2(r, o) \
  622         bus_space_read_2((r)->r_bustag, (r)->r_bushandle, (o))
  623 #define bus_read_multi_2(r, o, d, c) \
  624         bus_space_read_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  625 #define bus_read_region_2(r, o, d, c) \
  626         bus_space_read_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  627 #define bus_set_multi_2(r, o, v, c) \
  628         bus_space_set_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  629 #define bus_set_region_2(r, o, v, c) \
  630         bus_space_set_region_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  631 #define bus_write_2(r, o, v) \
  632         bus_space_write_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
  633 #define bus_write_multi_2(r, o, d, c) \
  634         bus_space_write_multi_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  635 #define bus_write_region_2(r, o, d, c) \
  636         bus_space_write_region_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  637 #define bus_read_stream_2(r, o) \
  638         bus_space_read_stream_2((r)->r_bustag, (r)->r_bushandle, (o))
  639 #define bus_read_multi_stream_2(r, o, d, c) \
  640         bus_space_read_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  641 #define bus_read_region_stream_2(r, o, d, c) \
  642         bus_space_read_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  643 #define bus_set_multi_stream_2(r, o, v, c) \
  644         bus_space_set_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  645 #define bus_set_region_stream_2(r, o, v, c) \
  646         bus_space_set_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  647 #define bus_write_stream_2(r, o, v) \
  648         bus_space_write_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (v))
  649 #define bus_write_multi_stream_2(r, o, d, c) \
  650         bus_space_write_multi_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  651 #define bus_write_region_stream_2(r, o, d, c) \
  652         bus_space_write_region_stream_2((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  653 #define bus_read_4(r, o) \
  654         bus_space_read_4((r)->r_bustag, (r)->r_bushandle, (o))
  655 #define bus_read_multi_4(r, o, d, c) \
  656         bus_space_read_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  657 #define bus_read_region_4(r, o, d, c) \
  658         bus_space_read_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  659 #define bus_set_multi_4(r, o, v, c) \
  660         bus_space_set_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  661 #define bus_set_region_4(r, o, v, c) \
  662         bus_space_set_region_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  663 #define bus_write_4(r, o, v) \
  664         bus_space_write_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
  665 #define bus_write_multi_4(r, o, d, c) \
  666         bus_space_write_multi_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  667 #define bus_write_region_4(r, o, d, c) \
  668         bus_space_write_region_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  669 #define bus_read_stream_4(r, o) \
  670         bus_space_read_stream_4((r)->r_bustag, (r)->r_bushandle, (o))
  671 #define bus_read_multi_stream_4(r, o, d, c) \
  672         bus_space_read_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  673 #define bus_read_region_stream_4(r, o, d, c) \
  674         bus_space_read_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  675 #define bus_set_multi_stream_4(r, o, v, c) \
  676         bus_space_set_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  677 #define bus_set_region_stream_4(r, o, v, c) \
  678         bus_space_set_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  679 #define bus_write_stream_4(r, o, v) \
  680         bus_space_write_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (v))
  681 #define bus_write_multi_stream_4(r, o, d, c) \
  682         bus_space_write_multi_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  683 #define bus_write_region_stream_4(r, o, d, c) \
  684         bus_space_write_region_stream_4((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  685 #define bus_read_8(r, o) \
  686         bus_space_read_8((r)->r_bustag, (r)->r_bushandle, (o))
  687 #define bus_read_multi_8(r, o, d, c) \
  688         bus_space_read_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  689 #define bus_read_region_8(r, o, d, c) \
  690         bus_space_read_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  691 #define bus_set_multi_8(r, o, v, c) \
  692         bus_space_set_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  693 #define bus_set_region_8(r, o, v, c) \
  694         bus_space_set_region_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  695 #define bus_write_8(r, o, v) \
  696         bus_space_write_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
  697 #define bus_write_multi_8(r, o, d, c) \
  698         bus_space_write_multi_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  699 #define bus_write_region_8(r, o, d, c) \
  700         bus_space_write_region_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  701 #define bus_read_stream_8(r, o) \
  702         bus_space_read_stream_8((r)->r_bustag, (r)->r_bushandle, (o))
  703 #define bus_read_multi_stream_8(r, o, d, c) \
  704         bus_space_read_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  705 #define bus_read_region_stream_8(r, o, d, c) \
  706         bus_space_read_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  707 #define bus_set_multi_stream_8(r, o, v, c) \
  708         bus_space_set_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  709 #define bus_set_region_stream_8(r, o, v, c) \
  710         bus_space_set_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v), (c))
  711 #define bus_write_stream_8(r, o, v) \
  712         bus_space_write_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (v))
  713 #define bus_write_multi_stream_8(r, o, d, c) \
  714         bus_space_write_multi_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  715 #define bus_write_region_stream_8(r, o, d, c) \
  716         bus_space_write_region_stream_8((r)->r_bustag, (r)->r_bushandle, (o), (d), (c))
  717 #endif /* _KERNEL */
  718 
  719 #endif /* !_SYS_BUS_H_ */

Cache object: d9caae468241451a1445d9ebbf27ea9a


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