1 /*- 2 * Copyright (c) 2006 Bernd Walter. All rights reserved. 3 * Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org> 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 ``AS IS'' AND ANY EXPRESS OR 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 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 53 #include <sys/cdefs.h> 54 #include <sys/param.h> 55 #include <sys/systm.h> 56 #include <sys/kernel.h> 57 #include <sys/lock.h> 58 #include <sys/mutex.h> 59 #include <sys/time.h> 60 61 #include <dev/mmc/bridge.h> 62 #include <dev/mmc/mmc_private.h> 63 #include <dev/mmc/mmc_subr.h> 64 #include <dev/mmc/mmcreg.h> 65 #include <dev/mmc/mmcbrvar.h> 66 67 #include "mmcbus_if.h" 68 69 #define CMD_RETRIES 3 70 #define LOG_PPS 5 /* Log no more than 5 errors per second. */ 71 72 int 73 mmc_wait_for_cmd(device_t busdev, device_t dev, struct mmc_command *cmd, 74 int retries) 75 { 76 struct mmc_request mreq; 77 struct mmc_softc *sc; 78 int err; 79 80 do { 81 memset(&mreq, 0, sizeof(mreq)); 82 memset(cmd->resp, 0, sizeof(cmd->resp)); 83 cmd->retries = 0; /* Retries done here, not in hardware. */ 84 cmd->mrq = &mreq; 85 if (cmd->data != NULL) 86 cmd->data->mrq = &mreq; 87 mreq.cmd = cmd; 88 if (MMCBUS_WAIT_FOR_REQUEST(busdev, dev, &mreq) != 0) 89 err = MMC_ERR_FAILED; 90 else 91 err = cmd->error; 92 } while (err != MMC_ERR_NONE && retries-- > 0); 93 94 if (err != MMC_ERR_NONE && busdev == dev) { 95 sc = device_get_softc(busdev); 96 if (sc->squelched == 0 && ppsratecheck(&sc->log_time, 97 &sc->log_count, LOG_PPS)) { 98 device_printf(sc->dev, "CMD%d failed, RESULT: %d\n", 99 cmd->opcode, err); 100 } 101 } 102 103 return (err); 104 } 105 106 int 107 mmc_wait_for_app_cmd(device_t busdev, device_t dev, uint16_t rca, 108 struct mmc_command *cmd, int retries) 109 { 110 struct mmc_command appcmd; 111 struct mmc_softc *sc; 112 int err; 113 114 sc = device_get_softc(busdev); 115 116 /* Squelch error reporting at lower levels, we report below. */ 117 sc->squelched++; 118 do { 119 memset(&appcmd, 0, sizeof(appcmd)); 120 appcmd.opcode = MMC_APP_CMD; 121 appcmd.arg = (uint32_t)rca << 16; 122 appcmd.flags = MMC_RSP_R1 | MMC_CMD_AC; 123 if (mmc_wait_for_cmd(busdev, dev, &appcmd, 0) != 0) 124 err = MMC_ERR_FAILED; 125 else 126 err = appcmd.error; 127 if (err == MMC_ERR_NONE) { 128 if (!(appcmd.resp[0] & R1_APP_CMD)) 129 err = MMC_ERR_FAILED; 130 else if (mmc_wait_for_cmd(busdev, dev, cmd, 0) != 0) 131 err = MMC_ERR_FAILED; 132 else 133 err = cmd->error; 134 } 135 } while (err != MMC_ERR_NONE && retries-- > 0); 136 sc->squelched--; 137 138 if (err != MMC_ERR_NONE && busdev == dev) { 139 if (sc->squelched == 0 && ppsratecheck(&sc->log_time, 140 &sc->log_count, LOG_PPS)) { 141 device_printf(sc->dev, "ACMD%d failed, RESULT: %d\n", 142 cmd->opcode, err); 143 } 144 } 145 146 return (err); 147 } 148 149 int 150 mmc_switch(device_t busdev, device_t dev, uint16_t rca, uint8_t set, 151 uint8_t index, uint8_t value, u_int timeout, bool status) 152 { 153 struct mmc_command cmd; 154 struct mmc_softc *sc; 155 int err; 156 157 KASSERT(timeout != 0, ("%s: no timeout", __func__)); 158 159 sc = device_get_softc(busdev); 160 161 memset(&cmd, 0, sizeof(cmd)); 162 cmd.opcode = MMC_SWITCH_FUNC; 163 cmd.arg = (MMC_SWITCH_FUNC_WR << 24) | (index << 16) | (value << 8) | 164 set; 165 /* 166 * If the hardware supports busy detection but the switch timeout 167 * exceeds the maximum host timeout, use a R1 instead of a R1B 168 * response in order to keep the hardware from timing out. 169 */ 170 if (mmcbr_get_caps(busdev) & MMC_CAP_WAIT_WHILE_BUSY && 171 timeout > mmcbr_get_max_busy_timeout(busdev)) 172 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC; 173 else 174 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC; 175 /* 176 * Pause re-tuning so it won't interfere with the busy state and also 177 * so that the result of CMD13 will always refer to switching rather 178 * than to a tuning command that may have snuck in between. 179 */ 180 sc->retune_paused++; 181 err = mmc_wait_for_cmd(busdev, dev, &cmd, CMD_RETRIES); 182 if (err != MMC_ERR_NONE || status == false) 183 goto out; 184 err = mmc_switch_status(busdev, dev, rca, timeout); 185 out: 186 sc->retune_paused--; 187 return (err); 188 } 189 190 int 191 mmc_switch_status(device_t busdev, device_t dev, uint16_t rca, u_int timeout) 192 { 193 struct timeval cur, end; 194 int err, crc_timeout; 195 uint32_t status; 196 197 KASSERT(timeout != 0, ("%s: no timeout", __func__)); 198 199 /* 200 * Note that when using a R1B response in mmc_switch(), bridges of 201 * type MMC_CAP_WAIT_WHILE_BUSY will issue mmc_send_status() only 202 * once and then exit the loop. 203 */ 204 end.tv_sec = end.tv_usec = 0; 205 for (;;) { 206 crc_timeout=0; 207 do { 208 /* 209 * CRC errors indicate that the command wasn't accepted 210 * and executed due to a communications error. Retry 211 * CRC errors a couple of times to cope with transient 212 * failures. 213 * 214 * This is required for some cheap laptops to boot. 215 */ 216 err = mmc_send_status(busdev, dev, rca, &status); 217 crc_timeout++; 218 } while (err == MMC_ERR_BADCRC && crc_timeout < 10); 219 if (err != MMC_ERR_NONE) 220 break; 221 if (R1_CURRENT_STATE(status) == R1_STATE_TRAN) 222 break; 223 getmicrouptime(&cur); 224 if (end.tv_sec == 0 && end.tv_usec == 0) { 225 end.tv_usec = timeout; 226 timevaladd(&end, &cur); 227 } 228 if (timevalcmp(&cur, &end, >)) { 229 err = MMC_ERR_TIMEOUT; 230 break; 231 } 232 } 233 if (err == MMC_ERR_NONE && (status & R1_SWITCH_ERROR) != 0) 234 return (MMC_ERR_FAILED); 235 return (err); 236 } 237 238 int 239 mmc_send_ext_csd(device_t busdev, device_t dev, uint8_t *rawextcsd) 240 { 241 struct mmc_command cmd; 242 struct mmc_data data; 243 int err; 244 245 memset(&cmd, 0, sizeof(cmd)); 246 memset(&data, 0, sizeof(data)); 247 248 memset(rawextcsd, 0, MMC_EXTCSD_SIZE); 249 cmd.opcode = MMC_SEND_EXT_CSD; 250 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC; 251 cmd.data = &data; 252 253 data.data = rawextcsd; 254 data.len = MMC_EXTCSD_SIZE; 255 data.flags = MMC_DATA_READ; 256 257 err = mmc_wait_for_cmd(busdev, dev, &cmd, CMD_RETRIES); 258 return (err); 259 } 260 261 int 262 mmc_send_status(device_t busdev, device_t dev, uint16_t rca, uint32_t *status) 263 { 264 struct mmc_command cmd; 265 int err; 266 267 memset(&cmd, 0, sizeof(cmd)); 268 cmd.opcode = MMC_SEND_STATUS; 269 cmd.arg = (uint32_t)rca << 16; 270 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC; 271 err = mmc_wait_for_cmd(busdev, dev, &cmd, CMD_RETRIES); 272 *status = cmd.resp[0]; 273 return (err); 274 } 275