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    block_bits;
  62         unsigned int    read_only;
  63 };
  64
  65 static DEFINE_MUTEX(open_lock);
  66
  67 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
  68 {
  69         struct mmc_blk_data *md;
  70
  71         mutex_lock(&open_lock);
  72         md = disk->private_data;
  73         if (md && md->usage == 0)
  74                 md = NULL;
  75         if (md)
  76                 md->usage++;
  77         mutex_unlock(&open_lock);
  78
  79         return md;
  80 }
  81
  82 static void mmc_blk_put(struct mmc_blk_data *md)
  83 {
  84         mutex_lock(&open_lock);
  85         md->usage--;
  86         if (md->usage == 0) {
  87                 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
  88                 __clear_bit(devidx, dev_use);
  89
  90                 put_disk(md->disk);
  91                 kfree(md);
  92         }
  93         mutex_unlock(&open_lock);
  94 }
  95
  96 static int mmc_blk_open(struct inode *inode, struct file *filp)
  97 {
  98         struct mmc_blk_data *md;
  99         int ret = -ENXIO;
 100
 101         md = mmc_blk_get(inode->i_bdev->bd_disk);
 102         if (md) {
 103                 if (md->usage == 2)
 104                         check_disk_change(inode->i_bdev);
 105                 ret = 0;
 106
 107                 if ((filp->f_mode & FMODE_WRITE) && md->read_only) {
 108                         mmc_blk_put(md);
 109                         ret = -EROFS;
 110                 }
 111         }
 112
 113         return ret;
 114 }
 115
 116 static int mmc_blk_release(struct inode *inode, struct file *filp)
 117 {
 118         struct mmc_blk_data *md = inode->i_bdev->bd_disk->private_data;
 119
 120         mmc_blk_put(md);
 121         return 0;
 122 }
 123
 124 static int
 125 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
 126 {
 127         geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
 128         geo->heads = 4;
 129         geo->sectors = 16;
 130         return 0;
 131 }
 132
 133 static struct block_device_operations mmc_bdops = {
 134         .open                   = mmc_blk_open,
 135         .release                = mmc_blk_release,
 136         .getgeo                 = mmc_blk_getgeo,
 137         .owner                  = THIS_MODULE,
 138 };
 139
 140 struct mmc_blk_request {
 141         struct mmc_request      mrq;
 142         struct mmc_command      cmd;
 143         struct mmc_command      stop;
 144         struct mmc_data         data;
 145 };
 146
 147 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
 148 {
 149         int err;
 150         u32 blocks;
 151
 152         struct mmc_request mrq;
 153         struct mmc_command cmd;
 154         struct mmc_data data;
 155         unsigned int timeout_us;
 156
 157         struct scatterlist sg;
 158
 159         memset(&cmd, 0, sizeof(struct mmc_command));
 160
 161         cmd.opcode = MMC_APP_CMD;
 162         cmd.arg = card->rca << 16;
 163         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
 164
 165         err = mmc_wait_for_cmd(card->host, &cmd, 0);
 166         if (err)
 167                 return (u32)-1;
 168         if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
 169                 return (u32)-1;
 170
 171         memset(&cmd, 0, sizeof(struct mmc_command));
 172
 173         cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
 174         cmd.arg = 0;
 175         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
 176
 177         memset(&data, 0, sizeof(struct mmc_data));
 178
 179         data.timeout_ns = card->csd.tacc_ns * 100;
 180         data.timeout_clks = card->csd.tacc_clks * 100;
 181
 182         timeout_us = data.timeout_ns / 1000;
 183         timeout_us += data.timeout_clks * 1000 /
 184                 (card->host->ios.clock / 1000);
 185
 186         if (timeout_us > 100000) {
 187                 data.timeout_ns = 100000000;
 188                 data.timeout_clks = 0;
 189         }
 190
 191         data.blksz = 4;
 192         data.blocks = 1;
 193         data.flags = MMC_DATA_READ;
 194         data.sg = &sg;
 195         data.sg_len = 1;
 196
 197         memset(&mrq, 0, sizeof(struct mmc_request));
 198
 199         mrq.cmd = &cmd;
 200         mrq.data = &data;
 201
 202         sg_init_one(&sg, &blocks, 4);
 203
 204         mmc_wait_for_req(card->host, &mrq);
 205
 206         if (cmd.error || data.error)
 207                 return (u32)-1;
 208
 209         blocks = ntohl(blocks);
 210
 211         return blocks;
 212 }
 213
 214 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
 215 {
 216         struct mmc_blk_data *md = mq->data;
 217         struct mmc_card *card = md->queue.card;
 218         struct mmc_blk_request brq;
 219         int ret = 1, data_size, i;
 220         struct scatterlist *sg;
 221
 222         mmc_claim_host(card->host);
 223
 224         do {
 225                 struct mmc_command cmd;
 226                 u32 readcmd, writecmd;
 227
 228                 memset(&brq, 0, sizeof(struct mmc_blk_request));
 229                 brq.mrq.cmd = &brq.cmd;
 230                 brq.mrq.data = &brq.data;
 231
 232                 brq.cmd.arg = req->sector;
 233                 if (!mmc_card_blockaddr(card))
 234                         brq.cmd.arg <<= 9;
 235                 brq.cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
 236                 brq.data.blksz = 1 << md->block_bits;
 237                 brq.stop.opcode = MMC_STOP_TRANSMISSION;
 238                 brq.stop.arg = 0;
 239                 brq.stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
 240                 brq.data.blocks = req->nr_sectors >> (md->block_bits - 9);
 241                 if (brq.data.blocks > card->host->max_blk_count)
 242                         brq.data.blocks = card->host->max_blk_count;
 243
 244                 if (brq.data.blocks > 1) {
 245                         /* SPI multiblock writes terminate using a special
 246                          * token, not a STOP_TRANSMISSION request.
 247                          */
 248                         if (!mmc_host_is_spi(card->host)
 249                                         || rq_data_dir(req) == READ)
 250                                 brq.mrq.stop = &brq.stop;
 251                         readcmd = MMC_READ_MULTIPLE_BLOCK;
 252                         writecmd = MMC_WRITE_MULTIPLE_BLOCK;
 253                 } else {
 254                         brq.mrq.stop = NULL;
 255                         readcmd = MMC_READ_SINGLE_BLOCK;
 256                         writecmd = MMC_WRITE_BLOCK;
 257                 }
 258
 259                 if (rq_data_dir(req) == READ) {
 260                         brq.cmd.opcode = readcmd;
 261                         brq.data.flags |= MMC_DATA_READ;
 262                 } else {
 263                         brq.cmd.opcode = writecmd;
 264                         brq.data.flags |= MMC_DATA_WRITE;
 265                 }
 266
 267                 mmc_set_data_timeout(&brq.data, card);
 268
 269                 brq.data.sg = mq->sg;
 270                 brq.data.sg_len = mmc_queue_map_sg(mq);
 271
 272                 mmc_queue_bounce_pre(mq);
 273
 274                 /*
 275                  * Adjust the sg list so it is the same size as the
 276                  * request.
 277                  */
 278                 if (brq.data.blocks !=
 279                     (req->nr_sectors >> (md->block_bits - 9))) {
 280                         data_size = brq.data.blocks * brq.data.blksz;
 281                         for_each_sg(brq.data.sg, sg, brq.data.sg_len, i) {
 282                                 data_size -= sg->length;
 283                                 if (data_size <= 0) {
 284                                         sg->length += data_size;
 285                                         i++;
 286                                         break;
 287                                 }
 288                         }
 289                         brq.data.sg_len = i;
 290                 }
 291
 292                 mmc_wait_for_req(card->host, &brq.mrq);
 293
 294                 mmc_queue_bounce_post(mq);
 295
 296                 /*
 297                  * Check for errors here, but don't jump to cmd_err
 298                  * until later as we need to wait for the card to leave
 299                  * programming mode even when things go wrong.
 300                  */
 301                 if (brq.cmd.error) {
 302                         printk(KERN_ERR "%s: error %d sending read/write command\n",
 303                                req->rq_disk->disk_name, brq.cmd.error);
 304                 }
 305
 306                 if (brq.data.error) {
 307                         printk(KERN_ERR "%s: error %d transferring data\n",
 308                                req->rq_disk->disk_name, brq.data.error);
 309                 }
 310
 311                 if (brq.stop.error) {
 312                         printk(KERN_ERR "%s: error %d sending stop command\n",
 313                                req->rq_disk->disk_name, brq.stop.error);
 314                 }
 315
 316                 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
 317                         do {
 318                                 int err;
 319
 320                                 cmd.opcode = MMC_SEND_STATUS;
 321                                 cmd.arg = card->rca << 16;
 322                                 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
 323                                 err = mmc_wait_for_cmd(card->host, &cmd, 5);
 324                                 if (err) {
 325                                         printk(KERN_ERR "%s: error %d requesting status\n",
 326                                                req->rq_disk->disk_name, err);
 327                                         goto cmd_err;
 328                                 }
 329                                 /*
 330                                  * Some cards mishandle the status bits,
 331                                  * so make sure to check both the busy
 332                                  * indication and the card state.
 333                                  */
 334                         } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
 335                                 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
 336
 337 #if 0
 338                         if (cmd.resp[0] & ~0x00000900)
 339                                 printk(KERN_ERR "%s: status = %08x\n",
 340                                        req->rq_disk->disk_name, cmd.resp[0]);
 341                         if (mmc_decode_status(cmd.resp))
 342                                 goto cmd_err;
 343 #endif
 344                 }
 345
 346                 if (brq.cmd.error || brq.data.error || brq.stop.error)
 347                         goto cmd_err;
 348
 349                 /*
 350                  * A block was successfully transferred.
 351                  */
 352                 spin_lock_irq(&md->lock);
 353                 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
 354                 spin_unlock_irq(&md->lock);
 355         } while (ret);
 356
 357         mmc_release_host(card->host);
 358
 359         return 1;
 360
 361  cmd_err:
 362         /*
 363          * If this is an SD card and we're writing, we can first
 364          * mark the known good sectors as ok.
 365          *
 366          * If the card is not SD, we can still ok written sectors
 367          * as reported by the controller (which might be less than
 368          * the real number of written sectors, but never more).
 369          *
 370          * For reads we just fail the entire chunk as that should
 371          * be safe in all cases.
 372          */
 373         if (rq_data_dir(req) != READ) {
 374                 if (mmc_card_sd(card)) {
 375                         u32 blocks;
 376                         unsigned int bytes;
 377
 378                         blocks = mmc_sd_num_wr_blocks(card);
 379                         if (blocks != (u32)-1) {
 380                                 if (card->csd.write_partial)
 381                                         bytes = blocks << md->block_bits;
 382                                 else
 383                                         bytes = blocks << 9;
 384                                 spin_lock_irq(&md->lock);
 385                                 ret = __blk_end_request(req, 0, bytes);
 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         /*
 436          * Both SD and MMC specifications state (although a bit
 437          * unclearly in the MMC case) that a block size of 512
 438          * bytes must always be supported by the card.
 439          */
 440         md->block_bits = 9;
 441
 442         md->disk = alloc_disk(1 << MMC_SHIFT);
 443         if (md->disk == NULL) {
 444                 ret = -ENOMEM;
 445                 goto err_kfree;
 446         }
 447
 448         spin_lock_init(&md->lock);
 449         md->usage = 1;
 450
 451         ret = mmc_init_queue(&md->queue, card, &md->lock);
 452         if (ret)
 453                 goto err_putdisk;
 454
 455         md->queue.issue_fn = mmc_blk_issue_rq;
 456         md->queue.data = md;
 457
 458         md->disk->major = MMC_BLOCK_MAJOR;
 459         md->disk->first_minor = devidx << MMC_SHIFT;
 460         md->disk->fops = &mmc_bdops;
 461         md->disk->private_data = md;
 462         md->disk->queue = md->queue.queue;
 463         md->disk->driverfs_dev = &card->dev;
 464
 465         /*
 466          * As discussed on lkml, GENHD_FL_REMOVABLE should:
 467          *
 468          * - be set for removable media with permanent block devices
 469          * - be unset for removable block devices with permanent media
 470          *
 471          * Since MMC block devices clearly fall under the second
 472          * case, we do not set GENHD_FL_REMOVABLE.  Userspace
 473          * should use the block device creation/destruction hotplug
 474          * messages to tell when the card is present.
 475          */
 476
 477         sprintf(md->disk->disk_name, "mmcblk%d", devidx);
 478
 479         blk_queue_hardsect_size(md->queue.queue, 1 << md->block_bits);
 480
 481         if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
 482                 /*
 483                  * The EXT_CSD sector count is in number or 512 byte
 484                  * sectors.
 485                  */
 486                 set_capacity(md->disk, card->ext_csd.sectors);
 487         } else {
 488                 /*
 489                  * The CSD capacity field is in units of read_blkbits.
 490                  * set_capacity takes units of 512 bytes.
 491                  */
 492                 set_capacity(md->disk,
 493                         card->csd.capacity << (card->csd.read_blkbits - 9));
 494         }
 495         return md;
 496
 497  err_putdisk:
 498         put_disk(md->disk);
 499  err_kfree:
 500         kfree(md);
 501  out:
 502         return ERR_PTR(ret);
 503 }
 504
 505 static int
 506 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
 507 {
 508         struct mmc_command cmd;
 509         int err;
 510
 511         /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
 512         if (mmc_card_blockaddr(card))
 513                 return 0;
 514
 515         mmc_claim_host(card->host);
 516         cmd.opcode = MMC_SET_BLOCKLEN;
 517         cmd.arg = 1 << md->block_bits;
 518         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
 519         err = mmc_wait_for_cmd(card->host, &cmd, 5);
 520         mmc_release_host(card->host);
 521
 522         if (err) {
 523                 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
 524                         md->disk->disk_name, cmd.arg, err);
 525                 return -EINVAL;
 526         }
 527
 528         return 0;
 529 }
 530
 531 static int mmc_blk_probe(struct mmc_card *card)
 532 {
 533         struct mmc_blk_data *md;
 534         int err;
 535
 536         char cap_str[10];
 537
 538         /*
 539          * Check that the card supports the command class(es) we need.
 540          */
 541         if (!(card->csd.cmdclass & CCC_BLOCK_READ))
 542                 return -ENODEV;
 543
 544         md = mmc_blk_alloc(card);
 545         if (IS_ERR(md))
 546                 return PTR_ERR(md);
 547
 548         err = mmc_blk_set_blksize(md, card);
 549         if (err)
 550                 goto out;
 551
 552         string_get_size(get_capacity(md->disk) << 9, STRING_UNITS_2,
 553                         cap_str, sizeof(cap_str));
 554         printk(KERN_INFO "%s: %s %s %s %s\n",
 555                 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
 556                 cap_str, md->read_only ? "(ro)" : "");
 557
 558         mmc_set_drvdata(card, md);
 559         add_disk(md->disk);
 560         return 0;
 561
 562  out:
 563         mmc_blk_put(md);
 564
 565         return err;
 566 }
 567
 568 static void mmc_blk_remove(struct mmc_card *card)
 569 {
 570         struct mmc_blk_data *md = mmc_get_drvdata(card);
 571
 572         if (md) {
 573                 /* Stop new requests from getting into the queue */
 574                 del_gendisk(md->disk);
 575
 576                 /* Then flush out any already in there */
 577                 mmc_cleanup_queue(&md->queue);
 578
 579                 mmc_blk_put(md);
 580         }
 581         mmc_set_drvdata(card, NULL);
 582 }
 583
 584 #ifdef CONFIG_PM
 585 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
 586 {
 587         struct mmc_blk_data *md = mmc_get_drvdata(card);
 588
 589         if (md) {
 590                 mmc_queue_suspend(&md->queue);
 591         }
 592         return 0;
 593 }
 594
 595 static int mmc_blk_resume(struct mmc_card *card)
 596 {
 597         struct mmc_blk_data *md = mmc_get_drvdata(card);
 598
 599         if (md) {
 600                 mmc_blk_set_blksize(md, card);
 601                 mmc_queue_resume(&md->queue);
 602         }
 603         return 0;
 604 }
 605 #else
 606 #define mmc_blk_suspend NULL
 607 #define mmc_blk_resume  NULL
 608 #endif
 609
 610 static struct mmc_driver mmc_driver = {
 611         .drv            = {
 612                 .name   = "mmcblk",
 613         },
 614         .probe          = mmc_blk_probe,
 615         .remove         = mmc_blk_remove,
 616         .suspend        = mmc_blk_suspend,
 617         .resume         = mmc_blk_resume,
 618 };
 619
 620 static int __init mmc_blk_init(void)
 621 {
 622         int res;
 623
 624         res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
 625         if (res)
 626                 goto out;
 627
 628         res = mmc_register_driver(&mmc_driver);
 629         if (res)
 630                 goto out2;
 631
 632         return 0;
 633  out2:
 634         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
 635  out:
 636         return res;
 637 }
 638
 639 static void __exit mmc_blk_exit(void)
 640 {
 641         mmc_unregister_driver(&mmc_driver);
 642         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
 643 }
 644
 645 module_init(mmc_blk_init);
 646 module_exit(mmc_blk_exit);
 647
 648 MODULE_LICENSE("GPL");
 649 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
 650