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