FreeBSD/Linux Kernel Cross Reference
sys/dev/mmc/mmcbr_if.m

     #-
     # Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org>
     #
     # 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.
    #
    # Portions of this software may have been developed with reference to
    # the SD Simplified Specification.  The following disclaimer may apply:
    #
    # The following conditions apply to the release of the simplified
    # specification ("Simplified Specification") by the SD Card Association and
    # the SD Group. The Simplified Specification is a subset of the complete SD
    # Specification which is owned by the SD Card Association and the SD
    # Group. This Simplified Specification is provided on a non-confidential
    # basis subject to the disclaimers below. Any implementation of the
    # Simplified Specification may require a license from the SD Card
    # Association, SD Group, SD-3C LLC or other third parties.
    #
    # Disclaimers:
    #
    # The information contained in the Simplified Specification is presented only
    # as a standard specification for SD Cards and SD Host/Ancillary products and
    # is provided "AS-IS" without any representations or warranties of any
    # kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
    # Card Association for any damages, any infringements of patents or other
    # right of the SD Group, SD-3C LLC, the SD Card Association or any third
    # parties, which may result from its use. No license is granted by
    # implication, estoppel or otherwise under any patent or other rights of the
    # SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
    # herein shall be construed as an obligation by the SD Group, the SD-3C LLC
    # or the SD Card Association to disclose or distribute any technical
    # information, know-how or other confidential information to any third party.
    #
    # $FreeBSD$
    #
    
    #include <sys/types.h>
    #include <dev/mmc/mmcreg.h>
    
    #
    # This is the interface that a mmc bridge chip gives to the mmc bus
    # that attaches to the mmc bridge.
    #
    
    INTERFACE mmcbr;
    
    #
    # Default implementations of some methods.
    #
    CODE {
            static int
            null_switch_vccq(device_t brdev __unused, device_t reqdev __unused)
            {
    
                    return (0);
            }
    
            static int
            null_retune(device_t brdev __unused, device_t reqdev __unused,
                bool reset __unused)
            {
    
                    return (0);
            }
    
            static int
            null_tune(device_t brdev __unused, device_t reqdev __unused,
                bool hs400 __unused)
            {
    
                    return (0);
            }
    };
    
    #
    # Called by the mmcbus to set up the IO pins correctly, the common/core
    # supply voltage (VDD/VCC) to use for the device, the clock frequency, the
    # type of SPI chip select, power mode and bus width.
    #
    METHOD int update_ios {
            device_t        brdev;
           device_t        reqdev;
   };
   
   #
   # Called by the mmcbus to switch the signaling voltage (VCCQ).
   #
   METHOD int switch_vccq {
           device_t        brdev;
           device_t        reqdev;
   } DEFAULT null_switch_vccq;
   
   #
   # Called by the mmcbus with the bridge claimed to execute initial tuning.
   #
   METHOD int tune {
           device_t        brdev;
           device_t        reqdev;
           bool            hs400;
   } DEFAULT null_tune;
   
   #
   # Called by the mmcbus with the bridge claimed to execute re-tuning.
   #
   METHOD int retune {
           device_t        brdev;
           device_t        reqdev;
           bool            reset;
   } DEFAULT null_retune;
   
   #
   # Called by the mmcbus or its children to schedule a mmc request.  These
   # requests are queued.  Time passes.  The bridge then gets notification
   # of the status of the request, who then notifies the requesting device
   # by calling the completion function supplied as part of the request.
   # Requires the bridge to be claimed.
   #
   METHOD int request {
           device_t        brdev;
           device_t        reqdev;
           struct mmc_request *req;
   };
   
   #
   # Called by mmcbus to get the read only status bits.
   #
   METHOD int get_ro {
           device_t        brdev;
           device_t        reqdev;
   };
   
   #
   # Claim the current bridge, blocking the current thread until the host
   # is no longer busy.
   #
   METHOD int acquire_host {
           device_t        brdev;
           device_t        reqdev;
   };
   
   #
   # Release the current bridge.
   #
   METHOD int release_host {
           device_t        brdev;
           device_t        reqdev;
   };

Cache object: 0322649cc24149bee00789176d8929b9