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