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 "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("%s: unrecognised EXT_CSD structure version %d\n",
 216                         mmc_hostname(card->host), ext_csd_struct);
 217                 return -EINVAL;
 218         }
 219
 220         if (ext_csd_struct >= 2) {
 221                 card->ext_csd.sectors =
 222                         ext_csd[EXT_CSD_SEC_CNT + 0] << 0 |
 223                         ext_csd[EXT_CSD_SEC_CNT + 1] << 8 |
 224                         ext_csd[EXT_CSD_SEC_CNT + 2] << 16 |
 225                         ext_csd[EXT_CSD_SEC_CNT + 3] << 24;
 226                 if (card->ext_csd.sectors)
 227                         mmc_card_set_blockaddr(card);
 228         }
 229
 230         switch (ext_csd[EXT_CSD_CARD_TYPE]) {
 231         case EXT_CSD_CARD_TYPE_52 | EXT_CSD_CARD_TYPE_26:
 232                 card->ext_csd.hs_max_dtr = 52000000;
 233                 break;
 234         case EXT_CSD_CARD_TYPE_26:
 235                 card->ext_csd.hs_max_dtr = 26000000;
 236                 break;
 237         default:
 238                 /* MMC v4 spec says this cannot happen */
 239                 printk(KERN_WARNING "%s: card is mmc v4 but doesn't "
 240                         "support any high-speed modes.\n",
 241                         mmc_hostname(card->host));
 242                 goto out;
 243         }
 244
 245 out:
 246         kfree(ext_csd);
 247
 248         return err;
 249 }
 250
 251 /*
 252  * Handle the detection and initialisation of a card.
 253  *
 254  * In the case of a resume, "curcard" will contain the card
 255  * we're trying to reinitialise.
 256  */
 257 static int mmc_init_card(struct mmc_host *host, u32 ocr,
 258         struct mmc_card *oldcard)
 259 {
 260         struct mmc_card *card;
 261         int err;
 262         u32 cid[4];
 263         unsigned int max_dtr;
 264
 265         BUG_ON(!host);
 266         BUG_ON(!host->claimed);
 267
 268         /*
 269          * Since we're changing the OCR value, we seem to
 270          * need to tell some cards to go back to the idle
 271          * state.  We wait 1ms to give cards time to
 272          * respond.
 273          */
 274         mmc_go_idle(host);
 275
 276         /* The extra bit indicates that we support high capacity */
 277         err = mmc_send_op_cond(host, ocr | (1 << 30), NULL);
 278         if (err)
 279                 goto err;
 280
 281         /*
 282          * Fetch CID from card.
 283          */
 284         err = mmc_all_send_cid(host, cid);
 285         if (err)
 286                 goto err;
 287
 288         if (oldcard) {
 289                 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) {
 290                         err = -ENOENT;
 291                         goto err;
 292                 }
 293
 294                 card = oldcard;
 295         } else {
 296                 /*
 297                  * Allocate card structure.
 298                  */
 299                 card = mmc_alloc_card(host);
 300                 if (IS_ERR(card)) {
 301                         err = PTR_ERR(card);
 302                         goto err;
 303                 }
 304
 305                 card->type = MMC_TYPE_MMC;
 306                 card->rca = 1;
 307                 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
 308         }
 309
 310         /*
 311          * Set card RCA.
 312          */
 313         err = mmc_set_relative_addr(card);
 314         if (err)
 315                 goto free_card;
 316
 317         mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
 318
 319         if (!oldcard) {
 320                 /*
 321                  * Fetch CSD from card.
 322                  */
 323                 err = mmc_send_csd(card, card->raw_csd);
 324                 if (err)
 325                         goto free_card;
 326
 327                 err = mmc_decode_csd(card);
 328                 if (err)
 329                         goto free_card;
 330                 err = mmc_decode_cid(card);
 331                 if (err)
 332                         goto free_card;
 333         }
 334
 335         /*
 336          * Select card, as all following commands rely on that.
 337          */
 338         err = mmc_select_card(card);
 339         if (err)
 340                 goto free_card;
 341
 342         if (!oldcard) {
 343                 /*
 344                  * Fetch and process extened CSD.
 345                  */
 346                 err = mmc_read_ext_csd(card);
 347                 if (err)
 348                         goto free_card;
 349         }
 350
 351         /*
 352          * Activate high speed (if supported)
 353          */
 354         if ((card->ext_csd.hs_max_dtr != 0) &&
 355                 (host->caps & MMC_CAP_MMC_HIGHSPEED)) {
 356                 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
 357                         EXT_CSD_HS_TIMING, 1);
 358                 if (err)
 359                         goto free_card;
 360
 361                 mmc_card_set_highspeed(card);
 362
 363                 mmc_set_timing(card->host, MMC_TIMING_MMC_HS);
 364         }
 365
 366         /*
 367          * Compute bus speed.
 368          */
 369         max_dtr = (unsigned int)-1;
 370
 371         if (mmc_card_highspeed(card)) {
 372                 if (max_dtr > card->ext_csd.hs_max_dtr)
 373                         max_dtr = card->ext_csd.hs_max_dtr;
 374         } else if (max_dtr > card->csd.max_dtr) {
 375                 max_dtr = card->csd.max_dtr;
 376         }
 377
 378         mmc_set_clock(host, max_dtr);
 379
 380         /*
 381          * Activate wide bus (if supported).
 382          */
 383         if ((card->csd.mmca_vsn >= CSD_SPEC_VER_4) &&
 384                 (host->caps & MMC_CAP_4_BIT_DATA)) {
 385                 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
 386                         EXT_CSD_BUS_WIDTH, EXT_CSD_BUS_WIDTH_4);
 387                 if (err)
 388                         goto free_card;
 389
 390                 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
 391         }
 392
 393         if (!oldcard)
 394                 host->card = card;
 395
 396         return 0;
 397
 398 free_card:
 399         if (!oldcard)
 400                 mmc_remove_card(card);
 401 err:
 402
 403         return err;
 404 }
 405
 406 /*
 407  * Host is being removed. Free up the current card.
 408  */
 409 static void mmc_remove(struct mmc_host *host)
 410 {
 411         BUG_ON(!host);
 412         BUG_ON(!host->card);
 413
 414         mmc_remove_card(host->card);
 415         host->card = NULL;
 416 }
 417
 418 /*
 419  * Card detection callback from host.
 420  */
 421 static void mmc_detect(struct mmc_host *host)
 422 {
 423         int err;
 424
 425         BUG_ON(!host);
 426         BUG_ON(!host->card);
 427
 428         mmc_claim_host(host);
 429
 430         /*
 431          * Just check if our card has been removed.
 432          */
 433         err = mmc_send_status(host->card, NULL);
 434
 435         mmc_release_host(host);
 436
 437         if (err) {
 438                 mmc_remove(host);
 439
 440                 mmc_claim_host(host);
 441                 mmc_detach_bus(host);
 442                 mmc_release_host(host);
 443         }
 444 }
 445
 446 MMC_ATTR_FN(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
 447         card->raw_cid[2], card->raw_cid[3]);
 448 MMC_ATTR_FN(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
 449         card->raw_csd[2], card->raw_csd[3]);
 450 MMC_ATTR_FN(date, "%02d/%04d\n", card->cid.month, card->cid.year);
 451 MMC_ATTR_FN(fwrev, "0x%x\n", card->cid.fwrev);
 452 MMC_ATTR_FN(hwrev, "0x%x\n", card->cid.hwrev);
 453 MMC_ATTR_FN(manfid, "0x%06x\n", card->cid.manfid);
 454 MMC_ATTR_FN(name, "%s\n", card->cid.prod_name);
 455 MMC_ATTR_FN(oemid, "0x%04x\n", card->cid.oemid);
 456 MMC_ATTR_FN(serial, "0x%08x\n", card->cid.serial);
 457
 458 static struct device_attribute mmc_dev_attrs[] = {
 459         MMC_ATTR_RO(cid),
 460         MMC_ATTR_RO(csd),
 461         MMC_ATTR_RO(date),
 462         MMC_ATTR_RO(fwrev),
 463         MMC_ATTR_RO(hwrev),
 464         MMC_ATTR_RO(manfid),
 465         MMC_ATTR_RO(name),
 466         MMC_ATTR_RO(oemid),
 467         MMC_ATTR_RO(serial),
 468         __ATTR_NULL,
 469 };
 470
 471 /*
 472  * Adds sysfs entries as relevant.
 473  */
 474 static int mmc_sysfs_add(struct mmc_host *host, struct mmc_card *card)
 475 {
 476         int ret;
 477
 478         ret = mmc_add_attrs(card, mmc_dev_attrs);
 479         if (ret < 0)
 480                 return ret;
 481
 482         return 0;
 483 }
 484
 485 /*
 486  * Removes the sysfs entries added by mmc_sysfs_add().
 487  */
 488 static void mmc_sysfs_remove(struct mmc_host *host, struct mmc_card *card)
 489 {
 490         mmc_remove_attrs(card, mmc_dev_attrs);
 491 }
 492
 493 #ifdef CONFIG_MMC_UNSAFE_RESUME
 494
 495 /*
 496  * Suspend callback from host.
 497  */
 498 static void mmc_suspend(struct mmc_host *host)
 499 {
 500         BUG_ON(!host);
 501         BUG_ON(!host->card);
 502
 503         mmc_claim_host(host);
 504         mmc_deselect_cards(host);
 505         host->card->state &= ~MMC_STATE_HIGHSPEED;
 506         mmc_release_host(host);
 507 }
 508
 509 /*
 510  * Resume callback from host.
 511  *
 512  * This function tries to determine if the same card is still present
 513  * and, if so, restore all state to it.
 514  */
 515 static void mmc_resume(struct mmc_host *host)
 516 {
 517         int err;
 518
 519         BUG_ON(!host);
 520         BUG_ON(!host->card);
 521
 522         mmc_claim_host(host);
 523         err = mmc_init_card(host, host->ocr, host->card);
 524         mmc_release_host(host);
 525
 526         if (err) {
 527                 mmc_remove(host);
 528
 529                 mmc_claim_host(host);
 530                 mmc_detach_bus(host);
 531                 mmc_release_host(host);
 532         }
 533
 534 }
 535
 536 #else
 537
 538 #define mmc_suspend NULL
 539 #define mmc_resume NULL
 540
 541 #endif
 542
 543 static const struct mmc_bus_ops mmc_ops = {
 544         .remove = mmc_remove,
 545         .detect = mmc_detect,
 546         .sysfs_add = mmc_sysfs_add,
 547         .sysfs_remove = mmc_sysfs_remove,
 548         .suspend = mmc_suspend,
 549         .resume = mmc_resume,
 550 };
 551
 552 /*
 553  * Starting point for MMC card init.
 554  */
 555 int mmc_attach_mmc(struct mmc_host *host, u32 ocr)
 556 {
 557         int err;
 558
 559         BUG_ON(!host);
 560         BUG_ON(!host->claimed);
 561
 562         mmc_attach_bus(host, &mmc_ops);
 563
 564         /*
 565          * Sanity check the voltages that the card claims to
 566          * support.
 567          */
 568         if (ocr & 0x7F) {
 569                 printk(KERN_WARNING "%s: card claims to support voltages "
 570                        "below the defined range. These will be ignored.\n",
 571                        mmc_hostname(host));
 572                 ocr &= ~0x7F;
 573         }
 574
 575         host->ocr = mmc_select_voltage(host, ocr);
 576
 577         /*
 578          * Can we support the voltage of the card?
 579          */
 580         if (!host->ocr) {
 581                 err = -EINVAL;
 582                 goto err;
 583         }
 584
 585         /*
 586          * Detect and init the card.
 587          */
 588         err = mmc_init_card(host, host->ocr, NULL);
 589         if (err)
 590                 goto err;
 591
 592         mmc_release_host(host);
 593
 594         err = mmc_add_card(host->card);
 595         if (err)
 596                 goto remove_card;
 597
 598         return 0;
 599
 600 remove_card:
 601         mmc_remove_card(host->card);
 602         host->card = NULL;
 603         mmc_claim_host(host);
 604 err:
 605         mmc_detach_bus(host);
 606         mmc_release_host(host);
 607
 608         printk(KERN_ERR "%s: error %d whilst initialising MMC card\n",
 609                 mmc_hostname(host), err);
 610
 611         return err;
 612 }
 613