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/sched.h>
  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
  32 #include <linux/mmc/card.h>
  33 #include <linux/mmc/host.h>
  34 #include <linux/mmc/protocol.h>
  35
  36 #include <asm/system.h>
  37 #include <asm/uaccess.h>
  38
  39 #include "mmc_queue.h"
  40
  41 /*
  42  * max 8 partitions per card
  43  */
  44 #define MMC_SHIFT       3
  45
  46 static int major;
  47
  48 /*
  49  * There is one mmc_blk_data per slot.
  50  */
  51 struct mmc_blk_data {
  52         spinlock_t      lock;
  53         struct gendisk  *disk;
  54         struct mmc_queue queue;
  55
  56         unsigned int    usage;
  57         unsigned int    block_bits;
  58         unsigned int    read_only;
  59 };
  60
  61 static DEFINE_MUTEX(open_lock);
  62
  63 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
  64 {
  65         struct mmc_blk_data *md;
  66
  67         mutex_lock(&open_lock);
  68         md = disk->private_data;
  69         if (md && md->usage == 0)
  70                 md = NULL;
  71         if (md)
  72                 md->usage++;
  73         mutex_unlock(&open_lock);
  74
  75         return md;
  76 }
  77
  78 static void mmc_blk_put(struct mmc_blk_data *md)
  79 {
  80         mutex_lock(&open_lock);
  81         md->usage--;
  82         if (md->usage == 0) {
  83                 put_disk(md->disk);
  84                 mmc_cleanup_queue(&md->queue);
  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 int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
 157 {
 158         struct mmc_blk_data *md = mq->data;
 159         struct mmc_card *card = md->queue.card;
 160         int ret;
 161
 162         if (mmc_card_claim_host(card))
 163                 goto cmd_err;
 164
 165         do {
 166                 struct mmc_blk_request brq;
 167                 struct mmc_command cmd;
 168
 169                 memset(&brq, 0, sizeof(struct mmc_blk_request));
 170                 brq.mrq.cmd = &brq.cmd;
 171                 brq.mrq.data = &brq.data;
 172
 173                 brq.cmd.arg = req->sector << 9;
 174                 brq.cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
 175                 brq.data.blksz_bits = md->block_bits;
 176                 brq.data.blksz = 1 << md->block_bits;
 177                 brq.data.blocks = req->nr_sectors >> (md->block_bits - 9);
 178                 brq.stop.opcode = MMC_STOP_TRANSMISSION;
 179                 brq.stop.arg = 0;
 180                 brq.stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
 181
 182                 brq.data.timeout_ns = card->csd.tacc_ns * 10;
 183                 brq.data.timeout_clks = card->csd.tacc_clks * 10;
 184
 185                 /*
 186                  * Scale up the timeout by the r2w factor
 187                  */
 188                 if (rq_data_dir(req) == WRITE) {
 189                         brq.data.timeout_ns <<= card->csd.r2w_factor;
 190                         brq.data.timeout_clks <<= card->csd.r2w_factor;
 191                 }
 192
 193                 /*
 194                  * SD cards use a 100 multiplier and has a upper limit
 195                  */
 196                 if (mmc_card_sd(card)) {
 197                         unsigned int limit_us, timeout_us;
 198
 199                         brq.data.timeout_ns *= 10;
 200                         brq.data.timeout_clks *= 10;
 201
 202                         if (rq_data_dir(req) == READ)
 203                                 limit_us = 100000;
 204                         else
 205                                 limit_us = 250000;
 206
 207                         timeout_us = brq.data.timeout_ns / 1000;
 208                         timeout_us += brq.data.timeout_clks * 1000 /
 209                                 (card->host->ios.clock / 1000);
 210
 211                         if (timeout_us > limit_us) {
 212                                 brq.data.timeout_ns = limit_us * 1000;
 213                                 brq.data.timeout_clks = 0;
 214                         }
 215                 }
 216
 217                 if (rq_data_dir(req) == READ) {
 218                         brq.cmd.opcode = brq.data.blocks > 1 ? MMC_READ_MULTIPLE_BLOCK : MMC_READ_SINGLE_BLOCK;
 219                         brq.data.flags |= MMC_DATA_READ;
 220                 } else {
 221                         brq.cmd.opcode = MMC_WRITE_BLOCK;
 222                         brq.data.flags |= MMC_DATA_WRITE;
 223                         brq.data.blocks = 1;
 224                 }
 225
 226                 if (brq.data.blocks > 1) {
 227                         brq.data.flags |= MMC_DATA_MULTI;
 228                         brq.mrq.stop = &brq.stop;
 229                 } else {
 230                         brq.mrq.stop = NULL;
 231                 }
 232
 233                 brq.data.sg = mq->sg;
 234                 brq.data.sg_len = blk_rq_map_sg(req->q, req, brq.data.sg);
 235
 236                 mmc_wait_for_req(card->host, &brq.mrq);
 237                 if (brq.cmd.error) {
 238                         printk(KERN_ERR "%s: error %d sending read/write command\n",
 239                                req->rq_disk->disk_name, brq.cmd.error);
 240                         goto cmd_err;
 241                 }
 242
 243                 if (brq.data.error) {
 244                         printk(KERN_ERR "%s: error %d transferring data\n",
 245                                req->rq_disk->disk_name, brq.data.error);
 246                         goto cmd_err;
 247                 }
 248
 249                 if (brq.stop.error) {
 250                         printk(KERN_ERR "%s: error %d sending stop command\n",
 251                                req->rq_disk->disk_name, brq.stop.error);
 252                         goto cmd_err;
 253                 }
 254
 255                 do {
 256                         int err;
 257
 258                         cmd.opcode = MMC_SEND_STATUS;
 259                         cmd.arg = card->rca << 16;
 260                         cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
 261                         err = mmc_wait_for_cmd(card->host, &cmd, 5);
 262                         if (err) {
 263                                 printk(KERN_ERR "%s: error %d requesting status\n",
 264                                        req->rq_disk->disk_name, err);
 265                                 goto cmd_err;
 266                         }
 267                 } while (!(cmd.resp[0] & R1_READY_FOR_DATA));
 268
 269 #if 0
 270                 if (cmd.resp[0] & ~0x00000900)
 271                         printk(KERN_ERR "%s: status = %08x\n",
 272                                req->rq_disk->disk_name, cmd.resp[0]);
 273                 if (mmc_decode_status(cmd.resp))
 274                         goto cmd_err;
 275 #endif
 276
 277                 /*
 278                  * A block was successfully transferred.
 279                  */
 280                 spin_lock_irq(&md->lock);
 281                 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
 282                 if (!ret) {
 283                         /*
 284                          * The whole request completed successfully.
 285                          */
 286                         add_disk_randomness(req->rq_disk);
 287                         blkdev_dequeue_request(req);
 288                         end_that_request_last(req, 1);
 289                 }
 290                 spin_unlock_irq(&md->lock);
 291         } while (ret);
 292
 293         mmc_card_release_host(card);
 294
 295         return 1;
 296
 297  cmd_err:
 298         mmc_card_release_host(card);
 299
 300         /*
 301          * This is a little draconian, but until we get proper
 302          * error handling sorted out here, its the best we can
 303          * do - especially as some hosts have no idea how much
 304          * data was transferred before the error occurred.
 305          */
 306         spin_lock_irq(&md->lock);
 307         do {
 308                 ret = end_that_request_chunk(req, 0,
 309                                 req->current_nr_sectors << 9);
 310         } while (ret);
 311
 312         add_disk_randomness(req->rq_disk);
 313         blkdev_dequeue_request(req);
 314         end_that_request_last(req, 0);
 315         spin_unlock_irq(&md->lock);
 316
 317         return 0;
 318 }
 319
 320 #define MMC_NUM_MINORS  (256 >> MMC_SHIFT)
 321
 322 static unsigned long dev_use[MMC_NUM_MINORS/(8*sizeof(unsigned long))];
 323
 324 static inline int mmc_blk_readonly(struct mmc_card *card)
 325 {
 326         return mmc_card_readonly(card) ||
 327                !(card->csd.cmdclass & CCC_BLOCK_WRITE);
 328 }
 329
 330 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
 331 {
 332         struct mmc_blk_data *md;
 333         int devidx, ret;
 334
 335         devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
 336         if (devidx >= MMC_NUM_MINORS)
 337                 return ERR_PTR(-ENOSPC);
 338         __set_bit(devidx, dev_use);
 339
 340         md = kmalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
 341         if (!md) {
 342                 ret = -ENOMEM;
 343                 goto out;
 344         }
 345
 346         memset(md, 0, sizeof(struct mmc_blk_data));
 347
 348         /*
 349          * Set the read-only status based on the supported commands
 350          * and the write protect switch.
 351          */
 352         md->read_only = mmc_blk_readonly(card);
 353
 354         /*
 355          * Figure out a workable block size.  MMC cards have:
 356          *  - two block sizes, one for read and one for write.
 357          *  - may support partial reads and/or writes
 358          *    (allows block sizes smaller than specified)
 359          */
 360         md->block_bits = card->csd.read_blkbits;
 361         if (card->csd.write_blkbits != card->csd.read_blkbits) {
 362                 if (card->csd.write_blkbits < card->csd.read_blkbits &&
 363                     card->csd.read_partial) {
 364                         /*
 365                          * write block size is smaller than read block
 366                          * size, but we support partial reads, so choose
 367                          * the smaller write block size.
 368                          */
 369                         md->block_bits = card->csd.write_blkbits;
 370                 } else if (card->csd.write_blkbits > card->csd.read_blkbits &&
 371                            card->csd.write_partial) {
 372                         /*
 373                          * read block size is smaller than write block
 374                          * size, but we support partial writes.  Use read
 375                          * block size.
 376                          */
 377                 } else {
 378                         /*
 379                          * We don't support this configuration for writes.
 380                          */
 381                         printk(KERN_ERR "%s: unable to select block size for "
 382                                 "writing (rb%u wb%u rp%u wp%u)\n",
 383                                 mmc_card_id(card),
 384                                 1 << card->csd.read_blkbits,
 385                                 1 << card->csd.write_blkbits,
 386                                 card->csd.read_partial,
 387                                 card->csd.write_partial);
 388                         md->read_only = 1;
 389                 }
 390         }
 391
 392         /*
 393          * Refuse to allow block sizes smaller than 512 bytes.
 394          */
 395         if (md->block_bits < 9) {
 396                 printk(KERN_ERR "%s: unable to support block size %u\n",
 397                         mmc_card_id(card), 1 << md->block_bits);
 398                 ret = -EINVAL;
 399                 goto err_kfree;
 400         }
 401
 402         md->disk = alloc_disk(1 << MMC_SHIFT);
 403         if (md->disk == NULL) {
 404                 ret = -ENOMEM;
 405                 goto err_kfree;
 406         }
 407
 408         spin_lock_init(&md->lock);
 409         md->usage = 1;
 410
 411         ret = mmc_init_queue(&md->queue, card, &md->lock);
 412         if (ret)
 413                 goto err_putdisk;
 414
 415         md->queue.prep_fn = mmc_blk_prep_rq;
 416         md->queue.issue_fn = mmc_blk_issue_rq;
 417         md->queue.data = md;
 418
 419         md->disk->major = major;
 420         md->disk->first_minor = devidx << MMC_SHIFT;
 421         md->disk->fops = &mmc_bdops;
 422         md->disk->private_data = md;
 423         md->disk->queue = md->queue.queue;
 424         md->disk->driverfs_dev = &card->dev;
 425
 426         /*
 427          * As discussed on lkml, GENHD_FL_REMOVABLE should:
 428          *
 429          * - be set for removable media with permanent block devices
 430          * - be unset for removable block devices with permanent media
 431          *
 432          * Since MMC block devices clearly fall under the second
 433          * case, we do not set GENHD_FL_REMOVABLE.  Userspace
 434          * should use the block device creation/destruction hotplug
 435          * messages to tell when the card is present.
 436          */
 437
 438         sprintf(md->disk->disk_name, "mmcblk%d", devidx);
 439
 440         blk_queue_hardsect_size(md->queue.queue, 1 << md->block_bits);
 441
 442         /*
 443          * The CSD capacity field is in units of read_blkbits.
 444          * set_capacity takes units of 512 bytes.
 445          */
 446         set_capacity(md->disk, card->csd.capacity << (card->csd.read_blkbits - 9));
 447         return md;
 448
 449  err_putdisk:
 450         put_disk(md->disk);
 451  err_kfree:
 452         kfree(md);
 453  out:
 454         return ERR_PTR(ret);
 455 }
 456
 457 static int
 458 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
 459 {
 460         struct mmc_command cmd;
 461         int err;
 462
 463         mmc_card_claim_host(card);
 464         cmd.opcode = MMC_SET_BLOCKLEN;
 465         cmd.arg = 1 << md->block_bits;
 466         cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
 467         err = mmc_wait_for_cmd(card->host, &cmd, 5);
 468         mmc_card_release_host(card);
 469
 470         if (err) {
 471                 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
 472                         md->disk->disk_name, cmd.arg, err);
 473                 return -EINVAL;
 474         }
 475
 476         return 0;
 477 }
 478
 479 static int mmc_blk_probe(struct mmc_card *card)
 480 {
 481         struct mmc_blk_data *md;
 482         int err;
 483
 484         /*
 485          * Check that the card supports the command class(es) we need.
 486          */
 487         if (!(card->csd.cmdclass & CCC_BLOCK_READ))
 488                 return -ENODEV;
 489
 490         md = mmc_blk_alloc(card);
 491         if (IS_ERR(md))
 492                 return PTR_ERR(md);
 493
 494         err = mmc_blk_set_blksize(md, card);
 495         if (err)
 496                 goto out;
 497
 498         printk(KERN_INFO "%s: %s %s %lluKiB %s\n",
 499                 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
 500                 (unsigned long long)(get_capacity(md->disk) >> 1),
 501                 md->read_only ? "(ro)" : "");
 502
 503         mmc_set_drvdata(card, md);
 504         add_disk(md->disk);
 505         return 0;
 506
 507  out:
 508         mmc_blk_put(md);
 509
 510         return err;
 511 }
 512
 513 static void mmc_blk_remove(struct mmc_card *card)
 514 {
 515         struct mmc_blk_data *md = mmc_get_drvdata(card);
 516
 517         if (md) {
 518                 int devidx;
 519
 520                 del_gendisk(md->disk);
 521
 522                 /*
 523                  * I think this is needed.
 524                  */
 525                 md->disk->queue = NULL;
 526
 527                 devidx = md->disk->first_minor >> MMC_SHIFT;
 528                 __clear_bit(devidx, dev_use);
 529
 530                 mmc_blk_put(md);
 531         }
 532         mmc_set_drvdata(card, NULL);
 533 }
 534
 535 #ifdef CONFIG_PM
 536 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
 537 {
 538         struct mmc_blk_data *md = mmc_get_drvdata(card);
 539
 540         if (md) {
 541                 mmc_queue_suspend(&md->queue);
 542         }
 543         return 0;
 544 }
 545
 546 static int mmc_blk_resume(struct mmc_card *card)
 547 {
 548         struct mmc_blk_data *md = mmc_get_drvdata(card);
 549
 550         if (md) {
 551                 mmc_blk_set_blksize(md, card);
 552                 mmc_queue_resume(&md->queue);
 553         }
 554         return 0;
 555 }
 556 #else
 557 #define mmc_blk_suspend NULL
 558 #define mmc_blk_resume  NULL
 559 #endif
 560
 561 static struct mmc_driver mmc_driver = {
 562         .drv            = {
 563                 .name   = "mmcblk",
 564         },
 565         .probe          = mmc_blk_probe,
 566         .remove         = mmc_blk_remove,
 567         .suspend        = mmc_blk_suspend,
 568         .resume         = mmc_blk_resume,
 569 };
 570
 571 static int __init mmc_blk_init(void)
 572 {
 573         int res = -ENOMEM;
 574
 575         res = register_blkdev(major, "mmc");
 576         if (res < 0) {
 577                 printk(KERN_WARNING "Unable to get major %d for MMC media: %d\n",
 578                        major, res);
 579                 goto out;
 580         }
 581         if (major == 0)
 582                 major = res;
 583
 584         return mmc_register_driver(&mmc_driver);
 585
 586  out:
 587         return res;
 588 }
 589
 590 static void __exit mmc_blk_exit(void)
 591 {
 592         mmc_unregister_driver(&mmc_driver);
 593         unregister_blkdev(major, "mmc");
 594 }
 595
 596 module_init(mmc_blk_init);
 597 module_exit(mmc_blk_exit);
 598
 599 MODULE_LICENSE("GPL");
 600 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
 601
 602 module_param(major, int, 0444);
 603 MODULE_PARM_DESC(major, "specify the major device number for MMC block driver");