xref: /linux/drivers/mmc/core/sd_ops.c (revision f850548ef88e5ff9e40bae9e1a7140bef0653e6b)
1 /*
2  *  linux/drivers/mmc/core/sd_ops.h
3  *
4  *  Copyright 2006-2007 Pierre Ossman
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or (at
9  * your option) any later version.
10  */
11 
12 #include <linux/slab.h>
13 #include <linux/types.h>
14 #include <linux/scatterlist.h>
15 
16 #include <linux/mmc/host.h>
17 #include <linux/mmc/card.h>
18 #include <linux/mmc/mmc.h>
19 #include <linux/mmc/sd.h>
20 
21 #include "core.h"
22 #include "sd_ops.h"
23 
24 static int mmc_app_cmd(struct mmc_host *host, struct mmc_card *card)
25 {
26 	int err;
27 	struct mmc_command cmd;
28 
29 	BUG_ON(!host);
30 	BUG_ON(card && (card->host != host));
31 
32 	cmd.opcode = MMC_APP_CMD;
33 
34 	if (card) {
35 		cmd.arg = card->rca << 16;
36 		cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
37 	} else {
38 		cmd.arg = 0;
39 		cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_BCR;
40 	}
41 
42 	err = mmc_wait_for_cmd(host, &cmd, 0);
43 	if (err)
44 		return err;
45 
46 	/* Check that card supported application commands */
47 	if (!mmc_host_is_spi(host) && !(cmd.resp[0] & R1_APP_CMD))
48 		return -EOPNOTSUPP;
49 
50 	return 0;
51 }
52 
53 /**
54  *	mmc_wait_for_app_cmd - start an application command and wait for
55  			       completion
56  *	@host: MMC host to start command
57  *	@card: Card to send MMC_APP_CMD to
58  *	@cmd: MMC command to start
59  *	@retries: maximum number of retries
60  *
61  *	Sends a MMC_APP_CMD, checks the card response, sends the command
62  *	in the parameter and waits for it to complete. Return any error
63  *	that occurred while the command was executing.  Do not attempt to
64  *	parse the response.
65  */
66 int mmc_wait_for_app_cmd(struct mmc_host *host, struct mmc_card *card,
67 	struct mmc_command *cmd, int retries)
68 {
69 	struct mmc_request mrq;
70 
71 	int i, err;
72 
73 	BUG_ON(!cmd);
74 	BUG_ON(retries < 0);
75 
76 	err = -EIO;
77 
78 	/*
79 	 * We have to resend MMC_APP_CMD for each attempt so
80 	 * we cannot use the retries field in mmc_command.
81 	 */
82 	for (i = 0;i <= retries;i++) {
83 		err = mmc_app_cmd(host, card);
84 		if (err) {
85 			/* no point in retrying; no APP commands allowed */
86 			if (mmc_host_is_spi(host)) {
87 				if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
88 					break;
89 			}
90 			continue;
91 		}
92 
93 		memset(&mrq, 0, sizeof(struct mmc_request));
94 
95 		memset(cmd->resp, 0, sizeof(cmd->resp));
96 		cmd->retries = 0;
97 
98 		mrq.cmd = cmd;
99 		cmd->data = NULL;
100 
101 		mmc_wait_for_req(host, &mrq);
102 
103 		err = cmd->error;
104 		if (!cmd->error)
105 			break;
106 
107 		/* no point in retrying illegal APP commands */
108 		if (mmc_host_is_spi(host)) {
109 			if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
110 				break;
111 		}
112 	}
113 
114 	return err;
115 }
116 
117 EXPORT_SYMBOL(mmc_wait_for_app_cmd);
118 
119 int mmc_app_set_bus_width(struct mmc_card *card, int width)
120 {
121 	int err;
122 	struct mmc_command cmd;
123 
124 	BUG_ON(!card);
125 	BUG_ON(!card->host);
126 
127 	memset(&cmd, 0, sizeof(struct mmc_command));
128 
129 	cmd.opcode = SD_APP_SET_BUS_WIDTH;
130 	cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
131 
132 	switch (width) {
133 	case MMC_BUS_WIDTH_1:
134 		cmd.arg = SD_BUS_WIDTH_1;
135 		break;
136 	case MMC_BUS_WIDTH_4:
137 		cmd.arg = SD_BUS_WIDTH_4;
138 		break;
139 	default:
140 		return -EINVAL;
141 	}
142 
143 	err = mmc_wait_for_app_cmd(card->host, card, &cmd, MMC_CMD_RETRIES);
144 	if (err)
145 		return err;
146 
147 	return 0;
148 }
149 
150 int mmc_send_app_op_cond(struct mmc_host *host, u32 ocr, u32 *rocr)
151 {
152 	struct mmc_command cmd;
153 	int i, err = 0;
154 
155 	BUG_ON(!host);
156 
157 	memset(&cmd, 0, sizeof(struct mmc_command));
158 
159 	cmd.opcode = SD_APP_OP_COND;
160 	if (mmc_host_is_spi(host))
161 		cmd.arg = ocr & (1 << 30); /* SPI only defines one bit */
162 	else
163 		cmd.arg = ocr;
164 	cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R3 | MMC_CMD_BCR;
165 
166 	for (i = 100; i; i--) {
167 		err = mmc_wait_for_app_cmd(host, NULL, &cmd, MMC_CMD_RETRIES);
168 		if (err)
169 			break;
170 
171 		/* if we're just probing, do a single pass */
172 		if (ocr == 0)
173 			break;
174 
175 		/* otherwise wait until reset completes */
176 		if (mmc_host_is_spi(host)) {
177 			if (!(cmd.resp[0] & R1_SPI_IDLE))
178 				break;
179 		} else {
180 			if (cmd.resp[0] & MMC_CARD_BUSY)
181 				break;
182 		}
183 
184 		err = -ETIMEDOUT;
185 
186 		mmc_delay(10);
187 	}
188 
189 	if (rocr && !mmc_host_is_spi(host))
190 		*rocr = cmd.resp[0];
191 
192 	return err;
193 }
194 
195 int mmc_send_if_cond(struct mmc_host *host, u32 ocr)
196 {
197 	struct mmc_command cmd;
198 	int err;
199 	static const u8 test_pattern = 0xAA;
200 	u8 result_pattern;
201 
202 	/*
203 	 * To support SD 2.0 cards, we must always invoke SD_SEND_IF_COND
204 	 * before SD_APP_OP_COND. This command will harmlessly fail for
205 	 * SD 1.0 cards.
206 	 */
207 	cmd.opcode = SD_SEND_IF_COND;
208 	cmd.arg = ((ocr & 0xFF8000) != 0) << 8 | test_pattern;
209 	cmd.flags = MMC_RSP_SPI_R7 | MMC_RSP_R7 | MMC_CMD_BCR;
210 
211 	err = mmc_wait_for_cmd(host, &cmd, 0);
212 	if (err)
213 		return err;
214 
215 	if (mmc_host_is_spi(host))
216 		result_pattern = cmd.resp[1] & 0xFF;
217 	else
218 		result_pattern = cmd.resp[0] & 0xFF;
219 
220 	if (result_pattern != test_pattern)
221 		return -EIO;
222 
223 	return 0;
224 }
225 
226 int mmc_send_relative_addr(struct mmc_host *host, unsigned int *rca)
227 {
228 	int err;
229 	struct mmc_command cmd;
230 
231 	BUG_ON(!host);
232 	BUG_ON(!rca);
233 
234 	memset(&cmd, 0, sizeof(struct mmc_command));
235 
236 	cmd.opcode = SD_SEND_RELATIVE_ADDR;
237 	cmd.arg = 0;
238 	cmd.flags = MMC_RSP_R6 | MMC_CMD_BCR;
239 
240 	err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
241 	if (err)
242 		return err;
243 
244 	*rca = cmd.resp[0] >> 16;
245 
246 	return 0;
247 }
248 
249 int mmc_app_send_scr(struct mmc_card *card, u32 *scr)
250 {
251 	int err;
252 	struct mmc_request mrq;
253 	struct mmc_command cmd;
254 	struct mmc_data data;
255 	struct scatterlist sg;
256 	void *data_buf;
257 
258 	BUG_ON(!card);
259 	BUG_ON(!card->host);
260 	BUG_ON(!scr);
261 
262 	/* NOTE: caller guarantees scr is heap-allocated */
263 
264 	err = mmc_app_cmd(card->host, card);
265 	if (err)
266 		return err;
267 
268 	/* dma onto stack is unsafe/nonportable, but callers to this
269 	 * routine normally provide temporary on-stack buffers ...
270 	 */
271 	data_buf = kmalloc(sizeof(card->raw_scr), GFP_KERNEL);
272 	if (data_buf == NULL)
273 		return -ENOMEM;
274 
275 	memset(&mrq, 0, sizeof(struct mmc_request));
276 	memset(&cmd, 0, sizeof(struct mmc_command));
277 	memset(&data, 0, sizeof(struct mmc_data));
278 
279 	mrq.cmd = &cmd;
280 	mrq.data = &data;
281 
282 	cmd.opcode = SD_APP_SEND_SCR;
283 	cmd.arg = 0;
284 	cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
285 
286 	data.blksz = 8;
287 	data.blocks = 1;
288 	data.flags = MMC_DATA_READ;
289 	data.sg = &sg;
290 	data.sg_len = 1;
291 
292 	sg_init_one(&sg, data_buf, 8);
293 
294 	mmc_set_data_timeout(&data, card);
295 
296 	mmc_wait_for_req(card->host, &mrq);
297 
298 	memcpy(scr, data_buf, sizeof(card->raw_scr));
299 	kfree(data_buf);
300 
301 	if (cmd.error)
302 		return cmd.error;
303 	if (data.error)
304 		return data.error;
305 
306 	scr[0] = be32_to_cpu(scr[0]);
307 	scr[1] = be32_to_cpu(scr[1]);
308 
309 	return 0;
310 }
311 
312 int mmc_sd_switch(struct mmc_card *card, int mode, int group,
313 	u8 value, u8 *resp)
314 {
315 	struct mmc_request mrq;
316 	struct mmc_command cmd;
317 	struct mmc_data data;
318 	struct scatterlist sg;
319 
320 	BUG_ON(!card);
321 	BUG_ON(!card->host);
322 
323 	/* NOTE: caller guarantees resp is heap-allocated */
324 
325 	mode = !!mode;
326 	value &= 0xF;
327 
328 	memset(&mrq, 0, sizeof(struct mmc_request));
329 	memset(&cmd, 0, sizeof(struct mmc_command));
330 	memset(&data, 0, sizeof(struct mmc_data));
331 
332 	mrq.cmd = &cmd;
333 	mrq.data = &data;
334 
335 	cmd.opcode = SD_SWITCH;
336 	cmd.arg = mode << 31 | 0x00FFFFFF;
337 	cmd.arg &= ~(0xF << (group * 4));
338 	cmd.arg |= value << (group * 4);
339 	cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
340 
341 	data.blksz = 64;
342 	data.blocks = 1;
343 	data.flags = MMC_DATA_READ;
344 	data.sg = &sg;
345 	data.sg_len = 1;
346 
347 	sg_init_one(&sg, resp, 64);
348 
349 	mmc_set_data_timeout(&data, card);
350 
351 	mmc_wait_for_req(card->host, &mrq);
352 
353 	if (cmd.error)
354 		return cmd.error;
355 	if (data.error)
356 		return data.error;
357 
358 	return 0;
359 }
360 
361 int mmc_app_sd_status(struct mmc_card *card, void *ssr)
362 {
363 	int err;
364 	struct mmc_request mrq;
365 	struct mmc_command cmd;
366 	struct mmc_data data;
367 	struct scatterlist sg;
368 
369 	BUG_ON(!card);
370 	BUG_ON(!card->host);
371 	BUG_ON(!ssr);
372 
373 	/* NOTE: caller guarantees ssr is heap-allocated */
374 
375 	err = mmc_app_cmd(card->host, card);
376 	if (err)
377 		return err;
378 
379 	memset(&mrq, 0, sizeof(struct mmc_request));
380 	memset(&cmd, 0, sizeof(struct mmc_command));
381 	memset(&data, 0, sizeof(struct mmc_data));
382 
383 	mrq.cmd = &cmd;
384 	mrq.data = &data;
385 
386 	cmd.opcode = SD_APP_SD_STATUS;
387 	cmd.arg = 0;
388 	cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_ADTC;
389 
390 	data.blksz = 64;
391 	data.blocks = 1;
392 	data.flags = MMC_DATA_READ;
393 	data.sg = &sg;
394 	data.sg_len = 1;
395 
396 	sg_init_one(&sg, ssr, 64);
397 
398 	mmc_set_data_timeout(&data, card);
399 
400 	mmc_wait_for_req(card->host, &mrq);
401 
402 	if (cmd.error)
403 		return cmd.error;
404 	if (data.error)
405 		return data.error;
406 
407 	return 0;
408 }
409