FreeBSD/Linux Kernel Cross Reference
sys/kern/bus_if.m

     #
     # Copyright (c) 1998 Doug Rabson
     # All rights reserved.
     #
     # Redistribution and use in source and binary forms, with or without
     # modification, are permitted provided that the following conditions
     # are met:
     # 1. Redistributions of source code must retain the above copyright
     #    notice, this list of conditions and the following disclaimer.
    # 2. Redistributions in binary form must reproduce the above copyright
    #    notice, this list of conditions and the following disclaimer in the
    #    documentation and/or other materials provided with the distribution.
    #
    # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    # SUCH DAMAGE.
    #
    # $FreeBSD$
    #
    
    INTERFACE bus;
    
    #
    # This is called from system code which prints out a description of a
    # device.  It should describe the attachment that the child has with
    # the parent.  For instance the TurboLaser bus prints which node the
    # device is attached to.
    #
    METHOD void print_child {
            device_t dev;
            device_t child;
    };
    
    #
    # These two methods manage a bus specific set of instance variables of
    # a child device.  The intention is that each different type of bus
    # defines a set of appropriate instance variables (such as ports and
    # irqs for ISA bus etc.)
    #
    # This information could be given to the child device as a struct but
    # that makes it hard for a bus to add or remove variables without
    # forcing an edit and recompile for all drivers which may not be
    # possible for vendor supplied binary drivers.
    
    #
    # Read an instance variable.  Return 0 on success.
    #
    METHOD int read_ivar {
            device_t dev;
            device_t child;
            int index;
            uintptr_t *result;
    };
    
    #
    # Write an instance variable.  Return 0 on success.
    #
    METHOD int write_ivar {
            device_t dev;
            device_t child;
            int index;
            uintptr_t value;
    };
    
    #
    # Allocate a system resource attached to `dev' on behalf of `child'.
    # The types are defined in <machine/resource.h>; the meaning of the
    # resource-ID field varies from bus to bus (but *rid == 0 is always
    # valid if the resource type is).  start and end reflect the allowable
    # range, and should be passed as `0UL' and `~0UL', respectively, if
    # the client has no range restriction.  count is the number of consecutive
    # indices in the resource required.  flags is a set of sharing flags
    # as defined in <sys/rman.h>.
    #
    # Returns a resource or a null pointer on failure.  The caller is
    # responsible for calling rman_activate_resource() when it actually
    # uses the resource.
    #
    METHOD struct resource * alloc_resource {
            device_t        dev;
            device_t        child;
            int             type;
            int            *rid;
            u_long          start;
            u_long          end;
            u_long          count;
            u_int           flags;
    };
    
    METHOD int activate_resource {
            device_t        dev;
           device_t        child;
           int             type;
           int             rid;
           struct resource *r;
   };
   
   METHOD int deactivate_resource {
           device_t        dev;
           device_t        child;
           int             type;
           int             rid;
           struct resource *r;
   };
   
   #
   # Free a resource allocated by the preceding method.  The `rid' value
   # must be the same as the one returned by BUS_ALLOC_RESOURCE (which
   # is not necessarily the same as the one the client passed).
   #
   METHOD int release_resource {
           device_t        dev;
           device_t        child;
           int             type;
           int             rid;
           struct resource *res;
   };
   
   METHOD int setup_intr {
           device_t        dev;
           device_t        child;
           struct resource *irq;
           driver_intr_t   *intr;
           void            *arg;
           void            **cookiep;
   };
   
   METHOD int teardown_intr {
           device_t        dev;
           device_t        child;
           struct resource *irq;
           void            *cookie;
   };

Cache object: 7a84563b08dc06e8aed63b2d3a9a1059