err.no Git - linux-2.6/blob - drivers/mmc/mmc_block.c

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