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