drivers/mmc/core/mmc.c

   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         unsigned int ext_csd_struct;
 164
 165         BUG_ON(!card);
 166
 167         if (card->csd.mmca_vsn < CSD_SPEC_VER_4)
 168                 return 0;
 169
 170         /*
 171          * As the ext_csd is so large and mostly unused, we don't store the
 172          * raw block in mmc_card.
 173          */
 174         ext_csd = kmalloc(512, GFP_KERNEL);
 175         if (!ext_csd) {
 176                 printk(KERN_ERR "%s: could not allocate a buffer to "
 177                         "receive the ext_csd.\n", mmc_hostname(card->host));
 178                 return -ENOMEM;
 179         }
 180
 181         err = mmc_send_ext_csd(card, ext_csd);
 182         if (err) {
 183                 /*
 184                  * We all hosts that cannot perform the command
 185                  * to fail more gracefully
 186                  */
 187                 if (err != -EINVAL)
 188                         goto out;
 189
 190                 /*
 191                  * High capacity cards should have this "magic" size
 192                  * stored in their CSD.
 193                  */
 194                 if (card->csd.capacity == (4096 * 512)) {
 195                         printk(KERN_ERR "%s: unable to read EXT_CSD "
 196                                 "on a possible high capacity card. "
 197                                 "Card will be ignored.\n",
 198                                 mmc_hostname(card->host));
 199                 } else {
 200                         printk(KERN_WARNING "%s: unable to read "
 201                                 "EXT_CSD, performance might "
 202                                 "suffer.\n",
 203                                 mmc_hostname(card->host));
 204                         err = 0;
 205                 }
 206
 207                 goto out;
 208         }
 209
 210         ext_csd_struct = ext_csd[EXT_CSD_REV];
 211         if (ext_csd_struct > 2) {
 212                 printk(KERN_ERR "%s: unrecognised EXT_CSD structure "
 213                         "version %d\n", mmc_hostname(card->host),
 214                         ext_csd_struct);
 215                 err = -EINVAL;
 216                 goto out;
 217         }
 218
 219         if (ext_csd_struct >= 2) {
 220                 card->ext_csd.sectors =
 221                         ext_csd[EXT_CSD_SEC_CNT + 0] << 0 |
 222                         ext_csd[EXT_CSD_SEC_CNT + 1] << 8 |
 223                         ext_csd[EXT_CSD_SEC_CNT + 2] << 16 |
 224                         ext_csd[EXT_CSD_SEC_CNT + 3] << 24;
 225                 if (card->ext_csd.sectors)
 226                         mmc_card_set_blockaddr(card);
 227         }
 228
 229         switch (ext_csd[EXT_CSD_CARD_TYPE]) {
 230         case EXT_CSD_CARD_TYPE_52 | EXT_CSD_CARD_TYPE_26:
 231                 card->ext_csd.hs_max_dtr = 52000000;
 232                 break;
 233         case EXT_CSD_CARD_TYPE_26:
 234                 card->ext_csd.hs_max_dtr = 26000000;
 235                 break;
 236         default:
 237                 /* MMC v4 spec says this cannot happen */
 238                 printk(KERN_WARNING "%s: card is mmc v4 but doesn't "
 239                         "support any high-speed modes.\n",
 240                         mmc_hostname(card->host));
 241                 goto out;
 242         }
 243
 244 out:
 245         kfree(ext_csd);
 246
 247         return err;
 248 }
 249
 250 MMC_DEV_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
 251         card->raw_cid[2], card->raw_cid[3]);
 252 MMC_DEV_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
 253         card->raw_csd[2], card->raw_csd[3]);
 254 MMC_DEV_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
 255 MMC_DEV_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
 256 MMC_DEV_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
 257 MMC_DEV_ATTR(manfid, "0x%06x\n", card->cid.manfid);
 258 MMC_DEV_ATTR(name, "%s\n", card->cid.prod_name);
 259 MMC_DEV_ATTR(oemid, "0x%04x\n", card->cid.oemid);
 260 MMC_DEV_ATTR(serial, "0x%08x\n", card->cid.serial);
 261
 262 static struct attribute *mmc_std_attrs[] = {
 263         &dev_attr_cid.attr,
 264         &dev_attr_csd.attr,
 265         &dev_attr_date.attr,
 266         &dev_attr_fwrev.attr,
 267         &dev_attr_hwrev.attr,
 268         &dev_attr_manfid.attr,
 269         &dev_attr_name.attr,
 270         &dev_attr_oemid.attr,
 271         &dev_attr_serial.attr,
 272         NULL,
 273 };
 274
 275 static struct attribute_group mmc_std_attr_group = {
 276         .attrs = mmc_std_attrs,
 277 };
 278
 279 static struct attribute_group *mmc_attr_groups[] = {
 280         &mmc_std_attr_group,
 281         NULL,
 282 };
 283
 284 static struct device_type mmc_type = {
 285         .groups = mmc_attr_groups,
 286 };
 287
 288 /*
 289  * Handle the detection and initialisation of a card.
 290  *
 291  * In the case of a resume, "oldcard" will contain the card
 292  * we're trying to reinitialise.
 293  */
 294 static int mmc_init_card(struct mmc_host *host, u32 ocr,
 295         struct mmc_card *oldcard)
 296 {
 297         struct mmc_card *card;
 298         int err;
 299         u32 cid[4];
 300         unsigned int max_dtr;
 301
 302         BUG_ON(!host);
 303         WARN_ON(!host->claimed);
 304
 305         /*
 306          * Since we're changing the OCR value, we seem to
 307          * need to tell some cards to go back to the idle
 308          * state.  We wait 1ms to give cards time to
 309          * respond.
 310          */
 311         mmc_go_idle(host);
 312
 313         /* The extra bit indicates that we support high capacity */
 314         err = mmc_send_op_cond(host, ocr | (1 << 30), NULL);
 315         if (err)
 316                 goto err;
 317
 318         /*
 319          * For SPI, enable CRC as appropriate.
 320          */
 321         if (mmc_host_is_spi(host)) {
 322                 err = mmc_spi_set_crc(host, use_spi_crc);
 323                 if (err)
 324                         goto err;
 325         }
 326
 327         /*
 328          * Fetch CID from card.
 329          */
 330         if (mmc_host_is_spi(host))
 331                 err = mmc_send_cid(host, cid);
 332         else
 333                 err = mmc_all_send_cid(host, cid);
 334         if (err)
 335                 goto err;
 336
 337         if (oldcard) {
 338                 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) {
 339                         err = -ENOENT;
 340                         goto err;
 341                 }
 342
 343                 card = oldcard;
 344         } else {
 345                 /*
 346                  * Allocate card structure.
 347                  */
 348                 card = mmc_alloc_card(host, &mmc_type);
 349                 if (IS_ERR(card)) {
 350                         err = PTR_ERR(card);
 351                         goto err;
 352                 }
 353
 354                 card->type = MMC_TYPE_MMC;
 355                 card->rca = 1;
 356                 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
 357         }
 358
 359         /*
 360          * For native busses:  set card RCA and quit open drain mode.
 361          */
 362         if (!mmc_host_is_spi(host)) {
 363                 err = mmc_set_relative_addr(card);
 364                 if (err)
 365                         goto free_card;
 366
 367                 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
 368         }
 369
 370         if (!oldcard) {
 371                 /*
 372                  * Fetch CSD from card.
 373                  */
 374                 err = mmc_send_csd(card, card->raw_csd);
 375                 if (err)
 376                         goto free_card;
 377
 378                 err = mmc_decode_csd(card);
 379                 if (err)
 380                         goto free_card;
 381                 err = mmc_decode_cid(card);
 382                 if (err)
 383                         goto free_card;
 384         }
 385
 386         /*
 387          * Select card, as all following commands rely on that.
 388          */
 389         if (!mmc_host_is_spi(host)) {
 390                 err = mmc_select_card(card);
 391                 if (err)
 392                         goto free_card;
 393         }
 394
 395         if (!oldcard) {
 396                 /*
 397                  * Fetch and process extended CSD.
 398                  */
 399                 err = mmc_read_ext_csd(card);
 400                 if (err)
 401                         goto free_card;
 402         }
 403
 404         /*
 405          * Activate high speed (if supported)
 406          */
 407         if ((card->ext_csd.hs_max_dtr != 0) &&
 408                 (host->caps & MMC_CAP_MMC_HIGHSPEED)) {
 409                 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
 410                         EXT_CSD_HS_TIMING, 1);
 411                 if (err)
 412                         goto free_card;
 413
 414                 mmc_card_set_highspeed(card);
 415
 416                 mmc_set_timing(card->host, MMC_TIMING_MMC_HS);
 417         }
 418
 419         /*
 420          * Compute bus speed.
 421          */
 422         max_dtr = (unsigned int)-1;
 423
 424         if (mmc_card_highspeed(card)) {
 425                 if (max_dtr > card->ext_csd.hs_max_dtr)
 426                         max_dtr = card->ext_csd.hs_max_dtr;
 427         } else if (max_dtr > card->csd.max_dtr) {
 428                 max_dtr = card->csd.max_dtr;
 429         }
 430
 431         mmc_set_clock(host, max_dtr);
 432
 433         /*
 434          * Activate wide bus (if supported).
 435          */
 436         if ((card->csd.mmca_vsn >= CSD_SPEC_VER_4) &&
 437             (host->caps & (MMC_CAP_4_BIT_DATA | MMC_CAP_8_BIT_DATA))) {
 438                 unsigned ext_csd_bit, bus_width;
 439
 440                 if (host->caps & MMC_CAP_8_BIT_DATA) {
 441                         ext_csd_bit = EXT_CSD_BUS_WIDTH_8;
 442                         bus_width = MMC_BUS_WIDTH_8;
 443                 } else {
 444                         ext_csd_bit = EXT_CSD_BUS_WIDTH_4;
 445                         bus_width = MMC_BUS_WIDTH_4;
 446                 }
 447
 448                 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
 449                                  EXT_CSD_BUS_WIDTH, ext_csd_bit);
 450
 451                 if (err)
 452                         goto free_card;
 453
 454                 mmc_set_bus_width(card->host, bus_width);
 455         }
 456
 457         if (!oldcard)
 458                 host->card = card;
 459
 460         return 0;
 461
 462 free_card:
 463         if (!oldcard)
 464                 mmc_remove_card(card);
 465 err:
 466
 467         return err;
 468 }
 469
 470 /*
 471  * Host is being removed. Free up the current card.
 472  */
 473 static void mmc_remove(struct mmc_host *host)
 474 {
 475         BUG_ON(!host);
 476         BUG_ON(!host->card);
 477
 478         mmc_remove_card(host->card);
 479         host->card = NULL;
 480 }
 481
 482 /*
 483  * Card detection callback from host.
 484  */
 485 static void mmc_detect(struct mmc_host *host)
 486 {
 487         int err;
 488
 489         BUG_ON(!host);
 490         BUG_ON(!host->card);
 491
 492         mmc_claim_host(host);
 493
 494         /*
 495          * Just check if our card has been removed.
 496          */
 497         err = mmc_send_status(host->card, NULL);
 498
 499         mmc_release_host(host);
 500
 501         if (err) {
 502                 mmc_remove(host);
 503
 504                 mmc_claim_host(host);
 505                 mmc_detach_bus(host);
 506                 mmc_release_host(host);
 507         }
 508 }
 509
 510 #ifdef CONFIG_MMC_UNSAFE_RESUME
 511
 512 /*
 513  * Suspend callback from host.
 514  */
 515 static void mmc_suspend(struct mmc_host *host)
 516 {
 517         BUG_ON(!host);
 518         BUG_ON(!host->card);
 519
 520         mmc_claim_host(host);
 521         if (!mmc_host_is_spi(host))
 522                 mmc_deselect_cards(host);
 523         host->card->state &= ~MMC_STATE_HIGHSPEED;
 524         mmc_release_host(host);
 525 }
 526
 527 /*
 528  * Resume callback from host.
 529  *
 530  * This function tries to determine if the same card is still present
 531  * and, if so, restore all state to it.
 532  */
 533 static void mmc_resume(struct mmc_host *host)
 534 {
 535         int err;
 536
 537         BUG_ON(!host);
 538         BUG_ON(!host->card);
 539
 540         mmc_claim_host(host);
 541         err = mmc_init_card(host, host->ocr, host->card);
 542         mmc_release_host(host);
 543
 544         if (err) {
 545                 mmc_remove(host);
 546
 547                 mmc_claim_host(host);
 548                 mmc_detach_bus(host);
 549                 mmc_release_host(host);
 550         }
 551
 552 }
 553
 554 #else
 555
 556 #define mmc_suspend NULL
 557 #define mmc_resume NULL
 558
 559 #endif
 560
 561 static const struct mmc_bus_ops mmc_ops = {
 562         .remove = mmc_remove,
 563         .detect = mmc_detect,
 564         .suspend = mmc_suspend,
 565         .resume = mmc_resume,
 566 };
 567
 568 /*
 569  * Starting point for MMC card init.
 570  */
 571 int mmc_attach_mmc(struct mmc_host *host, u32 ocr)
 572 {
 573         int err;
 574
 575         BUG_ON(!host);
 576         WARN_ON(!host->claimed);
 577
 578         mmc_attach_bus(host, &mmc_ops);
 579
 580         /*
 581          * We need to get OCR a different way for SPI.
 582          */
 583         if (mmc_host_is_spi(host)) {
 584                 err = mmc_spi_read_ocr(host, 1, &ocr);
 585                 if (err)
 586                         goto err;
 587         }
 588
 589         /*
 590          * Sanity check the voltages that the card claims to
 591          * support.
 592          */
 593         if (ocr & 0x7F) {
 594                 printk(KERN_WARNING "%s: card claims to support voltages "
 595                        "below the defined range. These will be ignored.\n",
 596                        mmc_hostname(host));
 597                 ocr &= ~0x7F;
 598         }
 599
 600         host->ocr = mmc_select_voltage(host, ocr);
 601
 602         /*
 603          * Can we support the voltage of the card?
 604          */
 605         if (!host->ocr) {
 606                 err = -EINVAL;
 607                 goto err;
 608         }
 609
 610         /*
 611          * Detect and init the card.
 612          */
 613         err = mmc_init_card(host, host->ocr, NULL);
 614         if (err)
 615                 goto err;
 616
 617         mmc_release_host(host);
 618
 619         err = mmc_add_card(host->card);
 620         if (err)
 621                 goto remove_card;
 622
 623         return 0;
 624
 625 remove_card:
 626         mmc_remove_card(host->card);
 627         host->card = NULL;
 628         mmc_claim_host(host);
 629 err:
 630         mmc_detach_bus(host);
 631         mmc_release_host(host);
 632
 633         printk(KERN_ERR "%s: error %d whilst initialising MMC card\n",
 634                 mmc_hostname(host), err);
 635
 636         return err;
 637 }