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>
45 * max 8 partitions per card
48 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
50 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
53 * There is one mmc_blk_data per slot.
58 struct mmc_queue queue;
61 unsigned int read_only;
64 static DEFINE_MUTEX(open_lock);
66 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
68 struct mmc_blk_data *md;
70 mutex_lock(&open_lock);
71 md = disk->private_data;
72 if (md && md->usage == 0)
76 mutex_unlock(&open_lock);
81 static void mmc_blk_put(struct mmc_blk_data *md)
83 mutex_lock(&open_lock);
86 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
87 __clear_bit(devidx, dev_use);
92 mutex_unlock(&open_lock);
95 static int mmc_blk_open(struct block_device *bdev, fmode_t mode)
97 struct mmc_blk_data *md = mmc_blk_get(bdev->bd_disk);
102 check_disk_change(bdev);
105 if ((mode & FMODE_WRITE) && md->read_only) {
114 static int mmc_blk_release(struct gendisk *disk, fmode_t mode)
116 struct mmc_blk_data *md = disk->private_data;
123 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
125 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
131 static struct block_device_operations mmc_bdops = {
132 .open = mmc_blk_open,
133 .release = mmc_blk_release,
134 .getgeo = mmc_blk_getgeo,
135 .owner = THIS_MODULE,
138 struct mmc_blk_request {
139 struct mmc_request mrq;
140 struct mmc_command cmd;
141 struct mmc_command stop;
142 struct mmc_data data;
145 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
150 struct mmc_request mrq;
151 struct mmc_command cmd;
152 struct mmc_data data;
153 unsigned int timeout_us;
155 struct scatterlist sg;
157 memset(&cmd, 0, sizeof(struct mmc_command));
159 cmd.opcode = MMC_APP_CMD;
160 cmd.arg = card->rca << 16;
161 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
163 err = mmc_wait_for_cmd(card->host, &cmd, 0);
166 if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
169 memset(&cmd, 0, sizeof(struct mmc_command));
171 cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
173 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
175 memset(&data, 0, sizeof(struct mmc_data));
177 data.timeout_ns = card->csd.tacc_ns * 100;
178 data.timeout_clks = card->csd.tacc_clks * 100;
180 timeout_us = data.timeout_ns / 1000;
181 timeout_us += data.timeout_clks * 1000 /
182 (card->host->ios.clock / 1000);
184 if (timeout_us > 100000) {
185 data.timeout_ns = 100000000;
186 data.timeout_clks = 0;
191 data.flags = MMC_DATA_READ;
195 memset(&mrq, 0, sizeof(struct mmc_request));
200 sg_init_one(&sg, &blocks, 4);
202 mmc_wait_for_req(card->host, &mrq);
204 if (cmd.error || data.error)
207 return ntohl(blocks);
210 static u32 get_card_status(struct mmc_card *card, struct request *req)
212 struct mmc_command cmd;
215 memset(&cmd, 0, sizeof(struct mmc_command));
216 cmd.opcode = MMC_SEND_STATUS;
217 if (!mmc_host_is_spi(card->host))
218 cmd.arg = card->rca << 16;
219 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
220 err = mmc_wait_for_cmd(card->host, &cmd, 0);
222 printk(KERN_ERR "%s: error %d sending status comand",
223 req->rq_disk->disk_name, err);
227 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
229 struct mmc_blk_data *md = mq->data;
230 struct mmc_card *card = md->queue.card;
231 struct mmc_blk_request brq;
234 mmc_claim_host(card->host);
237 struct mmc_command cmd;
238 u32 readcmd, writecmd, status = 0;
240 memset(&brq, 0, sizeof(struct mmc_blk_request));
241 brq.mrq.cmd = &brq.cmd;
242 brq.mrq.data = &brq.data;
244 brq.cmd.arg = req->sector;
245 if (!mmc_card_blockaddr(card))
247 brq.cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
248 brq.data.blksz = 512;
249 brq.stop.opcode = MMC_STOP_TRANSMISSION;
251 brq.stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
252 brq.data.blocks = req->nr_sectors;
254 if (brq.data.blocks > 1) {
255 /* SPI multiblock writes terminate using a special
256 * token, not a STOP_TRANSMISSION request.
258 if (!mmc_host_is_spi(card->host)
259 || rq_data_dir(req) == READ)
260 brq.mrq.stop = &brq.stop;
261 readcmd = MMC_READ_MULTIPLE_BLOCK;
262 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
265 readcmd = MMC_READ_SINGLE_BLOCK;
266 writecmd = MMC_WRITE_BLOCK;
269 if (rq_data_dir(req) == READ) {
270 brq.cmd.opcode = readcmd;
271 brq.data.flags |= MMC_DATA_READ;
273 brq.cmd.opcode = writecmd;
274 brq.data.flags |= MMC_DATA_WRITE;
277 mmc_set_data_timeout(&brq.data, card);
279 brq.data.sg = mq->sg;
280 brq.data.sg_len = mmc_queue_map_sg(mq);
282 mmc_queue_bounce_pre(mq);
284 mmc_wait_for_req(card->host, &brq.mrq);
286 mmc_queue_bounce_post(mq);
289 * Check for errors here, but don't jump to cmd_err
290 * until later as we need to wait for the card to leave
291 * programming mode even when things go wrong.
293 if (brq.cmd.error || brq.data.error || brq.stop.error)
294 status = get_card_status(card, req);
297 printk(KERN_ERR "%s: error %d sending read/write "
298 "command, response %#x, card status %#x\n",
299 req->rq_disk->disk_name, brq.cmd.error,
300 brq.cmd.resp[0], status);
303 if (brq.data.error) {
304 if (brq.data.error == -ETIMEDOUT && brq.mrq.stop)
305 /* 'Stop' response contains card status */
306 status = brq.mrq.stop->resp[0];
307 printk(KERN_ERR "%s: error %d transferring data,"
308 " sector %u, nr %u, card status %#x\n",
309 req->rq_disk->disk_name, brq.data.error,
310 (unsigned)req->sector,
311 (unsigned)req->nr_sectors, status);
314 if (brq.stop.error) {
315 printk(KERN_ERR "%s: error %d sending stop command, "
316 "response %#x, card status %#x\n",
317 req->rq_disk->disk_name, brq.stop.error,
318 brq.stop.resp[0], status);
321 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
325 cmd.opcode = MMC_SEND_STATUS;
326 cmd.arg = card->rca << 16;
327 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
328 err = mmc_wait_for_cmd(card->host, &cmd, 5);
330 printk(KERN_ERR "%s: error %d requesting status\n",
331 req->rq_disk->disk_name, err);
335 * Some cards mishandle the status bits,
336 * so make sure to check both the busy
337 * indication and the card state.
339 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
340 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
343 if (cmd.resp[0] & ~0x00000900)
344 printk(KERN_ERR "%s: status = %08x\n",
345 req->rq_disk->disk_name, cmd.resp[0]);
346 if (mmc_decode_status(cmd.resp))
351 if (brq.cmd.error || brq.data.error || brq.stop.error)
355 * A block was successfully transferred.
357 spin_lock_irq(&md->lock);
358 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
359 spin_unlock_irq(&md->lock);
362 mmc_release_host(card->host);
368 * If this is an SD card and we're writing, we can first
369 * mark the known good sectors as ok.
371 * If the card is not SD, we can still ok written sectors
372 * as reported by the controller (which might be less than
373 * the real number of written sectors, but never more).
375 * For reads we just fail the entire chunk as that should
376 * be safe in all cases.
378 if (rq_data_dir(req) != READ) {
379 if (mmc_card_sd(card)) {
382 blocks = mmc_sd_num_wr_blocks(card);
383 if (blocks != (u32)-1) {
384 spin_lock_irq(&md->lock);
385 ret = __blk_end_request(req, 0, blocks << 9);
386 spin_unlock_irq(&md->lock);
389 spin_lock_irq(&md->lock);
390 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
391 spin_unlock_irq(&md->lock);
395 mmc_release_host(card->host);
397 spin_lock_irq(&md->lock);
399 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
400 spin_unlock_irq(&md->lock);
406 static inline int mmc_blk_readonly(struct mmc_card *card)
408 return mmc_card_readonly(card) ||
409 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
412 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
414 struct mmc_blk_data *md;
417 devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
418 if (devidx >= MMC_NUM_MINORS)
419 return ERR_PTR(-ENOSPC);
420 __set_bit(devidx, dev_use);
422 md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
430 * Set the read-only status based on the supported commands
431 * and the write protect switch.
433 md->read_only = mmc_blk_readonly(card);
435 md->disk = alloc_disk(1 << MMC_SHIFT);
436 if (md->disk == NULL) {
441 spin_lock_init(&md->lock);
444 ret = mmc_init_queue(&md->queue, card, &md->lock);
448 md->queue.issue_fn = mmc_blk_issue_rq;
451 md->disk->major = MMC_BLOCK_MAJOR;
452 md->disk->first_minor = devidx << MMC_SHIFT;
453 md->disk->fops = &mmc_bdops;
454 md->disk->private_data = md;
455 md->disk->queue = md->queue.queue;
456 md->disk->driverfs_dev = &card->dev;
459 * As discussed on lkml, GENHD_FL_REMOVABLE should:
461 * - be set for removable media with permanent block devices
462 * - be unset for removable block devices with permanent media
464 * Since MMC block devices clearly fall under the second
465 * case, we do not set GENHD_FL_REMOVABLE. Userspace
466 * should use the block device creation/destruction hotplug
467 * messages to tell when the card is present.
470 sprintf(md->disk->disk_name, "mmcblk%d", devidx);
472 blk_queue_hardsect_size(md->queue.queue, 512);
474 if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
476 * The EXT_CSD sector count is in number or 512 byte
479 set_capacity(md->disk, card->ext_csd.sectors);
482 * The CSD capacity field is in units of read_blkbits.
483 * set_capacity takes units of 512 bytes.
485 set_capacity(md->disk,
486 card->csd.capacity << (card->csd.read_blkbits - 9));
499 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
501 struct mmc_command cmd;
504 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
505 if (mmc_card_blockaddr(card))
508 mmc_claim_host(card->host);
509 cmd.opcode = MMC_SET_BLOCKLEN;
511 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
512 err = mmc_wait_for_cmd(card->host, &cmd, 5);
513 mmc_release_host(card->host);
516 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
517 md->disk->disk_name, cmd.arg, err);
524 static int mmc_blk_probe(struct mmc_card *card)
526 struct mmc_blk_data *md;
532 * Check that the card supports the command class(es) we need.
534 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
537 md = mmc_blk_alloc(card);
541 err = mmc_blk_set_blksize(md, card);
545 string_get_size(get_capacity(md->disk) << 9, STRING_UNITS_2,
546 cap_str, sizeof(cap_str));
547 printk(KERN_INFO "%s: %s %s %s %s\n",
548 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
549 cap_str, md->read_only ? "(ro)" : "");
551 mmc_set_drvdata(card, md);
561 static void mmc_blk_remove(struct mmc_card *card)
563 struct mmc_blk_data *md = mmc_get_drvdata(card);
566 /* Stop new requests from getting into the queue */
567 del_gendisk(md->disk);
569 /* Then flush out any already in there */
570 mmc_cleanup_queue(&md->queue);
574 mmc_set_drvdata(card, NULL);
578 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
580 struct mmc_blk_data *md = mmc_get_drvdata(card);
583 mmc_queue_suspend(&md->queue);
588 static int mmc_blk_resume(struct mmc_card *card)
590 struct mmc_blk_data *md = mmc_get_drvdata(card);
593 mmc_blk_set_blksize(md, card);
594 mmc_queue_resume(&md->queue);
599 #define mmc_blk_suspend NULL
600 #define mmc_blk_resume NULL
603 static struct mmc_driver mmc_driver = {
607 .probe = mmc_blk_probe,
608 .remove = mmc_blk_remove,
609 .suspend = mmc_blk_suspend,
610 .resume = mmc_blk_resume,
613 static int __init mmc_blk_init(void)
617 res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
621 res = mmc_register_driver(&mmc_driver);
627 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
632 static void __exit mmc_blk_exit(void)
634 mmc_unregister_driver(&mmc_driver);
635 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
638 module_init(mmc_blk_init);
639 module_exit(mmc_blk_exit);
641 MODULE_LICENSE("GPL");
642 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");