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/sched.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>
33 #include <linux/mmc/card.h>
34 #include <linux/mmc/host.h>
35 #include <linux/mmc/protocol.h>
36 #include <linux/mmc/host.h>
38 #include <asm/system.h>
39 #include <asm/uaccess.h>
41 #include "mmc_queue.h"
44 * max 8 partitions per card
51 * There is one mmc_blk_data per slot.
56 struct mmc_queue queue;
59 unsigned int block_bits;
60 unsigned int read_only;
63 static DEFINE_MUTEX(open_lock);
65 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
67 struct mmc_blk_data *md;
69 mutex_lock(&open_lock);
70 md = disk->private_data;
71 if (md && md->usage == 0)
75 mutex_unlock(&open_lock);
80 static void mmc_blk_put(struct mmc_blk_data *md)
82 mutex_lock(&open_lock);
88 mutex_unlock(&open_lock);
91 static int mmc_blk_open(struct inode *inode, struct file *filp)
93 struct mmc_blk_data *md;
96 md = mmc_blk_get(inode->i_bdev->bd_disk);
99 check_disk_change(inode->i_bdev);
102 if ((filp->f_mode & FMODE_WRITE) && md->read_only)
109 static int mmc_blk_release(struct inode *inode, struct file *filp)
111 struct mmc_blk_data *md = inode->i_bdev->bd_disk->private_data;
118 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
120 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
126 static struct block_device_operations mmc_bdops = {
127 .open = mmc_blk_open,
128 .release = mmc_blk_release,
129 .getgeo = mmc_blk_getgeo,
130 .owner = THIS_MODULE,
133 struct mmc_blk_request {
134 struct mmc_request mrq;
135 struct mmc_command cmd;
136 struct mmc_command stop;
137 struct mmc_data data;
140 static int mmc_blk_prep_rq(struct mmc_queue *mq, struct request *req)
142 struct mmc_blk_data *md = mq->data;
143 int stat = BLKPREP_OK;
146 * If we have no device, we haven't finished initialising.
148 if (!md || !mq->card) {
149 printk(KERN_ERR "%s: killing request - no device/host\n",
150 req->rq_disk->disk_name);
157 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
162 struct mmc_request mrq;
163 struct mmc_command cmd;
164 struct mmc_data data;
165 unsigned int timeout_us;
167 struct scatterlist sg;
169 memset(&cmd, 0, sizeof(struct mmc_command));
171 cmd.opcode = MMC_APP_CMD;
172 cmd.arg = card->rca << 16;
173 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
175 err = mmc_wait_for_cmd(card->host, &cmd, 0);
176 if ((err != MMC_ERR_NONE) || !(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_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 sg_init_one(&sg, &blocks, 4);
212 mmc_wait_for_req(card->host, &mrq);
214 if (cmd.error != MMC_ERR_NONE || data.error != MMC_ERR_NONE)
217 blocks = ntohl(blocks);
222 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
224 struct mmc_blk_data *md = mq->data;
225 struct mmc_card *card = md->queue.card;
226 struct mmc_blk_request brq;
229 if (mmc_card_claim_host(card))
233 struct mmc_command cmd;
234 u32 readcmd, writecmd;
236 memset(&brq, 0, sizeof(struct mmc_blk_request));
237 brq.mrq.cmd = &brq.cmd;
238 brq.mrq.data = &brq.data;
240 brq.cmd.arg = req->sector;
241 if (!mmc_card_blockaddr(card))
243 brq.cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
244 brq.data.blksz = 1 << md->block_bits;
245 brq.data.blocks = req->nr_sectors >> (md->block_bits - 9);
246 brq.stop.opcode = MMC_STOP_TRANSMISSION;
248 brq.stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
250 mmc_set_data_timeout(&brq.data, card, rq_data_dir(req) != READ);
253 * If the host doesn't support multiple block writes, force
254 * block writes to single block. SD cards are excepted from
255 * this rule as they support querying the number of
256 * successfully written sectors.
258 if (rq_data_dir(req) != READ &&
259 !(card->host->caps & MMC_CAP_MULTIWRITE) &&
263 if (brq.data.blocks > 1) {
264 brq.data.flags |= MMC_DATA_MULTI;
265 brq.mrq.stop = &brq.stop;
266 readcmd = MMC_READ_MULTIPLE_BLOCK;
267 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
270 readcmd = MMC_READ_SINGLE_BLOCK;
271 writecmd = MMC_WRITE_BLOCK;
274 if (rq_data_dir(req) == READ) {
275 brq.cmd.opcode = readcmd;
276 brq.data.flags |= MMC_DATA_READ;
278 brq.cmd.opcode = writecmd;
279 brq.data.flags |= MMC_DATA_WRITE;
282 brq.data.sg = mq->sg;
283 brq.data.sg_len = blk_rq_map_sg(req->q, req, brq.data.sg);
285 mmc_wait_for_req(card->host, &brq.mrq);
287 printk(KERN_ERR "%s: error %d sending read/write command\n",
288 req->rq_disk->disk_name, brq.cmd.error);
292 if (brq.data.error) {
293 printk(KERN_ERR "%s: error %d transferring data\n",
294 req->rq_disk->disk_name, brq.data.error);
298 if (brq.stop.error) {
299 printk(KERN_ERR "%s: error %d sending stop command\n",
300 req->rq_disk->disk_name, brq.stop.error);
304 if (rq_data_dir(req) != READ) {
308 cmd.opcode = MMC_SEND_STATUS;
309 cmd.arg = card->rca << 16;
310 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
311 err = mmc_wait_for_cmd(card->host, &cmd, 5);
313 printk(KERN_ERR "%s: error %d requesting status\n",
314 req->rq_disk->disk_name, err);
317 } while (!(cmd.resp[0] & R1_READY_FOR_DATA));
320 if (cmd.resp[0] & ~0x00000900)
321 printk(KERN_ERR "%s: status = %08x\n",
322 req->rq_disk->disk_name, cmd.resp[0]);
323 if (mmc_decode_status(cmd.resp))
329 * A block was successfully transferred.
331 spin_lock_irq(&md->lock);
332 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
335 * The whole request completed successfully.
337 add_disk_randomness(req->rq_disk);
338 blkdev_dequeue_request(req);
339 end_that_request_last(req, 1);
341 spin_unlock_irq(&md->lock);
344 mmc_card_release_host(card);
350 * If this is an SD card and we're writing, we can first
351 * mark the known good sectors as ok.
353 * If the card is not SD, we can still ok written sectors
354 * if the controller can do proper error reporting.
356 * For reads we just fail the entire chunk as that should
357 * be safe in all cases.
359 if (rq_data_dir(req) != READ && mmc_card_sd(card)) {
363 blocks = mmc_sd_num_wr_blocks(card);
364 if (blocks != (u32)-1) {
365 if (card->csd.write_partial)
366 bytes = blocks << md->block_bits;
369 spin_lock_irq(&md->lock);
370 ret = end_that_request_chunk(req, 1, bytes);
371 spin_unlock_irq(&md->lock);
373 } else if (rq_data_dir(req) != READ &&
374 (card->host->caps & MMC_CAP_MULTIWRITE)) {
375 spin_lock_irq(&md->lock);
376 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
377 spin_unlock_irq(&md->lock);
380 mmc_card_release_host(card);
383 spin_lock_irq(&md->lock);
385 ret = end_that_request_chunk(req, 0,
386 req->current_nr_sectors << 9);
389 add_disk_randomness(req->rq_disk);
390 blkdev_dequeue_request(req);
391 end_that_request_last(req, 0);
392 spin_unlock_irq(&md->lock);
397 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
399 static unsigned long dev_use[MMC_NUM_MINORS/(8*sizeof(unsigned long))];
401 static inline int mmc_blk_readonly(struct mmc_card *card)
403 return mmc_card_readonly(card) ||
404 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
407 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
409 struct mmc_blk_data *md;
412 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
413 if (devidx >= MMC_NUM_MINORS)
414 return ERR_PTR(-ENOSPC);
415 __set_bit(devidx, dev_use);
417 md = kmalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
423 memset(md, 0, sizeof(struct mmc_blk_data));
426 * Set the read-only status based on the supported commands
427 * and the write protect switch.
429 md->read_only = mmc_blk_readonly(card);
432 * Both SD and MMC specifications state (although a bit
433 * unclearly in the MMC case) that a block size of 512
434 * bytes must always be supported by the card.
438 md->disk = alloc_disk(1 << MMC_SHIFT);
439 if (md->disk == NULL) {
444 spin_lock_init(&md->lock);
447 ret = mmc_init_queue(&md->queue, card, &md->lock);
451 md->queue.prep_fn = mmc_blk_prep_rq;
452 md->queue.issue_fn = mmc_blk_issue_rq;
455 md->disk->major = major;
456 md->disk->first_minor = devidx << MMC_SHIFT;
457 md->disk->fops = &mmc_bdops;
458 md->disk->private_data = md;
459 md->disk->queue = md->queue.queue;
460 md->disk->driverfs_dev = &card->dev;
463 * As discussed on lkml, GENHD_FL_REMOVABLE should:
465 * - be set for removable media with permanent block devices
466 * - be unset for removable block devices with permanent media
468 * Since MMC block devices clearly fall under the second
469 * case, we do not set GENHD_FL_REMOVABLE. Userspace
470 * should use the block device creation/destruction hotplug
471 * messages to tell when the card is present.
474 sprintf(md->disk->disk_name, "mmcblk%d", devidx);
476 blk_queue_hardsect_size(md->queue.queue, 1 << md->block_bits);
479 * The CSD capacity field is in units of read_blkbits.
480 * set_capacity takes units of 512 bytes.
482 set_capacity(md->disk, card->csd.capacity << (card->csd.read_blkbits - 9));
494 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
496 struct mmc_command cmd;
499 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
500 if (mmc_card_blockaddr(card))
503 mmc_card_claim_host(card);
504 cmd.opcode = MMC_SET_BLOCKLEN;
505 cmd.arg = 1 << md->block_bits;
506 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
507 err = mmc_wait_for_cmd(card->host, &cmd, 5);
508 mmc_card_release_host(card);
511 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
512 md->disk->disk_name, cmd.arg, err);
519 static int mmc_blk_probe(struct mmc_card *card)
521 struct mmc_blk_data *md;
525 * Check that the card supports the command class(es) we need.
527 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
530 md = mmc_blk_alloc(card);
534 err = mmc_blk_set_blksize(md, card);
538 printk(KERN_INFO "%s: %s %s %lluKiB %s\n",
539 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
540 (unsigned long long)(get_capacity(md->disk) >> 1),
541 md->read_only ? "(ro)" : "");
543 mmc_set_drvdata(card, md);
553 static void mmc_blk_remove(struct mmc_card *card)
555 struct mmc_blk_data *md = mmc_get_drvdata(card);
560 /* Stop new requests from getting into the queue */
561 del_gendisk(md->disk);
563 /* Then flush out any already in there */
564 mmc_cleanup_queue(&md->queue);
566 devidx = md->disk->first_minor >> MMC_SHIFT;
567 __clear_bit(devidx, dev_use);
571 mmc_set_drvdata(card, NULL);
575 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
577 struct mmc_blk_data *md = mmc_get_drvdata(card);
580 mmc_queue_suspend(&md->queue);
585 static int mmc_blk_resume(struct mmc_card *card)
587 struct mmc_blk_data *md = mmc_get_drvdata(card);
590 mmc_blk_set_blksize(md, card);
591 mmc_queue_resume(&md->queue);
596 #define mmc_blk_suspend NULL
597 #define mmc_blk_resume NULL
600 static struct mmc_driver mmc_driver = {
604 .probe = mmc_blk_probe,
605 .remove = mmc_blk_remove,
606 .suspend = mmc_blk_suspend,
607 .resume = mmc_blk_resume,
610 static int __init mmc_blk_init(void)
614 res = register_blkdev(major, "mmc");
616 printk(KERN_WARNING "Unable to get major %d for MMC media: %d\n",
623 return mmc_register_driver(&mmc_driver);
629 static void __exit mmc_blk_exit(void)
631 mmc_unregister_driver(&mmc_driver);
632 unregister_blkdev(major, "mmc");
635 module_init(mmc_blk_init);
636 module_exit(mmc_blk_exit);
638 MODULE_LICENSE("GPL");
639 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
641 module_param(major, int, 0444);
642 MODULE_PARM_DESC(major, "specify the major device number for MMC block driver");