mmc: MMC 4.4 DDR support
[linux-2.6/cjktty.git] / drivers / mmc / card / block.c
blobaab593480975dea1f0f31143d4179fd6e3b7178b
1 /*
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
18 * 28 May 2002
20 #include <linux/moduleparam.h>
21 #include <linux/module.h>
22 #include <linux/init.h>
24 #include <linux/kernel.h>
25 #include <linux/fs.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/scatterlist.h>
33 #include <linux/string_helpers.h>
35 #include <linux/mmc/card.h>
36 #include <linux/mmc/host.h>
37 #include <linux/mmc/mmc.h>
38 #include <linux/mmc/sd.h>
40 #include <asm/system.h>
41 #include <asm/uaccess.h>
43 #include "queue.h"
45 MODULE_ALIAS("mmc:block");
48 * max 8 partitions per card
50 #define MMC_SHIFT 3
51 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
53 static DEFINE_MUTEX(block_mutex);
54 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
57 * There is one mmc_blk_data per slot.
59 struct mmc_blk_data {
60 spinlock_t lock;
61 struct gendisk *disk;
62 struct mmc_queue queue;
64 unsigned int usage;
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)
77 md = NULL;
78 if (md)
79 md->usage++;
80 mutex_unlock(&open_lock);
82 return md;
85 static void mmc_blk_put(struct mmc_blk_data *md)
87 mutex_lock(&open_lock);
88 md->usage--;
89 if (md->usage == 0) {
90 int devmaj = MAJOR(disk_devt(md->disk));
91 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
93 if (!devmaj)
94 devidx = md->disk->first_minor >> MMC_SHIFT;
96 blk_cleanup_queue(md->queue.queue);
98 __clear_bit(devidx, dev_use);
100 put_disk(md->disk);
101 kfree(md);
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);
109 int ret = -ENXIO;
111 mutex_lock(&block_mutex);
112 if (md) {
113 if (md->usage == 2)
114 check_disk_change(bdev);
115 ret = 0;
117 if ((mode & FMODE_WRITE) && md->read_only) {
118 mmc_blk_put(md);
119 ret = -EROFS;
122 mutex_unlock(&block_mutex);
124 return ret;
127 static int mmc_blk_release(struct gendisk *disk, fmode_t mode)
129 struct mmc_blk_data *md = disk->private_data;
131 mutex_lock(&block_mutex);
132 mmc_blk_put(md);
133 mutex_unlock(&block_mutex);
134 return 0;
137 static int
138 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
140 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
141 geo->heads = 4;
142 geo->sectors = 16;
143 return 0;
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)
162 int err;
163 u32 result;
164 __be32 *blocks;
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);
180 if (err)
181 return (u32)-1;
182 if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
183 return (u32)-1;
185 memset(&cmd, 0, sizeof(struct mmc_command));
187 cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
188 cmd.arg = 0;
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;
205 data.blksz = 4;
206 data.blocks = 1;
207 data.flags = MMC_DATA_READ;
208 data.sg = &sg;
209 data.sg_len = 1;
211 memset(&mrq, 0, sizeof(struct mmc_request));
213 mrq.cmd = &cmd;
214 mrq.data = &data;
216 blocks = kmalloc(4, GFP_KERNEL);
217 if (!blocks)
218 return (u32)-1;
220 sg_init_one(&sg, blocks, 4);
222 mmc_wait_for_req(card->host, &mrq);
224 result = ntohl(*blocks);
225 kfree(blocks);
227 if (cmd.error || data.error)
228 result = (u32)-1;
230 return result;
233 static u32 get_card_status(struct mmc_card *card, struct request *req)
235 struct mmc_command cmd;
236 int err;
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);
244 if (err)
245 printk(KERN_ERR "%s: error %d sending status comand",
246 req->rq_disk->disk_name, err);
247 return cmd.resp[0];
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;
255 int err = 0;
257 mmc_claim_host(card->host);
259 if (!mmc_can_erase(card)) {
260 err = -EOPNOTSUPP;
261 goto out;
264 from = blk_rq_pos(req);
265 nr = blk_rq_sectors(req);
267 if (mmc_can_trim(card))
268 arg = MMC_TRIM_ARG;
269 else
270 arg = MMC_ERASE_ARG;
272 err = mmc_erase(card, from, nr, arg);
273 out:
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);
280 return err ? 0 : 1;
283 static int mmc_blk_issue_secdiscard_rq(struct mmc_queue *mq,
284 struct request *req)
286 struct mmc_blk_data *md = mq->data;
287 struct mmc_card *card = md->queue.card;
288 unsigned int from, nr, arg;
289 int err = 0;
291 mmc_claim_host(card->host);
293 if (!mmc_can_secure_erase_trim(card)) {
294 err = -EOPNOTSUPP;
295 goto out;
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;
303 else
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);
309 out:
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);
316 return err ? 0 : 1;
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);
328 do {
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))
338 brq.cmd.arg <<= 9;
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;
342 brq.stop.arg = 0;
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
349 * requests.
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
357 * successfully.
359 if (disable_multi && brq.data.blocks > 1)
360 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;
371 } else {
372 brq.mrq.stop = NULL;
373 readcmd = MMC_READ_SINGLE_BLOCK;
374 writecmd = MMC_WRITE_BLOCK;
376 if (mmc_card_ddr_mode(card))
377 brq.data.flags |= MMC_DDR_MODE;
378 if (rq_data_dir(req) == READ) {
379 brq.cmd.opcode = readcmd;
380 brq.data.flags |= MMC_DATA_READ;
381 } else {
382 brq.cmd.opcode = writecmd;
383 brq.data.flags |= MMC_DATA_WRITE;
386 mmc_set_data_timeout(&brq.data, card);
388 brq.data.sg = mq->sg;
389 brq.data.sg_len = mmc_queue_map_sg(mq);
392 * Adjust the sg list so it is the same size as the
393 * request.
395 if (brq.data.blocks != blk_rq_sectors(req)) {
396 int i, data_size = brq.data.blocks << 9;
397 struct scatterlist *sg;
399 for_each_sg(brq.data.sg, sg, brq.data.sg_len, i) {
400 data_size -= sg->length;
401 if (data_size <= 0) {
402 sg->length += data_size;
403 i++;
404 break;
407 brq.data.sg_len = i;
410 mmc_queue_bounce_pre(mq);
412 mmc_wait_for_req(card->host, &brq.mrq);
414 mmc_queue_bounce_post(mq);
417 * Check for errors here, but don't jump to cmd_err
418 * until later as we need to wait for the card to leave
419 * programming mode even when things go wrong.
421 if (brq.cmd.error || brq.data.error || brq.stop.error) {
422 if (brq.data.blocks > 1 && rq_data_dir(req) == READ) {
423 /* Redo read one sector at a time */
424 printk(KERN_WARNING "%s: retrying using single "
425 "block read\n", req->rq_disk->disk_name);
426 disable_multi = 1;
427 continue;
429 status = get_card_status(card, req);
432 if (brq.cmd.error) {
433 printk(KERN_ERR "%s: error %d sending read/write "
434 "command, response %#x, card status %#x\n",
435 req->rq_disk->disk_name, brq.cmd.error,
436 brq.cmd.resp[0], status);
439 if (brq.data.error) {
440 if (brq.data.error == -ETIMEDOUT && brq.mrq.stop)
441 /* 'Stop' response contains card status */
442 status = brq.mrq.stop->resp[0];
443 printk(KERN_ERR "%s: error %d transferring data,"
444 " sector %u, nr %u, card status %#x\n",
445 req->rq_disk->disk_name, brq.data.error,
446 (unsigned)blk_rq_pos(req),
447 (unsigned)blk_rq_sectors(req), status);
450 if (brq.stop.error) {
451 printk(KERN_ERR "%s: error %d sending stop command, "
452 "response %#x, card status %#x\n",
453 req->rq_disk->disk_name, brq.stop.error,
454 brq.stop.resp[0], status);
457 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
458 do {
459 int err;
461 cmd.opcode = MMC_SEND_STATUS;
462 cmd.arg = card->rca << 16;
463 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
464 err = mmc_wait_for_cmd(card->host, &cmd, 5);
465 if (err) {
466 printk(KERN_ERR "%s: error %d requesting status\n",
467 req->rq_disk->disk_name, err);
468 goto cmd_err;
471 * Some cards mishandle the status bits,
472 * so make sure to check both the busy
473 * indication and the card state.
475 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
476 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
478 #if 0
479 if (cmd.resp[0] & ~0x00000900)
480 printk(KERN_ERR "%s: status = %08x\n",
481 req->rq_disk->disk_name, cmd.resp[0]);
482 if (mmc_decode_status(cmd.resp))
483 goto cmd_err;
484 #endif
487 if (brq.cmd.error || brq.stop.error || brq.data.error) {
488 if (rq_data_dir(req) == READ) {
490 * After an error, we redo I/O one sector at a
491 * time, so we only reach here after trying to
492 * read a single sector.
494 spin_lock_irq(&md->lock);
495 ret = __blk_end_request(req, -EIO, brq.data.blksz);
496 spin_unlock_irq(&md->lock);
497 continue;
499 goto cmd_err;
503 * A block was successfully transferred.
505 spin_lock_irq(&md->lock);
506 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
507 spin_unlock_irq(&md->lock);
508 } while (ret);
510 mmc_release_host(card->host);
512 return 1;
514 cmd_err:
516 * If this is an SD card and we're writing, we can first
517 * mark the known good sectors as ok.
519 * If the card is not SD, we can still ok written sectors
520 * as reported by the controller (which might be less than
521 * the real number of written sectors, but never more).
523 if (mmc_card_sd(card)) {
524 u32 blocks;
526 blocks = mmc_sd_num_wr_blocks(card);
527 if (blocks != (u32)-1) {
528 spin_lock_irq(&md->lock);
529 ret = __blk_end_request(req, 0, blocks << 9);
530 spin_unlock_irq(&md->lock);
532 } else {
533 spin_lock_irq(&md->lock);
534 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
535 spin_unlock_irq(&md->lock);
538 mmc_release_host(card->host);
540 spin_lock_irq(&md->lock);
541 while (ret)
542 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
543 spin_unlock_irq(&md->lock);
545 return 0;
548 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
550 if (req->cmd_flags & REQ_DISCARD) {
551 if (req->cmd_flags & REQ_SECURE)
552 return mmc_blk_issue_secdiscard_rq(mq, req);
553 else
554 return mmc_blk_issue_discard_rq(mq, req);
555 } else {
556 return mmc_blk_issue_rw_rq(mq, req);
560 static inline int mmc_blk_readonly(struct mmc_card *card)
562 return mmc_card_readonly(card) ||
563 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
566 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
568 struct mmc_blk_data *md;
569 int devidx, ret;
571 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
572 if (devidx >= MMC_NUM_MINORS)
573 return ERR_PTR(-ENOSPC);
574 __set_bit(devidx, dev_use);
576 md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
577 if (!md) {
578 ret = -ENOMEM;
579 goto out;
584 * Set the read-only status based on the supported commands
585 * and the write protect switch.
587 md->read_only = mmc_blk_readonly(card);
589 md->disk = alloc_disk(1 << MMC_SHIFT);
590 if (md->disk == NULL) {
591 ret = -ENOMEM;
592 goto err_kfree;
595 spin_lock_init(&md->lock);
596 md->usage = 1;
598 ret = mmc_init_queue(&md->queue, card, &md->lock);
599 if (ret)
600 goto err_putdisk;
602 md->queue.issue_fn = mmc_blk_issue_rq;
603 md->queue.data = md;
605 md->disk->major = MMC_BLOCK_MAJOR;
606 md->disk->first_minor = devidx << MMC_SHIFT;
607 md->disk->fops = &mmc_bdops;
608 md->disk->private_data = md;
609 md->disk->queue = md->queue.queue;
610 md->disk->driverfs_dev = &card->dev;
613 * As discussed on lkml, GENHD_FL_REMOVABLE should:
615 * - be set for removable media with permanent block devices
616 * - be unset for removable block devices with permanent media
618 * Since MMC block devices clearly fall under the second
619 * case, we do not set GENHD_FL_REMOVABLE. Userspace
620 * should use the block device creation/destruction hotplug
621 * messages to tell when the card is present.
624 snprintf(md->disk->disk_name, sizeof(md->disk->disk_name),
625 "mmcblk%d", devidx);
627 blk_queue_logical_block_size(md->queue.queue, 512);
629 if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
631 * The EXT_CSD sector count is in number or 512 byte
632 * sectors.
634 set_capacity(md->disk, card->ext_csd.sectors);
635 } else {
637 * The CSD capacity field is in units of read_blkbits.
638 * set_capacity takes units of 512 bytes.
640 set_capacity(md->disk,
641 card->csd.capacity << (card->csd.read_blkbits - 9));
643 return md;
645 err_putdisk:
646 put_disk(md->disk);
647 err_kfree:
648 kfree(md);
649 out:
650 return ERR_PTR(ret);
653 static int
654 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
656 struct mmc_command cmd;
657 int err;
660 * Block-addressed and ddr mode supported cards
661 * ignore MMC_SET_BLOCKLEN.
663 if (mmc_card_blockaddr(card) || mmc_card_ddr_mode(card))
664 return 0;
666 mmc_claim_host(card->host);
667 cmd.opcode = MMC_SET_BLOCKLEN;
668 cmd.arg = 512;
669 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
670 err = mmc_wait_for_cmd(card->host, &cmd, 5);
671 mmc_release_host(card->host);
673 if (err) {
674 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
675 md->disk->disk_name, cmd.arg, err);
676 return -EINVAL;
679 return 0;
682 static int mmc_blk_probe(struct mmc_card *card)
684 struct mmc_blk_data *md;
685 int err;
687 char cap_str[10];
690 * Check that the card supports the command class(es) we need.
692 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
693 return -ENODEV;
695 md = mmc_blk_alloc(card);
696 if (IS_ERR(md))
697 return PTR_ERR(md);
699 err = mmc_blk_set_blksize(md, card);
700 if (err)
701 goto out;
703 string_get_size((u64)get_capacity(md->disk) << 9, STRING_UNITS_2,
704 cap_str, sizeof(cap_str));
705 printk(KERN_INFO "%s: %s %s %s %s\n",
706 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
707 cap_str, md->read_only ? "(ro)" : "");
709 mmc_set_drvdata(card, md);
710 add_disk(md->disk);
711 return 0;
713 out:
714 mmc_cleanup_queue(&md->queue);
715 mmc_blk_put(md);
717 return err;
720 static void mmc_blk_remove(struct mmc_card *card)
722 struct mmc_blk_data *md = mmc_get_drvdata(card);
724 if (md) {
725 /* Stop new requests from getting into the queue */
726 del_gendisk(md->disk);
728 /* Then flush out any already in there */
729 mmc_cleanup_queue(&md->queue);
731 mmc_blk_put(md);
733 mmc_set_drvdata(card, NULL);
736 #ifdef CONFIG_PM
737 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
739 struct mmc_blk_data *md = mmc_get_drvdata(card);
741 if (md) {
742 mmc_queue_suspend(&md->queue);
744 return 0;
747 static int mmc_blk_resume(struct mmc_card *card)
749 struct mmc_blk_data *md = mmc_get_drvdata(card);
751 if (md) {
752 mmc_blk_set_blksize(md, card);
753 mmc_queue_resume(&md->queue);
755 return 0;
757 #else
758 #define mmc_blk_suspend NULL
759 #define mmc_blk_resume NULL
760 #endif
762 static struct mmc_driver mmc_driver = {
763 .drv = {
764 .name = "mmcblk",
766 .probe = mmc_blk_probe,
767 .remove = mmc_blk_remove,
768 .suspend = mmc_blk_suspend,
769 .resume = mmc_blk_resume,
772 static int __init mmc_blk_init(void)
774 int res;
776 res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
777 if (res)
778 goto out;
780 res = mmc_register_driver(&mmc_driver);
781 if (res)
782 goto out2;
784 return 0;
785 out2:
786 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
787 out:
788 return res;
791 static void __exit mmc_blk_exit(void)
793 mmc_unregister_driver(&mmc_driver);
794 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
797 module_init(mmc_blk_init);
798 module_exit(mmc_blk_exit);
800 MODULE_LICENSE("GPL");
801 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");