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