2 * Block driver for media (i.e., flash cards)
4 * Copyright 2002 Hewlett-Packard Company
5 * Copyright 2005-2008 Pierre Ossman
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.
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.
15 * Many thanks to Alessandro Rubini and Jonathan Corbet!
17 * Author: Andrew Christian
20 #include <linux/moduleparam.h>
21 #include <linux/module.h>
22 #include <linux/init.h>
24 #include <linux/kernel.h>
26 #include <linux/slab.h>
27 #include <linux/errno.h>
28 #include <linux/hdreg.h>
29 #include <linux/kdev_t.h>
30 #include <linux/blkdev.h>
31 #include <linux/mutex.h>
32 #include <linux/smp_lock.h>
33 #include <linux/scatterlist.h>
34 #include <linux/string_helpers.h>
36 #include <linux/mmc/card.h>
37 #include <linux/mmc/host.h>
38 #include <linux/mmc/mmc.h>
39 #include <linux/mmc/sd.h>
41 #include <asm/system.h>
42 #include <asm/uaccess.h>
46 MODULE_ALIAS("mmc:block");
49 * max 8 partitions per card
52 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
54 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
57 * There is one mmc_blk_data per slot.
62 struct mmc_queue queue;
65 unsigned int read_only;
68 static DEFINE_MUTEX(open_lock);
70 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
72 struct mmc_blk_data *md;
74 mutex_lock(&open_lock);
75 md = disk->private_data;
76 if (md && md->usage == 0)
80 mutex_unlock(&open_lock);
85 static void mmc_blk_put(struct mmc_blk_data *md)
87 mutex_lock(&open_lock);
90 int devmaj = MAJOR(disk_devt(md->disk));
91 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
94 devidx = md->disk->first_minor >> MMC_SHIFT;
96 blk_cleanup_queue(md->queue.queue);
98 __clear_bit(devidx, dev_use);
103 mutex_unlock(&open_lock);
106 static int mmc_blk_open(struct block_device *bdev, fmode_t mode)
108 struct mmc_blk_data *md = mmc_blk_get(bdev->bd_disk);
114 check_disk_change(bdev);
117 if ((mode & FMODE_WRITE) && md->read_only) {
127 static int mmc_blk_release(struct gendisk *disk, fmode_t mode)
129 struct mmc_blk_data *md = disk->private_data;
138 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
140 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
146 static const struct block_device_operations mmc_bdops = {
147 .open = mmc_blk_open,
148 .release = mmc_blk_release,
149 .getgeo = mmc_blk_getgeo,
150 .owner = THIS_MODULE,
153 struct mmc_blk_request {
154 struct mmc_request mrq;
155 struct mmc_command cmd;
156 struct mmc_command stop;
157 struct mmc_data data;
160 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
166 struct mmc_request mrq;
167 struct mmc_command cmd;
168 struct mmc_data data;
169 unsigned int timeout_us;
171 struct scatterlist sg;
173 memset(&cmd, 0, sizeof(struct mmc_command));
175 cmd.opcode = MMC_APP_CMD;
176 cmd.arg = card->rca << 16;
177 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
179 err = mmc_wait_for_cmd(card->host, &cmd, 0);
182 if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
185 memset(&cmd, 0, sizeof(struct mmc_command));
187 cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
189 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
191 memset(&data, 0, sizeof(struct mmc_data));
193 data.timeout_ns = card->csd.tacc_ns * 100;
194 data.timeout_clks = card->csd.tacc_clks * 100;
196 timeout_us = data.timeout_ns / 1000;
197 timeout_us += data.timeout_clks * 1000 /
198 (card->host->ios.clock / 1000);
200 if (timeout_us > 100000) {
201 data.timeout_ns = 100000000;
202 data.timeout_clks = 0;
207 data.flags = MMC_DATA_READ;
211 memset(&mrq, 0, sizeof(struct mmc_request));
216 blocks = kmalloc(4, GFP_KERNEL);
220 sg_init_one(&sg, blocks, 4);
222 mmc_wait_for_req(card->host, &mrq);
224 result = ntohl(*blocks);
227 if (cmd.error || data.error)
233 static u32 get_card_status(struct mmc_card *card, struct request *req)
235 struct mmc_command cmd;
238 memset(&cmd, 0, sizeof(struct mmc_command));
239 cmd.opcode = MMC_SEND_STATUS;
240 if (!mmc_host_is_spi(card->host))
241 cmd.arg = card->rca << 16;
242 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
243 err = mmc_wait_for_cmd(card->host, &cmd, 0);
245 printk(KERN_ERR "%s: error %d sending status comand",
246 req->rq_disk->disk_name, err);
250 static int mmc_blk_issue_discard_rq(struct mmc_queue *mq, struct request *req)
252 struct mmc_blk_data *md = mq->data;
253 struct mmc_card *card = md->queue.card;
254 unsigned int from, nr, arg;
257 mmc_claim_host(card->host);
259 if (!mmc_can_erase(card)) {
264 from = blk_rq_pos(req);
265 nr = blk_rq_sectors(req);
267 if (mmc_can_trim(card))
272 err = mmc_erase(card, from, nr, arg);
274 spin_lock_irq(&md->lock);
275 __blk_end_request(req, err, blk_rq_bytes(req));
276 spin_unlock_irq(&md->lock);
278 mmc_release_host(card->host);
283 static int mmc_blk_issue_secdiscard_rq(struct mmc_queue *mq,
286 struct mmc_blk_data *md = mq->data;
287 struct mmc_card *card = md->queue.card;
288 unsigned int from, nr, arg;
291 mmc_claim_host(card->host);
293 if (!mmc_can_secure_erase_trim(card)) {
298 from = blk_rq_pos(req);
299 nr = blk_rq_sectors(req);
301 if (mmc_can_trim(card) && !mmc_erase_group_aligned(card, from, nr))
302 arg = MMC_SECURE_TRIM1_ARG;
304 arg = MMC_SECURE_ERASE_ARG;
306 err = mmc_erase(card, from, nr, arg);
307 if (!err && arg == MMC_SECURE_TRIM1_ARG)
308 err = mmc_erase(card, from, nr, MMC_SECURE_TRIM2_ARG);
310 spin_lock_irq(&md->lock);
311 __blk_end_request(req, err, blk_rq_bytes(req));
312 spin_unlock_irq(&md->lock);
314 mmc_release_host(card->host);
319 static int mmc_blk_issue_rw_rq(struct mmc_queue *mq, struct request *req)
321 struct mmc_blk_data *md = mq->data;
322 struct mmc_card *card = md->queue.card;
323 struct mmc_blk_request brq;
324 int ret = 1, disable_multi = 0;
326 mmc_claim_host(card->host);
329 struct mmc_command cmd;
330 u32 readcmd, writecmd, status = 0;
332 memset(&brq, 0, sizeof(struct mmc_blk_request));
333 brq.mrq.cmd = &brq.cmd;
334 brq.mrq.data = &brq.data;
336 brq.cmd.arg = blk_rq_pos(req);
337 if (!mmc_card_blockaddr(card))
339 brq.cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
340 brq.data.blksz = 512;
341 brq.stop.opcode = MMC_STOP_TRANSMISSION;
343 brq.stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
344 brq.data.blocks = blk_rq_sectors(req);
347 * The block layer doesn't support all sector count
348 * restrictions, so we need to be prepared for too big
351 if (brq.data.blocks > card->host->max_blk_count)
352 brq.data.blocks = card->host->max_blk_count;
355 * After a read error, we redo the request one sector at a time
356 * in order to accurately determine which sectors can be read
359 if (disable_multi && brq.data.blocks > 1)
362 if (brq.data.blocks > 1) {
363 /* SPI multiblock writes terminate using a special
364 * token, not a STOP_TRANSMISSION request.
366 if (!mmc_host_is_spi(card->host)
367 || rq_data_dir(req) == READ)
368 brq.mrq.stop = &brq.stop;
369 readcmd = MMC_READ_MULTIPLE_BLOCK;
370 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
373 readcmd = MMC_READ_SINGLE_BLOCK;
374 writecmd = MMC_WRITE_BLOCK;
377 if (rq_data_dir(req) == READ) {
378 brq.cmd.opcode = readcmd;
379 brq.data.flags |= MMC_DATA_READ;
381 brq.cmd.opcode = writecmd;
382 brq.data.flags |= MMC_DATA_WRITE;
385 mmc_set_data_timeout(&brq.data, card);
387 brq.data.sg = mq->sg;
388 brq.data.sg_len = mmc_queue_map_sg(mq);
391 * Adjust the sg list so it is the same size as the
394 if (brq.data.blocks != blk_rq_sectors(req)) {
395 int i, data_size = brq.data.blocks << 9;
396 struct scatterlist *sg;
398 for_each_sg(brq.data.sg, sg, brq.data.sg_len, i) {
399 data_size -= sg->length;
400 if (data_size <= 0) {
401 sg->length += data_size;
409 mmc_queue_bounce_pre(mq);
411 mmc_wait_for_req(card->host, &brq.mrq);
413 mmc_queue_bounce_post(mq);
416 * Check for errors here, but don't jump to cmd_err
417 * until later as we need to wait for the card to leave
418 * programming mode even when things go wrong.
420 if (brq.cmd.error || brq.data.error || brq.stop.error) {
421 if (brq.data.blocks > 1 && rq_data_dir(req) == READ) {
422 /* Redo read one sector at a time */
423 printk(KERN_WARNING "%s: retrying using single "
424 "block read\n", req->rq_disk->disk_name);
428 status = get_card_status(card, req);
432 printk(KERN_ERR "%s: error %d sending read/write "
433 "command, response %#x, card status %#x\n",
434 req->rq_disk->disk_name, brq.cmd.error,
435 brq.cmd.resp[0], status);
438 if (brq.data.error) {
439 if (brq.data.error == -ETIMEDOUT && brq.mrq.stop)
440 /* 'Stop' response contains card status */
441 status = brq.mrq.stop->resp[0];
442 printk(KERN_ERR "%s: error %d transferring data,"
443 " sector %u, nr %u, card status %#x\n",
444 req->rq_disk->disk_name, brq.data.error,
445 (unsigned)blk_rq_pos(req),
446 (unsigned)blk_rq_sectors(req), status);
449 if (brq.stop.error) {
450 printk(KERN_ERR "%s: error %d sending stop command, "
451 "response %#x, card status %#x\n",
452 req->rq_disk->disk_name, brq.stop.error,
453 brq.stop.resp[0], status);
456 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
460 cmd.opcode = MMC_SEND_STATUS;
461 cmd.arg = card->rca << 16;
462 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
463 err = mmc_wait_for_cmd(card->host, &cmd, 5);
465 printk(KERN_ERR "%s: error %d requesting status\n",
466 req->rq_disk->disk_name, err);
470 * Some cards mishandle the status bits,
471 * so make sure to check both the busy
472 * indication and the card state.
474 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
475 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
478 if (cmd.resp[0] & ~0x00000900)
479 printk(KERN_ERR "%s: status = %08x\n",
480 req->rq_disk->disk_name, cmd.resp[0]);
481 if (mmc_decode_status(cmd.resp))
486 if (brq.cmd.error || brq.stop.error || brq.data.error) {
487 if (rq_data_dir(req) == READ) {
489 * After an error, we redo I/O one sector at a
490 * time, so we only reach here after trying to
491 * read a single sector.
493 spin_lock_irq(&md->lock);
494 ret = __blk_end_request(req, -EIO, brq.data.blksz);
495 spin_unlock_irq(&md->lock);
502 * A block was successfully transferred.
504 spin_lock_irq(&md->lock);
505 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
506 spin_unlock_irq(&md->lock);
509 mmc_release_host(card->host);
515 * If this is an SD card and we're writing, we can first
516 * mark the known good sectors as ok.
518 * If the card is not SD, we can still ok written sectors
519 * as reported by the controller (which might be less than
520 * the real number of written sectors, but never more).
522 if (mmc_card_sd(card)) {
525 blocks = mmc_sd_num_wr_blocks(card);
526 if (blocks != (u32)-1) {
527 spin_lock_irq(&md->lock);
528 ret = __blk_end_request(req, 0, blocks << 9);
529 spin_unlock_irq(&md->lock);
532 spin_lock_irq(&md->lock);
533 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
534 spin_unlock_irq(&md->lock);
537 mmc_release_host(card->host);
539 spin_lock_irq(&md->lock);
541 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
542 spin_unlock_irq(&md->lock);
547 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
549 if (req->cmd_flags & REQ_DISCARD) {
550 if (req->cmd_flags & REQ_SECURE)
551 return mmc_blk_issue_secdiscard_rq(mq, req);
553 return mmc_blk_issue_discard_rq(mq, req);
555 return mmc_blk_issue_rw_rq(mq, req);
559 static inline int mmc_blk_readonly(struct mmc_card *card)
561 return mmc_card_readonly(card) ||
562 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
565 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
567 struct mmc_blk_data *md;
570 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
571 if (devidx >= MMC_NUM_MINORS)
572 return ERR_PTR(-ENOSPC);
573 __set_bit(devidx, dev_use);
575 md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
583 * Set the read-only status based on the supported commands
584 * and the write protect switch.
586 md->read_only = mmc_blk_readonly(card);
588 md->disk = alloc_disk(1 << MMC_SHIFT);
589 if (md->disk == NULL) {
594 spin_lock_init(&md->lock);
597 ret = mmc_init_queue(&md->queue, card, &md->lock);
601 md->queue.issue_fn = mmc_blk_issue_rq;
604 md->disk->major = MMC_BLOCK_MAJOR;
605 md->disk->first_minor = devidx << MMC_SHIFT;
606 md->disk->fops = &mmc_bdops;
607 md->disk->private_data = md;
608 md->disk->queue = md->queue.queue;
609 md->disk->driverfs_dev = &card->dev;
612 * As discussed on lkml, GENHD_FL_REMOVABLE should:
614 * - be set for removable media with permanent block devices
615 * - be unset for removable block devices with permanent media
617 * Since MMC block devices clearly fall under the second
618 * case, we do not set GENHD_FL_REMOVABLE. Userspace
619 * should use the block device creation/destruction hotplug
620 * messages to tell when the card is present.
623 sprintf(md->disk->disk_name, "mmcblk%d", devidx);
625 blk_queue_logical_block_size(md->queue.queue, 512);
627 if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
629 * The EXT_CSD sector count is in number or 512 byte
632 set_capacity(md->disk, card->ext_csd.sectors);
635 * The CSD capacity field is in units of read_blkbits.
636 * set_capacity takes units of 512 bytes.
638 set_capacity(md->disk,
639 card->csd.capacity << (card->csd.read_blkbits - 9));
652 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
654 struct mmc_command cmd;
657 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
658 if (mmc_card_blockaddr(card))
661 mmc_claim_host(card->host);
662 cmd.opcode = MMC_SET_BLOCKLEN;
664 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
665 err = mmc_wait_for_cmd(card->host, &cmd, 5);
666 mmc_release_host(card->host);
669 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
670 md->disk->disk_name, cmd.arg, err);
677 static int mmc_blk_probe(struct mmc_card *card)
679 struct mmc_blk_data *md;
685 * Check that the card supports the command class(es) we need.
687 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
690 md = mmc_blk_alloc(card);
694 err = mmc_blk_set_blksize(md, card);
698 string_get_size((u64)get_capacity(md->disk) << 9, STRING_UNITS_2,
699 cap_str, sizeof(cap_str));
700 printk(KERN_INFO "%s: %s %s %s %s\n",
701 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
702 cap_str, md->read_only ? "(ro)" : "");
704 mmc_set_drvdata(card, md);
709 mmc_cleanup_queue(&md->queue);
715 static void mmc_blk_remove(struct mmc_card *card)
717 struct mmc_blk_data *md = mmc_get_drvdata(card);
720 /* Stop new requests from getting into the queue */
721 del_gendisk(md->disk);
723 /* Then flush out any already in there */
724 mmc_cleanup_queue(&md->queue);
728 mmc_set_drvdata(card, NULL);
732 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
734 struct mmc_blk_data *md = mmc_get_drvdata(card);
737 mmc_queue_suspend(&md->queue);
742 static int mmc_blk_resume(struct mmc_card *card)
744 struct mmc_blk_data *md = mmc_get_drvdata(card);
747 mmc_blk_set_blksize(md, card);
748 mmc_queue_resume(&md->queue);
753 #define mmc_blk_suspend NULL
754 #define mmc_blk_resume NULL
757 static struct mmc_driver mmc_driver = {
761 .probe = mmc_blk_probe,
762 .remove = mmc_blk_remove,
763 .suspend = mmc_blk_suspend,
764 .resume = mmc_blk_resume,
767 static int __init mmc_blk_init(void)
771 res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
775 res = mmc_register_driver(&mmc_driver);
781 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
786 static void __exit mmc_blk_exit(void)
788 mmc_unregister_driver(&mmc_driver);
789 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
792 module_init(mmc_blk_init);
793 module_exit(mmc_blk_exit);
795 MODULE_LICENSE("GPL");
796 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");