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");
47 * max 8 partitions per card
50 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
52 static DECLARE_BITMAP(dev_use
, MMC_NUM_MINORS
);
55 * There is one mmc_blk_data per slot.
60 struct mmc_queue queue
;
63 unsigned int read_only
;
66 static DEFINE_MUTEX(open_lock
);
68 static struct mmc_blk_data
*mmc_blk_get(struct gendisk
*disk
)
70 struct mmc_blk_data
*md
;
72 mutex_lock(&open_lock
);
73 md
= disk
->private_data
;
74 if (md
&& md
->usage
== 0)
78 mutex_unlock(&open_lock
);
83 static void mmc_blk_put(struct mmc_blk_data
*md
)
85 mutex_lock(&open_lock
);
88 int devmaj
= MAJOR(disk_devt(md
->disk
));
89 int devidx
= MINOR(disk_devt(md
->disk
)) >> MMC_SHIFT
;
92 devidx
= md
->disk
->first_minor
>> MMC_SHIFT
;
94 blk_cleanup_queue(md
->queue
.queue
);
96 __clear_bit(devidx
, dev_use
);
101 mutex_unlock(&open_lock
);
104 static int mmc_blk_open(struct block_device
*bdev
, fmode_t mode
)
106 struct mmc_blk_data
*md
= mmc_blk_get(bdev
->bd_disk
);
111 check_disk_change(bdev
);
114 if ((mode
& FMODE_WRITE
) && md
->read_only
) {
123 static int mmc_blk_release(struct gendisk
*disk
, fmode_t mode
)
125 struct mmc_blk_data
*md
= disk
->private_data
;
132 mmc_blk_getgeo(struct block_device
*bdev
, struct hd_geometry
*geo
)
134 geo
->cylinders
= get_capacity(bdev
->bd_disk
) / (4 * 16);
140 static const struct block_device_operations mmc_bdops
= {
141 .open
= mmc_blk_open
,
142 .release
= mmc_blk_release
,
143 .getgeo
= mmc_blk_getgeo
,
144 .owner
= THIS_MODULE
,
147 struct mmc_blk_request
{
148 struct mmc_request mrq
;
149 struct mmc_command cmd
;
150 struct mmc_command stop
;
151 struct mmc_data data
;
154 static u32
mmc_sd_num_wr_blocks(struct mmc_card
*card
)
160 struct mmc_request mrq
;
161 struct mmc_command cmd
;
162 struct mmc_data data
;
163 unsigned int timeout_us
;
165 struct scatterlist sg
;
167 memset(&cmd
, 0, sizeof(struct mmc_command
));
169 cmd
.opcode
= MMC_APP_CMD
;
170 cmd
.arg
= card
->rca
<< 16;
171 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_AC
;
173 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 0);
176 if (!mmc_host_is_spi(card
->host
) && !(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_SPI_R1
| 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 blocks
= kmalloc(4, GFP_KERNEL
);
214 sg_init_one(&sg
, blocks
, 4);
216 mmc_wait_for_req(card
->host
, &mrq
);
218 result
= ntohl(*blocks
);
221 if (cmd
.error
|| data
.error
)
227 static u32
get_card_status(struct mmc_card
*card
, struct request
*req
)
229 struct mmc_command cmd
;
232 memset(&cmd
, 0, sizeof(struct mmc_command
));
233 cmd
.opcode
= MMC_SEND_STATUS
;
234 if (!mmc_host_is_spi(card
->host
))
235 cmd
.arg
= card
->rca
<< 16;
236 cmd
.flags
= MMC_RSP_SPI_R2
| MMC_RSP_R1
| MMC_CMD_AC
;
237 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 0);
239 printk(KERN_ERR
"%s: error %d sending status comand",
240 req
->rq_disk
->disk_name
, err
);
244 static int mmc_blk_issue_rq(struct mmc_queue
*mq
, struct request
*req
)
246 struct mmc_blk_data
*md
= mq
->data
;
247 struct mmc_card
*card
= md
->queue
.card
;
248 struct mmc_blk_request brq
;
249 int ret
= 1, disable_multi
= 0;
251 mmc_claim_host(card
->host
);
254 struct mmc_command cmd
;
255 u32 readcmd
, writecmd
, status
= 0;
257 memset(&brq
, 0, sizeof(struct mmc_blk_request
));
258 brq
.mrq
.cmd
= &brq
.cmd
;
259 brq
.mrq
.data
= &brq
.data
;
261 brq
.cmd
.arg
= blk_rq_pos(req
);
262 if (!mmc_card_blockaddr(card
))
264 brq
.cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_ADTC
;
265 brq
.data
.blksz
= 512;
266 brq
.stop
.opcode
= MMC_STOP_TRANSMISSION
;
268 brq
.stop
.flags
= MMC_RSP_SPI_R1B
| MMC_RSP_R1B
| MMC_CMD_AC
;
269 brq
.data
.blocks
= blk_rq_sectors(req
);
272 * The block layer doesn't support all sector count
273 * restrictions, so we need to be prepared for too big
276 if (brq
.data
.blocks
> card
->host
->max_blk_count
)
277 brq
.data
.blocks
= card
->host
->max_blk_count
;
280 * After a read error, we redo the request one sector at a time
281 * in order to accurately determine which sectors can be read
284 if (disable_multi
&& brq
.data
.blocks
> 1)
287 if (brq
.data
.blocks
> 1) {
288 /* SPI multiblock writes terminate using a special
289 * token, not a STOP_TRANSMISSION request.
291 if (!mmc_host_is_spi(card
->host
)
292 || rq_data_dir(req
) == READ
)
293 brq
.mrq
.stop
= &brq
.stop
;
294 readcmd
= MMC_READ_MULTIPLE_BLOCK
;
295 writecmd
= MMC_WRITE_MULTIPLE_BLOCK
;
298 readcmd
= MMC_READ_SINGLE_BLOCK
;
299 writecmd
= MMC_WRITE_BLOCK
;
302 if (rq_data_dir(req
) == READ
) {
303 brq
.cmd
.opcode
= readcmd
;
304 brq
.data
.flags
|= MMC_DATA_READ
;
306 brq
.cmd
.opcode
= writecmd
;
307 brq
.data
.flags
|= MMC_DATA_WRITE
;
310 mmc_set_data_timeout(&brq
.data
, card
);
312 brq
.data
.sg
= mq
->sg
;
313 brq
.data
.sg_len
= mmc_queue_map_sg(mq
);
316 * Adjust the sg list so it is the same size as the
319 if (brq
.data
.blocks
!= blk_rq_sectors(req
)) {
320 int i
, data_size
= brq
.data
.blocks
<< 9;
321 struct scatterlist
*sg
;
323 for_each_sg(brq
.data
.sg
, sg
, brq
.data
.sg_len
, i
) {
324 data_size
-= sg
->length
;
325 if (data_size
<= 0) {
326 sg
->length
+= data_size
;
334 mmc_queue_bounce_pre(mq
);
336 mmc_wait_for_req(card
->host
, &brq
.mrq
);
338 mmc_queue_bounce_post(mq
);
341 * Check for errors here, but don't jump to cmd_err
342 * until later as we need to wait for the card to leave
343 * programming mode even when things go wrong.
345 if (brq
.cmd
.error
|| brq
.data
.error
|| brq
.stop
.error
) {
346 if (brq
.data
.blocks
> 1 && rq_data_dir(req
) == READ
) {
347 /* Redo read one sector at a time */
348 printk(KERN_WARNING
"%s: retrying using single "
349 "block read\n", req
->rq_disk
->disk_name
);
353 status
= get_card_status(card
, req
);
357 printk(KERN_ERR
"%s: error %d sending read/write "
358 "command, response %#x, card status %#x\n",
359 req
->rq_disk
->disk_name
, brq
.cmd
.error
,
360 brq
.cmd
.resp
[0], status
);
363 if (brq
.data
.error
) {
364 if (brq
.data
.error
== -ETIMEDOUT
&& brq
.mrq
.stop
)
365 /* 'Stop' response contains card status */
366 status
= brq
.mrq
.stop
->resp
[0];
367 printk(KERN_ERR
"%s: error %d transferring data,"
368 " sector %u, nr %u, card status %#x\n",
369 req
->rq_disk
->disk_name
, brq
.data
.error
,
370 (unsigned)blk_rq_pos(req
),
371 (unsigned)blk_rq_sectors(req
), status
);
374 if (brq
.stop
.error
) {
375 printk(KERN_ERR
"%s: error %d sending stop command, "
376 "response %#x, card status %#x\n",
377 req
->rq_disk
->disk_name
, brq
.stop
.error
,
378 brq
.stop
.resp
[0], status
);
381 if (!mmc_host_is_spi(card
->host
) && rq_data_dir(req
) != READ
) {
385 cmd
.opcode
= MMC_SEND_STATUS
;
386 cmd
.arg
= card
->rca
<< 16;
387 cmd
.flags
= MMC_RSP_R1
| MMC_CMD_AC
;
388 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 5);
390 printk(KERN_ERR
"%s: error %d requesting status\n",
391 req
->rq_disk
->disk_name
, err
);
395 * Some cards mishandle the status bits,
396 * so make sure to check both the busy
397 * indication and the card state.
399 } while (!(cmd
.resp
[0] & R1_READY_FOR_DATA
) ||
400 (R1_CURRENT_STATE(cmd
.resp
[0]) == 7));
403 if (cmd
.resp
[0] & ~0x00000900)
404 printk(KERN_ERR
"%s: status = %08x\n",
405 req
->rq_disk
->disk_name
, cmd
.resp
[0]);
406 if (mmc_decode_status(cmd
.resp
))
411 if (brq
.cmd
.error
|| brq
.stop
.error
|| brq
.data
.error
) {
412 if (rq_data_dir(req
) == READ
) {
414 * After an error, we redo I/O one sector at a
415 * time, so we only reach here after trying to
416 * read a single sector.
418 spin_lock_irq(&md
->lock
);
419 ret
= __blk_end_request(req
, -EIO
, brq
.data
.blksz
);
420 spin_unlock_irq(&md
->lock
);
427 * A block was successfully transferred.
429 spin_lock_irq(&md
->lock
);
430 ret
= __blk_end_request(req
, 0, brq
.data
.bytes_xfered
);
431 spin_unlock_irq(&md
->lock
);
434 mmc_release_host(card
->host
);
440 * If this is an SD card and we're writing, we can first
441 * mark the known good sectors as ok.
443 * If the card is not SD, we can still ok written sectors
444 * as reported by the controller (which might be less than
445 * the real number of written sectors, but never more).
447 if (mmc_card_sd(card
)) {
450 blocks
= mmc_sd_num_wr_blocks(card
);
451 if (blocks
!= (u32
)-1) {
452 spin_lock_irq(&md
->lock
);
453 ret
= __blk_end_request(req
, 0, blocks
<< 9);
454 spin_unlock_irq(&md
->lock
);
457 spin_lock_irq(&md
->lock
);
458 ret
= __blk_end_request(req
, 0, brq
.data
.bytes_xfered
);
459 spin_unlock_irq(&md
->lock
);
462 mmc_release_host(card
->host
);
464 spin_lock_irq(&md
->lock
);
466 ret
= __blk_end_request(req
, -EIO
, blk_rq_cur_bytes(req
));
467 spin_unlock_irq(&md
->lock
);
473 static inline int mmc_blk_readonly(struct mmc_card
*card
)
475 return mmc_card_readonly(card
) ||
476 !(card
->csd
.cmdclass
& CCC_BLOCK_WRITE
);
479 static struct mmc_blk_data
*mmc_blk_alloc(struct mmc_card
*card
)
481 struct mmc_blk_data
*md
;
484 devidx
= find_first_zero_bit(dev_use
, MMC_NUM_MINORS
);
485 if (devidx
>= MMC_NUM_MINORS
)
486 return ERR_PTR(-ENOSPC
);
487 __set_bit(devidx
, dev_use
);
489 md
= kzalloc(sizeof(struct mmc_blk_data
), GFP_KERNEL
);
497 * Set the read-only status based on the supported commands
498 * and the write protect switch.
500 md
->read_only
= mmc_blk_readonly(card
);
502 md
->disk
= alloc_disk(1 << MMC_SHIFT
);
503 if (md
->disk
== NULL
) {
508 spin_lock_init(&md
->lock
);
511 ret
= mmc_init_queue(&md
->queue
, card
, &md
->lock
);
515 md
->queue
.issue_fn
= mmc_blk_issue_rq
;
518 md
->disk
->major
= MMC_BLOCK_MAJOR
;
519 md
->disk
->first_minor
= devidx
<< MMC_SHIFT
;
520 md
->disk
->fops
= &mmc_bdops
;
521 md
->disk
->private_data
= md
;
522 md
->disk
->queue
= md
->queue
.queue
;
523 md
->disk
->driverfs_dev
= &card
->dev
;
526 * As discussed on lkml, GENHD_FL_REMOVABLE should:
528 * - be set for removable media with permanent block devices
529 * - be unset for removable block devices with permanent media
531 * Since MMC block devices clearly fall under the second
532 * case, we do not set GENHD_FL_REMOVABLE. Userspace
533 * should use the block device creation/destruction hotplug
534 * messages to tell when the card is present.
537 sprintf(md
->disk
->disk_name
, "mmcblk%d", devidx
);
539 blk_queue_logical_block_size(md
->queue
.queue
, 512);
541 if (!mmc_card_sd(card
) && mmc_card_blockaddr(card
)) {
543 * The EXT_CSD sector count is in number or 512 byte
546 set_capacity(md
->disk
, card
->ext_csd
.sectors
);
549 * The CSD capacity field is in units of read_blkbits.
550 * set_capacity takes units of 512 bytes.
552 set_capacity(md
->disk
,
553 card
->csd
.capacity
<< (card
->csd
.read_blkbits
- 9));
566 mmc_blk_set_blksize(struct mmc_blk_data
*md
, struct mmc_card
*card
)
568 struct mmc_command cmd
;
571 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
572 if (mmc_card_blockaddr(card
))
575 mmc_claim_host(card
->host
);
576 cmd
.opcode
= MMC_SET_BLOCKLEN
;
578 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_AC
;
579 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 5);
580 mmc_release_host(card
->host
);
583 printk(KERN_ERR
"%s: unable to set block size to %d: %d\n",
584 md
->disk
->disk_name
, cmd
.arg
, err
);
591 static int mmc_blk_probe(struct mmc_card
*card
)
593 struct mmc_blk_data
*md
;
599 * Check that the card supports the command class(es) we need.
601 if (!(card
->csd
.cmdclass
& CCC_BLOCK_READ
))
604 md
= mmc_blk_alloc(card
);
608 err
= mmc_blk_set_blksize(md
, card
);
612 string_get_size((u64
)get_capacity(md
->disk
) << 9, STRING_UNITS_2
,
613 cap_str
, sizeof(cap_str
));
614 printk(KERN_INFO
"%s: %s %s %s %s\n",
615 md
->disk
->disk_name
, mmc_card_id(card
), mmc_card_name(card
),
616 cap_str
, md
->read_only
? "(ro)" : "");
618 mmc_set_drvdata(card
, md
);
623 mmc_cleanup_queue(&md
->queue
);
629 static void mmc_blk_remove(struct mmc_card
*card
)
631 struct mmc_blk_data
*md
= mmc_get_drvdata(card
);
634 /* Stop new requests from getting into the queue */
635 del_gendisk(md
->disk
);
637 /* Then flush out any already in there */
638 mmc_cleanup_queue(&md
->queue
);
642 mmc_set_drvdata(card
, NULL
);
646 static int mmc_blk_suspend(struct mmc_card
*card
, pm_message_t state
)
648 struct mmc_blk_data
*md
= mmc_get_drvdata(card
);
651 mmc_queue_suspend(&md
->queue
);
656 static int mmc_blk_resume(struct mmc_card
*card
)
658 struct mmc_blk_data
*md
= mmc_get_drvdata(card
);
661 mmc_blk_set_blksize(md
, card
);
662 mmc_queue_resume(&md
->queue
);
667 #define mmc_blk_suspend NULL
668 #define mmc_blk_resume NULL
671 static struct mmc_driver mmc_driver
= {
675 .probe
= mmc_blk_probe
,
676 .remove
= mmc_blk_remove
,
677 .suspend
= mmc_blk_suspend
,
678 .resume
= mmc_blk_resume
,
681 static int __init
mmc_blk_init(void)
685 res
= register_blkdev(MMC_BLOCK_MAJOR
, "mmc");
689 res
= mmc_register_driver(&mmc_driver
);
695 unregister_blkdev(MMC_BLOCK_MAJOR
, "mmc");
700 static void __exit
mmc_blk_exit(void)
702 mmc_unregister_driver(&mmc_driver
);
703 unregister_blkdev(MMC_BLOCK_MAJOR
, "mmc");
706 module_init(mmc_blk_init
);
707 module_exit(mmc_blk_exit
);
709 MODULE_LICENSE("GPL");
710 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");