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

Cache object: 1f7657981f777614432b3cef2eaaabe7


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