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");
46 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
47 static DEFINE_MUTEX(block_mutex); //added by xbw at 2011-04-21
51 * max 8 partitions per card
54 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
56 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
59 * There is one mmc_blk_data per slot.
64 struct mmc_queue queue;
67 unsigned int read_only;
70 static DEFINE_MUTEX(open_lock);
72 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
74 struct mmc_blk_data *md;
76 mutex_lock(&open_lock);
77 md = disk->private_data;
78 if (md && md->usage == 0)
82 mutex_unlock(&open_lock);
87 static void mmc_blk_put(struct mmc_blk_data *md)
89 mutex_lock(&open_lock);
92 int devmaj = MAJOR(disk_devt(md->disk));
93 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
96 devidx = md->disk->first_minor >> MMC_SHIFT;
98 blk_cleanup_queue(md->queue.queue);
100 __clear_bit(devidx, dev_use);
105 mutex_unlock(&open_lock);
108 static int mmc_blk_open(struct block_device *bdev, fmode_t mode)
110 struct mmc_blk_data *md = mmc_blk_get(bdev->bd_disk);
113 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
114 mutex_lock(&block_mutex); //added by xbw at 2011-04-21
119 check_disk_change(bdev);
122 if ((mode & FMODE_WRITE) && md->read_only) {
127 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
128 mutex_unlock(&block_mutex);
134 static int mmc_blk_release(struct gendisk *disk, fmode_t mode)
136 struct mmc_blk_data *md = disk->private_data;
138 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
139 mutex_lock(&block_mutex); //added by xbw at 2011-04-21
144 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
145 mutex_unlock(&block_mutex);
152 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
154 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
160 static const struct block_device_operations mmc_bdops = {
161 .open = mmc_blk_open,
162 .release = mmc_blk_release,
163 .getgeo = mmc_blk_getgeo,
164 .owner = THIS_MODULE,
167 struct mmc_blk_request {
168 struct mmc_request mrq;
169 struct mmc_command cmd;
170 struct mmc_command stop;
171 struct mmc_data data;
174 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
180 struct mmc_request mrq;
181 struct mmc_command cmd;
182 struct mmc_data data;
183 unsigned int timeout_us;
185 struct scatterlist sg;
187 memset(&cmd, 0, sizeof(struct mmc_command));
189 cmd.opcode = MMC_APP_CMD;
190 cmd.arg = card->rca << 16;
191 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
193 err = mmc_wait_for_cmd(card->host, &cmd, 0);
196 if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
199 memset(&cmd, 0, sizeof(struct mmc_command));
201 cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
203 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
205 memset(&data, 0, sizeof(struct mmc_data));
207 data.timeout_ns = card->csd.tacc_ns * 100;
208 data.timeout_clks = card->csd.tacc_clks * 100;
210 timeout_us = data.timeout_ns / 1000;
211 timeout_us += data.timeout_clks * 1000 /
212 (card->host->ios.clock / 1000);
214 if (timeout_us > 100000) {
215 data.timeout_ns = 100000000;
216 data.timeout_clks = 0;
221 data.flags = MMC_DATA_READ;
225 memset(&mrq, 0, sizeof(struct mmc_request));
230 blocks = kmalloc(4, GFP_KERNEL);
234 sg_init_one(&sg, blocks, 4);
236 mmc_wait_for_req(card->host, &mrq);
238 result = ntohl(*blocks);
241 if (cmd.error || data.error)
247 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD) //Deleted by xbw@2011-03-21
248 //static u32 get_card_status(struct mmc_card *card, struct request *req)
254 static u32 get_card_status(struct mmc_card *card, struct request *req)
256 struct mmc_command cmd;
259 memset(&cmd, 0, sizeof(struct mmc_command));
260 cmd.opcode = MMC_SEND_STATUS;
261 if (!mmc_host_is_spi(card->host))
262 cmd.arg = card->rca << 16;
263 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
264 err = mmc_wait_for_cmd(card->host, &cmd, 0);
266 printk(KERN_DEBUG "%s: error %d sending status comand",
267 req->rq_disk->disk_name, err);
273 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
275 struct mmc_command cmd;
278 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
279 if (mmc_card_blockaddr(card))
282 mmc_claim_host(card->host);
283 cmd.opcode = MMC_SET_BLOCKLEN;
285 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
286 err = mmc_wait_for_cmd(card->host, &cmd, 5);
287 mmc_release_host(card->host);
290 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
291 md->disk->disk_name, cmd.arg, err);
299 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
301 struct mmc_blk_data *md = mq->data;
302 struct mmc_card *card = md->queue.card;
303 struct mmc_blk_request brq;
304 int ret = 1, disable_multi = 0;
306 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
307 if (mmc_bus_needs_resume(card->host)) {
308 mmc_resume_bus(card->host);
309 mmc_blk_set_blksize(md, card);
313 mmc_claim_host(card->host);
316 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
317 //struct mmc_command cmd;//Deleted by xbw@2011-03-21
319 struct mmc_command cmd;
322 u32 readcmd, writecmd, status = 0;
324 memset(&brq, 0, sizeof(struct mmc_blk_request));
325 brq.mrq.cmd = &brq.cmd;
326 brq.mrq.data = &brq.data;
328 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
329 brq.cmd.retries = 2; //suppot retry read-write; added by xbw@2011-03-21
332 brq.cmd.arg = blk_rq_pos(req);
333 if (!mmc_card_blockaddr(card))
335 brq.cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
336 brq.data.blksz = 512;
337 brq.stop.opcode = MMC_STOP_TRANSMISSION;
339 brq.stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
340 brq.data.blocks = blk_rq_sectors(req);
343 * The block layer doesn't support all sector count
344 * restrictions, so we need to be prepared for too big
347 if (brq.data.blocks > card->host->max_blk_count)
348 brq.data.blocks = card->host->max_blk_count;
351 * After a read error, we redo the request one sector at a time
352 * in order to accurately determine which sectors can be read
355 if (disable_multi && brq.data.blocks > 1)
358 if (brq.data.blocks > 1) {
359 /* SPI multiblock writes terminate using a special
360 * token, not a STOP_TRANSMISSION request.
362 if (!mmc_host_is_spi(card->host)
363 || rq_data_dir(req) == READ)
364 brq.mrq.stop = &brq.stop;
365 readcmd = MMC_READ_MULTIPLE_BLOCK;
366 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
369 readcmd = MMC_READ_SINGLE_BLOCK;
370 writecmd = MMC_WRITE_BLOCK;
373 if (rq_data_dir(req) == READ) {
374 brq.cmd.opcode = readcmd;
375 brq.data.flags |= MMC_DATA_READ;
377 brq.cmd.opcode = writecmd;
378 brq.data.flags |= MMC_DATA_WRITE;
381 mmc_set_data_timeout(&brq.data, card);
383 brq.data.sg = mq->sg;
384 brq.data.sg_len = mmc_queue_map_sg(mq);
387 * Adjust the sg list so it is the same size as the
390 if (brq.data.blocks != blk_rq_sectors(req)) {
391 int i, data_size = brq.data.blocks << 9;
392 struct scatterlist *sg;
394 for_each_sg(brq.data.sg, sg, brq.data.sg_len, i) {
395 data_size -= sg->length;
396 if (data_size <= 0) {
397 sg->length += data_size;
405 mmc_queue_bounce_pre(mq);
407 mmc_wait_for_req(card->host, &brq.mrq);
409 mmc_queue_bounce_post(mq);
411 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
412 //not turn CMD18 to CMD17. deleted by xbw at 2011-04-21
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_DEBUG "%s: retrying using single "
425 "block read\n", req->rq_disk->disk_name);
429 status = get_card_status(card, req);
430 } else if (disable_multi == 1) {
436 printk(KERN_DEBUG "%s: error %d sending read/write "
437 "command, response %#x, card status %#x\n",
438 req->rq_disk->disk_name, brq.cmd.error,
439 brq.cmd.resp[0], status);
442 if (brq.data.error) {
443 if (brq.data.error == -ETIMEDOUT && brq.mrq.stop)
444 /* 'Stop' response contains card status */
445 status = brq.mrq.stop->resp[0];
446 printk(KERN_DEBUG "%s: error %d transferring data,"
447 " sector %u, nr %u, card status %#x\n",
448 req->rq_disk->disk_name, brq.data.error,
449 (unsigned)blk_rq_pos(req),
450 (unsigned)blk_rq_sectors(req), status);
453 if (brq.stop.error) {
454 printk(KERN_DEBUG "%s: error %d sending stop command, "
455 "response %#x, card status %#x\n",
456 req->rq_disk->disk_name, brq.stop.error,
457 brq.stop.resp[0], status);
460 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
461 //Deleted by xbw@2011-03-21
464 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
468 cmd.opcode = MMC_SEND_STATUS;
469 cmd.arg = card->rca << 16;
470 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
471 err = mmc_wait_for_cmd(card->host, &cmd, 5);
473 printk(KERN_DEBUG "%s: error %d requesting status\n",
474 req->rq_disk->disk_name, err);
478 * Some cards mishandle the status bits,
479 * so make sure to check both the busy
480 * indication and the card state.
482 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
483 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
486 if (cmd.resp[0] & ~0x00000900)
487 printk(KERN_ERR "%s: status = %08x\n",
488 req->rq_disk->disk_name, cmd.resp[0]);
489 if (mmc_decode_status(cmd.resp))
495 if (brq.cmd.error || brq.stop.error || brq.data.error) {
496 if (rq_data_dir(req) == READ) {
498 * After an error, we redo I/O one sector at a
499 * time, so we only reach here after trying to
500 * read a single sector.
502 spin_lock_irq(&md->lock);
503 ret = __blk_end_request(req, -EIO, brq.data.blksz);
504 spin_unlock_irq(&md->lock);
511 * A block was successfully transferred.
513 spin_lock_irq(&md->lock);
514 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
515 spin_unlock_irq(&md->lock);
518 mmc_release_host(card->host);
524 * If this is an SD card and we're writing, we can first
525 * mark the known good sectors as ok.
527 * If the card is not SD, we can still ok written sectors
528 * as reported by the controller (which might be less than
529 * the real number of written sectors, but never more).
531 if (mmc_card_sd(card)) {
534 blocks = mmc_sd_num_wr_blocks(card);
535 if (blocks != (u32)-1) {
536 spin_lock_irq(&md->lock);
537 ret = __blk_end_request(req, 0, blocks << 9);
538 spin_unlock_irq(&md->lock);
541 spin_lock_irq(&md->lock);
542 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
543 spin_unlock_irq(&md->lock);
546 mmc_release_host(card->host);
548 spin_lock_irq(&md->lock);
550 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
551 spin_unlock_irq(&md->lock);
557 static inline int mmc_blk_readonly(struct mmc_card *card)
559 return mmc_card_readonly(card) ||
560 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
563 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
565 struct mmc_blk_data *md;
568 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
569 if (devidx >= MMC_NUM_MINORS)
570 return ERR_PTR(-ENOSPC);
571 __set_bit(devidx, dev_use);
573 md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
581 * Set the read-only status based on the supported commands
582 * and the write protect switch.
584 md->read_only = mmc_blk_readonly(card);
586 md->disk = alloc_disk(1 << MMC_SHIFT);
587 if (md->disk == NULL) {
592 spin_lock_init(&md->lock);
595 ret = mmc_init_queue(&md->queue, card, &md->lock);
599 md->queue.issue_fn = mmc_blk_issue_rq;
602 md->disk->major = MMC_BLOCK_MAJOR;
603 md->disk->first_minor = devidx << MMC_SHIFT;
604 md->disk->fops = &mmc_bdops;
605 md->disk->private_data = md;
606 md->disk->queue = md->queue.queue;
607 md->disk->driverfs_dev = &card->dev;
610 * As discussed on lkml, GENHD_FL_REMOVABLE should:
612 * - be set for removable media with permanent block devices
613 * - be unset for removable block devices with permanent media
615 * Since MMC block devices clearly fall under the second
616 * case, we do not set GENHD_FL_REMOVABLE. Userspace
617 * should use the block device creation/destruction hotplug
618 * messages to tell when the card is present.
621 sprintf(md->disk->disk_name, "mmcblk%d", devidx);
623 #if defined(CONFIG_SDMMC_RK29) && !defined(CONFIG_SDMMC_RK29_OLD)
624 printk("%s..%d **** devidx=%d, dev_use[0]=%lu, disk_name=%s *** ==xbw[%s]==\n",\
625 __FUNCTION__,__LINE__, devidx, dev_use[0], md->disk->disk_name,mmc_hostname(card->host));
628 blk_queue_logical_block_size(md->queue.queue, 512);
630 if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
632 * The EXT_CSD sector count is in number or 512 byte
635 set_capacity(md->disk, card->ext_csd.sectors);
638 * The CSD capacity field is in units of read_blkbits.
639 * set_capacity takes units of 512 bytes.
641 set_capacity(md->disk,
642 card->csd.capacity << (card->csd.read_blkbits - 9));
654 static int mmc_blk_probe(struct mmc_card *card)
656 struct mmc_blk_data *md;
662 * Check that the card supports the command class(es) we need.
664 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
667 md = mmc_blk_alloc(card);
671 err = mmc_blk_set_blksize(md, card);
675 string_get_size((u64)get_capacity(md->disk) << 9, STRING_UNITS_2,
676 cap_str, sizeof(cap_str));
677 printk(KERN_INFO "%s: %s %s %s %s\n",
678 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
679 cap_str, md->read_only ? "(ro)" : "");
681 mmc_set_drvdata(card, md);
682 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
683 mmc_set_bus_resume_policy(card->host, 1);
689 mmc_cleanup_queue(&md->queue);
695 static void mmc_blk_remove(struct mmc_card *card)
697 struct mmc_blk_data *md = mmc_get_drvdata(card);
700 /* Stop new requests from getting into the queue */
701 del_gendisk(md->disk);
703 /* Then flush out any already in there */
704 mmc_cleanup_queue(&md->queue);
708 mmc_set_drvdata(card, NULL);
709 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
710 mmc_set_bus_resume_policy(card->host, 0);
715 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
717 struct mmc_blk_data *md = mmc_get_drvdata(card);
720 mmc_queue_suspend(&md->queue);
725 static int mmc_blk_resume(struct mmc_card *card)
727 struct mmc_blk_data *md = mmc_get_drvdata(card);
730 #ifndef CONFIG_MMC_BLOCK_DEFERRED_RESUME
731 mmc_blk_set_blksize(md, card);
733 mmc_queue_resume(&md->queue);
738 #define mmc_blk_suspend NULL
739 #define mmc_blk_resume NULL
742 static struct mmc_driver mmc_driver = {
746 .probe = mmc_blk_probe,
747 .remove = mmc_blk_remove,
748 .suspend = mmc_blk_suspend,
749 .resume = mmc_blk_resume,
752 static int __init mmc_blk_init(void)
756 res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
760 res = mmc_register_driver(&mmc_driver);
766 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
771 static void __exit mmc_blk_exit(void)
773 mmc_unregister_driver(&mmc_driver);
774 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
777 module_init(mmc_blk_init);
778 module_exit(mmc_blk_exit);
780 MODULE_LICENSE("GPL");
781 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");