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