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

Cache object: 1a7239d921532678292c1b1edae7a557


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