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