sys/dev/mmc/mmcbus_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$
  54 #
  55
  56 #include <sys/types.h>
  57 #include <dev/mmc/mmcreg.h>
  58
  59 #
  60 # This is the set of callbacks that the MMC subroutines and the mmc/sd card
  61 # driver call into the bus to make requests.
  62 #
  63
  64 INTERFACE mmcbus;
  65
  66 #
  67 # Pause re-tuning, optionally with triggering re-tuning up-front.  Requires
  68 # the bus to be claimed.
  69 #
  70 METHOD void retune_pause {
  71         device_t        busdev;
  72         device_t        reqdev;
  73         bool            retune;
  74 };
  75
  76 #
  77 # Unpause re-tuning.  Requires the bus to be claimed.
  78 #
  79 METHOD void retune_unpause {
  80         device_t        busdev;
  81         device_t        reqdev;
  82 };
  83
  84 #
  85 # Queue and wait for a request.  Requires the bus to be claimed.
  86 #
  87 METHOD int wait_for_request {
  88         device_t        busdev;
  89         device_t        reqdev;
  90         struct mmc_request *req;
  91 };
  92
  93 #
  94 # Claim the current bus, blocking the current thread until the host is no
  95 # longer busy.
  96 #
  97 METHOD int acquire_bus {
  98         device_t        busdev;
  99         device_t        reqdev;
 100 };
 101
 102 #
 103 # Release the current bus.
 104 #
 105 METHOD int release_bus {
 106         device_t        busdev;
 107         device_t        reqdev;
 108 };