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