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