sys/dev/mmc/mmcbus_if.m

   1 #-
   2 # Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org>
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions
   6 # are met:
   7 # 1. Redistributions of source code must retain the above copyright
   8 #    notice, this list of conditions and the following disclaimer.
   9 # 2. Redistributions in binary form must reproduce the above copyright
  10 #    notice, this list of conditions and the following disclaimer in the
  11 #    documentation and/or other materials provided with the distribution.
  12 #
  13 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 # SUCH DAMAGE.
  24 #
  25 # Portions of this software may have been developed with reference to
  26 # the SD Simplified Specification.  The following disclaimer may apply:
  27 #
  28 # The following conditions apply to the release of the simplified
  29 # specification ("Simplified Specification") by the SD Card Association and
  30 # the SD Group. The Simplified Specification is a subset of the complete SD
  31 # Specification which is owned by the SD Card Association and the SD
  32 # Group. This Simplified Specification is provided on a non-confidential
  33 # basis subject to the disclaimers below. Any implementation of the
  34 # Simplified Specification may require a license from the SD Card
  35 # Association, SD Group, SD-3C LLC or other third parties.
  36 #
  37 # Disclaimers:
  38 #
  39 # The information contained in the Simplified Specification is presented only
  40 # as a standard specification for SD Cards and SD Host/Ancillary products and
  41 # is provided "AS-IS" without any representations or warranties of any
  42 # kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
  43 # Card Association for any damages, any infringements of patents or other
  44 # right of the SD Group, SD-3C LLC, the SD Card Association or any third
  45 # parties, which may result from its use. No license is granted by
  46 # implication, estoppel or otherwise under any patent or other rights of the
  47 # SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
  48 # herein shall be construed as an obligation by the SD Group, the SD-3C LLC
  49 # or the SD Card Association to disclose or distribute any technical
  50 # information, know-how or other confidential information to any third party.
  51 #
  52 # $FreeBSD$
  53 #
  54
  55 #include <sys/types.h>
  56 #include <dev/mmc/mmcreg.h>
  57
  58 #
  59 # This is the set of callbacks that the MMC subroutines and the mmc/sd card
  60 # driver call into the bus to make requests.
  61 #
  62
  63 INTERFACE mmcbus;
  64
  65 #
  66 # Pause re-tuning, optionally with triggering re-tuning up-front.  Requires
  67 # the bus to be claimed.
  68 #
  69 METHOD void retune_pause {
  70         device_t        busdev;
  71         device_t        reqdev;
  72         bool            retune;
  73 };
  74
  75 #
  76 # Unpause re-tuning.  Requires the bus to be claimed.
  77 #
  78 METHOD void retune_unpause {
  79         device_t        busdev;
  80         device_t        reqdev;
  81 };
  82
  83 #
  84 # Queue and wait for a request.  Requires the bus to be claimed.
  85 #
  86 METHOD int wait_for_request {
  87         device_t        busdev;
  88         device_t        reqdev;
  89         struct mmc_request *req;
  90 };
  91
  92 #
  93 # Claim the current bus, blocking the current thread until the host is no
  94 # longer busy.
  95 #
  96 METHOD int acquire_bus {
  97         device_t        busdev;
  98         device_t        reqdev;
  99 };
 100
 101 #
 102 # Release the current bus.
 103 #
 104 METHOD int release_bus {
 105         device_t        busdev;
 106         device_t        reqdev;
 107 };