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/errno.h>
27 #include <linux/hdreg.h>
28 #include <linux/kdev_t.h>
29 #include <linux/blkdev.h>
30 #include <linux/mutex.h>
31 #include <linux/scatterlist.h>
32 #include <linux/string_helpers.h>
34 #include <linux/mmc/card.h>
35 #include <linux/mmc/host.h>
36 #include <linux/mmc/mmc.h>
37 #include <linux/mmc/sd.h>
39 #include <asm/system.h>
40 #include <asm/uaccess.h>
44 MODULE_ALIAS("mmc:block");
47 * max 8 partitions per card
50 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
52 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
55 * There is one mmc_blk_data per slot.
60 struct mmc_queue queue;
63 unsigned int read_only;
66 static DEFINE_MUTEX(open_lock);
68 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
70 struct mmc_blk_data *md;
72 mutex_lock(&open_lock);
73 md = disk->private_data;
74 if (md && md->usage == 0)
78 mutex_unlock(&open_lock);
83 static void mmc_blk_put(struct mmc_blk_data *md)
85 mutex_lock(&open_lock);
88 int devmaj = MAJOR(disk_devt(md->disk));
89 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
92 devidx = md->disk->first_minor >> MMC_SHIFT;
94 blk_cleanup_queue(md->queue.queue);
96 __clear_bit(devidx, dev_use);
101 mutex_unlock(&open_lock);
104 static int mmc_blk_open(struct block_device *bdev, fmode_t mode)
106 struct mmc_blk_data *md = mmc_blk_get(bdev->bd_disk);
111 check_disk_change(bdev);
114 if ((mode & FMODE_WRITE) && md->read_only) {
123 static int mmc_blk_release(struct gendisk *disk, fmode_t mode)
125 struct mmc_blk_data *md = disk->private_data;
132 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
134 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
140 static const struct block_device_operations mmc_bdops = {
141 .open = mmc_blk_open,
142 .release = mmc_blk_release,
143 .getgeo = mmc_blk_getgeo,
144 .owner = THIS_MODULE,
147 struct mmc_blk_request {
148 struct mmc_request mrq;
149 struct mmc_command cmd;
150 struct mmc_command stop;
151 struct mmc_data data;
154 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
160 struct mmc_request mrq;
161 struct mmc_command cmd;
162 struct mmc_data data;
163 unsigned int timeout_us;
165 struct scatterlist sg;
167 memset(&cmd, 0, sizeof(struct mmc_command));
169 cmd.opcode = MMC_APP_CMD;
170 cmd.arg = card->rca << 16;
171 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
173 err = mmc_wait_for_cmd(card->host, &cmd, 0);
176 if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
179 memset(&cmd, 0, sizeof(struct mmc_command));
181 cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
183 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
185 memset(&data, 0, sizeof(struct mmc_data));
187 data.timeout_ns = card->csd.tacc_ns * 100;
188 data.timeout_clks = card->csd.tacc_clks * 100;
190 timeout_us = data.timeout_ns / 1000;
191 timeout_us += data.timeout_clks * 1000 /
192 (card->host->ios.clock / 1000);
194 if (timeout_us > 100000) {
195 data.timeout_ns = 100000000;
196 data.timeout_clks = 0;
201 data.flags = MMC_DATA_READ;
205 memset(&mrq, 0, sizeof(struct mmc_request));
210 blocks = kmalloc(4, GFP_KERNEL);
214 sg_init_one(&sg, blocks, 4);
216 mmc_wait_for_req(card->host, &mrq);
218 result = ntohl(*blocks);
221 if (cmd.error || data.error)
227 static u32 get_card_status(struct mmc_card *card, struct request *req)
229 struct mmc_command cmd;
232 memset(&cmd, 0, sizeof(struct mmc_command));
233 cmd.opcode = MMC_SEND_STATUS;
234 if (!mmc_host_is_spi(card->host))
235 cmd.arg = card->rca << 16;
236 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
237 err = mmc_wait_for_cmd(card->host, &cmd, 0);
239 printk(KERN_DEBUG "%s: error %d sending status comand",
240 req->rq_disk->disk_name, err);
245 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
247 struct mmc_command cmd;
250 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
251 if (mmc_card_blockaddr(card))
254 mmc_claim_host(card->host);
255 cmd.opcode = MMC_SET_BLOCKLEN;
257 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
258 err = mmc_wait_for_cmd(card->host, &cmd, 5);
259 mmc_release_host(card->host);
262 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
263 md->disk->disk_name, cmd.arg, err);
271 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
273 struct mmc_blk_data *md = mq->data;
274 struct mmc_card *card = md->queue.card;
275 struct mmc_blk_request brq;
276 int ret = 1, disable_multi = 0;
278 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
279 if (mmc_bus_needs_resume(card->host)) {
280 mmc_resume_bus(card->host);
281 mmc_blk_set_blksize(md, card);
285 mmc_claim_host(card->host);
288 struct mmc_command cmd;
289 u32 readcmd, writecmd, status = 0;
291 memset(&brq, 0, sizeof(struct mmc_blk_request));
292 brq.mrq.cmd = &brq.cmd;
293 brq.mrq.data = &brq.data;
295 brq.cmd.arg = blk_rq_pos(req);
296 if (!mmc_card_blockaddr(card))
298 brq.cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
299 brq.data.blksz = 512;
300 brq.stop.opcode = MMC_STOP_TRANSMISSION;
302 brq.stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
303 brq.data.blocks = blk_rq_sectors(req);
306 * The block layer doesn't support all sector count
307 * restrictions, so we need to be prepared for too big
310 if (brq.data.blocks > card->host->max_blk_count)
311 brq.data.blocks = card->host->max_blk_count;
314 * After a read error, we redo the request one sector at a time
315 * in order to accurately determine which sectors can be read
318 if (disable_multi && brq.data.blocks > 1)
321 if (brq.data.blocks > 1) {
322 /* SPI multiblock writes terminate using a special
323 * token, not a STOP_TRANSMISSION request.
325 if (!mmc_host_is_spi(card->host)
326 || rq_data_dir(req) == READ)
327 brq.mrq.stop = &brq.stop;
328 readcmd = MMC_READ_MULTIPLE_BLOCK;
329 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
332 readcmd = MMC_READ_SINGLE_BLOCK;
333 writecmd = MMC_WRITE_BLOCK;
336 if (rq_data_dir(req) == READ) {
337 brq.cmd.opcode = readcmd;
338 brq.data.flags |= MMC_DATA_READ;
340 brq.cmd.opcode = writecmd;
341 brq.data.flags |= MMC_DATA_WRITE;
344 mmc_set_data_timeout(&brq.data, card);
346 brq.data.sg = mq->sg;
347 brq.data.sg_len = mmc_queue_map_sg(mq);
350 * Adjust the sg list so it is the same size as the
353 if (brq.data.blocks != blk_rq_sectors(req)) {
354 int i, data_size = brq.data.blocks << 9;
355 struct scatterlist *sg;
357 for_each_sg(brq.data.sg, sg, brq.data.sg_len, i) {
358 data_size -= sg->length;
359 if (data_size <= 0) {
360 sg->length += data_size;
368 mmc_queue_bounce_pre(mq);
370 mmc_wait_for_req(card->host, &brq.mrq);
372 mmc_queue_bounce_post(mq);
375 * Check for errors here, but don't jump to cmd_err
376 * until later as we need to wait for the card to leave
377 * programming mode even when things go wrong.
379 if (brq.cmd.error || brq.data.error || brq.stop.error) {
380 if (brq.data.blocks > 1 && rq_data_dir(req) == READ) {
381 /* Redo read one sector at a time */
382 printk(KERN_DEBUG "%s: retrying using single "
383 "block read\n", req->rq_disk->disk_name);
387 status = get_card_status(card, req);
388 } else if (disable_multi == 1) {
393 printk(KERN_DEBUG "%s: error %d sending read/write "
394 "command, response %#x, card status %#x\n",
395 req->rq_disk->disk_name, brq.cmd.error,
396 brq.cmd.resp[0], status);
399 if (brq.data.error) {
400 if (brq.data.error == -ETIMEDOUT && brq.mrq.stop)
401 /* 'Stop' response contains card status */
402 status = brq.mrq.stop->resp[0];
403 printk(KERN_DEBUG "%s: error %d transferring data,"
404 " sector %u, nr %u, card status %#x\n",
405 req->rq_disk->disk_name, brq.data.error,
406 (unsigned)blk_rq_pos(req),
407 (unsigned)blk_rq_sectors(req), status);
410 if (brq.stop.error) {
411 printk(KERN_DEBUG "%s: error %d sending stop command, "
412 "response %#x, card status %#x\n",
413 req->rq_disk->disk_name, brq.stop.error,
414 brq.stop.resp[0], status);
417 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
421 cmd.opcode = MMC_SEND_STATUS;
422 cmd.arg = card->rca << 16;
423 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
424 err = mmc_wait_for_cmd(card->host, &cmd, 5);
426 printk(KERN_DEBUG "%s: error %d requesting status\n",
427 req->rq_disk->disk_name, err);
431 * Some cards mishandle the status bits,
432 * so make sure to check both the busy
433 * indication and the card state.
435 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
436 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
439 if (cmd.resp[0] & ~0x00000900)
440 printk(KERN_ERR "%s: status = %08x\n",
441 req->rq_disk->disk_name, cmd.resp[0]);
442 if (mmc_decode_status(cmd.resp))
447 if (brq.cmd.error || brq.stop.error || brq.data.error) {
448 if (rq_data_dir(req) == READ) {
450 * After an error, we redo I/O one sector at a
451 * time, so we only reach here after trying to
452 * read a single sector.
454 spin_lock_irq(&md->lock);
455 ret = __blk_end_request(req, -EIO, brq.data.blksz);
456 spin_unlock_irq(&md->lock);
463 * A block was successfully transferred.
465 spin_lock_irq(&md->lock);
466 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
467 spin_unlock_irq(&md->lock);
470 mmc_release_host(card->host);
476 * If this is an SD card and we're writing, we can first
477 * mark the known good sectors as ok.
479 * If the card is not SD, we can still ok written sectors
480 * as reported by the controller (which might be less than
481 * the real number of written sectors, but never more).
483 if (mmc_card_sd(card)) {
486 blocks = mmc_sd_num_wr_blocks(card);
487 if (blocks != (u32)-1) {
488 spin_lock_irq(&md->lock);
489 ret = __blk_end_request(req, 0, blocks << 9);
490 spin_unlock_irq(&md->lock);
493 spin_lock_irq(&md->lock);
494 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
495 spin_unlock_irq(&md->lock);
498 mmc_release_host(card->host);
500 spin_lock_irq(&md->lock);
502 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
503 spin_unlock_irq(&md->lock);
509 static inline int mmc_blk_readonly(struct mmc_card *card)
511 return mmc_card_readonly(card) ||
512 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
515 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
517 struct mmc_blk_data *md;
520 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
521 if (devidx >= MMC_NUM_MINORS)
522 return ERR_PTR(-ENOSPC);
523 __set_bit(devidx, dev_use);
525 md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
533 * Set the read-only status based on the supported commands
534 * and the write protect switch.
536 md->read_only = mmc_blk_readonly(card);
538 md->disk = alloc_disk(1 << MMC_SHIFT);
539 if (md->disk == NULL) {
544 spin_lock_init(&md->lock);
547 ret = mmc_init_queue(&md->queue, card, &md->lock);
551 md->queue.issue_fn = mmc_blk_issue_rq;
554 md->disk->major = MMC_BLOCK_MAJOR;
555 md->disk->first_minor = devidx << MMC_SHIFT;
556 md->disk->fops = &mmc_bdops;
557 md->disk->private_data = md;
558 md->disk->queue = md->queue.queue;
559 md->disk->driverfs_dev = &card->dev;
562 * As discussed on lkml, GENHD_FL_REMOVABLE should:
564 * - be set for removable media with permanent block devices
565 * - be unset for removable block devices with permanent media
567 * Since MMC block devices clearly fall under the second
568 * case, we do not set GENHD_FL_REMOVABLE. Userspace
569 * should use the block device creation/destruction hotplug
570 * messages to tell when the card is present.
573 sprintf(md->disk->disk_name, "mmcblk%d", devidx);
575 blk_queue_logical_block_size(md->queue.queue, 512);
577 if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
579 * The EXT_CSD sector count is in number or 512 byte
582 set_capacity(md->disk, card->ext_csd.sectors);
585 * The CSD capacity field is in units of read_blkbits.
586 * set_capacity takes units of 512 bytes.
588 set_capacity(md->disk,
589 card->csd.capacity << (card->csd.read_blkbits - 9));
601 static int mmc_blk_probe(struct mmc_card *card)
603 struct mmc_blk_data *md;
609 * Check that the card supports the command class(es) we need.
611 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
614 md = mmc_blk_alloc(card);
618 err = mmc_blk_set_blksize(md, card);
622 string_get_size((u64)get_capacity(md->disk) << 9, STRING_UNITS_2,
623 cap_str, sizeof(cap_str));
624 printk(KERN_INFO "%s: %s %s %s %s\n",
625 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
626 cap_str, md->read_only ? "(ro)" : "");
628 mmc_set_drvdata(card, md);
629 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
630 mmc_set_bus_resume_policy(card->host, 1);
636 mmc_cleanup_queue(&md->queue);
642 static void mmc_blk_remove(struct mmc_card *card)
644 struct mmc_blk_data *md = mmc_get_drvdata(card);
647 /* Stop new requests from getting into the queue */
648 del_gendisk(md->disk);
650 /* Then flush out any already in there */
651 mmc_cleanup_queue(&md->queue);
655 mmc_set_drvdata(card, NULL);
656 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
657 mmc_set_bus_resume_policy(card->host, 0);
662 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
664 struct mmc_blk_data *md = mmc_get_drvdata(card);
667 mmc_queue_suspend(&md->queue);
672 static int mmc_blk_resume(struct mmc_card *card)
674 struct mmc_blk_data *md = mmc_get_drvdata(card);
677 #ifndef CONFIG_MMC_BLOCK_DEFERRED_RESUME
678 mmc_blk_set_blksize(md, card);
680 mmc_queue_resume(&md->queue);
685 #define mmc_blk_suspend NULL
686 #define mmc_blk_resume NULL
689 static struct mmc_driver mmc_driver = {
693 .probe = mmc_blk_probe,
694 .remove = mmc_blk_remove,
695 .suspend = mmc_blk_suspend,
696 .resume = mmc_blk_resume,
699 static int __init mmc_blk_init(void)
703 res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
707 res = mmc_register_driver(&mmc_driver);
713 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
718 static void __exit mmc_blk_exit(void)
720 mmc_unregister_driver(&mmc_driver);
721 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
724 module_init(mmc_blk_init);
725 module_exit(mmc_blk_exit);
727 MODULE_LICENSE("GPL");
728 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");