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 "sysfs.h" 21 #include "bus.h" 22 #include "mmc_ops.h" 23 24 static const unsigned int tran_exp[] = { 25 10000, 100000, 1000000, 10000000, 26 0, 0, 0, 0 27 }; 28 29 static const unsigned char tran_mant[] = { 30 0, 10, 12, 13, 15, 20, 25, 30, 31 35, 40, 45, 50, 55, 60, 70, 80, 32 }; 33 34 static const unsigned int tacc_exp[] = { 35 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 36 }; 37 38 static const unsigned int tacc_mant[] = { 39 0, 10, 12, 13, 15, 20, 25, 30, 40 35, 40, 45, 50, 55, 60, 70, 80, 41 }; 42 43 #define UNSTUFF_BITS(resp,start,size) \ 44 ({ \ 45 const int __size = size; \ 46 const u32 __mask = (__size < 32 ? 1 << __size : 0) - 1; \ 47 const int __off = 3 - ((start) / 32); \ 48 const int __shft = (start) & 31; \ 49 u32 __res; \ 50 \ 51 __res = resp[__off] >> __shft; \ 52 if (__size + __shft > 32) \ 53 __res |= resp[__off-1] << ((32 - __shft) % 32); \ 54 __res & __mask; \ 55 }) 56 57 /* 58 * Given the decoded CSD structure, decode the raw CID to our CID structure. 59 */ 60 static int mmc_decode_cid(struct mmc_card *card) 61 { 62 u32 *resp = card->raw_cid; 63 64 /* 65 * The selection of the format here is based upon published 66 * specs from sandisk and from what people have reported. 67 */ 68 switch (card->csd.mmca_vsn) { 69 case 0: /* MMC v1.0 - v1.2 */ 70 case 1: /* MMC v1.4 */ 71 card->cid.manfid = UNSTUFF_BITS(resp, 104, 24); 72 card->cid.prod_name[0] = UNSTUFF_BITS(resp, 96, 8); 73 card->cid.prod_name[1] = UNSTUFF_BITS(resp, 88, 8); 74 card->cid.prod_name[2] = UNSTUFF_BITS(resp, 80, 8); 75 card->cid.prod_name[3] = UNSTUFF_BITS(resp, 72, 8); 76 card->cid.prod_name[4] = UNSTUFF_BITS(resp, 64, 8); 77 card->cid.prod_name[5] = UNSTUFF_BITS(resp, 56, 8); 78 card->cid.prod_name[6] = UNSTUFF_BITS(resp, 48, 8); 79 card->cid.hwrev = UNSTUFF_BITS(resp, 44, 4); 80 card->cid.fwrev = UNSTUFF_BITS(resp, 40, 4); 81 card->cid.serial = UNSTUFF_BITS(resp, 16, 24); 82 card->cid.month = UNSTUFF_BITS(resp, 12, 4); 83 card->cid.year = UNSTUFF_BITS(resp, 8, 4) + 1997; 84 break; 85 86 case 2: /* MMC v2.0 - v2.2 */ 87 case 3: /* MMC v3.1 - v3.3 */ 88 case 4: /* MMC v4 */ 89 card->cid.manfid = UNSTUFF_BITS(resp, 120, 8); 90 card->cid.oemid = UNSTUFF_BITS(resp, 104, 16); 91 card->cid.prod_name[0] = UNSTUFF_BITS(resp, 96, 8); 92 card->cid.prod_name[1] = UNSTUFF_BITS(resp, 88, 8); 93 card->cid.prod_name[2] = UNSTUFF_BITS(resp, 80, 8); 94 card->cid.prod_name[3] = UNSTUFF_BITS(resp, 72, 8); 95 card->cid.prod_name[4] = UNSTUFF_BITS(resp, 64, 8); 96 card->cid.prod_name[5] = UNSTUFF_BITS(resp, 56, 8); 97 card->cid.serial = UNSTUFF_BITS(resp, 16, 32); 98 card->cid.month = UNSTUFF_BITS(resp, 12, 4); 99 card->cid.year = UNSTUFF_BITS(resp, 8, 4) + 1997; 100 break; 101 102 default: 103 printk(KERN_ERR "%s: card has unknown MMCA version %d\n", 104 mmc_hostname(card->host), card->csd.mmca_vsn); 105 return -EINVAL; 106 } 107 108 return 0; 109 } 110 111 /* 112 * Given a 128-bit response, decode to our card CSD structure. 113 */ 114 static int mmc_decode_csd(struct mmc_card *card) 115 { 116 struct mmc_csd *csd = &card->csd; 117 unsigned int e, m, csd_struct; 118 u32 *resp = card->raw_csd; 119 120 /* 121 * We only understand CSD structure v1.1 and v1.2. 122 * v1.2 has extra information in bits 15, 11 and 10. 123 */ 124 csd_struct = UNSTUFF_BITS(resp, 126, 2); 125 if (csd_struct != 1 && csd_struct != 2) { 126 printk(KERN_ERR "%s: unrecognised CSD structure version %d\n", 127 mmc_hostname(card->host), csd_struct); 128 return -EINVAL; 129 } 130 131 csd->mmca_vsn = UNSTUFF_BITS(resp, 122, 4); 132 m = UNSTUFF_BITS(resp, 115, 4); 133 e = UNSTUFF_BITS(resp, 112, 3); 134 csd->tacc_ns = (tacc_exp[e] * tacc_mant[m] + 9) / 10; 135 csd->tacc_clks = UNSTUFF_BITS(resp, 104, 8) * 100; 136 137 m = UNSTUFF_BITS(resp, 99, 4); 138 e = UNSTUFF_BITS(resp, 96, 3); 139 csd->max_dtr = tran_exp[e] * tran_mant[m]; 140 csd->cmdclass = UNSTUFF_BITS(resp, 84, 12); 141 142 e = UNSTUFF_BITS(resp, 47, 3); 143 m = UNSTUFF_BITS(resp, 62, 12); 144 csd->capacity = (1 + m) << (e + 2); 145 146 csd->read_blkbits = UNSTUFF_BITS(resp, 80, 4); 147 csd->read_partial = UNSTUFF_BITS(resp, 79, 1); 148 csd->write_misalign = UNSTUFF_BITS(resp, 78, 1); 149 csd->read_misalign = UNSTUFF_BITS(resp, 77, 1); 150 csd->r2w_factor = UNSTUFF_BITS(resp, 26, 3); 151 csd->write_blkbits = UNSTUFF_BITS(resp, 22, 4); 152 csd->write_partial = UNSTUFF_BITS(resp, 21, 1); 153 154 return 0; 155 } 156 157 /* 158 * Read and decode extended CSD. 159 */ 160 static int mmc_read_ext_csd(struct mmc_card *card) 161 { 162 int err; 163 u8 *ext_csd; 164 unsigned int ext_csd_struct; 165 166 BUG_ON(!card); 167 168 err = -EIO; 169 170 if (card->csd.mmca_vsn < CSD_SPEC_VER_4) 171 return 0; 172 173 /* 174 * As the ext_csd is so large and mostly unused, we don't store the 175 * raw block in mmc_card. 176 */ 177 ext_csd = kmalloc(512, GFP_KERNEL); 178 if (!ext_csd) { 179 printk(KERN_ERR "%s: could not allocate a buffer to " 180 "receive the ext_csd.\n", mmc_hostname(card->host)); 181 return -ENOMEM; 182 } 183 184 err = mmc_send_ext_csd(card, ext_csd); 185 if (err) { 186 /* 187 * We all hosts that cannot perform the command 188 * to fail more gracefully 189 */ 190 if (err != -EINVAL) 191 goto out; 192 193 /* 194 * High capacity cards should have this "magic" size 195 * stored in their CSD. 196 */ 197 if (card->csd.capacity == (4096 * 512)) { 198 printk(KERN_ERR "%s: unable to read EXT_CSD " 199 "on a possible high capacity card. " 200 "Card will be ignored.\n", 201 mmc_hostname(card->host)); 202 } else { 203 printk(KERN_WARNING "%s: unable to read " 204 "EXT_CSD, performance might " 205 "suffer.\n", 206 mmc_hostname(card->host)); 207 err = 0; 208 } 209 210 goto out; 211 } 212 213 ext_csd_struct = ext_csd[EXT_CSD_REV]; 214 if (ext_csd_struct > 2) { 215 printk(KERN_ERR "%s: unrecognised EXT_CSD structure " 216 "version %d\n", mmc_hostname(card->host), 217 ext_csd_struct); 218 return -EINVAL; 219 } 220 221 if (ext_csd_struct >= 2) { 222 card->ext_csd.sectors = 223 ext_csd[EXT_CSD_SEC_CNT + 0] << 0 | 224 ext_csd[EXT_CSD_SEC_CNT + 1] << 8 | 225 ext_csd[EXT_CSD_SEC_CNT + 2] << 16 | 226 ext_csd[EXT_CSD_SEC_CNT + 3] << 24; 227 if (card->ext_csd.sectors) 228 mmc_card_set_blockaddr(card); 229 } 230 231 switch (ext_csd[EXT_CSD_CARD_TYPE]) { 232 case EXT_CSD_CARD_TYPE_52 | EXT_CSD_CARD_TYPE_26: 233 card->ext_csd.hs_max_dtr = 52000000; 234 break; 235 case EXT_CSD_CARD_TYPE_26: 236 card->ext_csd.hs_max_dtr = 26000000; 237 break; 238 default: 239 /* MMC v4 spec says this cannot happen */ 240 printk(KERN_WARNING "%s: card is mmc v4 but doesn't " 241 "support any high-speed modes.\n", 242 mmc_hostname(card->host)); 243 goto out; 244 } 245 246 out: 247 kfree(ext_csd); 248 249 return err; 250 } 251 252 /* 253 * Handle the detection and initialisation of a card. 254 * 255 * In the case of a resume, "curcard" will contain the card 256 * we're trying to reinitialise. 257 */ 258 static int mmc_init_card(struct mmc_host *host, u32 ocr, 259 struct mmc_card *oldcard) 260 { 261 struct mmc_card *card; 262 int err; 263 u32 cid[4]; 264 unsigned int max_dtr; 265 266 BUG_ON(!host); 267 WARN_ON(!host->claimed); 268 269 /* 270 * Since we're changing the OCR value, we seem to 271 * need to tell some cards to go back to the idle 272 * state. We wait 1ms to give cards time to 273 * respond. 274 */ 275 mmc_go_idle(host); 276 277 /* The extra bit indicates that we support high capacity */ 278 err = mmc_send_op_cond(host, ocr | (1 << 30), NULL); 279 if (err) 280 goto err; 281 282 /* 283 * Fetch CID from card. 284 */ 285 err = mmc_all_send_cid(host, cid); 286 if (err) 287 goto err; 288 289 if (oldcard) { 290 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) { 291 err = -ENOENT; 292 goto err; 293 } 294 295 card = oldcard; 296 } else { 297 /* 298 * Allocate card structure. 299 */ 300 card = mmc_alloc_card(host); 301 if (IS_ERR(card)) { 302 err = PTR_ERR(card); 303 goto err; 304 } 305 306 card->type = MMC_TYPE_MMC; 307 card->rca = 1; 308 memcpy(card->raw_cid, cid, sizeof(card->raw_cid)); 309 } 310 311 /* 312 * Set card RCA. 313 */ 314 err = mmc_set_relative_addr(card); 315 if (err) 316 goto free_card; 317 318 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL); 319 320 if (!oldcard) { 321 /* 322 * Fetch CSD from card. 323 */ 324 err = mmc_send_csd(card, card->raw_csd); 325 if (err) 326 goto free_card; 327 328 err = mmc_decode_csd(card); 329 if (err) 330 goto free_card; 331 err = mmc_decode_cid(card); 332 if (err) 333 goto free_card; 334 } 335 336 /* 337 * Select card, as all following commands rely on that. 338 */ 339 err = mmc_select_card(card); 340 if (err) 341 goto free_card; 342 343 if (!oldcard) { 344 /* 345 * Fetch and process extened CSD. 346 */ 347 err = mmc_read_ext_csd(card); 348 if (err) 349 goto free_card; 350 } 351 352 /* 353 * Activate high speed (if supported) 354 */ 355 if ((card->ext_csd.hs_max_dtr != 0) && 356 (host->caps & MMC_CAP_MMC_HIGHSPEED)) { 357 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL, 358 EXT_CSD_HS_TIMING, 1); 359 if (err) 360 goto free_card; 361 362 mmc_card_set_highspeed(card); 363 364 mmc_set_timing(card->host, MMC_TIMING_MMC_HS); 365 } 366 367 /* 368 * Compute bus speed. 369 */ 370 max_dtr = (unsigned int)-1; 371 372 if (mmc_card_highspeed(card)) { 373 if (max_dtr > card->ext_csd.hs_max_dtr) 374 max_dtr = card->ext_csd.hs_max_dtr; 375 } else if (max_dtr > card->csd.max_dtr) { 376 max_dtr = card->csd.max_dtr; 377 } 378 379 mmc_set_clock(host, max_dtr); 380 381 /* 382 * Activate wide bus (if supported). 383 */ 384 if ((card->csd.mmca_vsn >= CSD_SPEC_VER_4) && 385 (host->caps & MMC_CAP_4_BIT_DATA)) { 386 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL, 387 EXT_CSD_BUS_WIDTH, EXT_CSD_BUS_WIDTH_4); 388 if (err) 389 goto free_card; 390 391 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4); 392 } 393 394 if (!oldcard) 395 host->card = card; 396 397 return 0; 398 399 free_card: 400 if (!oldcard) 401 mmc_remove_card(card); 402 err: 403 404 return err; 405 } 406 407 /* 408 * Host is being removed. Free up the current card. 409 */ 410 static void mmc_remove(struct mmc_host *host) 411 { 412 BUG_ON(!host); 413 BUG_ON(!host->card); 414 415 mmc_remove_card(host->card); 416 host->card = NULL; 417 } 418 419 /* 420 * Card detection callback from host. 421 */ 422 static void mmc_detect(struct mmc_host *host) 423 { 424 int err; 425 426 BUG_ON(!host); 427 BUG_ON(!host->card); 428 429 mmc_claim_host(host); 430 431 /* 432 * Just check if our card has been removed. 433 */ 434 err = mmc_send_status(host->card, NULL); 435 436 mmc_release_host(host); 437 438 if (err) { 439 mmc_remove(host); 440 441 mmc_claim_host(host); 442 mmc_detach_bus(host); 443 mmc_release_host(host); 444 } 445 } 446 447 MMC_ATTR_FN(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1], 448 card->raw_cid[2], card->raw_cid[3]); 449 MMC_ATTR_FN(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1], 450 card->raw_csd[2], card->raw_csd[3]); 451 MMC_ATTR_FN(date, "%02d/%04d\n", card->cid.month, card->cid.year); 452 MMC_ATTR_FN(fwrev, "0x%x\n", card->cid.fwrev); 453 MMC_ATTR_FN(hwrev, "0x%x\n", card->cid.hwrev); 454 MMC_ATTR_FN(manfid, "0x%06x\n", card->cid.manfid); 455 MMC_ATTR_FN(name, "%s\n", card->cid.prod_name); 456 MMC_ATTR_FN(oemid, "0x%04x\n", card->cid.oemid); 457 MMC_ATTR_FN(serial, "0x%08x\n", card->cid.serial); 458 459 static struct device_attribute mmc_dev_attrs[] = { 460 MMC_ATTR_RO(cid), 461 MMC_ATTR_RO(csd), 462 MMC_ATTR_RO(date), 463 MMC_ATTR_RO(fwrev), 464 MMC_ATTR_RO(hwrev), 465 MMC_ATTR_RO(manfid), 466 MMC_ATTR_RO(name), 467 MMC_ATTR_RO(oemid), 468 MMC_ATTR_RO(serial), 469 __ATTR_NULL, 470 }; 471 472 /* 473 * Adds sysfs entries as relevant. 474 */ 475 static int mmc_sysfs_add(struct mmc_host *host, struct mmc_card *card) 476 { 477 int ret; 478 479 ret = mmc_add_attrs(card, mmc_dev_attrs); 480 if (ret < 0) 481 return ret; 482 483 return 0; 484 } 485 486 /* 487 * Removes the sysfs entries added by mmc_sysfs_add(). 488 */ 489 static void mmc_sysfs_remove(struct mmc_host *host, struct mmc_card *card) 490 { 491 mmc_remove_attrs(card, mmc_dev_attrs); 492 } 493 494 #ifdef CONFIG_MMC_UNSAFE_RESUME 495 496 /* 497 * Suspend callback from host. 498 */ 499 static void mmc_suspend(struct mmc_host *host) 500 { 501 BUG_ON(!host); 502 BUG_ON(!host->card); 503 504 mmc_claim_host(host); 505 mmc_deselect_cards(host); 506 host->card->state &= ~MMC_STATE_HIGHSPEED; 507 mmc_release_host(host); 508 } 509 510 /* 511 * Resume callback from host. 512 * 513 * This function tries to determine if the same card is still present 514 * and, if so, restore all state to it. 515 */ 516 static void mmc_resume(struct mmc_host *host) 517 { 518 int err; 519 520 BUG_ON(!host); 521 BUG_ON(!host->card); 522 523 mmc_claim_host(host); 524 err = mmc_init_card(host, host->ocr, host->card); 525 mmc_release_host(host); 526 527 if (err) { 528 mmc_remove(host); 529 530 mmc_claim_host(host); 531 mmc_detach_bus(host); 532 mmc_release_host(host); 533 } 534 535 } 536 537 #else 538 539 #define mmc_suspend NULL 540 #define mmc_resume NULL 541 542 #endif 543 544 static const struct mmc_bus_ops mmc_ops = { 545 .remove = mmc_remove, 546 .detect = mmc_detect, 547 .sysfs_add = mmc_sysfs_add, 548 .sysfs_remove = mmc_sysfs_remove, 549 .suspend = mmc_suspend, 550 .resume = mmc_resume, 551 }; 552 553 /* 554 * Starting point for MMC card init. 555 */ 556 int mmc_attach_mmc(struct mmc_host *host, u32 ocr) 557 { 558 int err; 559 560 BUG_ON(!host); 561 WARN_ON(!host->claimed); 562 563 mmc_attach_bus(host, &mmc_ops); 564 565 /* 566 * Sanity check the voltages that the card claims to 567 * support. 568 */ 569 if (ocr & 0x7F) { 570 printk(KERN_WARNING "%s: card claims to support voltages " 571 "below the defined range. These will be ignored.\n", 572 mmc_hostname(host)); 573 ocr &= ~0x7F; 574 } 575 576 host->ocr = mmc_select_voltage(host, ocr); 577 578 /* 579 * Can we support the voltage of the card? 580 */ 581 if (!host->ocr) { 582 err = -EINVAL; 583 goto err; 584 } 585 586 /* 587 * Detect and init the card. 588 */ 589 err = mmc_init_card(host, host->ocr, NULL); 590 if (err) 591 goto err; 592 593 mmc_release_host(host); 594 595 err = mmc_add_card(host->card); 596 if (err) 597 goto remove_card; 598 599 return 0; 600 601 remove_card: 602 mmc_remove_card(host->card); 603 host->card = NULL; 604 mmc_claim_host(host); 605 err: 606 mmc_detach_bus(host); 607 mmc_release_host(host); 608 609 printk(KERN_ERR "%s: error %d whilst initialising MMC card\n", 610 mmc_hostname(host), err); 611 612 return err; 613 } 614 615