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.stop.opcode = MMC_STOP_TRANSMISSION;
247 brq.stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
248 brq.data.blocks = req->nr_sectors >> (md->block_bits - 9);
249 if (brq.data.blocks > card->host->max_blk_count)
250 brq.data.blocks = card->host->max_blk_count;
252 mmc_set_data_timeout(&brq.data, card, rq_data_dir(req) != READ);
255 * If the host doesn't support multiple block writes, force
256 * block writes to single block. SD cards are excepted from
257 * this rule as they support querying the number of
258 * successfully written sectors.
260 if (rq_data_dir(req) != READ &&
261 !(card->host->caps & MMC_CAP_MULTIWRITE) &&
265 if (brq.data.blocks > 1) {
266 brq.data.flags |= MMC_DATA_MULTI;
267 brq.mrq.stop = &brq.stop;
268 readcmd = MMC_READ_MULTIPLE_BLOCK;
269 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
272 readcmd = MMC_READ_SINGLE_BLOCK;
273 writecmd = MMC_WRITE_BLOCK;
276 if (rq_data_dir(req) == READ) {
277 brq.cmd.opcode = readcmd;
278 brq.data.flags |= MMC_DATA_READ;
280 brq.cmd.opcode = writecmd;
281 brq.data.flags |= MMC_DATA_WRITE;
284 brq.data.sg = mq->sg;
285 brq.data.sg_len = blk_rq_map_sg(req->q, req, brq.data.sg);
287 mmc_wait_for_req(card->host, &brq.mrq);
289 printk(KERN_ERR "%s: error %d sending read/write command\n",
290 req->rq_disk->disk_name, brq.cmd.error);
294 if (brq.data.error) {
295 printk(KERN_ERR "%s: error %d transferring data\n",
296 req->rq_disk->disk_name, brq.data.error);
300 if (brq.stop.error) {
301 printk(KERN_ERR "%s: error %d sending stop command\n",
302 req->rq_disk->disk_name, brq.stop.error);
306 if (rq_data_dir(req) != READ) {
310 cmd.opcode = MMC_SEND_STATUS;
311 cmd.arg = card->rca << 16;
312 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
313 err = mmc_wait_for_cmd(card->host, &cmd, 5);
315 printk(KERN_ERR "%s: error %d requesting status\n",
316 req->rq_disk->disk_name, err);
319 } while (!(cmd.resp[0] & R1_READY_FOR_DATA));
322 if (cmd.resp[0] & ~0x00000900)
323 printk(KERN_ERR "%s: status = %08x\n",
324 req->rq_disk->disk_name, cmd.resp[0]);
325 if (mmc_decode_status(cmd.resp))
331 * A block was successfully transferred.
333 spin_lock_irq(&md->lock);
334 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
337 * The whole request completed successfully.
339 add_disk_randomness(req->rq_disk);
340 blkdev_dequeue_request(req);
341 end_that_request_last(req, 1);
343 spin_unlock_irq(&md->lock);
346 mmc_card_release_host(card);
352 * If this is an SD card and we're writing, we can first
353 * mark the known good sectors as ok.
355 * If the card is not SD, we can still ok written sectors
356 * if the controller can do proper error reporting.
358 * For reads we just fail the entire chunk as that should
359 * be safe in all cases.
361 if (rq_data_dir(req) != READ && mmc_card_sd(card)) {
365 blocks = mmc_sd_num_wr_blocks(card);
366 if (blocks != (u32)-1) {
367 if (card->csd.write_partial)
368 bytes = blocks << md->block_bits;
371 spin_lock_irq(&md->lock);
372 ret = end_that_request_chunk(req, 1, bytes);
373 spin_unlock_irq(&md->lock);
375 } else if (rq_data_dir(req) != READ &&
376 (card->host->caps & MMC_CAP_MULTIWRITE)) {
377 spin_lock_irq(&md->lock);
378 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
379 spin_unlock_irq(&md->lock);
382 mmc_card_release_host(card);
385 spin_lock_irq(&md->lock);
387 ret = end_that_request_chunk(req, 0,
388 req->current_nr_sectors << 9);
391 add_disk_randomness(req->rq_disk);
392 blkdev_dequeue_request(req);
393 end_that_request_last(req, 0);
394 spin_unlock_irq(&md->lock);
399 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
401 static unsigned long dev_use[MMC_NUM_MINORS/(8*sizeof(unsigned long))];
403 static inline int mmc_blk_readonly(struct mmc_card *card)
405 return mmc_card_readonly(card) ||
406 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
409 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
411 struct mmc_blk_data *md;
414 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
415 if (devidx >= MMC_NUM_MINORS)
416 return ERR_PTR(-ENOSPC);
417 __set_bit(devidx, dev_use);
419 md = kmalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
425 memset(md, 0, sizeof(struct mmc_blk_data));
428 * Set the read-only status based on the supported commands
429 * and the write protect switch.
431 md->read_only = mmc_blk_readonly(card);
434 * Both SD and MMC specifications state (although a bit
435 * unclearly in the MMC case) that a block size of 512
436 * bytes must always be supported by the card.
440 md->disk = alloc_disk(1 << MMC_SHIFT);
441 if (md->disk == NULL) {
446 spin_lock_init(&md->lock);
449 ret = mmc_init_queue(&md->queue, card, &md->lock);
453 md->queue.prep_fn = mmc_blk_prep_rq;
454 md->queue.issue_fn = mmc_blk_issue_rq;
457 md->disk->major = major;
458 md->disk->first_minor = devidx << MMC_SHIFT;
459 md->disk->fops = &mmc_bdops;
460 md->disk->private_data = md;
461 md->disk->queue = md->queue.queue;
462 md->disk->driverfs_dev = &card->dev;
465 * As discussed on lkml, GENHD_FL_REMOVABLE should:
467 * - be set for removable media with permanent block devices
468 * - be unset for removable block devices with permanent media
470 * Since MMC block devices clearly fall under the second
471 * case, we do not set GENHD_FL_REMOVABLE. Userspace
472 * should use the block device creation/destruction hotplug
473 * messages to tell when the card is present.
476 sprintf(md->disk->disk_name, "mmcblk%d", devidx);
478 blk_queue_hardsect_size(md->queue.queue, 1 << md->block_bits);
481 * The CSD capacity field is in units of read_blkbits.
482 * set_capacity takes units of 512 bytes.
484 set_capacity(md->disk, card->csd.capacity << (card->csd.read_blkbits - 9));
496 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
498 struct mmc_command cmd;
501 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
502 if (mmc_card_blockaddr(card))
505 mmc_card_claim_host(card);
506 cmd.opcode = MMC_SET_BLOCKLEN;
507 cmd.arg = 1 << md->block_bits;
508 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
509 err = mmc_wait_for_cmd(card->host, &cmd, 5);
510 mmc_card_release_host(card);
513 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
514 md->disk->disk_name, cmd.arg, err);
521 static int mmc_blk_probe(struct mmc_card *card)
523 struct mmc_blk_data *md;
527 * Check that the card supports the command class(es) we need.
529 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
532 md = mmc_blk_alloc(card);
536 err = mmc_blk_set_blksize(md, card);
540 printk(KERN_INFO "%s: %s %s %lluKiB %s\n",
541 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
542 (unsigned long long)(get_capacity(md->disk) >> 1),
543 md->read_only ? "(ro)" : "");
545 mmc_set_drvdata(card, md);
555 static void mmc_blk_remove(struct mmc_card *card)
557 struct mmc_blk_data *md = mmc_get_drvdata(card);
562 /* Stop new requests from getting into the queue */
563 del_gendisk(md->disk);
565 /* Then flush out any already in there */
566 mmc_cleanup_queue(&md->queue);
568 devidx = md->disk->first_minor >> MMC_SHIFT;
569 __clear_bit(devidx, dev_use);
573 mmc_set_drvdata(card, NULL);
577 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
579 struct mmc_blk_data *md = mmc_get_drvdata(card);
582 mmc_queue_suspend(&md->queue);
587 static int mmc_blk_resume(struct mmc_card *card)
589 struct mmc_blk_data *md = mmc_get_drvdata(card);
592 mmc_blk_set_blksize(md, card);
593 mmc_queue_resume(&md->queue);
598 #define mmc_blk_suspend NULL
599 #define mmc_blk_resume NULL
602 static struct mmc_driver mmc_driver = {
606 .probe = mmc_blk_probe,
607 .remove = mmc_blk_remove,
608 .suspend = mmc_blk_suspend,
609 .resume = mmc_blk_resume,
612 static int __init mmc_blk_init(void)
616 res = register_blkdev(major, "mmc");
618 printk(KERN_WARNING "Unable to get major %d for MMC media: %d\n",
625 return mmc_register_driver(&mmc_driver);
631 static void __exit mmc_blk_exit(void)
633 mmc_unregister_driver(&mmc_driver);
634 unregister_blkdev(major, "mmc");
637 module_init(mmc_blk_init);
638 module_exit(mmc_blk_exit);
640 MODULE_LICENSE("GPL");
641 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
643 module_param(major, int, 0444);
644 MODULE_PARM_DESC(major, "specify the major device number for MMC block driver");