xref: /linux/drivers/mmc/core/sdio.c (revision c0e297dc61f8d4453e07afbea1fa8d0e67cd4a34)
1 /*
2  *  linux/drivers/mmc/sdio.c
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/err.h>
13 #include <linux/pm_runtime.h>
14 
15 #include <linux/mmc/host.h>
16 #include <linux/mmc/card.h>
17 #include <linux/mmc/mmc.h>
18 #include <linux/mmc/sdio.h>
19 #include <linux/mmc/sdio_func.h>
20 #include <linux/mmc/sdio_ids.h>
21 
22 #include "core.h"
23 #include "bus.h"
24 #include "sd.h"
25 #include "sdio_bus.h"
26 #include "mmc_ops.h"
27 #include "sd_ops.h"
28 #include "sdio_ops.h"
29 #include "sdio_cis.h"
30 
31 static int sdio_read_fbr(struct sdio_func *func)
32 {
33 	int ret;
34 	unsigned char data;
35 
36 	if (mmc_card_nonstd_func_interface(func->card)) {
37 		func->class = SDIO_CLASS_NONE;
38 		return 0;
39 	}
40 
41 	ret = mmc_io_rw_direct(func->card, 0, 0,
42 		SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF, 0, &data);
43 	if (ret)
44 		goto out;
45 
46 	data &= 0x0f;
47 
48 	if (data == 0x0f) {
49 		ret = mmc_io_rw_direct(func->card, 0, 0,
50 			SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF_EXT, 0, &data);
51 		if (ret)
52 			goto out;
53 	}
54 
55 	func->class = data;
56 
57 out:
58 	return ret;
59 }
60 
61 static int sdio_init_func(struct mmc_card *card, unsigned int fn)
62 {
63 	int ret;
64 	struct sdio_func *func;
65 
66 	BUG_ON(fn > SDIO_MAX_FUNCS);
67 
68 	func = sdio_alloc_func(card);
69 	if (IS_ERR(func))
70 		return PTR_ERR(func);
71 
72 	func->num = fn;
73 
74 	if (!(card->quirks & MMC_QUIRK_NONSTD_SDIO)) {
75 		ret = sdio_read_fbr(func);
76 		if (ret)
77 			goto fail;
78 
79 		ret = sdio_read_func_cis(func);
80 		if (ret)
81 			goto fail;
82 	} else {
83 		func->vendor = func->card->cis.vendor;
84 		func->device = func->card->cis.device;
85 		func->max_blksize = func->card->cis.blksize;
86 	}
87 
88 	card->sdio_func[fn - 1] = func;
89 
90 	return 0;
91 
92 fail:
93 	/*
94 	 * It is okay to remove the function here even though we hold
95 	 * the host lock as we haven't registered the device yet.
96 	 */
97 	sdio_remove_func(func);
98 	return ret;
99 }
100 
101 static int sdio_read_cccr(struct mmc_card *card, u32 ocr)
102 {
103 	int ret;
104 	int cccr_vsn;
105 	int uhs = ocr & R4_18V_PRESENT;
106 	unsigned char data;
107 	unsigned char speed;
108 
109 	memset(&card->cccr, 0, sizeof(struct sdio_cccr));
110 
111 	ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CCCR, 0, &data);
112 	if (ret)
113 		goto out;
114 
115 	cccr_vsn = data & 0x0f;
116 
117 	if (cccr_vsn > SDIO_CCCR_REV_3_00) {
118 		pr_err("%s: unrecognised CCCR structure version %d\n",
119 			mmc_hostname(card->host), cccr_vsn);
120 		return -EINVAL;
121 	}
122 
123 	card->cccr.sdio_vsn = (data & 0xf0) >> 4;
124 
125 	ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CAPS, 0, &data);
126 	if (ret)
127 		goto out;
128 
129 	if (data & SDIO_CCCR_CAP_SMB)
130 		card->cccr.multi_block = 1;
131 	if (data & SDIO_CCCR_CAP_LSC)
132 		card->cccr.low_speed = 1;
133 	if (data & SDIO_CCCR_CAP_4BLS)
134 		card->cccr.wide_bus = 1;
135 
136 	if (cccr_vsn >= SDIO_CCCR_REV_1_10) {
137 		ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_POWER, 0, &data);
138 		if (ret)
139 			goto out;
140 
141 		if (data & SDIO_POWER_SMPC)
142 			card->cccr.high_power = 1;
143 	}
144 
145 	if (cccr_vsn >= SDIO_CCCR_REV_1_20) {
146 		ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
147 		if (ret)
148 			goto out;
149 
150 		card->scr.sda_spec3 = 0;
151 		card->sw_caps.sd3_bus_mode = 0;
152 		card->sw_caps.sd3_drv_type = 0;
153 		if (cccr_vsn >= SDIO_CCCR_REV_3_00 && uhs) {
154 			card->scr.sda_spec3 = 1;
155 			ret = mmc_io_rw_direct(card, 0, 0,
156 				SDIO_CCCR_UHS, 0, &data);
157 			if (ret)
158 				goto out;
159 
160 			if (mmc_host_uhs(card->host)) {
161 				if (data & SDIO_UHS_DDR50)
162 					card->sw_caps.sd3_bus_mode
163 						|= SD_MODE_UHS_DDR50;
164 
165 				if (data & SDIO_UHS_SDR50)
166 					card->sw_caps.sd3_bus_mode
167 						|= SD_MODE_UHS_SDR50;
168 
169 				if (data & SDIO_UHS_SDR104)
170 					card->sw_caps.sd3_bus_mode
171 						|= SD_MODE_UHS_SDR104;
172 			}
173 
174 			ret = mmc_io_rw_direct(card, 0, 0,
175 				SDIO_CCCR_DRIVE_STRENGTH, 0, &data);
176 			if (ret)
177 				goto out;
178 
179 			if (data & SDIO_DRIVE_SDTA)
180 				card->sw_caps.sd3_drv_type |= SD_DRIVER_TYPE_A;
181 			if (data & SDIO_DRIVE_SDTC)
182 				card->sw_caps.sd3_drv_type |= SD_DRIVER_TYPE_C;
183 			if (data & SDIO_DRIVE_SDTD)
184 				card->sw_caps.sd3_drv_type |= SD_DRIVER_TYPE_D;
185 		}
186 
187 		/* if no uhs mode ensure we check for high speed */
188 		if (!card->sw_caps.sd3_bus_mode) {
189 			if (speed & SDIO_SPEED_SHS) {
190 				card->cccr.high_speed = 1;
191 				card->sw_caps.hs_max_dtr = 50000000;
192 			} else {
193 				card->cccr.high_speed = 0;
194 				card->sw_caps.hs_max_dtr = 25000000;
195 			}
196 		}
197 	}
198 
199 out:
200 	return ret;
201 }
202 
203 static int sdio_enable_wide(struct mmc_card *card)
204 {
205 	int ret;
206 	u8 ctrl;
207 
208 	if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
209 		return 0;
210 
211 	if (card->cccr.low_speed && !card->cccr.wide_bus)
212 		return 0;
213 
214 	ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
215 	if (ret)
216 		return ret;
217 
218 	if ((ctrl & SDIO_BUS_WIDTH_MASK) == SDIO_BUS_WIDTH_RESERVED)
219 		pr_warn("%s: SDIO_CCCR_IF is invalid: 0x%02x\n",
220 			mmc_hostname(card->host), ctrl);
221 
222 	/* set as 4-bit bus width */
223 	ctrl &= ~SDIO_BUS_WIDTH_MASK;
224 	ctrl |= SDIO_BUS_WIDTH_4BIT;
225 
226 	ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
227 	if (ret)
228 		return ret;
229 
230 	return 1;
231 }
232 
233 /*
234  * If desired, disconnect the pull-up resistor on CD/DAT[3] (pin 1)
235  * of the card. This may be required on certain setups of boards,
236  * controllers and embedded sdio device which do not need the card's
237  * pull-up. As a result, card detection is disabled and power is saved.
238  */
239 static int sdio_disable_cd(struct mmc_card *card)
240 {
241 	int ret;
242 	u8 ctrl;
243 
244 	if (!mmc_card_disable_cd(card))
245 		return 0;
246 
247 	ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
248 	if (ret)
249 		return ret;
250 
251 	ctrl |= SDIO_BUS_CD_DISABLE;
252 
253 	return mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
254 }
255 
256 /*
257  * Devices that remain active during a system suspend are
258  * put back into 1-bit mode.
259  */
260 static int sdio_disable_wide(struct mmc_card *card)
261 {
262 	int ret;
263 	u8 ctrl;
264 
265 	if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
266 		return 0;
267 
268 	if (card->cccr.low_speed && !card->cccr.wide_bus)
269 		return 0;
270 
271 	ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
272 	if (ret)
273 		return ret;
274 
275 	if (!(ctrl & SDIO_BUS_WIDTH_4BIT))
276 		return 0;
277 
278 	ctrl &= ~SDIO_BUS_WIDTH_4BIT;
279 	ctrl |= SDIO_BUS_ASYNC_INT;
280 
281 	ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
282 	if (ret)
283 		return ret;
284 
285 	mmc_set_bus_width(card->host, MMC_BUS_WIDTH_1);
286 
287 	return 0;
288 }
289 
290 
291 static int sdio_enable_4bit_bus(struct mmc_card *card)
292 {
293 	int err;
294 
295 	if (card->type == MMC_TYPE_SDIO)
296 		err = sdio_enable_wide(card);
297 	else if ((card->host->caps & MMC_CAP_4_BIT_DATA) &&
298 		 (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
299 		err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
300 		if (err)
301 			return err;
302 		err = sdio_enable_wide(card);
303 		if (err <= 0)
304 			mmc_app_set_bus_width(card, MMC_BUS_WIDTH_1);
305 	} else
306 		return 0;
307 
308 	if (err > 0) {
309 		mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
310 		err = 0;
311 	}
312 
313 	return err;
314 }
315 
316 
317 /*
318  * Test if the card supports high-speed mode and, if so, switch to it.
319  */
320 static int mmc_sdio_switch_hs(struct mmc_card *card, int enable)
321 {
322 	int ret;
323 	u8 speed;
324 
325 	if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
326 		return 0;
327 
328 	if (!card->cccr.high_speed)
329 		return 0;
330 
331 	ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
332 	if (ret)
333 		return ret;
334 
335 	if (enable)
336 		speed |= SDIO_SPEED_EHS;
337 	else
338 		speed &= ~SDIO_SPEED_EHS;
339 
340 	ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
341 	if (ret)
342 		return ret;
343 
344 	return 1;
345 }
346 
347 /*
348  * Enable SDIO/combo card's high-speed mode. Return 0/1 if [not]supported.
349  */
350 static int sdio_enable_hs(struct mmc_card *card)
351 {
352 	int ret;
353 
354 	ret = mmc_sdio_switch_hs(card, true);
355 	if (ret <= 0 || card->type == MMC_TYPE_SDIO)
356 		return ret;
357 
358 	ret = mmc_sd_switch_hs(card);
359 	if (ret <= 0)
360 		mmc_sdio_switch_hs(card, false);
361 
362 	return ret;
363 }
364 
365 static unsigned mmc_sdio_get_max_clock(struct mmc_card *card)
366 {
367 	unsigned max_dtr;
368 
369 	if (mmc_card_hs(card)) {
370 		/*
371 		 * The SDIO specification doesn't mention how
372 		 * the CIS transfer speed register relates to
373 		 * high-speed, but it seems that 50 MHz is
374 		 * mandatory.
375 		 */
376 		max_dtr = 50000000;
377 	} else {
378 		max_dtr = card->cis.max_dtr;
379 	}
380 
381 	if (card->type == MMC_TYPE_SD_COMBO)
382 		max_dtr = min(max_dtr, mmc_sd_get_max_clock(card));
383 
384 	return max_dtr;
385 }
386 
387 static unsigned char host_drive_to_sdio_drive(int host_strength)
388 {
389 	switch (host_strength) {
390 	case MMC_SET_DRIVER_TYPE_A:
391 		return SDIO_DTSx_SET_TYPE_A;
392 	case MMC_SET_DRIVER_TYPE_B:
393 		return SDIO_DTSx_SET_TYPE_B;
394 	case MMC_SET_DRIVER_TYPE_C:
395 		return SDIO_DTSx_SET_TYPE_C;
396 	case MMC_SET_DRIVER_TYPE_D:
397 		return SDIO_DTSx_SET_TYPE_D;
398 	default:
399 		return SDIO_DTSx_SET_TYPE_B;
400 	}
401 }
402 
403 static void sdio_select_driver_type(struct mmc_card *card)
404 {
405 	int card_drv_type, drive_strength, drv_type;
406 	unsigned char card_strength;
407 	int err;
408 
409 	card->drive_strength = 0;
410 
411 	card_drv_type = card->sw_caps.sd3_drv_type | SD_DRIVER_TYPE_B;
412 
413 	drive_strength = mmc_select_drive_strength(card,
414 						   card->sw_caps.uhs_max_dtr,
415 						   card_drv_type, &drv_type);
416 
417 	if (drive_strength) {
418 		/* if error just use default for drive strength B */
419 		err = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_DRIVE_STRENGTH, 0,
420 				       &card_strength);
421 		if (err)
422 			return;
423 
424 		card_strength &= ~(SDIO_DRIVE_DTSx_MASK<<SDIO_DRIVE_DTSx_SHIFT);
425 		card_strength |= host_drive_to_sdio_drive(drive_strength);
426 
427 		/* if error default to drive strength B */
428 		err = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_DRIVE_STRENGTH,
429 				       card_strength, NULL);
430 		if (err)
431 			return;
432 		card->drive_strength = drive_strength;
433 	}
434 
435 	if (drv_type)
436 		mmc_set_driver_type(card->host, drv_type);
437 }
438 
439 
440 static int sdio_set_bus_speed_mode(struct mmc_card *card)
441 {
442 	unsigned int bus_speed, timing;
443 	int err;
444 	unsigned char speed;
445 
446 	/*
447 	 * If the host doesn't support any of the UHS-I modes, fallback on
448 	 * default speed.
449 	 */
450 	if (!mmc_host_uhs(card->host))
451 		return 0;
452 
453 	bus_speed = SDIO_SPEED_SDR12;
454 	timing = MMC_TIMING_UHS_SDR12;
455 	if ((card->host->caps & MMC_CAP_UHS_SDR104) &&
456 	    (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR104)) {
457 			bus_speed = SDIO_SPEED_SDR104;
458 			timing = MMC_TIMING_UHS_SDR104;
459 			card->sw_caps.uhs_max_dtr = UHS_SDR104_MAX_DTR;
460 			card->sd_bus_speed = UHS_SDR104_BUS_SPEED;
461 	} else if ((card->host->caps & MMC_CAP_UHS_DDR50) &&
462 		   (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_DDR50)) {
463 			bus_speed = SDIO_SPEED_DDR50;
464 			timing = MMC_TIMING_UHS_DDR50;
465 			card->sw_caps.uhs_max_dtr = UHS_DDR50_MAX_DTR;
466 			card->sd_bus_speed = UHS_DDR50_BUS_SPEED;
467 	} else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
468 		    MMC_CAP_UHS_SDR50)) && (card->sw_caps.sd3_bus_mode &
469 		    SD_MODE_UHS_SDR50)) {
470 			bus_speed = SDIO_SPEED_SDR50;
471 			timing = MMC_TIMING_UHS_SDR50;
472 			card->sw_caps.uhs_max_dtr = UHS_SDR50_MAX_DTR;
473 			card->sd_bus_speed = UHS_SDR50_BUS_SPEED;
474 	} else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
475 		    MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25)) &&
476 		   (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR25)) {
477 			bus_speed = SDIO_SPEED_SDR25;
478 			timing = MMC_TIMING_UHS_SDR25;
479 			card->sw_caps.uhs_max_dtr = UHS_SDR25_MAX_DTR;
480 			card->sd_bus_speed = UHS_SDR25_BUS_SPEED;
481 	} else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
482 		    MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25 |
483 		    MMC_CAP_UHS_SDR12)) && (card->sw_caps.sd3_bus_mode &
484 		    SD_MODE_UHS_SDR12)) {
485 			bus_speed = SDIO_SPEED_SDR12;
486 			timing = MMC_TIMING_UHS_SDR12;
487 			card->sw_caps.uhs_max_dtr = UHS_SDR12_MAX_DTR;
488 			card->sd_bus_speed = UHS_SDR12_BUS_SPEED;
489 	}
490 
491 	err = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
492 	if (err)
493 		return err;
494 
495 	speed &= ~SDIO_SPEED_BSS_MASK;
496 	speed |= bus_speed;
497 	err = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
498 	if (err)
499 		return err;
500 
501 	if (bus_speed) {
502 		mmc_set_timing(card->host, timing);
503 		mmc_set_clock(card->host, card->sw_caps.uhs_max_dtr);
504 	}
505 
506 	return 0;
507 }
508 
509 /*
510  * UHS-I specific initialization procedure
511  */
512 static int mmc_sdio_init_uhs_card(struct mmc_card *card)
513 {
514 	int err;
515 
516 	if (!card->scr.sda_spec3)
517 		return 0;
518 
519 	/*
520 	 * Switch to wider bus (if supported).
521 	 */
522 	if (card->host->caps & MMC_CAP_4_BIT_DATA)
523 		err = sdio_enable_4bit_bus(card);
524 
525 	/* Set the driver strength for the card */
526 	sdio_select_driver_type(card);
527 
528 	/* Set bus speed mode of the card */
529 	err = sdio_set_bus_speed_mode(card);
530 	if (err)
531 		goto out;
532 
533 	/*
534 	 * SPI mode doesn't define CMD19 and tuning is only valid for SDR50 and
535 	 * SDR104 mode SD-cards. Note that tuning is mandatory for SDR104.
536 	 */
537 	if (!mmc_host_is_spi(card->host) &&
538 	    ((card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR50) ||
539 	     (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR104)))
540 		err = mmc_execute_tuning(card);
541 out:
542 	return err;
543 }
544 
545 /*
546  * Handle the detection and initialisation of a card.
547  *
548  * In the case of a resume, "oldcard" will contain the card
549  * we're trying to reinitialise.
550  */
551 static int mmc_sdio_init_card(struct mmc_host *host, u32 ocr,
552 			      struct mmc_card *oldcard, int powered_resume)
553 {
554 	struct mmc_card *card;
555 	int err;
556 	int retries = 10;
557 	u32 rocr = 0;
558 	u32 ocr_card = ocr;
559 
560 	BUG_ON(!host);
561 	WARN_ON(!host->claimed);
562 
563 	/* to query card if 1.8V signalling is supported */
564 	if (mmc_host_uhs(host))
565 		ocr |= R4_18V_PRESENT;
566 
567 try_again:
568 	if (!retries) {
569 		pr_warn("%s: Skipping voltage switch\n", mmc_hostname(host));
570 		ocr &= ~R4_18V_PRESENT;
571 	}
572 
573 	/*
574 	 * Inform the card of the voltage
575 	 */
576 	if (!powered_resume) {
577 		err = mmc_send_io_op_cond(host, ocr, &rocr);
578 		if (err)
579 			goto err;
580 	}
581 
582 	/*
583 	 * For SPI, enable CRC as appropriate.
584 	 */
585 	if (mmc_host_is_spi(host)) {
586 		err = mmc_spi_set_crc(host, use_spi_crc);
587 		if (err)
588 			goto err;
589 	}
590 
591 	/*
592 	 * Allocate card structure.
593 	 */
594 	card = mmc_alloc_card(host, NULL);
595 	if (IS_ERR(card)) {
596 		err = PTR_ERR(card);
597 		goto err;
598 	}
599 
600 	if ((rocr & R4_MEMORY_PRESENT) &&
601 	    mmc_sd_get_cid(host, ocr & rocr, card->raw_cid, NULL) == 0) {
602 		card->type = MMC_TYPE_SD_COMBO;
603 
604 		if (oldcard && (oldcard->type != MMC_TYPE_SD_COMBO ||
605 		    memcmp(card->raw_cid, oldcard->raw_cid, sizeof(card->raw_cid)) != 0)) {
606 			mmc_remove_card(card);
607 			return -ENOENT;
608 		}
609 	} else {
610 		card->type = MMC_TYPE_SDIO;
611 
612 		if (oldcard && oldcard->type != MMC_TYPE_SDIO) {
613 			mmc_remove_card(card);
614 			return -ENOENT;
615 		}
616 	}
617 
618 	/*
619 	 * Call the optional HC's init_card function to handle quirks.
620 	 */
621 	if (host->ops->init_card)
622 		host->ops->init_card(host, card);
623 
624 	/*
625 	 * If the host and card support UHS-I mode request the card
626 	 * to switch to 1.8V signaling level.  No 1.8v signalling if
627 	 * UHS mode is not enabled to maintain compatibility and some
628 	 * systems that claim 1.8v signalling in fact do not support
629 	 * it.
630 	 */
631 	if (!powered_resume && (rocr & ocr & R4_18V_PRESENT)) {
632 		err = mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180,
633 					ocr);
634 		if (err == -EAGAIN) {
635 			sdio_reset(host);
636 			mmc_go_idle(host);
637 			mmc_send_if_cond(host, host->ocr_avail);
638 			mmc_remove_card(card);
639 			retries--;
640 			goto try_again;
641 		} else if (err) {
642 			ocr &= ~R4_18V_PRESENT;
643 		}
644 		err = 0;
645 	} else {
646 		ocr &= ~R4_18V_PRESENT;
647 	}
648 
649 	/*
650 	 * For native busses:  set card RCA and quit open drain mode.
651 	 */
652 	if (!powered_resume && !mmc_host_is_spi(host)) {
653 		err = mmc_send_relative_addr(host, &card->rca);
654 		if (err)
655 			goto remove;
656 
657 		/*
658 		 * Update oldcard with the new RCA received from the SDIO
659 		 * device -- we're doing this so that it's updated in the
660 		 * "card" struct when oldcard overwrites that later.
661 		 */
662 		if (oldcard)
663 			oldcard->rca = card->rca;
664 	}
665 
666 	/*
667 	 * Read CSD, before selecting the card
668 	 */
669 	if (!oldcard && card->type == MMC_TYPE_SD_COMBO) {
670 		err = mmc_sd_get_csd(host, card);
671 		if (err)
672 			return err;
673 
674 		mmc_decode_cid(card);
675 	}
676 
677 	/*
678 	 * Select card, as all following commands rely on that.
679 	 */
680 	if (!powered_resume && !mmc_host_is_spi(host)) {
681 		err = mmc_select_card(card);
682 		if (err)
683 			goto remove;
684 	}
685 
686 	if (card->quirks & MMC_QUIRK_NONSTD_SDIO) {
687 		/*
688 		 * This is non-standard SDIO device, meaning it doesn't
689 		 * have any CIA (Common I/O area) registers present.
690 		 * It's host's responsibility to fill cccr and cis
691 		 * structures in init_card().
692 		 */
693 		mmc_set_clock(host, card->cis.max_dtr);
694 
695 		if (card->cccr.high_speed) {
696 			mmc_set_timing(card->host, MMC_TIMING_SD_HS);
697 		}
698 
699 		goto finish;
700 	}
701 
702 	/*
703 	 * Read the common registers.
704 	 */
705 	err = sdio_read_cccr(card, ocr);
706 	if (err)
707 		goto remove;
708 
709 	/*
710 	 * Read the common CIS tuples.
711 	 */
712 	err = sdio_read_common_cis(card);
713 	if (err)
714 		goto remove;
715 
716 	if (oldcard) {
717 		int same = (card->cis.vendor == oldcard->cis.vendor &&
718 			    card->cis.device == oldcard->cis.device);
719 		mmc_remove_card(card);
720 		if (!same)
721 			return -ENOENT;
722 
723 		card = oldcard;
724 	}
725 	card->ocr = ocr_card;
726 	mmc_fixup_device(card, NULL);
727 
728 	if (card->type == MMC_TYPE_SD_COMBO) {
729 		err = mmc_sd_setup_card(host, card, oldcard != NULL);
730 		/* handle as SDIO-only card if memory init failed */
731 		if (err) {
732 			mmc_go_idle(host);
733 			if (mmc_host_is_spi(host))
734 				/* should not fail, as it worked previously */
735 				mmc_spi_set_crc(host, use_spi_crc);
736 			card->type = MMC_TYPE_SDIO;
737 		} else
738 			card->dev.type = &sd_type;
739 	}
740 
741 	/*
742 	 * If needed, disconnect card detection pull-up resistor.
743 	 */
744 	err = sdio_disable_cd(card);
745 	if (err)
746 		goto remove;
747 
748 	/* Initialization sequence for UHS-I cards */
749 	/* Only if card supports 1.8v and UHS signaling */
750 	if ((ocr & R4_18V_PRESENT) && card->sw_caps.sd3_bus_mode) {
751 		err = mmc_sdio_init_uhs_card(card);
752 		if (err)
753 			goto remove;
754 	} else {
755 		/*
756 		 * Switch to high-speed (if supported).
757 		 */
758 		err = sdio_enable_hs(card);
759 		if (err > 0)
760 			mmc_set_timing(card->host, MMC_TIMING_SD_HS);
761 		else if (err)
762 			goto remove;
763 
764 		/*
765 		 * Change to the card's maximum speed.
766 		 */
767 		mmc_set_clock(host, mmc_sdio_get_max_clock(card));
768 
769 		/*
770 		 * Switch to wider bus (if supported).
771 		 */
772 		err = sdio_enable_4bit_bus(card);
773 		if (err)
774 			goto remove;
775 	}
776 finish:
777 	if (!oldcard)
778 		host->card = card;
779 	return 0;
780 
781 remove:
782 	if (!oldcard)
783 		mmc_remove_card(card);
784 
785 err:
786 	return err;
787 }
788 
789 /*
790  * Host is being removed. Free up the current card.
791  */
792 static void mmc_sdio_remove(struct mmc_host *host)
793 {
794 	int i;
795 
796 	BUG_ON(!host);
797 	BUG_ON(!host->card);
798 
799 	for (i = 0;i < host->card->sdio_funcs;i++) {
800 		if (host->card->sdio_func[i]) {
801 			sdio_remove_func(host->card->sdio_func[i]);
802 			host->card->sdio_func[i] = NULL;
803 		}
804 	}
805 
806 	mmc_remove_card(host->card);
807 	host->card = NULL;
808 }
809 
810 /*
811  * Card detection - card is alive.
812  */
813 static int mmc_sdio_alive(struct mmc_host *host)
814 {
815 	return mmc_select_card(host->card);
816 }
817 
818 /*
819  * Card detection callback from host.
820  */
821 static void mmc_sdio_detect(struct mmc_host *host)
822 {
823 	int err;
824 
825 	BUG_ON(!host);
826 	BUG_ON(!host->card);
827 
828 	/* Make sure card is powered before detecting it */
829 	if (host->caps & MMC_CAP_POWER_OFF_CARD) {
830 		err = pm_runtime_get_sync(&host->card->dev);
831 		if (err < 0) {
832 			pm_runtime_put_noidle(&host->card->dev);
833 			goto out;
834 		}
835 	}
836 
837 	mmc_claim_host(host);
838 
839 	/*
840 	 * Just check if our card has been removed.
841 	 */
842 	err = _mmc_detect_card_removed(host);
843 
844 	mmc_release_host(host);
845 
846 	/*
847 	 * Tell PM core it's OK to power off the card now.
848 	 *
849 	 * The _sync variant is used in order to ensure that the card
850 	 * is left powered off in case an error occurred, and the card
851 	 * is going to be removed.
852 	 *
853 	 * Since there is no specific reason to believe a new user
854 	 * is about to show up at this point, the _sync variant is
855 	 * desirable anyway.
856 	 */
857 	if (host->caps & MMC_CAP_POWER_OFF_CARD)
858 		pm_runtime_put_sync(&host->card->dev);
859 
860 out:
861 	if (err) {
862 		mmc_sdio_remove(host);
863 
864 		mmc_claim_host(host);
865 		mmc_detach_bus(host);
866 		mmc_power_off(host);
867 		mmc_release_host(host);
868 	}
869 }
870 
871 /*
872  * SDIO pre_suspend.  We need to suspend all functions separately.
873  * Therefore all registered functions must have drivers with suspend
874  * and resume methods.  Failing that we simply remove the whole card.
875  */
876 static int mmc_sdio_pre_suspend(struct mmc_host *host)
877 {
878 	int i, err = 0;
879 
880 	for (i = 0; i < host->card->sdio_funcs; i++) {
881 		struct sdio_func *func = host->card->sdio_func[i];
882 		if (func && sdio_func_present(func) && func->dev.driver) {
883 			const struct dev_pm_ops *pmops = func->dev.driver->pm;
884 			if (!pmops || !pmops->suspend || !pmops->resume) {
885 				/* force removal of entire card in that case */
886 				err = -ENOSYS;
887 				break;
888 			}
889 		}
890 	}
891 
892 	return err;
893 }
894 
895 /*
896  * SDIO suspend.  Suspend all functions separately.
897  */
898 static int mmc_sdio_suspend(struct mmc_host *host)
899 {
900 	if (mmc_card_keep_power(host) && mmc_card_wake_sdio_irq(host)) {
901 		mmc_claim_host(host);
902 		sdio_disable_wide(host->card);
903 		mmc_release_host(host);
904 	}
905 
906 	if (!mmc_card_keep_power(host)) {
907 		mmc_power_off(host);
908 	} else if (host->retune_period) {
909 		mmc_retune_timer_stop(host);
910 		mmc_retune_needed(host);
911 	}
912 
913 	return 0;
914 }
915 
916 static int mmc_sdio_resume(struct mmc_host *host)
917 {
918 	int err = 0;
919 
920 	BUG_ON(!host);
921 	BUG_ON(!host->card);
922 
923 	/* Basic card reinitialization. */
924 	mmc_claim_host(host);
925 
926 	/* Restore power if needed */
927 	if (!mmc_card_keep_power(host)) {
928 		mmc_power_up(host, host->card->ocr);
929 		/*
930 		 * Tell runtime PM core we just powered up the card,
931 		 * since it still believes the card is powered off.
932 		 * Note that currently runtime PM is only enabled
933 		 * for SDIO cards that are MMC_CAP_POWER_OFF_CARD
934 		 */
935 		if (host->caps & MMC_CAP_POWER_OFF_CARD) {
936 			pm_runtime_disable(&host->card->dev);
937 			pm_runtime_set_active(&host->card->dev);
938 			pm_runtime_enable(&host->card->dev);
939 		}
940 	}
941 
942 	/* No need to reinitialize powered-resumed nonremovable cards */
943 	if (mmc_card_is_removable(host) || !mmc_card_keep_power(host)) {
944 		sdio_reset(host);
945 		mmc_go_idle(host);
946 		mmc_send_if_cond(host, host->card->ocr);
947 		err = mmc_send_io_op_cond(host, 0, NULL);
948 		if (!err)
949 			err = mmc_sdio_init_card(host, host->card->ocr,
950 						 host->card,
951 						 mmc_card_keep_power(host));
952 	} else if (mmc_card_keep_power(host) && mmc_card_wake_sdio_irq(host)) {
953 		/* We may have switched to 1-bit mode during suspend */
954 		err = sdio_enable_4bit_bus(host->card);
955 	}
956 
957 	if (!err && host->sdio_irqs) {
958 		if (!(host->caps2 & MMC_CAP2_SDIO_IRQ_NOTHREAD)) {
959 			wake_up_process(host->sdio_irq_thread);
960 		} else if (host->caps & MMC_CAP_SDIO_IRQ) {
961 			mmc_host_clk_hold(host);
962 			host->ops->enable_sdio_irq(host, 1);
963 			mmc_host_clk_release(host);
964 		}
965 	}
966 
967 	mmc_release_host(host);
968 
969 	host->pm_flags &= ~MMC_PM_KEEP_POWER;
970 	return err;
971 }
972 
973 static int mmc_sdio_power_restore(struct mmc_host *host)
974 {
975 	int ret;
976 
977 	BUG_ON(!host);
978 	BUG_ON(!host->card);
979 
980 	mmc_claim_host(host);
981 
982 	/*
983 	 * Reset the card by performing the same steps that are taken by
984 	 * mmc_rescan_try_freq() and mmc_attach_sdio() during a "normal" probe.
985 	 *
986 	 * sdio_reset() is technically not needed. Having just powered up the
987 	 * hardware, it should already be in reset state. However, some
988 	 * platforms (such as SD8686 on OLPC) do not instantly cut power,
989 	 * meaning that a reset is required when restoring power soon after
990 	 * powering off. It is harmless in other cases.
991 	 *
992 	 * The CMD5 reset (mmc_send_io_op_cond()), according to the SDIO spec,
993 	 * is not necessary for non-removable cards. However, it is required
994 	 * for OLPC SD8686 (which expects a [CMD5,5,3,7] init sequence), and
995 	 * harmless in other situations.
996 	 *
997 	 */
998 
999 	sdio_reset(host);
1000 	mmc_go_idle(host);
1001 	mmc_send_if_cond(host, host->card->ocr);
1002 
1003 	ret = mmc_send_io_op_cond(host, 0, NULL);
1004 	if (ret)
1005 		goto out;
1006 
1007 	ret = mmc_sdio_init_card(host, host->card->ocr, host->card,
1008 				mmc_card_keep_power(host));
1009 	if (!ret && host->sdio_irqs)
1010 		mmc_signal_sdio_irq(host);
1011 
1012 out:
1013 	mmc_release_host(host);
1014 
1015 	return ret;
1016 }
1017 
1018 static int mmc_sdio_runtime_suspend(struct mmc_host *host)
1019 {
1020 	/* No references to the card, cut the power to it. */
1021 	mmc_power_off(host);
1022 	return 0;
1023 }
1024 
1025 static int mmc_sdio_runtime_resume(struct mmc_host *host)
1026 {
1027 	/* Restore power and re-initialize. */
1028 	mmc_power_up(host, host->card->ocr);
1029 	return mmc_sdio_power_restore(host);
1030 }
1031 
1032 static int mmc_sdio_reset(struct mmc_host *host)
1033 {
1034 	mmc_power_cycle(host, host->card->ocr);
1035 	return mmc_sdio_power_restore(host);
1036 }
1037 
1038 static const struct mmc_bus_ops mmc_sdio_ops = {
1039 	.remove = mmc_sdio_remove,
1040 	.detect = mmc_sdio_detect,
1041 	.pre_suspend = mmc_sdio_pre_suspend,
1042 	.suspend = mmc_sdio_suspend,
1043 	.resume = mmc_sdio_resume,
1044 	.runtime_suspend = mmc_sdio_runtime_suspend,
1045 	.runtime_resume = mmc_sdio_runtime_resume,
1046 	.power_restore = mmc_sdio_power_restore,
1047 	.alive = mmc_sdio_alive,
1048 	.reset = mmc_sdio_reset,
1049 };
1050 
1051 
1052 /*
1053  * Starting point for SDIO card init.
1054  */
1055 int mmc_attach_sdio(struct mmc_host *host)
1056 {
1057 	int err, i, funcs;
1058 	u32 ocr, rocr;
1059 	struct mmc_card *card;
1060 
1061 	BUG_ON(!host);
1062 	WARN_ON(!host->claimed);
1063 
1064 	err = mmc_send_io_op_cond(host, 0, &ocr);
1065 	if (err)
1066 		return err;
1067 
1068 	mmc_attach_bus(host, &mmc_sdio_ops);
1069 	if (host->ocr_avail_sdio)
1070 		host->ocr_avail = host->ocr_avail_sdio;
1071 
1072 
1073 	rocr = mmc_select_voltage(host, ocr);
1074 
1075 	/*
1076 	 * Can we support the voltage(s) of the card(s)?
1077 	 */
1078 	if (!rocr) {
1079 		err = -EINVAL;
1080 		goto err;
1081 	}
1082 
1083 	/*
1084 	 * Detect and init the card.
1085 	 */
1086 	err = mmc_sdio_init_card(host, rocr, NULL, 0);
1087 	if (err)
1088 		goto err;
1089 
1090 	card = host->card;
1091 
1092 	/*
1093 	 * Enable runtime PM only if supported by host+card+board
1094 	 */
1095 	if (host->caps & MMC_CAP_POWER_OFF_CARD) {
1096 		/*
1097 		 * Let runtime PM core know our card is active
1098 		 */
1099 		err = pm_runtime_set_active(&card->dev);
1100 		if (err)
1101 			goto remove;
1102 
1103 		/*
1104 		 * Enable runtime PM for this card
1105 		 */
1106 		pm_runtime_enable(&card->dev);
1107 	}
1108 
1109 	/*
1110 	 * The number of functions on the card is encoded inside
1111 	 * the ocr.
1112 	 */
1113 	funcs = (ocr & 0x70000000) >> 28;
1114 	card->sdio_funcs = 0;
1115 
1116 	/*
1117 	 * Initialize (but don't add) all present functions.
1118 	 */
1119 	for (i = 0; i < funcs; i++, card->sdio_funcs++) {
1120 		err = sdio_init_func(host->card, i + 1);
1121 		if (err)
1122 			goto remove;
1123 
1124 		/*
1125 		 * Enable Runtime PM for this func (if supported)
1126 		 */
1127 		if (host->caps & MMC_CAP_POWER_OFF_CARD)
1128 			pm_runtime_enable(&card->sdio_func[i]->dev);
1129 	}
1130 
1131 	/*
1132 	 * First add the card to the driver model...
1133 	 */
1134 	mmc_release_host(host);
1135 	err = mmc_add_card(host->card);
1136 	if (err)
1137 		goto remove_added;
1138 
1139 	/*
1140 	 * ...then the SDIO functions.
1141 	 */
1142 	for (i = 0;i < funcs;i++) {
1143 		err = sdio_add_func(host->card->sdio_func[i]);
1144 		if (err)
1145 			goto remove_added;
1146 	}
1147 
1148 	mmc_claim_host(host);
1149 	return 0;
1150 
1151 
1152 remove_added:
1153 	/* Remove without lock if the device has been added. */
1154 	mmc_sdio_remove(host);
1155 	mmc_claim_host(host);
1156 remove:
1157 	/* And with lock if it hasn't been added. */
1158 	mmc_release_host(host);
1159 	if (host->card)
1160 		mmc_sdio_remove(host);
1161 	mmc_claim_host(host);
1162 err:
1163 	mmc_detach_bus(host);
1164 
1165 	pr_err("%s: error %d whilst initialising SDIO card\n",
1166 		mmc_hostname(host), err);
1167 
1168 	return err;
1169 }
1170 
1171