drivers/mmc/card/block.c

   1 /*
   2  * Block driver for media (i.e., flash cards)
   3  *
   4  * Copyright 2002 Hewlett-Packard Company
   5  * Copyright 2005-2008 Pierre Ossman
   6  *
   7  * Use consistent with the GNU GPL is permitted,
   8  * provided that this copyright notice is
   9  * preserved in its entirety in all copies and derived works.
  10  *
  11  * HEWLETT-PACKARD COMPANY MAKES NO WARRANTIES, EXPRESSED OR IMPLIED,
  12  * AS TO THE USEFULNESS OR CORRECTNESS OF THIS CODE OR ITS
  13  * FITNESS FOR ANY PARTICULAR PURPOSE.
  14  *
  15  * Many thanks to Alessandro Rubini and Jonathan Corbet!
  16  *
  17  * Author:  Andrew Christian
  18  *          28 May 2002
  19  */
  20 #include <linux/moduleparam.h>
  21 #include <linux/module.h>
  22 #include <linux/init.h>
  23
  24 #include <linux/kernel.h>
  25 #include <linux/fs.h>
  26 #include <linux/errno.h>
  27 #include <linux/hdreg.h>
  28 #include <linux/kdev_t.h>
  29 #include <linux/blkdev.h>
  30 #include <linux/mutex.h>
  31 #include <linux/scatterlist.h>
  32 #include <linux/string_helpers.h>
  33
  34 #include <linux/mmc/card.h>
  35 #include <linux/mmc/host.h>
  36 #include <linux/mmc/mmc.h>
  37 #include <linux/mmc/sd.h>
  38
  39 #include <asm/system.h>
  40 #include <asm/uaccess.h>
  41
  42 #include "queue.h"
  43
  44 /*
  45  * max 8 partitions per card
  46  */
  47 #define MMC_SHIFT       3
  48 #define MMC_NUM_MINORS  (256 >> MMC_SHIFT)
  49
  50 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
  51
  52 /*
  53  * There is one mmc_blk_data per slot.
  54  */
  55 struct mmc_blk_data {
  56         spinlock_t      lock;
  57         struct gendisk  *disk;
  58         struct mmc_queue queue;
  59
  60         unsigned int    usage;
  61         unsigned int    read_only;
  62 };
  63
  64 static DEFINE_MUTEX(open_lock);
  65
  66 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
  67 {
  68         struct mmc_blk_data *md;
  69
  70         mutex_lock(&open_lock);
  71         md = disk->private_data;
  72         if (md && md->usage == 0)
  73                 md = NULL;
  74         if (md)
  75                 md->usage++;
  76         mutex_unlock(&open_lock);
  77
  78         return md;
  79 }
  80
  81 static void mmc_blk_put(struct mmc_blk_data *md)
  82 {
  83         mutex_lock(&open_lock);
  84         md->usage--;
  85         if (md->usage == 0) {
  86                 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
  87                 __clear_bit(devidx, dev_use);
  88
  89                 put_disk(md->disk);
  90                 kfree(md);
  91         }
  92         mutex_unlock(&open_lock);
  93 }
  94
  95 static int mmc_blk_open(struct block_device *bdev, fmode_t mode)
  96 {
  97         struct mmc_blk_data *md = mmc_blk_get(bdev->bd_disk);
  98         int ret = -ENXIO;
  99
 100         if (md) {
 101                 if (md->usage == 2)
 102                         check_disk_change(bdev);
 103                 ret = 0;
 104
 105                 if ((mode & FMODE_WRITE) && md->read_only) {
 106                         mmc_blk_put(md);
 107                         ret = -EROFS;
 108                 }
 109         }
 110
 111         return ret;
 112 }
 113
 114 static int mmc_blk_release(struct gendisk *disk, fmode_t mode)
 115 {
 116         struct mmc_blk_data *md = disk->private_data;
 117
 118         mmc_blk_put(md);
 119         return 0;
 120 }
 121
 122 static int
 123 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
 124 {
 125         geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
 126         geo->heads = 4;
 127         geo->sectors = 16;
 128         return 0;
 129 }
 130
 131 static struct block_device_operations mmc_bdops = {
 132         .open                   = mmc_blk_open,
 133         .release                = mmc_blk_release,
 134         .getgeo                 = mmc_blk_getgeo,
 135         .owner                  = THIS_MODULE,
 136 };
 137
 138 struct mmc_blk_request {
 139         struct mmc_request      mrq;
 140         struct mmc_command      cmd;
 141         struct mmc_command      stop;
 142         struct mmc_data         data;
 143 };
 144
 145 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
 146 {
 147         int err;
 148         __be32 blocks;
 149
 150         struct mmc_request mrq;
 151         struct mmc_command cmd;
 152         struct mmc_data data;
 153         unsigned int timeout_us;
 154
 155         struct scatterlist sg;
 156
 157         memset(&cmd, 0, sizeof(struct mmc_command));
 158
 159         cmd.opcode = MMC_APP_CMD;
 160         cmd.arg = card->rca << 16;
 161         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
 162
 163         err = mmc_wait_for_cmd(card->host, &cmd, 0);
 164         if (err)
 165                 return (u32)-1;
 166         if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
 167                 return (u32)-1;
 168
 169         memset(&cmd, 0, sizeof(struct mmc_command));
 170
 171         cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
 172         cmd.arg = 0;
 173         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
 174
 175         memset(&data, 0, sizeof(struct mmc_data));
 176
 177         data.timeout_ns = card->csd.tacc_ns * 100;
 178         data.timeout_clks = card->csd.tacc_clks * 100;
 179
 180         timeout_us = data.timeout_ns / 1000;
 181         timeout_us += data.timeout_clks * 1000 /
 182                 (card->host->ios.clock / 1000);
 183
 184         if (timeout_us > 100000) {
 185                 data.timeout_ns = 100000000;
 186                 data.timeout_clks = 0;
 187         }
 188
 189         data.blksz = 4;
 190         data.blocks = 1;
 191         data.flags = MMC_DATA_READ;
 192         data.sg = &sg;
 193         data.sg_len = 1;
 194
 195         memset(&mrq, 0, sizeof(struct mmc_request));
 196
 197         mrq.cmd = &cmd;
 198         mrq.data = &data;
 199
 200         sg_init_one(&sg, &blocks, 4);
 201
 202         mmc_wait_for_req(card->host, &mrq);
 203
 204         if (cmd.error || data.error)
 205                 return (u32)-1;
 206
 207         return ntohl(blocks);
 208 }
 209
 210 static u32 get_card_status(struct mmc_card *card, struct request *req)
 211 {
 212         struct mmc_command cmd;
 213         int err;
 214
 215         memset(&cmd, 0, sizeof(struct mmc_command));
 216         cmd.opcode = MMC_SEND_STATUS;
 217         if (!mmc_host_is_spi(card->host))
 218                 cmd.arg = card->rca << 16;
 219         cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
 220         err = mmc_wait_for_cmd(card->host, &cmd, 0);
 221         if (err)
 222                 printk(KERN_ERR "%s: error %d sending status comand",
 223                        req->rq_disk->disk_name, err);
 224         return cmd.resp[0];
 225 }
 226
 227 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
 228 {
 229         struct mmc_blk_data *md = mq->data;
 230         struct mmc_card *card = md->queue.card;
 231         struct mmc_blk_request brq;
 232         int ret = 1;
 233
 234         mmc_claim_host(card->host);
 235
 236         do {
 237                 struct mmc_command cmd;
 238                 u32 readcmd, writecmd, status = 0;
 239
 240                 memset(&brq, 0, sizeof(struct mmc_blk_request));
 241                 brq.mrq.cmd = &brq.cmd;
 242                 brq.mrq.data = &brq.data;
 243
 244                 brq.cmd.arg = req->sector;
 245                 if (!mmc_card_blockaddr(card))
 246                         brq.cmd.arg <<= 9;
 247                 brq.cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
 248                 brq.data.blksz = 512;
 249                 brq.stop.opcode = MMC_STOP_TRANSMISSION;
 250                 brq.stop.arg = 0;
 251                 brq.stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
 252                 brq.data.blocks = req->nr_sectors;
 253
 254                 if (brq.data.blocks > 1) {
 255                         /* SPI multiblock writes terminate using a special
 256                          * token, not a STOP_TRANSMISSION request.
 257                          */
 258                         if (!mmc_host_is_spi(card->host)
 259                                         || rq_data_dir(req) == READ)
 260                                 brq.mrq.stop = &brq.stop;
 261                         readcmd = MMC_READ_MULTIPLE_BLOCK;
 262                         writecmd = MMC_WRITE_MULTIPLE_BLOCK;
 263                 } else {
 264                         brq.mrq.stop = NULL;
 265                         readcmd = MMC_READ_SINGLE_BLOCK;
 266                         writecmd = MMC_WRITE_BLOCK;
 267                 }
 268
 269                 if (rq_data_dir(req) == READ) {
 270                         brq.cmd.opcode = readcmd;
 271                         brq.data.flags |= MMC_DATA_READ;
 272                 } else {
 273                         brq.cmd.opcode = writecmd;
 274                         brq.data.flags |= MMC_DATA_WRITE;
 275                 }
 276
 277                 mmc_set_data_timeout(&brq.data, card);
 278
 279                 brq.data.sg = mq->sg;
 280                 brq.data.sg_len = mmc_queue_map_sg(mq);
 281
 282                 mmc_queue_bounce_pre(mq);
 283
 284                 mmc_wait_for_req(card->host, &brq.mrq);
 285
 286                 mmc_queue_bounce_post(mq);
 287
 288                 /*
 289                  * Check for errors here, but don't jump to cmd_err
 290                  * until later as we need to wait for the card to leave
 291                  * programming mode even when things go wrong.
 292                  */
 293                 if (brq.cmd.error || brq.data.error || brq.stop.error)
 294                         status = get_card_status(card, req);
 295
 296                 if (brq.cmd.error) {
 297                         printk(KERN_ERR "%s: error %d sending read/write "
 298                                "command, response %#x, card status %#x\n",
 299                                req->rq_disk->disk_name, brq.cmd.error,
 300                                brq.cmd.resp[0], status);
 301                 }
 302
 303                 if (brq.data.error) {
 304                         if (brq.data.error == -ETIMEDOUT && brq.mrq.stop)
 305                                 /* 'Stop' response contains card status */
 306                                 status = brq.mrq.stop->resp[0];
 307                         printk(KERN_ERR "%s: error %d transferring data,"
 308                                " sector %u, nr %u, card status %#x\n",
 309                                req->rq_disk->disk_name, brq.data.error,
 310                                (unsigned)req->sector,
 311                                (unsigned)req->nr_sectors, status);
 312                 }
 313
 314                 if (brq.stop.error) {
 315                         printk(KERN_ERR "%s: error %d sending stop command, "
 316                                "response %#x, card status %#x\n",
 317                                req->rq_disk->disk_name, brq.stop.error,
 318                                brq.stop.resp[0], status);
 319                 }
 320
 321                 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
 322                         do {
 323                                 int err;
 324
 325                                 cmd.opcode = MMC_SEND_STATUS;
 326                                 cmd.arg = card->rca << 16;
 327                                 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
 328                                 err = mmc_wait_for_cmd(card->host, &cmd, 5);
 329                                 if (err) {
 330                                         printk(KERN_ERR "%s: error %d requesting status\n",
 331                                                req->rq_disk->disk_name, err);
 332                                         goto cmd_err;
 333                                 }
 334                                 /*
 335                                  * Some cards mishandle the status bits,
 336                                  * so make sure to check both the busy
 337                                  * indication and the card state.
 338                                  */
 339                         } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
 340                                 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
 341
 342 #if 0
 343                         if (cmd.resp[0] & ~0x00000900)
 344                                 printk(KERN_ERR "%s: status = %08x\n",
 345                                        req->rq_disk->disk_name, cmd.resp[0]);
 346                         if (mmc_decode_status(cmd.resp))
 347                                 goto cmd_err;
 348 #endif
 349                 }
 350
 351                 if (brq.cmd.error || brq.data.error || brq.stop.error)
 352                         goto cmd_err;
 353
 354                 /*
 355                  * A block was successfully transferred.
 356                  */
 357                 spin_lock_irq(&md->lock);
 358                 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
 359                 spin_unlock_irq(&md->lock);
 360         } while (ret);
 361
 362         mmc_release_host(card->host);
 363
 364         return 1;
 365
 366  cmd_err:
 367         /*
 368          * If this is an SD card and we're writing, we can first
 369          * mark the known good sectors as ok.
 370          *
 371          * If the card is not SD, we can still ok written sectors
 372          * as reported by the controller (which might be less than
 373          * the real number of written sectors, but never more).
 374          *
 375          * For reads we just fail the entire chunk as that should
 376          * be safe in all cases.
 377          */
 378         if (rq_data_dir(req) != READ) {
 379                 if (mmc_card_sd(card)) {
 380                         u32 blocks;
 381
 382                         blocks = mmc_sd_num_wr_blocks(card);
 383                         if (blocks != (u32)-1) {
 384                                 spin_lock_irq(&md->lock);
 385                                 ret = __blk_end_request(req, 0, blocks << 9);
 386                                 spin_unlock_irq(&md->lock);
 387                         }
 388                 } else {
 389                         spin_lock_irq(&md->lock);
 390                         ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
 391                         spin_unlock_irq(&md->lock);
 392                 }
 393         }
 394
 395         mmc_release_host(card->host);
 396
 397         spin_lock_irq(&md->lock);
 398         while (ret)
 399                 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
 400         spin_unlock_irq(&md->lock);
 401
 402         return 0;
 403 }
 404
 405
 406 static inline int mmc_blk_readonly(struct mmc_card *card)
 407 {
 408         return mmc_card_readonly(card) ||
 409                !(card->csd.cmdclass & CCC_BLOCK_WRITE);
 410 }
 411
 412 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
 413 {
 414         struct mmc_blk_data *md;
 415         int devidx, ret;
 416
 417         devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
 418         if (devidx >= MMC_NUM_MINORS)
 419                 return ERR_PTR(-ENOSPC);
 420         __set_bit(devidx, dev_use);
 421
 422         md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
 423         if (!md) {
 424                 ret = -ENOMEM;
 425                 goto out;
 426         }
 427
 428
 429         /*
 430          * Set the read-only status based on the supported commands
 431          * and the write protect switch.
 432          */
 433         md->read_only = mmc_blk_readonly(card);
 434
 435         md->disk = alloc_disk(1 << MMC_SHIFT);
 436         if (md->disk == NULL) {
 437                 ret = -ENOMEM;
 438                 goto err_kfree;
 439         }
 440
 441         spin_lock_init(&md->lock);
 442         md->usage = 1;
 443
 444         ret = mmc_init_queue(&md->queue, card, &md->lock);
 445         if (ret)
 446                 goto err_putdisk;
 447
 448         md->queue.issue_fn = mmc_blk_issue_rq;
 449         md->queue.data = md;
 450
 451         md->disk->major = MMC_BLOCK_MAJOR;
 452         md->disk->first_minor = devidx << MMC_SHIFT;
 453         md->disk->fops = &mmc_bdops;
 454         md->disk->private_data = md;
 455         md->disk->queue = md->queue.queue;
 456         md->disk->driverfs_dev = &card->dev;
 457
 458         /*
 459          * As discussed on lkml, GENHD_FL_REMOVABLE should:
 460          *
 461          * - be set for removable media with permanent block devices
 462          * - be unset for removable block devices with permanent media
 463          *
 464          * Since MMC block devices clearly fall under the second
 465          * case, we do not set GENHD_FL_REMOVABLE.  Userspace
 466          * should use the block device creation/destruction hotplug
 467          * messages to tell when the card is present.
 468          */
 469
 470         sprintf(md->disk->disk_name, "mmcblk%d", devidx);
 471
 472         blk_queue_hardsect_size(md->queue.queue, 512);
 473
 474         if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
 475                 /*
 476                  * The EXT_CSD sector count is in number or 512 byte
 477                  * sectors.
 478                  */
 479                 set_capacity(md->disk, card->ext_csd.sectors);
 480         } else {
 481                 /*
 482                  * The CSD capacity field is in units of read_blkbits.
 483                  * set_capacity takes units of 512 bytes.
 484                  */
 485                 set_capacity(md->disk,
 486                         card->csd.capacity << (card->csd.read_blkbits - 9));
 487         }
 488         return md;
 489
 490  err_putdisk:
 491         put_disk(md->disk);
 492  err_kfree:
 493         kfree(md);
 494  out:
 495         return ERR_PTR(ret);
 496 }
 497
 498 static int
 499 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
 500 {
 501         struct mmc_command cmd;
 502         int err;
 503
 504         /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
 505         if (mmc_card_blockaddr(card))
 506                 return 0;
 507
 508         mmc_claim_host(card->host);
 509         cmd.opcode = MMC_SET_BLOCKLEN;
 510         cmd.arg = 512;
 511         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
 512         err = mmc_wait_for_cmd(card->host, &cmd, 5);
 513         mmc_release_host(card->host);
 514
 515         if (err) {
 516                 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
 517                         md->disk->disk_name, cmd.arg, err);
 518                 return -EINVAL;
 519         }
 520
 521         return 0;
 522 }
 523
 524 static int mmc_blk_probe(struct mmc_card *card)
 525 {
 526         struct mmc_blk_data *md;
 527         int err;
 528
 529         char cap_str[10];
 530
 531         /*
 532          * Check that the card supports the command class(es) we need.
 533          */
 534         if (!(card->csd.cmdclass & CCC_BLOCK_READ))
 535                 return -ENODEV;
 536
 537         md = mmc_blk_alloc(card);
 538         if (IS_ERR(md))
 539                 return PTR_ERR(md);
 540
 541         err = mmc_blk_set_blksize(md, card);
 542         if (err)
 543                 goto out;
 544
 545         string_get_size(get_capacity(md->disk) << 9, STRING_UNITS_2,
 546                         cap_str, sizeof(cap_str));
 547         printk(KERN_INFO "%s: %s %s %s %s\n",
 548                 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
 549                 cap_str, md->read_only ? "(ro)" : "");
 550
 551         mmc_set_drvdata(card, md);
 552         add_disk(md->disk);
 553         return 0;
 554
 555  out:
 556         mmc_blk_put(md);
 557
 558         return err;
 559 }
 560
 561 static void mmc_blk_remove(struct mmc_card *card)
 562 {
 563         struct mmc_blk_data *md = mmc_get_drvdata(card);
 564
 565         if (md) {
 566                 /* Stop new requests from getting into the queue */
 567                 del_gendisk(md->disk);
 568
 569                 /* Then flush out any already in there */
 570                 mmc_cleanup_queue(&md->queue);
 571
 572                 mmc_blk_put(md);
 573         }
 574         mmc_set_drvdata(card, NULL);
 575 }
 576
 577 #ifdef CONFIG_PM
 578 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
 579 {
 580         struct mmc_blk_data *md = mmc_get_drvdata(card);
 581
 582         if (md) {
 583                 mmc_queue_suspend(&md->queue);
 584         }
 585         return 0;
 586 }
 587
 588 static int mmc_blk_resume(struct mmc_card *card)
 589 {
 590         struct mmc_blk_data *md = mmc_get_drvdata(card);
 591
 592         if (md) {
 593                 mmc_blk_set_blksize(md, card);
 594                 mmc_queue_resume(&md->queue);
 595         }
 596         return 0;
 597 }
 598 #else
 599 #define mmc_blk_suspend NULL
 600 #define mmc_blk_resume  NULL
 601 #endif
 602
 603 static struct mmc_driver mmc_driver = {
 604         .drv            = {
 605                 .name   = "mmcblk",
 606         },
 607         .probe          = mmc_blk_probe,
 608         .remove         = mmc_blk_remove,
 609         .suspend        = mmc_blk_suspend,
 610         .resume         = mmc_blk_resume,
 611 };
 612
 613 static int __init mmc_blk_init(void)
 614 {
 615         int res;
 616
 617         res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
 618         if (res)
 619                 goto out;
 620
 621         res = mmc_register_driver(&mmc_driver);
 622         if (res)
 623                 goto out2;
 624
 625         return 0;
 626  out2:
 627         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
 628  out:
 629         return res;
 630 }
 631
 632 static void __exit mmc_blk_exit(void)
 633 {
 634         mmc_unregister_driver(&mmc_driver);
 635         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
 636 }
 637
 638 module_init(mmc_blk_init);
 639 module_exit(mmc_blk_exit);
 640
 641 MODULE_LICENSE("GPL");
 642 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
 643