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/kern/bus_if.m

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) 1998-2004 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.0/sys/kern/bus_if.m 139804 2005-01-06 23:35:40Z imp $
   27 #
   28 
   29 #include <sys/bus.h>
   30 
   31 /**
   32  * @defgroup BUS bus - KObj methods for drivers of devices with children
   33  * @brief A set of methods required device drivers that support
   34  * child devices.
   35  * @{
   36  */
   37 INTERFACE bus;
   38 
   39 #
   40 # Default implementations of some methods.
   41 #
   42 CODE {
   43         static struct resource *
   44         null_alloc_resource(device_t dev, device_t child,
   45             int type, int *rid, u_long start, u_long end,
   46             u_long count, u_int flags)
   47         {
   48             return (0);
   49         }
   50 };
   51 
   52 /**
   53  * @brief Print a description of a child device
   54  *
   55  * This is called from system code which prints out a description of a
   56  * device. It should describe the attachment that the child has with
   57  * the parent. For instance the TurboLaser bus prints which node the
   58  * device is attached to. See bus_generic_print_child() for more 
   59  * information.
   60  *
   61  * @param _dev          the device whose child is being printed
   62  * @param _child        the child device to describe
   63  *
   64  * @returns             the number of characters output.
   65  */
   66 METHOD int print_child {
   67         device_t _dev;
   68         device_t _child;
   69 } DEFAULT bus_generic_print_child;
   70 
   71 /**
   72  * @brief Print a notification about an unprobed child device.
   73  *
   74  * Called for each child device that did not succeed in probing for a
   75  * driver.
   76  *
   77  * @param _dev          the device whose child was being probed
   78  * @param _child        the child device which failed to probe
   79  */   
   80 METHOD void probe_nomatch {
   81         device_t _dev;
   82         device_t _child;
   83 };
   84 
   85 /**
   86  * @brief Read the value of a bus-specific attribute of a device
   87  *
   88  * This method, along with BUS_WRITE_IVAR() manages a bus-specific set
   89  * of instance variables of a child device.  The intention is that
   90  * each different type of bus defines a set of appropriate instance
   91  * variables (such as ports and irqs for ISA bus etc.)
   92  *
   93  * This information could be given to the child device as a struct but
   94  * that makes it hard for a bus to add or remove variables without
   95  * forcing an edit and recompile for all drivers which may not be
   96  * possible for vendor supplied binary drivers.
   97  *
   98  * This method copies the value of an instance variable to the
   99  * location specified by @p *_result.
  100  * 
  101  * @param _dev          the device whose child was being examined
  102  * @param _child        the child device whose instance variable is
  103  *                      being read
  104  * @param _index        the instance variable to read
  105  * @param _result       a loction to recieve the instance variable
  106  *                      value
  107  * 
  108  * @retval 0            success
  109  * @retval ENOENT       no such instance variable is supported by @p
  110  *                      _dev 
  111  */
  112 METHOD int read_ivar {
  113         device_t _dev;
  114         device_t _child;
  115         int _index;
  116         uintptr_t *_result;
  117 };
  118 
  119 /**
  120  * @brief Write the value of a bus-specific attribute of a device
  121  * 
  122  * This method sets the value of an instance variable to @p _value.
  123  * 
  124  * @param _dev          the device whose child was being updated
  125  * @param _child        the child device whose instance variable is
  126  *                      being written
  127  * @param _index        the instance variable to write
  128  * @param _value        the value to write to that instance variable
  129  * 
  130  * @retval 0            success
  131  * @retval ENOENT       no such instance variable is supported by @p
  132  *                      _dev 
  133  * @retval EINVAL       the instance variable was recognised but
  134  *                      contains a read-only value
  135  */
  136 METHOD int write_ivar {
  137         device_t _dev;
  138         device_t _child;
  139         int _indx;
  140         uintptr_t _value;
  141 };
  142 
  143 /**
  144  * @brief Notify a bus that a child was detached
  145  *
  146  * Called after the child's DEVICE_DETACH() method to allow the parent
  147  * to reclaim any resources allocated on behalf of the child.
  148  * 
  149  * @param _dev          the device whose child changed state
  150  * @param _child        the child device which changed state
  151  */
  152 METHOD void child_detached {
  153         device_t _dev;
  154         device_t _child;
  155 };
  156 
  157 /**
  158  * @brief Notify a bus that a new driver was added
  159  * 
  160  * Called when a new driver is added to the devclass which owns this
  161  * bus. The generic implementation of this method attempts to probe and
  162  * attach any un-matched children of the bus.
  163  * 
  164  * @param _dev          the device whose devclass had a new driver
  165  *                      added to it
  166  * @param _driver       the new driver which was added
  167  */
  168 METHOD void driver_added {
  169         device_t _dev;
  170         driver_t *_driver;
  171 } DEFAULT bus_generic_driver_added;
  172 
  173 /**
  174  * @brief Create a new child device
  175  *
  176  * For busses which use use drivers supporting DEVICE_IDENTIFY() to
  177  * enumerate their devices, this method is used to create new
  178  * device instances. The new device will be added after the last
  179  * existing child with the same order.
  180  * 
  181  * @param _dev          the bus device which will be the parent of the
  182  *                      new child device
  183  * @param _order        a value which is used to partially sort the
  184  *                      children of @p _dev - devices created using
  185  *                      lower values of @p _order appear first in @p
  186  *                      _dev's list of children
  187  * @param _name         devclass name for new device or @c NULL if not
  188  *                      specified
  189  * @param _unit         unit number for new device or @c -1 if not
  190  *                      specified
  191  */
  192 METHOD device_t add_child {
  193         device_t _dev;
  194         int _order;
  195         const char *_name;
  196         int _unit;
  197 };
  198 
  199 /**
  200  * @brief Allocate a system resource
  201  *
  202  * This method is called by child devices of a bus to allocate resources.
  203  * The types are defined in <machine/resource.h>; the meaning of the
  204  * resource-ID field varies from bus to bus (but @p *rid == 0 is always
  205  * valid if the resource type is). If a resource was allocated and the
  206  * caller did not use the RF_ACTIVE to specify that it should be
  207  * activated immediately, the caller is responsible for calling
  208  * BUS_ACTIVATE_RESOURCE() when it actually uses the resource.
  209  *
  210  * @param _dev          the parent device of @p _child
  211  * @param _child        the device which is requesting an allocation
  212  * @param _type         the type of resource to allocate
  213  * @param _rid          a pointer to the resource identifier
  214  * @param _start        hint at the start of the resource range - pass
  215  *                      @c 0UL for any start address
  216  * @param _end          hint at the end of the resource range - pass
  217  *                      @c ~0UL for any end address
  218  * @param _count        hint at the size of range required - pass @c 1
  219  *                      for any size
  220  * @param _flags        any extra flags to control the resource
  221  *                      allocation - see @c RF_XXX flags in
  222  *                      <sys/rman.h> for details
  223  * 
  224  * @returns             the resource which was allocated or @c NULL if no
  225  *                      resource could be allocated
  226  */
  227 METHOD struct resource * alloc_resource {
  228         device_t        _dev;
  229         device_t        _child;
  230         int             _type;
  231         int            *_rid;
  232         u_long          _start;
  233         u_long          _end;
  234         u_long          _count;
  235         u_int           _flags;
  236 } DEFAULT null_alloc_resource;
  237 
  238 /**
  239  * @brief Activate a resource
  240  *
  241  * Activate a resource previously allocated with
  242  * BUS_ALLOC_RESOURCE(). This may for instance map a memory region
  243  * into the kernel's virtual address space.
  244  *
  245  * @param _dev          the parent device of @p _child
  246  * @param _child        the device which allocated the resource
  247  * @param _type         the type of resource
  248  * @param _rid          the resource identifier
  249  * @param _r            the resource to activate
  250  */
  251 METHOD int activate_resource {
  252         device_t        _dev;
  253         device_t        _child;
  254         int             _type;
  255         int             _rid;
  256         struct resource *_r;
  257 };
  258 
  259 /**
  260  * @brief Deactivate a resource
  261  *
  262  * Deactivate a resource previously allocated with
  263  * BUS_ALLOC_RESOURCE(). This may for instance unmap a memory region
  264  * from the kernel's virtual address space.
  265  *
  266  * @param _dev          the parent device of @p _child
  267  * @param _child        the device which allocated the resource
  268  * @param _type         the type of resource
  269  * @param _rid          the resource identifier
  270  * @param _r            the resource to deactivate
  271  */
  272 METHOD int deactivate_resource {
  273         device_t        _dev;
  274         device_t        _child;
  275         int             _type;
  276         int             _rid;
  277         struct resource *_r;
  278 };
  279 
  280 /**
  281  * @brief Release a resource
  282  *
  283  * Free a resource allocated by the BUS_ALLOC_RESOURCE.  The @p _rid
  284  * value must be the same as the one returned by BUS_ALLOC_RESOURCE()
  285  * (which is not necessarily the same as the one the client passed).
  286  *
  287  * @param _dev          the parent device of @p _child
  288  * @param _child        the device which allocated the resource
  289  * @param _type         the type of resource
  290  * @param _rid          the resource identifier
  291  * @param _r            the resource to release
  292  */
  293 METHOD int release_resource {
  294         device_t        _dev;
  295         device_t        _child;
  296         int             _type;
  297         int             _rid;
  298         struct resource *_res;
  299 };
  300 
  301 /**
  302  * @brief Install an interrupt handler
  303  *
  304  * This method is used to associate an interrupt handler function with
  305  * an irq resource. When the interrupt triggers, the function @p _intr
  306  * will be called with the value of @p _arg as its single
  307  * argument. The value returned in @p *_cookiep is used to cancel the
  308  * interrupt handler - the caller should save this value to use in a
  309  * future call to BUS_TEARDOWN_INTR().
  310  * 
  311  * @param _dev          the parent device of @p _child
  312  * @param _child        the device which allocated the resource
  313  * @param _irq          the resource representing the interrupt
  314  * @param _flags        a set of bits from enum intr_type specifying
  315  *                      the class of interrupt
  316  * @param _intr         the function to call when the interrupt
  317  *                      triggers
  318  * @param _arg          a value to use as the single argument in calls
  319  *                      to @p _intr
  320  * @param _cookiep      a pointer to a location to recieve a cookie
  321  *                      value that may be used to remove the interrupt
  322  *                      handler
  323  */
  324 METHOD int setup_intr {
  325         device_t        _dev;
  326         device_t        _child;
  327         struct resource *_irq;
  328         int             _flags;
  329         driver_intr_t   *_intr;
  330         void            *_arg;
  331         void            **_cookiep;
  332 };
  333 
  334 /**
  335  * @brief Uninstall an interrupt handler
  336  *
  337  * This method is used to disassociate an interrupt handler function
  338  * with an irq resource. The value of @p _cookie must be the value
  339  * returned from a previous call to BUS_SETUP_INTR().
  340  * 
  341  * @param _dev          the parent device of @p _child
  342  * @param _child        the device which allocated the resource
  343  * @param _irq          the resource representing the interrupt
  344  * @param _cookie       the cookie value returned when the interrupt
  345  *                      was originally registered
  346  */
  347 METHOD int teardown_intr {
  348         device_t        _dev;
  349         device_t        _child;
  350         struct resource *_irq;
  351         void            *_cookie;
  352 };
  353 
  354 /**
  355  * @brief Define a resource which can be allocated with
  356  * BUS_ALLOC_RESOURCE().
  357  *
  358  * This method is used by some busses (typically ISA) to allow a
  359  * driver to describe a resource range that it would like to
  360  * allocate. The resource defined by @p _type and @p _rid is defined
  361  * to start at @p _start and to include @p _count indices in its
  362  * range.
  363  * 
  364  * @param _dev          the parent device of @p _child
  365  * @param _child        the device which owns the resource
  366  * @param _type         the type of resource
  367  * @param _rid          the resource identifier
  368  * @param _start        the start of the resource range
  369  * @param _count        the size of the resource range
  370  */
  371 METHOD int set_resource {
  372         device_t        _dev;
  373         device_t        _child;
  374         int             _type;
  375         int             _rid;
  376         u_long          _start;
  377         u_long          _count;
  378 };
  379 
  380 /**
  381  * @brief Describe a resource
  382  *
  383  * This method allows a driver to examine the range used for a given
  384  * resource without actually allocating it.
  385  * 
  386  * @param _dev          the parent device of @p _child
  387  * @param _child        the device which owns the resource
  388  * @param _type         the type of resource
  389  * @param _rid          the resource identifier
  390  * @param _start        the address of a location to recieve the start
  391  *                      index of the resource range
  392  * @param _count        the address of a location to recieve the size
  393  *                      of the resource range
  394  */
  395 METHOD int get_resource {
  396         device_t        _dev;
  397         device_t        _child;
  398         int             _type;
  399         int             _rid;
  400         u_long          *_startp;
  401         u_long          *_countp;
  402 };
  403 
  404 /**
  405  * @brief Delete a resource.
  406  * 
  407  * Use this to delete a resource (possibly one previously added with
  408  * BUS_SET_RESOURCE()).
  409  * 
  410  * @param _dev          the parent device of @p _child
  411  * @param _child        the device which owns the resource
  412  * @param _type         the type of resource
  413  * @param _rid          the resource identifier
  414  */
  415 METHOD void delete_resource {
  416         device_t        _dev;
  417         device_t        _child;
  418         int             _type;
  419         int             _rid;
  420 };
  421 
  422 /**
  423  * @brief Return a struct resource_list.
  424  *
  425  * Used by drivers which use bus_generic_rl_alloc_resource() etc. to
  426  * implement their resource handling. It should return the resource
  427  * list of the given child device.
  428  * 
  429  * @param _dev          the parent device of @p _child
  430  * @param _child        the device which owns the resource list
  431  */
  432 METHOD struct resource_list * get_resource_list {
  433         device_t        _dev;
  434         device_t        _child;
  435 } DEFAULT bus_generic_get_resource_list;
  436 
  437 /**
  438  * @brief Is the hardware described by @p _child still attached to the
  439  * system?
  440  *
  441  * This method should return 0 if the device is not present.  It
  442  * should return -1 if it is present.  Any errors in determining
  443  * should be returned as a normal errno value.  Client drivers are to
  444  * assume that the device is present, even if there is an error
  445  * determining if it is there.  Busses are to try to avoid returning
  446  * errors, but newcard will return an error if the device fails to
  447  * implement this method.
  448  * 
  449  * @param _dev          the parent device of @p _child
  450  * @param _child        the device which is being examined
  451  */
  452 METHOD int child_present {
  453         device_t        _dev;
  454         device_t        _child;
  455 } DEFAULT bus_generic_child_present;
  456 
  457 /**
  458  * @brief Returns the pnp info for this device.
  459  *
  460  * Return it as a string.  If the string is insufficient for the
  461  * storage, then return EOVERFLOW.
  462  * 
  463  * @param _dev          the parent device of @p _child
  464  * @param _child        the device which is being examined
  465  * @param _buf          the address of a buffer to receive the pnp
  466  *                      string
  467  * @param _buflen       the size of the buffer pointed to by @p _buf
  468  */
  469 METHOD int child_pnpinfo_str {
  470         device_t        _dev;
  471         device_t        _child;
  472         char            *_buf;
  473         size_t          _buflen;
  474 };
  475 
  476 /**
  477  * @brief Returns the location for this device.
  478  *
  479  * Return it as a string.  If the string is insufficient for the
  480  * storage, then return EOVERFLOW.
  481  * 
  482  * @param _dev          the parent device of @p _child
  483  * @param _child        the device which is being examined
  484  * @param _buf          the address of a buffer to receive the location
  485  *                      string
  486  * @param _buflen       the size of the buffer pointed to by @p _buf
  487  */
  488 METHOD int child_location_str {
  489         device_t        _dev;
  490         device_t        _child;
  491         char            *_buf;
  492         size_t          _buflen;
  493 };
  494 
  495 /**
  496  * @brief Allow (bus) drivers to specify the trigger mode and polarity
  497  * of the specified interrupt.
  498  * 
  499  * @param _dev          the bus device
  500  * @param _irq          the interrupt number to modify
  501  * @param _trig         the trigger mode required
  502  * @param _pol          the interrupt polarity required
  503  */
  504 METHOD int config_intr {
  505         device_t        _dev;
  506         int             _irq;
  507         enum intr_trigger _trig;
  508         enum intr_polarity _pol;
  509 } DEFAULT bus_generic_config_intr;

Cache object: 319731f45bedea7398360373122a9401


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