sys/dev/sdhci/sdhci_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 #
  57 # This is the set of callbacks that mmc bridges call into the bus, or
  58 # that mmc/sd card drivers call to make requests.
  59 #
  60
  61 #include <sys/types.h>
  62 #include <sys/systm.h>
  63 #include <sys/lock.h>
  64 #include <sys/mutex.h>
  65 #include <sys/sysctl.h>
  66 #include <sys/taskqueue.h>
  67
  68 #include <machine/bus.h>
  69
  70 #include <dev/mmc/bridge.h>
  71 #include <dev/mmc/mmcreg.h>
  72 #include <dev/sdhci/sdhci.h>
  73
  74 CODE {
  75         struct sdhci_slot;
  76 }
  77
  78 INTERFACE sdhci;
  79
  80 METHOD uint8_t read_1 {
  81         device_t                brdev;
  82         struct sdhci_slot       *slot;
  83         bus_size_t              off;
  84 }
  85
  86 METHOD uint16_t read_2 {
  87         device_t                brdev;
  88         struct sdhci_slot       *slot;
  89         bus_size_t              off;
  90 }
  91
  92 METHOD uint32_t read_4 {
  93         device_t                brdev;
  94         struct sdhci_slot       *slot;
  95         bus_size_t              off;
  96 }
  97
  98 METHOD void read_multi_4 {
  99         device_t                brdev;
 100         struct sdhci_slot       *slot;
 101         bus_size_t              off;
 102         uint32_t                *data;
 103         bus_size_t              count;
 104 }
 105
 106 METHOD void write_1 {
 107         device_t                brdev;
 108         struct sdhci_slot       *slot;
 109         bus_size_t              off;
 110         uint8_t                 val;
 111 }
 112
 113 METHOD void write_2 {
 114         device_t                brdev;
 115         struct sdhci_slot       *slot;
 116         bus_size_t              off;
 117         uint16_t                val;
 118 }
 119
 120 METHOD void write_4 {
 121         device_t                brdev;
 122         struct sdhci_slot       *slot;
 123         bus_size_t              off;
 124         uint32_t                val;
 125 }
 126
 127 METHOD void write_multi_4 {
 128         device_t                brdev;
 129         struct sdhci_slot       *slot;
 130         bus_size_t              off;
 131         uint32_t                *data;
 132         bus_size_t              count;
 133 }
 134
 135 METHOD int platform_will_handle {
 136         device_t                brdev;
 137         struct sdhci_slot       *slot;
 138 }
 139
 140 METHOD void platform_start_transfer {
 141         device_t                brdev;
 142         struct sdhci_slot       *slot;
 143         uint32_t                *intmask;
 144 }
 145
 146 METHOD void platform_finish_transfer {
 147         device_t                brdev;
 148         struct sdhci_slot       *slot;
 149 }
 150
 151 METHOD uint32_t min_freq {
 152         device_t                brdev;
 153         struct sdhci_slot       *slot;
 154 } DEFAULT sdhci_generic_min_freq;