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