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 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 = 512;
 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;
 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
 355                         blocks = mmc_sd_num_wr_blocks(card);
 356                         if (blocks != (u32)-1) {
 357                                 spin_lock_irq(&md->lock);
 358                                 ret = __blk_end_request(req, 0, blocks << 9);
 359                                 spin_unlock_irq(&md->lock);
 360                         }
 361                 } else {
 362                         spin_lock_irq(&md->lock);
 363                         ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
 364                         spin_unlock_irq(&md->lock);
 365                 }
 366         }
 367
 368         mmc_release_host(card->host);
 369
 370         spin_lock_irq(&md->lock);
 371         while (ret)
 372                 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
 373         spin_unlock_irq(&md->lock);
 374
 375         return 0;
 376 }
 377
 378
 379 static inline int mmc_blk_readonly(struct mmc_card *card)
 380 {
 381         return mmc_card_readonly(card) ||
 382                !(card->csd.cmdclass & CCC_BLOCK_WRITE);
 383 }
 384
 385 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
 386 {
 387         struct mmc_blk_data *md;
 388         int devidx, ret;
 389
 390         devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
 391         if (devidx >= MMC_NUM_MINORS)
 392                 return ERR_PTR(-ENOSPC);
 393         __set_bit(devidx, dev_use);
 394
 395         md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
 396         if (!md) {
 397                 ret = -ENOMEM;
 398                 goto out;
 399         }
 400
 401
 402         /*
 403          * Set the read-only status based on the supported commands
 404          * and the write protect switch.
 405          */
 406         md->read_only = mmc_blk_readonly(card);
 407
 408         md->disk = alloc_disk(1 << MMC_SHIFT);
 409         if (md->disk == NULL) {
 410                 ret = -ENOMEM;
 411                 goto err_kfree;
 412         }
 413
 414         spin_lock_init(&md->lock);
 415         md->usage = 1;
 416
 417         ret = mmc_init_queue(&md->queue, card, &md->lock);
 418         if (ret)
 419                 goto err_putdisk;
 420
 421         md->queue.issue_fn = mmc_blk_issue_rq;
 422         md->queue.data = md;
 423
 424         md->disk->major = MMC_BLOCK_MAJOR;
 425         md->disk->first_minor = devidx << MMC_SHIFT;
 426         md->disk->fops = &mmc_bdops;
 427         md->disk->private_data = md;
 428         md->disk->queue = md->queue.queue;
 429         md->disk->driverfs_dev = &card->dev;
 430
 431         /*
 432          * As discussed on lkml, GENHD_FL_REMOVABLE should:
 433          *
 434          * - be set for removable media with permanent block devices
 435          * - be unset for removable block devices with permanent media
 436          *
 437          * Since MMC block devices clearly fall under the second
 438          * case, we do not set GENHD_FL_REMOVABLE.  Userspace
 439          * should use the block device creation/destruction hotplug
 440          * messages to tell when the card is present.
 441          */
 442
 443         sprintf(md->disk->disk_name, "mmcblk%d", devidx);
 444
 445         blk_queue_hardsect_size(md->queue.queue, 512);
 446
 447         if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
 448                 /*
 449                  * The EXT_CSD sector count is in number or 512 byte
 450                  * sectors.
 451                  */
 452                 set_capacity(md->disk, card->ext_csd.sectors);
 453         } else {
 454                 /*
 455                  * The CSD capacity field is in units of read_blkbits.
 456                  * set_capacity takes units of 512 bytes.
 457                  */
 458                 set_capacity(md->disk,
 459                         card->csd.capacity << (card->csd.read_blkbits - 9));
 460         }
 461         return md;
 462
 463  err_putdisk:
 464         put_disk(md->disk);
 465  err_kfree:
 466         kfree(md);
 467  out:
 468         return ERR_PTR(ret);
 469 }
 470
 471 static int
 472 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
 473 {
 474         struct mmc_command cmd;
 475         int err;
 476
 477         /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
 478         if (mmc_card_blockaddr(card))
 479                 return 0;
 480
 481         mmc_claim_host(card->host);
 482         cmd.opcode = MMC_SET_BLOCKLEN;
 483         cmd.arg = 512;
 484         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
 485         err = mmc_wait_for_cmd(card->host, &cmd, 5);
 486         mmc_release_host(card->host);
 487
 488         if (err) {
 489                 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
 490                         md->disk->disk_name, cmd.arg, err);
 491                 return -EINVAL;
 492         }
 493
 494         return 0;
 495 }
 496
 497 static int mmc_blk_probe(struct mmc_card *card)
 498 {
 499         struct mmc_blk_data *md;
 500         int err;
 501
 502         char cap_str[10];
 503
 504         /*
 505          * Check that the card supports the command class(es) we need.
 506          */
 507         if (!(card->csd.cmdclass & CCC_BLOCK_READ))
 508                 return -ENODEV;
 509
 510         md = mmc_blk_alloc(card);
 511         if (IS_ERR(md))
 512                 return PTR_ERR(md);
 513
 514         err = mmc_blk_set_blksize(md, card);
 515         if (err)
 516                 goto out;
 517
 518         string_get_size(get_capacity(md->disk) << 9, STRING_UNITS_2,
 519                         cap_str, sizeof(cap_str));
 520         printk(KERN_INFO "%s: %s %s %s %s\n",
 521                 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
 522                 cap_str, md->read_only ? "(ro)" : "");
 523
 524         mmc_set_drvdata(card, md);
 525         add_disk(md->disk);
 526         return 0;
 527
 528  out:
 529         mmc_blk_put(md);
 530
 531         return err;
 532 }
 533
 534 static void mmc_blk_remove(struct mmc_card *card)
 535 {
 536         struct mmc_blk_data *md = mmc_get_drvdata(card);
 537
 538         if (md) {
 539                 /* Stop new requests from getting into the queue */
 540                 del_gendisk(md->disk);
 541
 542                 /* Then flush out any already in there */
 543                 mmc_cleanup_queue(&md->queue);
 544
 545                 mmc_blk_put(md);
 546         }
 547         mmc_set_drvdata(card, NULL);
 548 }
 549
 550 #ifdef CONFIG_PM
 551 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
 552 {
 553         struct mmc_blk_data *md = mmc_get_drvdata(card);
 554
 555         if (md) {
 556                 mmc_queue_suspend(&md->queue);
 557         }
 558         return 0;
 559 }
 560
 561 static int mmc_blk_resume(struct mmc_card *card)
 562 {
 563         struct mmc_blk_data *md = mmc_get_drvdata(card);
 564
 565         if (md) {
 566                 mmc_blk_set_blksize(md, card);
 567                 mmc_queue_resume(&md->queue);
 568         }
 569         return 0;
 570 }
 571 #else
 572 #define mmc_blk_suspend NULL
 573 #define mmc_blk_resume  NULL
 574 #endif
 575
 576 static struct mmc_driver mmc_driver = {
 577         .drv            = {
 578                 .name   = "mmcblk",
 579         },
 580         .probe          = mmc_blk_probe,
 581         .remove         = mmc_blk_remove,
 582         .suspend        = mmc_blk_suspend,
 583         .resume         = mmc_blk_resume,
 584 };
 585
 586 static int __init mmc_blk_init(void)
 587 {
 588         int res;
 589
 590         res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
 591         if (res)
 592                 goto out;
 593
 594         res = mmc_register_driver(&mmc_driver);
 595         if (res)
 596                 goto out2;
 597
 598         return 0;
 599  out2:
 600         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
 601  out:
 602         return res;
 603 }
 604
 605 static void __exit mmc_blk_exit(void)
 606 {
 607         mmc_unregister_driver(&mmc_driver);
 608         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
 609 }
 610
 611 module_init(mmc_blk_init);
 612 module_exit(mmc_blk_exit);
 613
 614 MODULE_LICENSE("GPL");
 615 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
 616