sys/bus/mmc/mmcbr_if.m

   1 #-
   2 # Copyright (c) 2006 M. Warner Losh
   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 # Portions of this software may have been developed with reference to
  27 # the SD Simplified Specification.  The following disclaimer may apply:
  28 #
  29 # The following conditions apply to the release of the simplified
  30 # specification ("Simplified Specification") by the SD Card Association and
  31 # the SD Group. The Simplified Specification is a subset of the complete SD
  32 # Specification which is owned by the SD Card Association and the SD
  33 # Group. This Simplified Specification is provided on a non-confidential
  34 # basis subject to the disclaimers below. Any implementation of the
  35 # Simplified Specification may require a license from the SD Card
  36 # Association, SD Group, SD-3C LLC or other third parties.
  37 #
  38 # Disclaimers:
  39 #
  40 # The information contained in the Simplified Specification is presented only
  41 # as a standard specification for SD Cards and SD Host/Ancillary products and
  42 # is provided "AS-IS" without any representations or warranties of any
  43 # kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
  44 # Card Association for any damages, any infringements of patents or other
  45 # right of the SD Group, SD-3C LLC, the SD Card Association or any third
  46 # parties, which may result from its use. No license is granted by
  47 # implication, estoppel or otherwise under any patent or other rights of the
  48 # SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
  49 # herein shall be construed as an obligation by the SD Group, the SD-3C LLC
  50 # or the SD Card Association to disclose or distribute any technical
  51 # information, know-how or other confidential information to any third party.
  52 #
  53 # $FreeBSD: src/sys/dev/mmc/mmcbr_if.m,v 1.2 2007/05/26 05:23:36 imp Exp $
  54 #
  55
  56 #include <sys/types.h>
  57 #include <sys/bus.h>
  58 #include <bus/mmc/bridge.h>
  59 #include <bus/mmc/mmcreg.h>
  60
  61 #
  62 # This is the interface that a mmc bridge chip gives to the mmc bus
  63 # that attaches to the mmc bridge.
  64 #
  65
  66 INTERFACE mmcbr;
  67
  68 #
  69 # Default implementations of some methods.
  70 #
  71 CODE {
  72         static int
  73         null_switch_vccq(device_t brdev __unused, device_t reqdev __unused)
  74         {
  75
  76                 return (0);
  77         }
  78 };
  79
  80 #
  81 # Called by the mmcbus to set up the IO pins correctly, the common/core
  82 # supply voltage (VDD/VCC) to use for the device, the clock frequency, the
  83 # type of SPI chip select, power mode and bus width.
  84 #
  85 METHOD int update_ios {
  86         device_t        brdev;
  87         device_t        reqdev;
  88 };
  89
  90 #
  91 # Called by the mmcbus to switch the signaling voltage (VCCQ).
  92 #
  93 METHOD int switch_vccq {
  94         device_t        brdev;
  95         device_t        reqdev;
  96 } DEFAULT null_switch_vccq;
  97
  98 #
  99 # Called by the mmcbus or its children to schedule a mmc request.  These
 100 # requests are queued.  Time passes.  The bridge then gets notification
 101 # of the status of the request, who then notifies the requesting device
 102 # by calling the completion function supplied as part of the request.
 103 #
 104 METHOD int request {
 105         device_t        brdev;
 106         device_t        reqdev;
 107         struct mmc_request *req;
 108 };
 109
 110 #
 111 # Called by mmcbus to get the read only status bits.
 112 #
 113 METHOD int get_ro {
 114         device_t        brdev;
 115         device_t        reqdev;
 116 };
 117
 118 #
 119 # Claim the current bridge, blocking the current thread until the host
 120 # is no longer busy.
 121 #
 122 METHOD int acquire_host {
 123         device_t        brdev;
 124         device_t        reqdev;
 125 }
 126
 127 #
 128 # Release the current bridge.
 129 #
 130 METHOD int release_host {
 131         device_t        brdev;
 132         device_t        reqdev;
 133 }