1 /* 2 * linux/drivers/mmc/core/mmc.c 3 * 4 * Copyright (C) 2003-2004 Russell King, All Rights Reserved. 5 * Copyright (C) 2005-2007 Pierre Ossman, All Rights Reserved. 6 * MMCv4 support Copyright (C) 2006 Philip Langdale, All Rights Reserved. 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License version 2 as 10 * published by the Free Software Foundation. 11 */ 12 13 #include <linux/err.h> 14 15 #include <linux/mmc/host.h> 16 #include <linux/mmc/card.h> 17 #include <linux/mmc/mmc.h> 18 19 #include "core.h" 20 #include "bus.h" 21 #include "mmc_ops.h" 22 23 static const unsigned int tran_exp[] = { 24 10000, 100000, 1000000, 10000000, 25 0, 0, 0, 0 26 }; 27 28 static const unsigned char tran_mant[] = { 29 0, 10, 12, 13, 15, 20, 25, 30, 30 35, 40, 45, 50, 55, 60, 70, 80, 31 }; 32 33 static const unsigned int tacc_exp[] = { 34 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 35 }; 36 37 static const unsigned int tacc_mant[] = { 38 0, 10, 12, 13, 15, 20, 25, 30, 39 35, 40, 45, 50, 55, 60, 70, 80, 40 }; 41 42 #define UNSTUFF_BITS(resp,start,size) \ 43 ({ \ 44 const int __size = size; \ 45 const u32 __mask = (__size < 32 ? 1 << __size : 0) - 1; \ 46 const int __off = 3 - ((start) / 32); \ 47 const int __shft = (start) & 31; \ 48 u32 __res; \ 49 \ 50 __res = resp[__off] >> __shft; \ 51 if (__size + __shft > 32) \ 52 __res |= resp[__off-1] << ((32 - __shft) % 32); \ 53 __res & __mask; \ 54 }) 55 56 /* 57 * Given the decoded CSD structure, decode the raw CID to our CID structure. 58 */ 59 static int mmc_decode_cid(struct mmc_card *card) 60 { 61 u32 *resp = card->raw_cid; 62 63 /* 64 * The selection of the format here is based upon published 65 * specs from sandisk and from what people have reported. 66 */ 67 switch (card->csd.mmca_vsn) { 68 case 0: /* MMC v1.0 - v1.2 */ 69 case 1: /* MMC v1.4 */ 70 card->cid.manfid = UNSTUFF_BITS(resp, 104, 24); 71 card->cid.prod_name[0] = UNSTUFF_BITS(resp, 96, 8); 72 card->cid.prod_name[1] = UNSTUFF_BITS(resp, 88, 8); 73 card->cid.prod_name[2] = UNSTUFF_BITS(resp, 80, 8); 74 card->cid.prod_name[3] = UNSTUFF_BITS(resp, 72, 8); 75 card->cid.prod_name[4] = UNSTUFF_BITS(resp, 64, 8); 76 card->cid.prod_name[5] = UNSTUFF_BITS(resp, 56, 8); 77 card->cid.prod_name[6] = UNSTUFF_BITS(resp, 48, 8); 78 card->cid.hwrev = UNSTUFF_BITS(resp, 44, 4); 79 card->cid.fwrev = UNSTUFF_BITS(resp, 40, 4); 80 card->cid.serial = UNSTUFF_BITS(resp, 16, 24); 81 card->cid.month = UNSTUFF_BITS(resp, 12, 4); 82 card->cid.year = UNSTUFF_BITS(resp, 8, 4) + 1997; 83 break; 84 85 case 2: /* MMC v2.0 - v2.2 */ 86 case 3: /* MMC v3.1 - v3.3 */ 87 case 4: /* MMC v4 */ 88 card->cid.manfid = UNSTUFF_BITS(resp, 120, 8); 89 card->cid.oemid = UNSTUFF_BITS(resp, 104, 16); 90 card->cid.prod_name[0] = UNSTUFF_BITS(resp, 96, 8); 91 card->cid.prod_name[1] = UNSTUFF_BITS(resp, 88, 8); 92 card->cid.prod_name[2] = UNSTUFF_BITS(resp, 80, 8); 93 card->cid.prod_name[3] = UNSTUFF_BITS(resp, 72, 8); 94 card->cid.prod_name[4] = UNSTUFF_BITS(resp, 64, 8); 95 card->cid.prod_name[5] = UNSTUFF_BITS(resp, 56, 8); 96 card->cid.serial = UNSTUFF_BITS(resp, 16, 32); 97 card->cid.month = UNSTUFF_BITS(resp, 12, 4); 98 card->cid.year = UNSTUFF_BITS(resp, 8, 4) + 1997; 99 break; 100 101 default: 102 printk(KERN_ERR "%s: card has unknown MMCA version %d\n", 103 mmc_hostname(card->host), card->csd.mmca_vsn); 104 return -EINVAL; 105 } 106 107 return 0; 108 } 109 110 /* 111 * Given a 128-bit response, decode to our card CSD structure. 112 */ 113 static int mmc_decode_csd(struct mmc_card *card) 114 { 115 struct mmc_csd *csd = &card->csd; 116 unsigned int e, m, csd_struct; 117 u32 *resp = card->raw_csd; 118 119 /* 120 * We only understand CSD structure v1.1 and v1.2. 121 * v1.2 has extra information in bits 15, 11 and 10. 122 */ 123 csd_struct = UNSTUFF_BITS(resp, 126, 2); 124 if (csd_struct != 1 && csd_struct != 2) { 125 printk(KERN_ERR "%s: unrecognised CSD structure version %d\n", 126 mmc_hostname(card->host), csd_struct); 127 return -EINVAL; 128 } 129 130 csd->mmca_vsn = UNSTUFF_BITS(resp, 122, 4); 131 m = UNSTUFF_BITS(resp, 115, 4); 132 e = UNSTUFF_BITS(resp, 112, 3); 133 csd->tacc_ns = (tacc_exp[e] * tacc_mant[m] + 9) / 10; 134 csd->tacc_clks = UNSTUFF_BITS(resp, 104, 8) * 100; 135 136 m = UNSTUFF_BITS(resp, 99, 4); 137 e = UNSTUFF_BITS(resp, 96, 3); 138 csd->max_dtr = tran_exp[e] * tran_mant[m]; 139 csd->cmdclass = UNSTUFF_BITS(resp, 84, 12); 140 141 e = UNSTUFF_BITS(resp, 47, 3); 142 m = UNSTUFF_BITS(resp, 62, 12); 143 csd->capacity = (1 + m) << (e + 2); 144 145 csd->read_blkbits = UNSTUFF_BITS(resp, 80, 4); 146 csd->read_partial = UNSTUFF_BITS(resp, 79, 1); 147 csd->write_misalign = UNSTUFF_BITS(resp, 78, 1); 148 csd->read_misalign = UNSTUFF_BITS(resp, 77, 1); 149 csd->r2w_factor = UNSTUFF_BITS(resp, 26, 3); 150 csd->write_blkbits = UNSTUFF_BITS(resp, 22, 4); 151 csd->write_partial = UNSTUFF_BITS(resp, 21, 1); 152 153 return 0; 154 } 155 156 /* 157 * Read and decode extended CSD. 158 */ 159 static int mmc_read_ext_csd(struct mmc_card *card) 160 { 161 int err; 162 u8 *ext_csd; 163 164 BUG_ON(!card); 165 166 if (card->csd.mmca_vsn < CSD_SPEC_VER_4) 167 return 0; 168 169 /* 170 * As the ext_csd is so large and mostly unused, we don't store the 171 * raw block in mmc_card. 172 */ 173 ext_csd = kmalloc(512, GFP_KERNEL); 174 if (!ext_csd) { 175 printk(KERN_ERR "%s: could not allocate a buffer to " 176 "receive the ext_csd.\n", mmc_hostname(card->host)); 177 return -ENOMEM; 178 } 179 180 err = mmc_send_ext_csd(card, ext_csd); 181 if (err) { 182 /* If the host or the card can't do the switch, 183 * fail more gracefully. */ 184 if ((err != -EINVAL) 185 && (err != -ENOSYS) 186 && (err != -EFAULT)) 187 goto out; 188 189 /* 190 * High capacity cards should have this "magic" size 191 * stored in their CSD. 192 */ 193 if (card->csd.capacity == (4096 * 512)) { 194 printk(KERN_ERR "%s: unable to read EXT_CSD " 195 "on a possible high capacity card. " 196 "Card will be ignored.\n", 197 mmc_hostname(card->host)); 198 } else { 199 printk(KERN_WARNING "%s: unable to read " 200 "EXT_CSD, performance might " 201 "suffer.\n", 202 mmc_hostname(card->host)); 203 err = 0; 204 } 205 206 goto out; 207 } 208 209 card->ext_csd.rev = ext_csd[EXT_CSD_REV]; 210 if (card->ext_csd.rev > 3) { 211 printk(KERN_ERR "%s: unrecognised EXT_CSD structure " 212 "version %d\n", mmc_hostname(card->host), 213 card->ext_csd.rev); 214 err = -EINVAL; 215 goto out; 216 } 217 218 if (card->ext_csd.rev >= 2) { 219 card->ext_csd.sectors = 220 ext_csd[EXT_CSD_SEC_CNT + 0] << 0 | 221 ext_csd[EXT_CSD_SEC_CNT + 1] << 8 | 222 ext_csd[EXT_CSD_SEC_CNT + 2] << 16 | 223 ext_csd[EXT_CSD_SEC_CNT + 3] << 24; 224 if (card->ext_csd.sectors) 225 mmc_card_set_blockaddr(card); 226 } 227 228 switch (ext_csd[EXT_CSD_CARD_TYPE]) { 229 case EXT_CSD_CARD_TYPE_52 | EXT_CSD_CARD_TYPE_26: 230 card->ext_csd.hs_max_dtr = 52000000; 231 break; 232 case EXT_CSD_CARD_TYPE_26: 233 card->ext_csd.hs_max_dtr = 26000000; 234 break; 235 default: 236 /* MMC v4 spec says this cannot happen */ 237 printk(KERN_WARNING "%s: card is mmc v4 but doesn't " 238 "support any high-speed modes.\n", 239 mmc_hostname(card->host)); 240 goto out; 241 } 242 243 if (card->ext_csd.rev >= 3) { 244 u8 sa_shift = ext_csd[EXT_CSD_S_A_TIMEOUT]; 245 246 /* Sleep / awake timeout in 100ns units */ 247 if (sa_shift > 0 && sa_shift <= 0x17) 248 card->ext_csd.sa_timeout = 249 1 << ext_csd[EXT_CSD_S_A_TIMEOUT]; 250 } 251 252 out: 253 kfree(ext_csd); 254 255 return err; 256 } 257 258 MMC_DEV_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1], 259 card->raw_cid[2], card->raw_cid[3]); 260 MMC_DEV_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1], 261 card->raw_csd[2], card->raw_csd[3]); 262 MMC_DEV_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year); 263 MMC_DEV_ATTR(fwrev, "0x%x\n", card->cid.fwrev); 264 MMC_DEV_ATTR(hwrev, "0x%x\n", card->cid.hwrev); 265 MMC_DEV_ATTR(manfid, "0x%06x\n", card->cid.manfid); 266 MMC_DEV_ATTR(name, "%s\n", card->cid.prod_name); 267 MMC_DEV_ATTR(oemid, "0x%04x\n", card->cid.oemid); 268 MMC_DEV_ATTR(serial, "0x%08x\n", card->cid.serial); 269 270 static struct attribute *mmc_std_attrs[] = { 271 &dev_attr_cid.attr, 272 &dev_attr_csd.attr, 273 &dev_attr_date.attr, 274 &dev_attr_fwrev.attr, 275 &dev_attr_hwrev.attr, 276 &dev_attr_manfid.attr, 277 &dev_attr_name.attr, 278 &dev_attr_oemid.attr, 279 &dev_attr_serial.attr, 280 NULL, 281 }; 282 283 static struct attribute_group mmc_std_attr_group = { 284 .attrs = mmc_std_attrs, 285 }; 286 287 static const struct attribute_group *mmc_attr_groups[] = { 288 &mmc_std_attr_group, 289 NULL, 290 }; 291 292 static struct device_type mmc_type = { 293 .groups = mmc_attr_groups, 294 }; 295 296 /* 297 * Handle the detection and initialisation of a card. 298 * 299 * In the case of a resume, "oldcard" will contain the card 300 * we're trying to reinitialise. 301 */ 302 static int mmc_init_card(struct mmc_host *host, u32 ocr, 303 struct mmc_card *oldcard) 304 { 305 struct mmc_card *card; 306 int err; 307 u32 cid[4]; 308 unsigned int max_dtr; 309 310 BUG_ON(!host); 311 WARN_ON(!host->claimed); 312 313 /* 314 * Since we're changing the OCR value, we seem to 315 * need to tell some cards to go back to the idle 316 * state. We wait 1ms to give cards time to 317 * respond. 318 */ 319 mmc_go_idle(host); 320 321 /* The extra bit indicates that we support high capacity */ 322 err = mmc_send_op_cond(host, ocr | (1 << 30), NULL); 323 if (err) 324 goto err; 325 326 /* 327 * For SPI, enable CRC as appropriate. 328 */ 329 if (mmc_host_is_spi(host)) { 330 err = mmc_spi_set_crc(host, use_spi_crc); 331 if (err) 332 goto err; 333 } 334 335 /* 336 * Fetch CID from card. 337 */ 338 if (mmc_host_is_spi(host)) 339 err = mmc_send_cid(host, cid); 340 else 341 err = mmc_all_send_cid(host, cid); 342 if (err) 343 goto err; 344 345 if (oldcard) { 346 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) { 347 err = -ENOENT; 348 goto err; 349 } 350 351 card = oldcard; 352 } else { 353 /* 354 * Allocate card structure. 355 */ 356 card = mmc_alloc_card(host, &mmc_type); 357 if (IS_ERR(card)) { 358 err = PTR_ERR(card); 359 goto err; 360 } 361 362 card->type = MMC_TYPE_MMC; 363 card->rca = 1; 364 memcpy(card->raw_cid, cid, sizeof(card->raw_cid)); 365 } 366 367 /* 368 * For native busses: set card RCA and quit open drain mode. 369 */ 370 if (!mmc_host_is_spi(host)) { 371 err = mmc_set_relative_addr(card); 372 if (err) 373 goto free_card; 374 375 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL); 376 } 377 378 if (!oldcard) { 379 /* 380 * Fetch CSD from card. 381 */ 382 err = mmc_send_csd(card, card->raw_csd); 383 if (err) 384 goto free_card; 385 386 err = mmc_decode_csd(card); 387 if (err) 388 goto free_card; 389 err = mmc_decode_cid(card); 390 if (err) 391 goto free_card; 392 } 393 394 /* 395 * Select card, as all following commands rely on that. 396 */ 397 if (!mmc_host_is_spi(host)) { 398 err = mmc_select_card(card); 399 if (err) 400 goto free_card; 401 } 402 403 if (!oldcard) { 404 /* 405 * Fetch and process extended CSD. 406 */ 407 err = mmc_read_ext_csd(card); 408 if (err) 409 goto free_card; 410 } 411 412 /* 413 * Activate high speed (if supported) 414 */ 415 if ((card->ext_csd.hs_max_dtr != 0) && 416 (host->caps & MMC_CAP_MMC_HIGHSPEED)) { 417 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL, 418 EXT_CSD_HS_TIMING, 1); 419 if (err && err != -EBADMSG) 420 goto free_card; 421 422 if (err) { 423 printk(KERN_WARNING "%s: switch to highspeed failed\n", 424 mmc_hostname(card->host)); 425 err = 0; 426 } else { 427 mmc_card_set_highspeed(card); 428 mmc_set_timing(card->host, MMC_TIMING_MMC_HS); 429 } 430 } 431 432 /* 433 * Compute bus speed. 434 */ 435 max_dtr = (unsigned int)-1; 436 437 if (mmc_card_highspeed(card)) { 438 if (max_dtr > card->ext_csd.hs_max_dtr) 439 max_dtr = card->ext_csd.hs_max_dtr; 440 } else if (max_dtr > card->csd.max_dtr) { 441 max_dtr = card->csd.max_dtr; 442 } 443 444 mmc_set_clock(host, max_dtr); 445 446 /* 447 * Activate wide bus (if supported). 448 */ 449 if ((card->csd.mmca_vsn >= CSD_SPEC_VER_4) && 450 (host->caps & (MMC_CAP_4_BIT_DATA | MMC_CAP_8_BIT_DATA))) { 451 unsigned ext_csd_bit, bus_width; 452 453 if (host->caps & MMC_CAP_8_BIT_DATA) { 454 ext_csd_bit = EXT_CSD_BUS_WIDTH_8; 455 bus_width = MMC_BUS_WIDTH_8; 456 } else { 457 ext_csd_bit = EXT_CSD_BUS_WIDTH_4; 458 bus_width = MMC_BUS_WIDTH_4; 459 } 460 461 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL, 462 EXT_CSD_BUS_WIDTH, ext_csd_bit); 463 464 if (err && err != -EBADMSG) 465 goto free_card; 466 467 if (err) { 468 printk(KERN_WARNING "%s: switch to bus width %d " 469 "failed\n", mmc_hostname(card->host), 470 1 << bus_width); 471 err = 0; 472 } else { 473 mmc_set_bus_width(card->host, bus_width); 474 } 475 } 476 477 if (!oldcard) 478 host->card = card; 479 480 return 0; 481 482 free_card: 483 if (!oldcard) 484 mmc_remove_card(card); 485 err: 486 487 return err; 488 } 489 490 /* 491 * Host is being removed. Free up the current card. 492 */ 493 static void mmc_remove(struct mmc_host *host) 494 { 495 BUG_ON(!host); 496 BUG_ON(!host->card); 497 498 mmc_remove_card(host->card); 499 host->card = NULL; 500 } 501 502 /* 503 * Card detection callback from host. 504 */ 505 static void mmc_detect(struct mmc_host *host) 506 { 507 int err; 508 509 BUG_ON(!host); 510 BUG_ON(!host->card); 511 512 mmc_claim_host(host); 513 514 /* 515 * Just check if our card has been removed. 516 */ 517 err = mmc_send_status(host->card, NULL); 518 519 mmc_release_host(host); 520 521 if (err) { 522 mmc_remove(host); 523 524 mmc_claim_host(host); 525 mmc_detach_bus(host); 526 mmc_release_host(host); 527 } 528 } 529 530 /* 531 * Suspend callback from host. 532 */ 533 static void mmc_suspend(struct mmc_host *host) 534 { 535 BUG_ON(!host); 536 BUG_ON(!host->card); 537 538 mmc_claim_host(host); 539 if (!mmc_host_is_spi(host)) 540 mmc_deselect_cards(host); 541 host->card->state &= ~MMC_STATE_HIGHSPEED; 542 mmc_release_host(host); 543 } 544 545 /* 546 * Resume callback from host. 547 * 548 * This function tries to determine if the same card is still present 549 * and, if so, restore all state to it. 550 */ 551 static void mmc_resume(struct mmc_host *host) 552 { 553 int err; 554 555 BUG_ON(!host); 556 BUG_ON(!host->card); 557 558 mmc_claim_host(host); 559 err = mmc_init_card(host, host->ocr, host->card); 560 mmc_release_host(host); 561 562 if (err) { 563 mmc_remove(host); 564 565 mmc_claim_host(host); 566 mmc_detach_bus(host); 567 mmc_release_host(host); 568 } 569 570 } 571 572 static void mmc_power_restore(struct mmc_host *host) 573 { 574 host->card->state &= ~MMC_STATE_HIGHSPEED; 575 mmc_claim_host(host); 576 mmc_init_card(host, host->ocr, host->card); 577 mmc_release_host(host); 578 } 579 580 static int mmc_sleep(struct mmc_host *host) 581 { 582 struct mmc_card *card = host->card; 583 int err = -ENOSYS; 584 585 if (card && card->ext_csd.rev >= 3) { 586 err = mmc_card_sleepawake(host, 1); 587 if (err < 0) 588 pr_debug("%s: Error %d while putting card into sleep", 589 mmc_hostname(host), err); 590 } 591 592 return err; 593 } 594 595 static int mmc_awake(struct mmc_host *host) 596 { 597 struct mmc_card *card = host->card; 598 int err = -ENOSYS; 599 600 if (card && card->ext_csd.rev >= 3) { 601 err = mmc_card_sleepawake(host, 0); 602 if (err < 0) 603 pr_debug("%s: Error %d while awaking sleeping card", 604 mmc_hostname(host), err); 605 } 606 607 return err; 608 } 609 610 #ifdef CONFIG_MMC_UNSAFE_RESUME 611 612 static const struct mmc_bus_ops mmc_ops = { 613 .awake = mmc_awake, 614 .sleep = mmc_sleep, 615 .remove = mmc_remove, 616 .detect = mmc_detect, 617 .suspend = mmc_suspend, 618 .resume = mmc_resume, 619 .power_restore = mmc_power_restore, 620 }; 621 622 static void mmc_attach_bus_ops(struct mmc_host *host) 623 { 624 mmc_attach_bus(host, &mmc_ops); 625 } 626 627 #else 628 629 static const struct mmc_bus_ops mmc_ops = { 630 .awake = mmc_awake, 631 .sleep = mmc_sleep, 632 .remove = mmc_remove, 633 .detect = mmc_detect, 634 .suspend = NULL, 635 .resume = NULL, 636 .power_restore = mmc_power_restore, 637 }; 638 639 static const struct mmc_bus_ops mmc_ops_unsafe = { 640 .awake = mmc_awake, 641 .sleep = mmc_sleep, 642 .remove = mmc_remove, 643 .detect = mmc_detect, 644 .suspend = mmc_suspend, 645 .resume = mmc_resume, 646 .power_restore = mmc_power_restore, 647 }; 648 649 static void mmc_attach_bus_ops(struct mmc_host *host) 650 { 651 const struct mmc_bus_ops *bus_ops; 652 653 if (host->caps & MMC_CAP_NONREMOVABLE) 654 bus_ops = &mmc_ops_unsafe; 655 else 656 bus_ops = &mmc_ops; 657 mmc_attach_bus(host, bus_ops); 658 } 659 660 #endif 661 662 /* 663 * Starting point for MMC card init. 664 */ 665 int mmc_attach_mmc(struct mmc_host *host, u32 ocr) 666 { 667 int err; 668 669 BUG_ON(!host); 670 WARN_ON(!host->claimed); 671 672 mmc_attach_bus_ops(host); 673 674 /* 675 * We need to get OCR a different way for SPI. 676 */ 677 if (mmc_host_is_spi(host)) { 678 err = mmc_spi_read_ocr(host, 1, &ocr); 679 if (err) 680 goto err; 681 } 682 683 /* 684 * Sanity check the voltages that the card claims to 685 * support. 686 */ 687 if (ocr & 0x7F) { 688 printk(KERN_WARNING "%s: card claims to support voltages " 689 "below the defined range. These will be ignored.\n", 690 mmc_hostname(host)); 691 ocr &= ~0x7F; 692 } 693 694 host->ocr = mmc_select_voltage(host, ocr); 695 696 /* 697 * Can we support the voltage of the card? 698 */ 699 if (!host->ocr) { 700 err = -EINVAL; 701 goto err; 702 } 703 704 /* 705 * Detect and init the card. 706 */ 707 err = mmc_init_card(host, host->ocr, NULL); 708 if (err) 709 goto err; 710 711 mmc_release_host(host); 712 713 err = mmc_add_card(host->card); 714 if (err) 715 goto remove_card; 716 717 return 0; 718 719 remove_card: 720 mmc_remove_card(host->card); 721 host->card = NULL; 722 mmc_claim_host(host); 723 err: 724 mmc_detach_bus(host); 725 mmc_release_host(host); 726 727 printk(KERN_ERR "%s: error %d whilst initialising MMC card\n", 728 mmc_hostname(host), err); 729 730 return err; 731 } 732