2 * Block driver for media (i.e., flash cards)
4 * Copyright 2002 Hewlett-Packard Company
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.
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.
14 * Many thanks to Alessandro Rubini and Jonathan Corbet!
16 * Author: Andrew Christian
19 #include <linux/moduleparam.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
23 #include <linux/kernel.h>
25 #include <linux/errno.h>
26 #include <linux/hdreg.h>
27 #include <linux/kdev_t.h>
28 #include <linux/blkdev.h>
29 #include <linux/mutex.h>
30 #include <linux/scatterlist.h>
32 #include <linux/mmc/card.h>
33 #include <linux/mmc/host.h>
34 #include <linux/mmc/protocol.h>
35 #include <linux/mmc/host.h>
37 #include <asm/system.h>
38 #include <asm/uaccess.h>
40 #include "mmc_queue.h"
43 * max 8 partitions per card
50 * There is one mmc_blk_data per slot.
55 struct mmc_queue queue;
58 unsigned int block_bits;
59 unsigned int read_only;
62 static DEFINE_MUTEX(open_lock);
64 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
66 struct mmc_blk_data *md;
68 mutex_lock(&open_lock);
69 md = disk->private_data;
70 if (md && md->usage == 0)
74 mutex_unlock(&open_lock);
79 static void mmc_blk_put(struct mmc_blk_data *md)
81 mutex_lock(&open_lock);
87 mutex_unlock(&open_lock);
90 static int mmc_blk_open(struct inode *inode, struct file *filp)
92 struct mmc_blk_data *md;
95 md = mmc_blk_get(inode->i_bdev->bd_disk);
98 check_disk_change(inode->i_bdev);
101 if ((filp->f_mode & FMODE_WRITE) && md->read_only)
108 static int mmc_blk_release(struct inode *inode, struct file *filp)
110 struct mmc_blk_data *md = inode->i_bdev->bd_disk->private_data;
117 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
119 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
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,
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;
139 static int mmc_blk_prep_rq(struct mmc_queue *mq, struct request *req)
141 struct mmc_blk_data *md = mq->data;
142 int stat = BLKPREP_OK;
145 * If we have no device, we haven't finished initialising.
147 if (!md || !mq->card) {
148 printk(KERN_ERR "%s: killing request - no device/host\n",
149 req->rq_disk->disk_name);
156 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
161 struct mmc_request mrq;
162 struct mmc_command cmd;
163 struct mmc_data data;
164 unsigned int timeout_us;
166 struct scatterlist sg;
168 memset(&cmd, 0, sizeof(struct mmc_command));
170 cmd.opcode = MMC_APP_CMD;
171 cmd.arg = card->rca << 16;
172 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
174 err = mmc_wait_for_cmd(card->host, &cmd, 0);
175 if ((err != MMC_ERR_NONE) || !(cmd.resp[0] & R1_APP_CMD))
178 memset(&cmd, 0, sizeof(struct mmc_command));
180 cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
182 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
184 memset(&data, 0, sizeof(struct mmc_data));
186 data.timeout_ns = card->csd.tacc_ns * 100;
187 data.timeout_clks = card->csd.tacc_clks * 100;
189 timeout_us = data.timeout_ns / 1000;
190 timeout_us += data.timeout_clks * 1000 /
191 (card->host->ios.clock / 1000);
193 if (timeout_us > 100000) {
194 data.timeout_ns = 100000000;
195 data.timeout_clks = 0;
200 data.flags = MMC_DATA_READ;
204 memset(&mrq, 0, sizeof(struct mmc_request));
209 sg_init_one(&sg, &blocks, 4);
211 mmc_wait_for_req(card->host, &mrq);
213 if (cmd.error != MMC_ERR_NONE || data.error != MMC_ERR_NONE)
216 blocks = ntohl(blocks);
221 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
223 struct mmc_blk_data *md = mq->data;
224 struct mmc_card *card = md->queue.card;
225 struct mmc_blk_request brq;
226 int ret = 1, sg_pos, data_size;
228 if (mmc_card_claim_host(card))
232 struct mmc_command cmd;
233 u32 readcmd, writecmd;
235 memset(&brq, 0, sizeof(struct mmc_blk_request));
236 brq.mrq.cmd = &brq.cmd;
237 brq.mrq.data = &brq.data;
239 brq.cmd.arg = req->sector;
240 if (!mmc_card_blockaddr(card))
242 brq.cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
243 brq.data.blksz = 1 << md->block_bits;
244 brq.stop.opcode = MMC_STOP_TRANSMISSION;
246 brq.stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
247 brq.data.blocks = req->nr_sectors >> (md->block_bits - 9);
248 if (brq.data.blocks > card->host->max_blk_count)
249 brq.data.blocks = card->host->max_blk_count;
251 mmc_set_data_timeout(&brq.data, card, rq_data_dir(req) != READ);
254 * If the host doesn't support multiple block writes, force
255 * block writes to single block. SD cards are excepted from
256 * this rule as they support querying the number of
257 * successfully written sectors.
259 if (rq_data_dir(req) != READ &&
260 !(card->host->caps & MMC_CAP_MULTIWRITE) &&
264 if (brq.data.blocks > 1) {
265 brq.data.flags |= MMC_DATA_MULTI;
266 brq.mrq.stop = &brq.stop;
267 readcmd = MMC_READ_MULTIPLE_BLOCK;
268 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
271 readcmd = MMC_READ_SINGLE_BLOCK;
272 writecmd = MMC_WRITE_BLOCK;
275 if (rq_data_dir(req) == READ) {
276 brq.cmd.opcode = readcmd;
277 brq.data.flags |= MMC_DATA_READ;
279 brq.cmd.opcode = writecmd;
280 brq.data.flags |= MMC_DATA_WRITE;
283 brq.data.sg = mq->sg;
284 brq.data.sg_len = blk_rq_map_sg(req->q, req, brq.data.sg);
286 if (brq.data.blocks !=
287 (req->nr_sectors >> (md->block_bits - 9))) {
288 data_size = brq.data.blocks * brq.data.blksz;
289 for (sg_pos = 0; sg_pos < brq.data.sg_len; sg_pos++) {
290 data_size -= mq->sg[sg_pos].length;
291 if (data_size <= 0) {
292 mq->sg[sg_pos].length += data_size;
297 brq.data.sg_len = sg_pos;
300 mmc_wait_for_req(card->host, &brq.mrq);
302 printk(KERN_ERR "%s: error %d sending read/write command\n",
303 req->rq_disk->disk_name, brq.cmd.error);
307 if (brq.data.error) {
308 printk(KERN_ERR "%s: error %d transferring data\n",
309 req->rq_disk->disk_name, brq.data.error);
313 if (brq.stop.error) {
314 printk(KERN_ERR "%s: error %d sending stop command\n",
315 req->rq_disk->disk_name, brq.stop.error);
319 if (rq_data_dir(req) != READ) {
323 cmd.opcode = MMC_SEND_STATUS;
324 cmd.arg = card->rca << 16;
325 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
326 err = mmc_wait_for_cmd(card->host, &cmd, 5);
328 printk(KERN_ERR "%s: error %d requesting status\n",
329 req->rq_disk->disk_name, err);
332 } while (!(cmd.resp[0] & R1_READY_FOR_DATA));
335 if (cmd.resp[0] & ~0x00000900)
336 printk(KERN_ERR "%s: status = %08x\n",
337 req->rq_disk->disk_name, cmd.resp[0]);
338 if (mmc_decode_status(cmd.resp))
344 * A block was successfully transferred.
346 spin_lock_irq(&md->lock);
347 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
350 * The whole request completed successfully.
352 add_disk_randomness(req->rq_disk);
353 blkdev_dequeue_request(req);
354 end_that_request_last(req, 1);
356 spin_unlock_irq(&md->lock);
359 mmc_card_release_host(card);
365 * If this is an SD card and we're writing, we can first
366 * mark the known good sectors as ok.
368 * If the card is not SD, we can still ok written sectors
369 * if the controller can do proper error reporting.
371 * For reads we just fail the entire chunk as that should
372 * be safe in all cases.
374 if (rq_data_dir(req) != READ && mmc_card_sd(card)) {
378 blocks = mmc_sd_num_wr_blocks(card);
379 if (blocks != (u32)-1) {
380 if (card->csd.write_partial)
381 bytes = blocks << md->block_bits;
384 spin_lock_irq(&md->lock);
385 ret = end_that_request_chunk(req, 1, bytes);
386 spin_unlock_irq(&md->lock);
388 } else if (rq_data_dir(req) != READ &&
389 (card->host->caps & MMC_CAP_MULTIWRITE)) {
390 spin_lock_irq(&md->lock);
391 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
392 spin_unlock_irq(&md->lock);
397 mmc_card_release_host(card);
399 spin_lock_irq(&md->lock);
401 ret = end_that_request_chunk(req, 0,
402 req->current_nr_sectors << 9);
405 add_disk_randomness(req->rq_disk);
406 blkdev_dequeue_request(req);
407 end_that_request_last(req, 0);
408 spin_unlock_irq(&md->lock);
413 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
415 static unsigned long dev_use[MMC_NUM_MINORS/(8*sizeof(unsigned long))];
417 static inline int mmc_blk_readonly(struct mmc_card *card)
419 return mmc_card_readonly(card) ||
420 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
423 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
425 struct mmc_blk_data *md;
428 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
429 if (devidx >= MMC_NUM_MINORS)
430 return ERR_PTR(-ENOSPC);
431 __set_bit(devidx, dev_use);
433 md = kmalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
439 memset(md, 0, sizeof(struct mmc_blk_data));
442 * Set the read-only status based on the supported commands
443 * and the write protect switch.
445 md->read_only = mmc_blk_readonly(card);
448 * Both SD and MMC specifications state (although a bit
449 * unclearly in the MMC case) that a block size of 512
450 * bytes must always be supported by the card.
454 md->disk = alloc_disk(1 << MMC_SHIFT);
455 if (md->disk == NULL) {
460 spin_lock_init(&md->lock);
463 ret = mmc_init_queue(&md->queue, card, &md->lock);
467 md->queue.prep_fn = mmc_blk_prep_rq;
468 md->queue.issue_fn = mmc_blk_issue_rq;
471 md->disk->major = major;
472 md->disk->first_minor = devidx << MMC_SHIFT;
473 md->disk->fops = &mmc_bdops;
474 md->disk->private_data = md;
475 md->disk->queue = md->queue.queue;
476 md->disk->driverfs_dev = &card->dev;
479 * As discussed on lkml, GENHD_FL_REMOVABLE should:
481 * - be set for removable media with permanent block devices
482 * - be unset for removable block devices with permanent media
484 * Since MMC block devices clearly fall under the second
485 * case, we do not set GENHD_FL_REMOVABLE. Userspace
486 * should use the block device creation/destruction hotplug
487 * messages to tell when the card is present.
490 sprintf(md->disk->disk_name, "mmcblk%d", devidx);
492 blk_queue_hardsect_size(md->queue.queue, 1 << md->block_bits);
494 if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
496 * The EXT_CSD sector count is in number or 512 byte
499 set_capacity(md->disk, card->ext_csd.sectors);
502 * The CSD capacity field is in units of read_blkbits.
503 * set_capacity takes units of 512 bytes.
505 set_capacity(md->disk,
506 card->csd.capacity << (card->csd.read_blkbits - 9));
519 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
521 struct mmc_command cmd;
524 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
525 if (mmc_card_blockaddr(card))
528 mmc_card_claim_host(card);
529 cmd.opcode = MMC_SET_BLOCKLEN;
530 cmd.arg = 1 << md->block_bits;
531 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
532 err = mmc_wait_for_cmd(card->host, &cmd, 5);
533 mmc_card_release_host(card);
536 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
537 md->disk->disk_name, cmd.arg, err);
544 static int mmc_blk_probe(struct mmc_card *card)
546 struct mmc_blk_data *md;
550 * Check that the card supports the command class(es) we need.
552 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
555 md = mmc_blk_alloc(card);
559 err = mmc_blk_set_blksize(md, card);
563 printk(KERN_INFO "%s: %s %s %lluKiB %s\n",
564 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
565 (unsigned long long)(get_capacity(md->disk) >> 1),
566 md->read_only ? "(ro)" : "");
568 mmc_set_drvdata(card, md);
578 static void mmc_blk_remove(struct mmc_card *card)
580 struct mmc_blk_data *md = mmc_get_drvdata(card);
585 /* Stop new requests from getting into the queue */
586 del_gendisk(md->disk);
588 /* Then flush out any already in there */
589 mmc_cleanup_queue(&md->queue);
591 devidx = md->disk->first_minor >> MMC_SHIFT;
592 __clear_bit(devidx, dev_use);
596 mmc_set_drvdata(card, NULL);
600 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
602 struct mmc_blk_data *md = mmc_get_drvdata(card);
605 mmc_queue_suspend(&md->queue);
610 static int mmc_blk_resume(struct mmc_card *card)
612 struct mmc_blk_data *md = mmc_get_drvdata(card);
615 mmc_blk_set_blksize(md, card);
616 mmc_queue_resume(&md->queue);
621 #define mmc_blk_suspend NULL
622 #define mmc_blk_resume NULL
625 static struct mmc_driver mmc_driver = {
629 .probe = mmc_blk_probe,
630 .remove = mmc_blk_remove,
631 .suspend = mmc_blk_suspend,
632 .resume = mmc_blk_resume,
635 static int __init mmc_blk_init(void)
639 res = register_blkdev(major, "mmc");
641 printk(KERN_WARNING "Unable to get major %d for MMC media: %d\n",
648 return mmc_register_driver(&mmc_driver);
654 static void __exit mmc_blk_exit(void)
656 mmc_unregister_driver(&mmc_driver);
657 unregister_blkdev(major, "mmc");
660 module_init(mmc_blk_init);
661 module_exit(mmc_blk_exit);
663 MODULE_LICENSE("GPL");
664 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
666 module_param(major, int, 0444);
667 MODULE_PARM_DESC(major, "specify the major device number for MMC block driver");