xref: /openbmc/linux/drivers/mmc/core/sd.c (revision 6b5fc336)
1 /*
2  *  linux/drivers/mmc/core/sd.c
3  *
4  *  Copyright (C) 2003-2004 Russell King, All Rights Reserved.
5  *  SD support Copyright (C) 2004 Ian Molton, All Rights Reserved.
6  *  Copyright (C) 2005-2007 Pierre Ossman, All Rights Reserved.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12 
13 #include <linux/err.h>
14 #include <linux/sizes.h>
15 #include <linux/slab.h>
16 #include <linux/stat.h>
17 #include <linux/pm_runtime.h>
18 
19 #include <linux/mmc/host.h>
20 #include <linux/mmc/card.h>
21 #include <linux/mmc/mmc.h>
22 #include <linux/mmc/sd.h>
23 
24 #include "core.h"
25 #include "card.h"
26 #include "host.h"
27 #include "bus.h"
28 #include "mmc_ops.h"
29 #include "sd.h"
30 #include "sd_ops.h"
31 
32 static const unsigned int tran_exp[] = {
33 	10000,		100000,		1000000,	10000000,
34 	0,		0,		0,		0
35 };
36 
37 static const unsigned char tran_mant[] = {
38 	0,	10,	12,	13,	15,	20,	25,	30,
39 	35,	40,	45,	50,	55,	60,	70,	80,
40 };
41 
42 static const unsigned int tacc_exp[] = {
43 	1,	10,	100,	1000,	10000,	100000,	1000000, 10000000,
44 };
45 
46 static const unsigned int tacc_mant[] = {
47 	0,	10,	12,	13,	15,	20,	25,	30,
48 	35,	40,	45,	50,	55,	60,	70,	80,
49 };
50 
51 static const unsigned int sd_au_size[] = {
52 	0,		SZ_16K / 512,		SZ_32K / 512,	SZ_64K / 512,
53 	SZ_128K / 512,	SZ_256K / 512,		SZ_512K / 512,	SZ_1M / 512,
54 	SZ_2M / 512,	SZ_4M / 512,		SZ_8M / 512,	(SZ_8M + SZ_4M) / 512,
55 	SZ_16M / 512,	(SZ_16M + SZ_8M) / 512,	SZ_32M / 512,	SZ_64M / 512,
56 };
57 
58 #define UNSTUFF_BITS(resp,start,size)					\
59 	({								\
60 		const int __size = size;				\
61 		const u32 __mask = (__size < 32 ? 1 << __size : 0) - 1;	\
62 		const int __off = 3 - ((start) / 32);			\
63 		const int __shft = (start) & 31;			\
64 		u32 __res;						\
65 									\
66 		__res = resp[__off] >> __shft;				\
67 		if (__size + __shft > 32)				\
68 			__res |= resp[__off-1] << ((32 - __shft) % 32);	\
69 		__res & __mask;						\
70 	})
71 
72 /*
73  * Given the decoded CSD structure, decode the raw CID to our CID structure.
74  */
75 void mmc_decode_cid(struct mmc_card *card)
76 {
77 	u32 *resp = card->raw_cid;
78 
79 	/*
80 	 * SD doesn't currently have a version field so we will
81 	 * have to assume we can parse this.
82 	 */
83 	card->cid.manfid		= UNSTUFF_BITS(resp, 120, 8);
84 	card->cid.oemid			= UNSTUFF_BITS(resp, 104, 16);
85 	card->cid.prod_name[0]		= UNSTUFF_BITS(resp, 96, 8);
86 	card->cid.prod_name[1]		= UNSTUFF_BITS(resp, 88, 8);
87 	card->cid.prod_name[2]		= UNSTUFF_BITS(resp, 80, 8);
88 	card->cid.prod_name[3]		= UNSTUFF_BITS(resp, 72, 8);
89 	card->cid.prod_name[4]		= UNSTUFF_BITS(resp, 64, 8);
90 	card->cid.hwrev			= UNSTUFF_BITS(resp, 60, 4);
91 	card->cid.fwrev			= UNSTUFF_BITS(resp, 56, 4);
92 	card->cid.serial		= UNSTUFF_BITS(resp, 24, 32);
93 	card->cid.year			= UNSTUFF_BITS(resp, 12, 8);
94 	card->cid.month			= UNSTUFF_BITS(resp, 8, 4);
95 
96 	card->cid.year += 2000; /* SD cards year offset */
97 }
98 
99 /*
100  * Given a 128-bit response, decode to our card CSD structure.
101  */
102 static int mmc_decode_csd(struct mmc_card *card)
103 {
104 	struct mmc_csd *csd = &card->csd;
105 	unsigned int e, m, csd_struct;
106 	u32 *resp = card->raw_csd;
107 
108 	csd_struct = UNSTUFF_BITS(resp, 126, 2);
109 
110 	switch (csd_struct) {
111 	case 0:
112 		m = UNSTUFF_BITS(resp, 115, 4);
113 		e = UNSTUFF_BITS(resp, 112, 3);
114 		csd->tacc_ns	 = (tacc_exp[e] * tacc_mant[m] + 9) / 10;
115 		csd->tacc_clks	 = UNSTUFF_BITS(resp, 104, 8) * 100;
116 
117 		m = UNSTUFF_BITS(resp, 99, 4);
118 		e = UNSTUFF_BITS(resp, 96, 3);
119 		csd->max_dtr	  = tran_exp[e] * tran_mant[m];
120 		csd->cmdclass	  = UNSTUFF_BITS(resp, 84, 12);
121 
122 		e = UNSTUFF_BITS(resp, 47, 3);
123 		m = UNSTUFF_BITS(resp, 62, 12);
124 		csd->capacity	  = (1 + m) << (e + 2);
125 
126 		csd->read_blkbits = UNSTUFF_BITS(resp, 80, 4);
127 		csd->read_partial = UNSTUFF_BITS(resp, 79, 1);
128 		csd->write_misalign = UNSTUFF_BITS(resp, 78, 1);
129 		csd->read_misalign = UNSTUFF_BITS(resp, 77, 1);
130 		csd->dsr_imp = UNSTUFF_BITS(resp, 76, 1);
131 		csd->r2w_factor = UNSTUFF_BITS(resp, 26, 3);
132 		csd->write_blkbits = UNSTUFF_BITS(resp, 22, 4);
133 		csd->write_partial = UNSTUFF_BITS(resp, 21, 1);
134 
135 		if (UNSTUFF_BITS(resp, 46, 1)) {
136 			csd->erase_size = 1;
137 		} else if (csd->write_blkbits >= 9) {
138 			csd->erase_size = UNSTUFF_BITS(resp, 39, 7) + 1;
139 			csd->erase_size <<= csd->write_blkbits - 9;
140 		}
141 		break;
142 	case 1:
143 		/*
144 		 * This is a block-addressed SDHC or SDXC card. Most
145 		 * interesting fields are unused and have fixed
146 		 * values. To avoid getting tripped by buggy cards,
147 		 * we assume those fixed values ourselves.
148 		 */
149 		mmc_card_set_blockaddr(card);
150 
151 		csd->tacc_ns	 = 0; /* Unused */
152 		csd->tacc_clks	 = 0; /* Unused */
153 
154 		m = UNSTUFF_BITS(resp, 99, 4);
155 		e = UNSTUFF_BITS(resp, 96, 3);
156 		csd->max_dtr	  = tran_exp[e] * tran_mant[m];
157 		csd->cmdclass	  = UNSTUFF_BITS(resp, 84, 12);
158 		csd->c_size	  = UNSTUFF_BITS(resp, 48, 22);
159 
160 		/* SDXC cards have a minimum C_SIZE of 0x00FFFF */
161 		if (csd->c_size >= 0xFFFF)
162 			mmc_card_set_ext_capacity(card);
163 
164 		m = UNSTUFF_BITS(resp, 48, 22);
165 		csd->capacity     = (1 + m) << 10;
166 
167 		csd->read_blkbits = 9;
168 		csd->read_partial = 0;
169 		csd->write_misalign = 0;
170 		csd->read_misalign = 0;
171 		csd->r2w_factor = 4; /* Unused */
172 		csd->write_blkbits = 9;
173 		csd->write_partial = 0;
174 		csd->erase_size = 1;
175 		break;
176 	default:
177 		pr_err("%s: unrecognised CSD structure version %d\n",
178 			mmc_hostname(card->host), csd_struct);
179 		return -EINVAL;
180 	}
181 
182 	card->erase_size = csd->erase_size;
183 
184 	return 0;
185 }
186 
187 /*
188  * Given a 64-bit response, decode to our card SCR structure.
189  */
190 static int mmc_decode_scr(struct mmc_card *card)
191 {
192 	struct sd_scr *scr = &card->scr;
193 	unsigned int scr_struct;
194 	u32 resp[4];
195 
196 	resp[3] = card->raw_scr[1];
197 	resp[2] = card->raw_scr[0];
198 
199 	scr_struct = UNSTUFF_BITS(resp, 60, 4);
200 	if (scr_struct != 0) {
201 		pr_err("%s: unrecognised SCR structure version %d\n",
202 			mmc_hostname(card->host), scr_struct);
203 		return -EINVAL;
204 	}
205 
206 	scr->sda_vsn = UNSTUFF_BITS(resp, 56, 4);
207 	scr->bus_widths = UNSTUFF_BITS(resp, 48, 4);
208 	if (scr->sda_vsn == SCR_SPEC_VER_2)
209 		/* Check if Physical Layer Spec v3.0 is supported */
210 		scr->sda_spec3 = UNSTUFF_BITS(resp, 47, 1);
211 
212 	if (UNSTUFF_BITS(resp, 55, 1))
213 		card->erased_byte = 0xFF;
214 	else
215 		card->erased_byte = 0x0;
216 
217 	if (scr->sda_spec3)
218 		scr->cmds = UNSTUFF_BITS(resp, 32, 2);
219 	return 0;
220 }
221 
222 /*
223  * Fetch and process SD Status register.
224  */
225 static int mmc_read_ssr(struct mmc_card *card)
226 {
227 	unsigned int au, es, et, eo;
228 	__be32 *raw_ssr;
229 	int i;
230 
231 	if (!(card->csd.cmdclass & CCC_APP_SPEC)) {
232 		pr_warn("%s: card lacks mandatory SD Status function\n",
233 			mmc_hostname(card->host));
234 		return 0;
235 	}
236 
237 	raw_ssr = kmalloc(sizeof(card->raw_ssr), GFP_KERNEL);
238 	if (!raw_ssr)
239 		return -ENOMEM;
240 
241 	if (mmc_app_sd_status(card, raw_ssr)) {
242 		pr_warn("%s: problem reading SD Status register\n",
243 			mmc_hostname(card->host));
244 		kfree(raw_ssr);
245 		return 0;
246 	}
247 
248 	for (i = 0; i < 16; i++)
249 		card->raw_ssr[i] = be32_to_cpu(raw_ssr[i]);
250 
251 	kfree(raw_ssr);
252 
253 	/*
254 	 * UNSTUFF_BITS only works with four u32s so we have to offset the
255 	 * bitfield positions accordingly.
256 	 */
257 	au = UNSTUFF_BITS(card->raw_ssr, 428 - 384, 4);
258 	if (au) {
259 		if (au <= 9 || card->scr.sda_spec3) {
260 			card->ssr.au = sd_au_size[au];
261 			es = UNSTUFF_BITS(card->raw_ssr, 408 - 384, 16);
262 			et = UNSTUFF_BITS(card->raw_ssr, 402 - 384, 6);
263 			if (es && et) {
264 				eo = UNSTUFF_BITS(card->raw_ssr, 400 - 384, 2);
265 				card->ssr.erase_timeout = (et * 1000) / es;
266 				card->ssr.erase_offset = eo * 1000;
267 			}
268 		} else {
269 			pr_warn("%s: SD Status: Invalid Allocation Unit size\n",
270 				mmc_hostname(card->host));
271 		}
272 	}
273 
274 	return 0;
275 }
276 
277 /*
278  * Fetches and decodes switch information
279  */
280 static int mmc_read_switch(struct mmc_card *card)
281 {
282 	int err;
283 	u8 *status;
284 
285 	if (card->scr.sda_vsn < SCR_SPEC_VER_1)
286 		return 0;
287 
288 	if (!(card->csd.cmdclass & CCC_SWITCH)) {
289 		pr_warn("%s: card lacks mandatory switch function, performance might suffer\n",
290 			mmc_hostname(card->host));
291 		return 0;
292 	}
293 
294 	err = -EIO;
295 
296 	status = kmalloc(64, GFP_KERNEL);
297 	if (!status)
298 		return -ENOMEM;
299 
300 	/*
301 	 * Find out the card's support bits with a mode 0 operation.
302 	 * The argument does not matter, as the support bits do not
303 	 * change with the arguments.
304 	 */
305 	err = mmc_sd_switch(card, 0, 0, 0, status);
306 	if (err) {
307 		/*
308 		 * If the host or the card can't do the switch,
309 		 * fail more gracefully.
310 		 */
311 		if (err != -EINVAL && err != -ENOSYS && err != -EFAULT)
312 			goto out;
313 
314 		pr_warn("%s: problem reading Bus Speed modes\n",
315 			mmc_hostname(card->host));
316 		err = 0;
317 
318 		goto out;
319 	}
320 
321 	if (status[13] & SD_MODE_HIGH_SPEED)
322 		card->sw_caps.hs_max_dtr = HIGH_SPEED_MAX_DTR;
323 
324 	if (card->scr.sda_spec3) {
325 		card->sw_caps.sd3_bus_mode = status[13];
326 		/* Driver Strengths supported by the card */
327 		card->sw_caps.sd3_drv_type = status[9];
328 		card->sw_caps.sd3_curr_limit = status[7] | status[6] << 8;
329 	}
330 
331 out:
332 	kfree(status);
333 
334 	return err;
335 }
336 
337 /*
338  * Test if the card supports high-speed mode and, if so, switch to it.
339  */
340 int mmc_sd_switch_hs(struct mmc_card *card)
341 {
342 	int err;
343 	u8 *status;
344 
345 	if (card->scr.sda_vsn < SCR_SPEC_VER_1)
346 		return 0;
347 
348 	if (!(card->csd.cmdclass & CCC_SWITCH))
349 		return 0;
350 
351 	if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
352 		return 0;
353 
354 	if (card->sw_caps.hs_max_dtr == 0)
355 		return 0;
356 
357 	status = kmalloc(64, GFP_KERNEL);
358 	if (!status)
359 		return -ENOMEM;
360 
361 	err = mmc_sd_switch(card, 1, 0, 1, status);
362 	if (err)
363 		goto out;
364 
365 	if ((status[16] & 0xF) != 1) {
366 		pr_warn("%s: Problem switching card into high-speed mode!\n",
367 			mmc_hostname(card->host));
368 		err = 0;
369 	} else {
370 		err = 1;
371 	}
372 
373 out:
374 	kfree(status);
375 
376 	return err;
377 }
378 
379 static int sd_select_driver_type(struct mmc_card *card, u8 *status)
380 {
381 	int card_drv_type, drive_strength, drv_type;
382 	int err;
383 
384 	card->drive_strength = 0;
385 
386 	card_drv_type = card->sw_caps.sd3_drv_type | SD_DRIVER_TYPE_B;
387 
388 	drive_strength = mmc_select_drive_strength(card,
389 						   card->sw_caps.uhs_max_dtr,
390 						   card_drv_type, &drv_type);
391 
392 	if (drive_strength) {
393 		err = mmc_sd_switch(card, 1, 2, drive_strength, status);
394 		if (err)
395 			return err;
396 		if ((status[15] & 0xF) != drive_strength) {
397 			pr_warn("%s: Problem setting drive strength!\n",
398 				mmc_hostname(card->host));
399 			return 0;
400 		}
401 		card->drive_strength = drive_strength;
402 	}
403 
404 	if (drv_type)
405 		mmc_set_driver_type(card->host, drv_type);
406 
407 	return 0;
408 }
409 
410 static void sd_update_bus_speed_mode(struct mmc_card *card)
411 {
412 	/*
413 	 * If the host doesn't support any of the UHS-I modes, fallback on
414 	 * default speed.
415 	 */
416 	if (!mmc_host_uhs(card->host)) {
417 		card->sd_bus_speed = 0;
418 		return;
419 	}
420 
421 	if ((card->host->caps & MMC_CAP_UHS_SDR104) &&
422 	    (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR104)) {
423 			card->sd_bus_speed = UHS_SDR104_BUS_SPEED;
424 	} else if ((card->host->caps & MMC_CAP_UHS_DDR50) &&
425 		   (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_DDR50)) {
426 			card->sd_bus_speed = UHS_DDR50_BUS_SPEED;
427 	} else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
428 		    MMC_CAP_UHS_SDR50)) && (card->sw_caps.sd3_bus_mode &
429 		    SD_MODE_UHS_SDR50)) {
430 			card->sd_bus_speed = UHS_SDR50_BUS_SPEED;
431 	} else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
432 		    MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25)) &&
433 		   (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR25)) {
434 			card->sd_bus_speed = UHS_SDR25_BUS_SPEED;
435 	} else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
436 		    MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25 |
437 		    MMC_CAP_UHS_SDR12)) && (card->sw_caps.sd3_bus_mode &
438 		    SD_MODE_UHS_SDR12)) {
439 			card->sd_bus_speed = UHS_SDR12_BUS_SPEED;
440 	}
441 }
442 
443 static int sd_set_bus_speed_mode(struct mmc_card *card, u8 *status)
444 {
445 	int err;
446 	unsigned int timing = 0;
447 
448 	switch (card->sd_bus_speed) {
449 	case UHS_SDR104_BUS_SPEED:
450 		timing = MMC_TIMING_UHS_SDR104;
451 		card->sw_caps.uhs_max_dtr = UHS_SDR104_MAX_DTR;
452 		break;
453 	case UHS_DDR50_BUS_SPEED:
454 		timing = MMC_TIMING_UHS_DDR50;
455 		card->sw_caps.uhs_max_dtr = UHS_DDR50_MAX_DTR;
456 		break;
457 	case UHS_SDR50_BUS_SPEED:
458 		timing = MMC_TIMING_UHS_SDR50;
459 		card->sw_caps.uhs_max_dtr = UHS_SDR50_MAX_DTR;
460 		break;
461 	case UHS_SDR25_BUS_SPEED:
462 		timing = MMC_TIMING_UHS_SDR25;
463 		card->sw_caps.uhs_max_dtr = UHS_SDR25_MAX_DTR;
464 		break;
465 	case UHS_SDR12_BUS_SPEED:
466 		timing = MMC_TIMING_UHS_SDR12;
467 		card->sw_caps.uhs_max_dtr = UHS_SDR12_MAX_DTR;
468 		break;
469 	default:
470 		return 0;
471 	}
472 
473 	err = mmc_sd_switch(card, 1, 0, card->sd_bus_speed, status);
474 	if (err)
475 		return err;
476 
477 	if ((status[16] & 0xF) != card->sd_bus_speed)
478 		pr_warn("%s: Problem setting bus speed mode!\n",
479 			mmc_hostname(card->host));
480 	else {
481 		mmc_set_timing(card->host, timing);
482 		mmc_set_clock(card->host, card->sw_caps.uhs_max_dtr);
483 	}
484 
485 	return 0;
486 }
487 
488 /* Get host's max current setting at its current voltage */
489 static u32 sd_get_host_max_current(struct mmc_host *host)
490 {
491 	u32 voltage, max_current;
492 
493 	voltage = 1 << host->ios.vdd;
494 	switch (voltage) {
495 	case MMC_VDD_165_195:
496 		max_current = host->max_current_180;
497 		break;
498 	case MMC_VDD_29_30:
499 	case MMC_VDD_30_31:
500 		max_current = host->max_current_300;
501 		break;
502 	case MMC_VDD_32_33:
503 	case MMC_VDD_33_34:
504 		max_current = host->max_current_330;
505 		break;
506 	default:
507 		max_current = 0;
508 	}
509 
510 	return max_current;
511 }
512 
513 static int sd_set_current_limit(struct mmc_card *card, u8 *status)
514 {
515 	int current_limit = SD_SET_CURRENT_NO_CHANGE;
516 	int err;
517 	u32 max_current;
518 
519 	/*
520 	 * Current limit switch is only defined for SDR50, SDR104, and DDR50
521 	 * bus speed modes. For other bus speed modes, we do not change the
522 	 * current limit.
523 	 */
524 	if ((card->sd_bus_speed != UHS_SDR50_BUS_SPEED) &&
525 	    (card->sd_bus_speed != UHS_SDR104_BUS_SPEED) &&
526 	    (card->sd_bus_speed != UHS_DDR50_BUS_SPEED))
527 		return 0;
528 
529 	/*
530 	 * Host has different current capabilities when operating at
531 	 * different voltages, so find out its max current first.
532 	 */
533 	max_current = sd_get_host_max_current(card->host);
534 
535 	/*
536 	 * We only check host's capability here, if we set a limit that is
537 	 * higher than the card's maximum current, the card will be using its
538 	 * maximum current, e.g. if the card's maximum current is 300ma, and
539 	 * when we set current limit to 200ma, the card will draw 200ma, and
540 	 * when we set current limit to 400/600/800ma, the card will draw its
541 	 * maximum 300ma from the host.
542 	 *
543 	 * The above is incorrect: if we try to set a current limit that is
544 	 * not supported by the card, the card can rightfully error out the
545 	 * attempt, and remain at the default current limit.  This results
546 	 * in a 300mA card being limited to 200mA even though the host
547 	 * supports 800mA. Failures seen with SanDisk 8GB UHS cards with
548 	 * an iMX6 host. --rmk
549 	 */
550 	if (max_current >= 800 &&
551 	    card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_800)
552 		current_limit = SD_SET_CURRENT_LIMIT_800;
553 	else if (max_current >= 600 &&
554 		 card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_600)
555 		current_limit = SD_SET_CURRENT_LIMIT_600;
556 	else if (max_current >= 400 &&
557 		 card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_400)
558 		current_limit = SD_SET_CURRENT_LIMIT_400;
559 	else if (max_current >= 200 &&
560 		 card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_200)
561 		current_limit = SD_SET_CURRENT_LIMIT_200;
562 
563 	if (current_limit != SD_SET_CURRENT_NO_CHANGE) {
564 		err = mmc_sd_switch(card, 1, 3, current_limit, status);
565 		if (err)
566 			return err;
567 
568 		if (((status[15] >> 4) & 0x0F) != current_limit)
569 			pr_warn("%s: Problem setting current limit!\n",
570 				mmc_hostname(card->host));
571 
572 	}
573 
574 	return 0;
575 }
576 
577 /*
578  * UHS-I specific initialization procedure
579  */
580 static int mmc_sd_init_uhs_card(struct mmc_card *card)
581 {
582 	int err;
583 	u8 *status;
584 
585 	if (!card->scr.sda_spec3)
586 		return 0;
587 
588 	if (!(card->csd.cmdclass & CCC_SWITCH))
589 		return 0;
590 
591 	status = kmalloc(64, GFP_KERNEL);
592 	if (!status)
593 		return -ENOMEM;
594 
595 	/* Set 4-bit bus width */
596 	if ((card->host->caps & MMC_CAP_4_BIT_DATA) &&
597 	    (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
598 		err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
599 		if (err)
600 			goto out;
601 
602 		mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
603 	}
604 
605 	/*
606 	 * Select the bus speed mode depending on host
607 	 * and card capability.
608 	 */
609 	sd_update_bus_speed_mode(card);
610 
611 	/* Set the driver strength for the card */
612 	err = sd_select_driver_type(card, status);
613 	if (err)
614 		goto out;
615 
616 	/* Set current limit for the card */
617 	err = sd_set_current_limit(card, status);
618 	if (err)
619 		goto out;
620 
621 	/* Set bus speed mode of the card */
622 	err = sd_set_bus_speed_mode(card, status);
623 	if (err)
624 		goto out;
625 
626 	/*
627 	 * SPI mode doesn't define CMD19 and tuning is only valid for SDR50 and
628 	 * SDR104 mode SD-cards. Note that tuning is mandatory for SDR104.
629 	 */
630 	if (!mmc_host_is_spi(card->host) &&
631 		(card->host->ios.timing == MMC_TIMING_UHS_SDR50 ||
632 		 card->host->ios.timing == MMC_TIMING_UHS_DDR50 ||
633 		 card->host->ios.timing == MMC_TIMING_UHS_SDR104)) {
634 		err = mmc_execute_tuning(card);
635 
636 		/*
637 		 * As SD Specifications Part1 Physical Layer Specification
638 		 * Version 3.01 says, CMD19 tuning is available for unlocked
639 		 * cards in transfer state of 1.8V signaling mode. The small
640 		 * difference between v3.00 and 3.01 spec means that CMD19
641 		 * tuning is also available for DDR50 mode.
642 		 */
643 		if (err && card->host->ios.timing == MMC_TIMING_UHS_DDR50) {
644 			pr_warn("%s: ddr50 tuning failed\n",
645 				mmc_hostname(card->host));
646 			err = 0;
647 		}
648 	}
649 
650 out:
651 	kfree(status);
652 
653 	return err;
654 }
655 
656 MMC_DEV_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
657 	card->raw_cid[2], card->raw_cid[3]);
658 MMC_DEV_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
659 	card->raw_csd[2], card->raw_csd[3]);
660 MMC_DEV_ATTR(scr, "%08x%08x\n", card->raw_scr[0], card->raw_scr[1]);
661 MMC_DEV_ATTR(ssr,
662 	"%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x\n",
663 		card->raw_ssr[0], card->raw_ssr[1], card->raw_ssr[2],
664 		card->raw_ssr[3], card->raw_ssr[4], card->raw_ssr[5],
665 		card->raw_ssr[6], card->raw_ssr[7], card->raw_ssr[8],
666 		card->raw_ssr[9], card->raw_ssr[10], card->raw_ssr[11],
667 		card->raw_ssr[12], card->raw_ssr[13], card->raw_ssr[14],
668 		card->raw_ssr[15]);
669 MMC_DEV_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
670 MMC_DEV_ATTR(erase_size, "%u\n", card->erase_size << 9);
671 MMC_DEV_ATTR(preferred_erase_size, "%u\n", card->pref_erase << 9);
672 MMC_DEV_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
673 MMC_DEV_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
674 MMC_DEV_ATTR(manfid, "0x%06x\n", card->cid.manfid);
675 MMC_DEV_ATTR(name, "%s\n", card->cid.prod_name);
676 MMC_DEV_ATTR(oemid, "0x%04x\n", card->cid.oemid);
677 MMC_DEV_ATTR(serial, "0x%08x\n", card->cid.serial);
678 MMC_DEV_ATTR(ocr, "%08x\n", card->ocr);
679 
680 
681 static ssize_t mmc_dsr_show(struct device *dev,
682                            struct device_attribute *attr,
683                            char *buf)
684 {
685        struct mmc_card *card = mmc_dev_to_card(dev);
686        struct mmc_host *host = card->host;
687 
688        if (card->csd.dsr_imp && host->dsr_req)
689                return sprintf(buf, "0x%x\n", host->dsr);
690        else
691                /* return default DSR value */
692                return sprintf(buf, "0x%x\n", 0x404);
693 }
694 
695 static DEVICE_ATTR(dsr, S_IRUGO, mmc_dsr_show, NULL);
696 
697 static struct attribute *sd_std_attrs[] = {
698 	&dev_attr_cid.attr,
699 	&dev_attr_csd.attr,
700 	&dev_attr_scr.attr,
701 	&dev_attr_ssr.attr,
702 	&dev_attr_date.attr,
703 	&dev_attr_erase_size.attr,
704 	&dev_attr_preferred_erase_size.attr,
705 	&dev_attr_fwrev.attr,
706 	&dev_attr_hwrev.attr,
707 	&dev_attr_manfid.attr,
708 	&dev_attr_name.attr,
709 	&dev_attr_oemid.attr,
710 	&dev_attr_serial.attr,
711 	&dev_attr_ocr.attr,
712 	&dev_attr_dsr.attr,
713 	NULL,
714 };
715 ATTRIBUTE_GROUPS(sd_std);
716 
717 struct device_type sd_type = {
718 	.groups = sd_std_groups,
719 };
720 
721 /*
722  * Fetch CID from card.
723  */
724 int mmc_sd_get_cid(struct mmc_host *host, u32 ocr, u32 *cid, u32 *rocr)
725 {
726 	int err;
727 	u32 max_current;
728 	int retries = 10;
729 	u32 pocr = ocr;
730 
731 try_again:
732 	if (!retries) {
733 		ocr &= ~SD_OCR_S18R;
734 		pr_warn("%s: Skipping voltage switch\n", mmc_hostname(host));
735 	}
736 
737 	/*
738 	 * Since we're changing the OCR value, we seem to
739 	 * need to tell some cards to go back to the idle
740 	 * state.  We wait 1ms to give cards time to
741 	 * respond.
742 	 */
743 	mmc_go_idle(host);
744 
745 	/*
746 	 * If SD_SEND_IF_COND indicates an SD 2.0
747 	 * compliant card and we should set bit 30
748 	 * of the ocr to indicate that we can handle
749 	 * block-addressed SDHC cards.
750 	 */
751 	err = mmc_send_if_cond(host, ocr);
752 	if (!err)
753 		ocr |= SD_OCR_CCS;
754 
755 	/*
756 	 * If the host supports one of UHS-I modes, request the card
757 	 * to switch to 1.8V signaling level. If the card has failed
758 	 * repeatedly to switch however, skip this.
759 	 */
760 	if (retries && mmc_host_uhs(host))
761 		ocr |= SD_OCR_S18R;
762 
763 	/*
764 	 * If the host can supply more than 150mA at current voltage,
765 	 * XPC should be set to 1.
766 	 */
767 	max_current = sd_get_host_max_current(host);
768 	if (max_current > 150)
769 		ocr |= SD_OCR_XPC;
770 
771 	err = mmc_send_app_op_cond(host, ocr, rocr);
772 	if (err)
773 		return err;
774 
775 	/*
776 	 * In case CCS and S18A in the response is set, start Signal Voltage
777 	 * Switch procedure. SPI mode doesn't support CMD11.
778 	 */
779 	if (!mmc_host_is_spi(host) && rocr &&
780 	   ((*rocr & 0x41000000) == 0x41000000)) {
781 		err = mmc_set_uhs_voltage(host, pocr);
782 		if (err == -EAGAIN) {
783 			retries--;
784 			goto try_again;
785 		} else if (err) {
786 			retries = 0;
787 			goto try_again;
788 		}
789 	}
790 
791 	err = mmc_send_cid(host, cid);
792 	return err;
793 }
794 
795 int mmc_sd_get_csd(struct mmc_host *host, struct mmc_card *card)
796 {
797 	int err;
798 
799 	/*
800 	 * Fetch CSD from card.
801 	 */
802 	err = mmc_send_csd(card, card->raw_csd);
803 	if (err)
804 		return err;
805 
806 	err = mmc_decode_csd(card);
807 	if (err)
808 		return err;
809 
810 	return 0;
811 }
812 
813 static int mmc_sd_get_ro(struct mmc_host *host)
814 {
815 	int ro;
816 
817 	/*
818 	 * Some systems don't feature a write-protect pin and don't need one.
819 	 * E.g. because they only have micro-SD card slot. For those systems
820 	 * assume that the SD card is always read-write.
821 	 */
822 	if (host->caps2 & MMC_CAP2_NO_WRITE_PROTECT)
823 		return 0;
824 
825 	if (!host->ops->get_ro)
826 		return -1;
827 
828 	ro = host->ops->get_ro(host);
829 
830 	return ro;
831 }
832 
833 int mmc_sd_setup_card(struct mmc_host *host, struct mmc_card *card,
834 	bool reinit)
835 {
836 	int err;
837 
838 	if (!reinit) {
839 		/*
840 		 * Fetch SCR from card.
841 		 */
842 		err = mmc_app_send_scr(card);
843 		if (err)
844 			return err;
845 
846 		err = mmc_decode_scr(card);
847 		if (err)
848 			return err;
849 
850 		/*
851 		 * Fetch and process SD Status register.
852 		 */
853 		err = mmc_read_ssr(card);
854 		if (err)
855 			return err;
856 
857 		/* Erase init depends on CSD and SSR */
858 		mmc_init_erase(card);
859 
860 		/*
861 		 * Fetch switch information from card.
862 		 */
863 		err = mmc_read_switch(card);
864 		if (err)
865 			return err;
866 	}
867 
868 	/*
869 	 * For SPI, enable CRC as appropriate.
870 	 * This CRC enable is located AFTER the reading of the
871 	 * card registers because some SDHC cards are not able
872 	 * to provide valid CRCs for non-512-byte blocks.
873 	 */
874 	if (mmc_host_is_spi(host)) {
875 		err = mmc_spi_set_crc(host, use_spi_crc);
876 		if (err)
877 			return err;
878 	}
879 
880 	/*
881 	 * Check if read-only switch is active.
882 	 */
883 	if (!reinit) {
884 		int ro = mmc_sd_get_ro(host);
885 
886 		if (ro < 0) {
887 			pr_warn("%s: host does not support reading read-only switch, assuming write-enable\n",
888 				mmc_hostname(host));
889 		} else if (ro > 0) {
890 			mmc_card_set_readonly(card);
891 		}
892 	}
893 
894 	return 0;
895 }
896 
897 unsigned mmc_sd_get_max_clock(struct mmc_card *card)
898 {
899 	unsigned max_dtr = (unsigned int)-1;
900 
901 	if (mmc_card_hs(card)) {
902 		if (max_dtr > card->sw_caps.hs_max_dtr)
903 			max_dtr = card->sw_caps.hs_max_dtr;
904 	} else if (max_dtr > card->csd.max_dtr) {
905 		max_dtr = card->csd.max_dtr;
906 	}
907 
908 	return max_dtr;
909 }
910 
911 /*
912  * Handle the detection and initialisation of a card.
913  *
914  * In the case of a resume, "oldcard" will contain the card
915  * we're trying to reinitialise.
916  */
917 static int mmc_sd_init_card(struct mmc_host *host, u32 ocr,
918 	struct mmc_card *oldcard)
919 {
920 	struct mmc_card *card;
921 	int err;
922 	u32 cid[4];
923 	u32 rocr = 0;
924 
925 	WARN_ON(!host->claimed);
926 
927 	err = mmc_sd_get_cid(host, ocr, cid, &rocr);
928 	if (err)
929 		return err;
930 
931 	if (oldcard) {
932 		if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0)
933 			return -ENOENT;
934 
935 		card = oldcard;
936 	} else {
937 		/*
938 		 * Allocate card structure.
939 		 */
940 		card = mmc_alloc_card(host, &sd_type);
941 		if (IS_ERR(card))
942 			return PTR_ERR(card);
943 
944 		card->ocr = ocr;
945 		card->type = MMC_TYPE_SD;
946 		memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
947 	}
948 
949 	/*
950 	 * Call the optional HC's init_card function to handle quirks.
951 	 */
952 	if (host->ops->init_card)
953 		host->ops->init_card(host, card);
954 
955 	/*
956 	 * For native busses:  get card RCA and quit open drain mode.
957 	 */
958 	if (!mmc_host_is_spi(host)) {
959 		err = mmc_send_relative_addr(host, &card->rca);
960 		if (err)
961 			goto free_card;
962 	}
963 
964 	if (!oldcard) {
965 		err = mmc_sd_get_csd(host, card);
966 		if (err)
967 			goto free_card;
968 
969 		mmc_decode_cid(card);
970 	}
971 
972 	/*
973 	 * handling only for cards supporting DSR and hosts requesting
974 	 * DSR configuration
975 	 */
976 	if (card->csd.dsr_imp && host->dsr_req)
977 		mmc_set_dsr(host);
978 
979 	/*
980 	 * Select card, as all following commands rely on that.
981 	 */
982 	if (!mmc_host_is_spi(host)) {
983 		err = mmc_select_card(card);
984 		if (err)
985 			goto free_card;
986 	}
987 
988 	err = mmc_sd_setup_card(host, card, oldcard != NULL);
989 	if (err)
990 		goto free_card;
991 
992 	/* Initialization sequence for UHS-I cards */
993 	if (rocr & SD_ROCR_S18A) {
994 		err = mmc_sd_init_uhs_card(card);
995 		if (err)
996 			goto free_card;
997 	} else {
998 		/*
999 		 * Attempt to change to high-speed (if supported)
1000 		 */
1001 		err = mmc_sd_switch_hs(card);
1002 		if (err > 0)
1003 			mmc_set_timing(card->host, MMC_TIMING_SD_HS);
1004 		else if (err)
1005 			goto free_card;
1006 
1007 		/*
1008 		 * Set bus speed.
1009 		 */
1010 		mmc_set_clock(host, mmc_sd_get_max_clock(card));
1011 
1012 		/*
1013 		 * Switch to wider bus (if supported).
1014 		 */
1015 		if ((host->caps & MMC_CAP_4_BIT_DATA) &&
1016 			(card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
1017 			err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
1018 			if (err)
1019 				goto free_card;
1020 
1021 			mmc_set_bus_width(host, MMC_BUS_WIDTH_4);
1022 		}
1023 	}
1024 
1025 	host->card = card;
1026 	return 0;
1027 
1028 free_card:
1029 	if (!oldcard)
1030 		mmc_remove_card(card);
1031 
1032 	return err;
1033 }
1034 
1035 /*
1036  * Host is being removed. Free up the current card.
1037  */
1038 static void mmc_sd_remove(struct mmc_host *host)
1039 {
1040 	mmc_remove_card(host->card);
1041 	host->card = NULL;
1042 }
1043 
1044 /*
1045  * Card detection - card is alive.
1046  */
1047 static int mmc_sd_alive(struct mmc_host *host)
1048 {
1049 	return mmc_send_status(host->card, NULL);
1050 }
1051 
1052 /*
1053  * Card detection callback from host.
1054  */
1055 static void mmc_sd_detect(struct mmc_host *host)
1056 {
1057 	int err;
1058 
1059 	mmc_get_card(host->card);
1060 
1061 	/*
1062 	 * Just check if our card has been removed.
1063 	 */
1064 	err = _mmc_detect_card_removed(host);
1065 
1066 	mmc_put_card(host->card);
1067 
1068 	if (err) {
1069 		mmc_sd_remove(host);
1070 
1071 		mmc_claim_host(host);
1072 		mmc_detach_bus(host);
1073 		mmc_power_off(host);
1074 		mmc_release_host(host);
1075 	}
1076 }
1077 
1078 static int _mmc_sd_suspend(struct mmc_host *host)
1079 {
1080 	int err = 0;
1081 
1082 	mmc_claim_host(host);
1083 
1084 	if (mmc_card_suspended(host->card))
1085 		goto out;
1086 
1087 	if (!mmc_host_is_spi(host))
1088 		err = mmc_deselect_cards(host);
1089 
1090 	if (!err) {
1091 		mmc_power_off(host);
1092 		mmc_card_set_suspended(host->card);
1093 	}
1094 
1095 out:
1096 	mmc_release_host(host);
1097 	return err;
1098 }
1099 
1100 /*
1101  * Callback for suspend
1102  */
1103 static int mmc_sd_suspend(struct mmc_host *host)
1104 {
1105 	int err;
1106 
1107 	err = _mmc_sd_suspend(host);
1108 	if (!err) {
1109 		pm_runtime_disable(&host->card->dev);
1110 		pm_runtime_set_suspended(&host->card->dev);
1111 	}
1112 
1113 	return err;
1114 }
1115 
1116 /*
1117  * This function tries to determine if the same card is still present
1118  * and, if so, restore all state to it.
1119  */
1120 static int _mmc_sd_resume(struct mmc_host *host)
1121 {
1122 	int err = 0;
1123 
1124 	mmc_claim_host(host);
1125 
1126 	if (!mmc_card_suspended(host->card))
1127 		goto out;
1128 
1129 	mmc_power_up(host, host->card->ocr);
1130 	err = mmc_sd_init_card(host, host->card->ocr, host->card);
1131 	mmc_card_clr_suspended(host->card);
1132 
1133 out:
1134 	mmc_release_host(host);
1135 	return err;
1136 }
1137 
1138 /*
1139  * Callback for resume
1140  */
1141 static int mmc_sd_resume(struct mmc_host *host)
1142 {
1143 	pm_runtime_enable(&host->card->dev);
1144 	return 0;
1145 }
1146 
1147 /*
1148  * Callback for runtime_suspend.
1149  */
1150 static int mmc_sd_runtime_suspend(struct mmc_host *host)
1151 {
1152 	int err;
1153 
1154 	if (!(host->caps & MMC_CAP_AGGRESSIVE_PM))
1155 		return 0;
1156 
1157 	err = _mmc_sd_suspend(host);
1158 	if (err)
1159 		pr_err("%s: error %d doing aggressive suspend\n",
1160 			mmc_hostname(host), err);
1161 
1162 	return err;
1163 }
1164 
1165 /*
1166  * Callback for runtime_resume.
1167  */
1168 static int mmc_sd_runtime_resume(struct mmc_host *host)
1169 {
1170 	int err;
1171 
1172 	err = _mmc_sd_resume(host);
1173 	if (err && err != -ENOMEDIUM)
1174 		pr_err("%s: error %d doing runtime resume\n",
1175 			mmc_hostname(host), err);
1176 
1177 	return 0;
1178 }
1179 
1180 static int mmc_sd_reset(struct mmc_host *host)
1181 {
1182 	mmc_power_cycle(host, host->card->ocr);
1183 	return mmc_sd_init_card(host, host->card->ocr, host->card);
1184 }
1185 
1186 static const struct mmc_bus_ops mmc_sd_ops = {
1187 	.remove = mmc_sd_remove,
1188 	.detect = mmc_sd_detect,
1189 	.runtime_suspend = mmc_sd_runtime_suspend,
1190 	.runtime_resume = mmc_sd_runtime_resume,
1191 	.suspend = mmc_sd_suspend,
1192 	.resume = mmc_sd_resume,
1193 	.alive = mmc_sd_alive,
1194 	.shutdown = mmc_sd_suspend,
1195 	.reset = mmc_sd_reset,
1196 };
1197 
1198 /*
1199  * Starting point for SD card init.
1200  */
1201 int mmc_attach_sd(struct mmc_host *host)
1202 {
1203 	int err;
1204 	u32 ocr, rocr;
1205 
1206 	WARN_ON(!host->claimed);
1207 
1208 	err = mmc_send_app_op_cond(host, 0, &ocr);
1209 	if (err)
1210 		return err;
1211 
1212 	mmc_attach_bus(host, &mmc_sd_ops);
1213 	if (host->ocr_avail_sd)
1214 		host->ocr_avail = host->ocr_avail_sd;
1215 
1216 	/*
1217 	 * We need to get OCR a different way for SPI.
1218 	 */
1219 	if (mmc_host_is_spi(host)) {
1220 		mmc_go_idle(host);
1221 
1222 		err = mmc_spi_read_ocr(host, 0, &ocr);
1223 		if (err)
1224 			goto err;
1225 	}
1226 
1227 	rocr = mmc_select_voltage(host, ocr);
1228 
1229 	/*
1230 	 * Can we support the voltage(s) of the card(s)?
1231 	 */
1232 	if (!rocr) {
1233 		err = -EINVAL;
1234 		goto err;
1235 	}
1236 
1237 	/*
1238 	 * Detect and init the card.
1239 	 */
1240 	err = mmc_sd_init_card(host, rocr, NULL);
1241 	if (err)
1242 		goto err;
1243 
1244 	mmc_release_host(host);
1245 	err = mmc_add_card(host->card);
1246 	if (err)
1247 		goto remove_card;
1248 
1249 	mmc_claim_host(host);
1250 	return 0;
1251 
1252 remove_card:
1253 	mmc_remove_card(host->card);
1254 	host->card = NULL;
1255 	mmc_claim_host(host);
1256 err:
1257 	mmc_detach_bus(host);
1258 
1259 	pr_err("%s: error %d whilst initialising SD card\n",
1260 		mmc_hostname(host), err);
1261 
1262 	return err;
1263 }
1264