2 * Block driver for media (i.e., flash cards)
4 * Copyright 2002 Hewlett-Packard Company
5 * Copyright 2005-2007 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>
33 #include <linux/mmc/card.h>
34 #include <linux/mmc/host.h>
35 #include <linux/mmc/mmc.h>
36 #include <linux/mmc/sd.h>
38 #include <asm/system.h>
39 #include <asm/uaccess.h>
44 * max 8 partitions per card
47 #define MMC_NUM_MINORS (256 >> MMC_SHIFT)
49 static unsigned long dev_use
[MMC_NUM_MINORS
/(8*sizeof(unsigned long))];
52 * There is one mmc_blk_data per slot.
57 struct mmc_queue queue
;
60 unsigned int block_bits
;
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
= md
->disk
->first_minor
>> MMC_SHIFT
;
87 __clear_bit(devidx
, dev_use
);
92 mutex_unlock(&open_lock
);
95 static int mmc_blk_open(struct inode
*inode
, struct file
*filp
)
97 struct mmc_blk_data
*md
;
100 md
= mmc_blk_get(inode
->i_bdev
->bd_disk
);
103 check_disk_change(inode
->i_bdev
);
106 if ((filp
->f_mode
& FMODE_WRITE
) && md
->read_only
)
113 static int mmc_blk_release(struct inode
*inode
, struct file
*filp
)
115 struct mmc_blk_data
*md
= inode
->i_bdev
->bd_disk
->private_data
;
122 mmc_blk_getgeo(struct block_device
*bdev
, struct hd_geometry
*geo
)
124 geo
->cylinders
= get_capacity(bdev
->bd_disk
) / (4 * 16);
130 static struct block_device_operations mmc_bdops
= {
131 .open
= mmc_blk_open
,
132 .release
= mmc_blk_release
,
133 .getgeo
= mmc_blk_getgeo
,
134 .owner
= THIS_MODULE
,
137 struct mmc_blk_request
{
138 struct mmc_request mrq
;
139 struct mmc_command cmd
;
140 struct mmc_command stop
;
141 struct mmc_data data
;
144 static u32
mmc_sd_num_wr_blocks(struct mmc_card
*card
)
149 struct mmc_request mrq
;
150 struct mmc_command cmd
;
151 struct mmc_data data
;
152 unsigned int timeout_us
;
154 struct scatterlist sg
;
156 memset(&cmd
, 0, sizeof(struct mmc_command
));
158 cmd
.opcode
= MMC_APP_CMD
;
159 cmd
.arg
= card
->rca
<< 16;
160 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_AC
;
162 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 0);
165 if (!mmc_host_is_spi(card
->host
) && !(cmd
.resp
[0] & R1_APP_CMD
))
168 memset(&cmd
, 0, sizeof(struct mmc_command
));
170 cmd
.opcode
= SD_APP_SEND_NUM_WR_BLKS
;
172 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_ADTC
;
174 memset(&data
, 0, sizeof(struct mmc_data
));
176 data
.timeout_ns
= card
->csd
.tacc_ns
* 100;
177 data
.timeout_clks
= card
->csd
.tacc_clks
* 100;
179 timeout_us
= data
.timeout_ns
/ 1000;
180 timeout_us
+= data
.timeout_clks
* 1000 /
181 (card
->host
->ios
.clock
/ 1000);
183 if (timeout_us
> 100000) {
184 data
.timeout_ns
= 100000000;
185 data
.timeout_clks
= 0;
190 data
.flags
= MMC_DATA_READ
;
194 memset(&mrq
, 0, sizeof(struct mmc_request
));
199 sg_init_one(&sg
, &blocks
, 4);
201 mmc_wait_for_req(card
->host
, &mrq
);
203 if (cmd
.error
|| data
.error
)
206 blocks
= ntohl(blocks
);
211 static int mmc_blk_issue_rq(struct mmc_queue
*mq
, struct request
*req
)
213 struct mmc_blk_data
*md
= mq
->data
;
214 struct mmc_card
*card
= md
->queue
.card
;
215 struct mmc_blk_request brq
;
216 int ret
= 1, sg_pos
, data_size
;
218 mmc_claim_host(card
->host
);
221 struct mmc_command cmd
;
222 u32 readcmd
, writecmd
;
224 memset(&brq
, 0, sizeof(struct mmc_blk_request
));
225 brq
.mrq
.cmd
= &brq
.cmd
;
226 brq
.mrq
.data
= &brq
.data
;
228 brq
.cmd
.arg
= req
->sector
;
229 if (!mmc_card_blockaddr(card
))
231 brq
.cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_ADTC
;
232 brq
.data
.blksz
= 1 << md
->block_bits
;
233 brq
.stop
.opcode
= MMC_STOP_TRANSMISSION
;
235 brq
.stop
.flags
= MMC_RSP_SPI_R1B
| MMC_RSP_R1B
| MMC_CMD_AC
;
236 brq
.data
.blocks
= req
->nr_sectors
>> (md
->block_bits
- 9);
237 if (brq
.data
.blocks
> card
->host
->max_blk_count
)
238 brq
.data
.blocks
= card
->host
->max_blk_count
;
241 * If the host doesn't support multiple block writes, force
242 * block writes to single block. SD cards are excepted from
243 * this rule as they support querying the number of
244 * successfully written sectors.
246 if (rq_data_dir(req
) != READ
&&
247 !(card
->host
->caps
& MMC_CAP_MULTIWRITE
) &&
251 if (brq
.data
.blocks
> 1) {
252 /* SPI multiblock writes terminate using a special
253 * token, not a STOP_TRANSMISSION request.
255 if (!mmc_host_is_spi(card
->host
)
256 || rq_data_dir(req
) == READ
)
257 brq
.mrq
.stop
= &brq
.stop
;
258 readcmd
= MMC_READ_MULTIPLE_BLOCK
;
259 writecmd
= MMC_WRITE_MULTIPLE_BLOCK
;
262 readcmd
= MMC_READ_SINGLE_BLOCK
;
263 writecmd
= MMC_WRITE_BLOCK
;
266 if (rq_data_dir(req
) == READ
) {
267 brq
.cmd
.opcode
= readcmd
;
268 brq
.data
.flags
|= MMC_DATA_READ
;
270 brq
.cmd
.opcode
= writecmd
;
271 brq
.data
.flags
|= MMC_DATA_WRITE
;
274 mmc_set_data_timeout(&brq
.data
, card
);
276 brq
.data
.sg
= mq
->sg
;
277 brq
.data
.sg_len
= mmc_queue_map_sg(mq
);
279 mmc_queue_bounce_pre(mq
);
281 if (brq
.data
.blocks
!=
282 (req
->nr_sectors
>> (md
->block_bits
- 9))) {
283 data_size
= brq
.data
.blocks
* brq
.data
.blksz
;
284 for (sg_pos
= 0; sg_pos
< brq
.data
.sg_len
; sg_pos
++) {
285 data_size
-= mq
->sg
[sg_pos
].length
;
286 if (data_size
<= 0) {
287 mq
->sg
[sg_pos
].length
+= data_size
;
292 brq
.data
.sg_len
= sg_pos
;
295 mmc_wait_for_req(card
->host
, &brq
.mrq
);
297 mmc_queue_bounce_post(mq
);
300 printk(KERN_ERR
"%s: error %d sending read/write command\n",
301 req
->rq_disk
->disk_name
, brq
.cmd
.error
);
305 if (brq
.data
.error
) {
306 printk(KERN_ERR
"%s: error %d transferring data\n",
307 req
->rq_disk
->disk_name
, brq
.data
.error
);
311 if (brq
.stop
.error
) {
312 printk(KERN_ERR
"%s: error %d sending stop command\n",
313 req
->rq_disk
->disk_name
, brq
.stop
.error
);
317 if (!mmc_host_is_spi(card
->host
) && rq_data_dir(req
) != READ
) {
321 cmd
.opcode
= MMC_SEND_STATUS
;
322 cmd
.arg
= card
->rca
<< 16;
323 cmd
.flags
= MMC_RSP_R1
| MMC_CMD_AC
;
324 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 5);
326 printk(KERN_ERR
"%s: error %d requesting status\n",
327 req
->rq_disk
->disk_name
, err
);
331 * Some cards mishandle the status bits,
332 * so make sure to check both the busy
333 * indication and the card state.
335 } while (!(cmd
.resp
[0] & R1_READY_FOR_DATA
) ||
336 (R1_CURRENT_STATE(cmd
.resp
[0]) == 7));
339 if (cmd
.resp
[0] & ~0x00000900)
340 printk(KERN_ERR
"%s: status = %08x\n",
341 req
->rq_disk
->disk_name
, cmd
.resp
[0]);
342 if (mmc_decode_status(cmd
.resp
))
348 * A block was successfully transferred.
350 spin_lock_irq(&md
->lock
);
351 ret
= end_that_request_chunk(req
, 1, brq
.data
.bytes_xfered
);
354 * The whole request completed successfully.
356 add_disk_randomness(req
->rq_disk
);
357 blkdev_dequeue_request(req
);
358 end_that_request_last(req
, 1);
360 spin_unlock_irq(&md
->lock
);
363 mmc_release_host(card
->host
);
369 * If this is an SD card and we're writing, we can first
370 * mark the known good sectors as ok.
372 * If the card is not SD, we can still ok written sectors
373 * if the controller can do proper error reporting.
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
&& mmc_card_sd(card
)) {
382 blocks
= mmc_sd_num_wr_blocks(card
);
383 if (blocks
!= (u32
)-1) {
384 if (card
->csd
.write_partial
)
385 bytes
= blocks
<< md
->block_bits
;
388 spin_lock_irq(&md
->lock
);
389 ret
= end_that_request_chunk(req
, 1, bytes
);
390 spin_unlock_irq(&md
->lock
);
392 } else if (rq_data_dir(req
) != READ
&&
393 (card
->host
->caps
& MMC_CAP_MULTIWRITE
)) {
394 spin_lock_irq(&md
->lock
);
395 ret
= end_that_request_chunk(req
, 1, brq
.data
.bytes_xfered
);
396 spin_unlock_irq(&md
->lock
);
399 mmc_release_host(card
->host
);
401 spin_lock_irq(&md
->lock
);
403 ret
= end_that_request_chunk(req
, 0,
404 req
->current_nr_sectors
<< 9);
407 add_disk_randomness(req
->rq_disk
);
408 blkdev_dequeue_request(req
);
409 end_that_request_last(req
, 0);
410 spin_unlock_irq(&md
->lock
);
416 static inline int mmc_blk_readonly(struct mmc_card
*card
)
418 return mmc_card_readonly(card
) ||
419 !(card
->csd
.cmdclass
& CCC_BLOCK_WRITE
);
422 static struct mmc_blk_data
*mmc_blk_alloc(struct mmc_card
*card
)
424 struct mmc_blk_data
*md
;
427 devidx
= find_first_zero_bit(dev_use
, MMC_NUM_MINORS
);
428 if (devidx
>= MMC_NUM_MINORS
)
429 return ERR_PTR(-ENOSPC
);
430 __set_bit(devidx
, dev_use
);
432 md
= kzalloc(sizeof(struct mmc_blk_data
), GFP_KERNEL
);
440 * Set the read-only status based on the supported commands
441 * and the write protect switch.
443 md
->read_only
= mmc_blk_readonly(card
);
446 * Both SD and MMC specifications state (although a bit
447 * unclearly in the MMC case) that a block size of 512
448 * bytes must always be supported by the card.
452 md
->disk
= alloc_disk(1 << MMC_SHIFT
);
453 if (md
->disk
== NULL
) {
458 spin_lock_init(&md
->lock
);
461 ret
= mmc_init_queue(&md
->queue
, card
, &md
->lock
);
465 md
->queue
.issue_fn
= mmc_blk_issue_rq
;
468 md
->disk
->major
= MMC_BLOCK_MAJOR
;
469 md
->disk
->first_minor
= devidx
<< MMC_SHIFT
;
470 md
->disk
->fops
= &mmc_bdops
;
471 md
->disk
->private_data
= md
;
472 md
->disk
->queue
= md
->queue
.queue
;
473 md
->disk
->driverfs_dev
= &card
->dev
;
476 * As discussed on lkml, GENHD_FL_REMOVABLE should:
478 * - be set for removable media with permanent block devices
479 * - be unset for removable block devices with permanent media
481 * Since MMC block devices clearly fall under the second
482 * case, we do not set GENHD_FL_REMOVABLE. Userspace
483 * should use the block device creation/destruction hotplug
484 * messages to tell when the card is present.
487 sprintf(md
->disk
->disk_name
, "mmcblk%d", devidx
);
489 blk_queue_hardsect_size(md
->queue
.queue
, 1 << md
->block_bits
);
491 if (!mmc_card_sd(card
) && mmc_card_blockaddr(card
)) {
493 * The EXT_CSD sector count is in number or 512 byte
496 set_capacity(md
->disk
, card
->ext_csd
.sectors
);
499 * The CSD capacity field is in units of read_blkbits.
500 * set_capacity takes units of 512 bytes.
502 set_capacity(md
->disk
,
503 card
->csd
.capacity
<< (card
->csd
.read_blkbits
- 9));
516 mmc_blk_set_blksize(struct mmc_blk_data
*md
, struct mmc_card
*card
)
518 struct mmc_command cmd
;
521 /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
522 if (mmc_card_blockaddr(card
))
525 mmc_claim_host(card
->host
);
526 cmd
.opcode
= MMC_SET_BLOCKLEN
;
527 cmd
.arg
= 1 << md
->block_bits
;
528 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_AC
;
529 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 5);
530 mmc_release_host(card
->host
);
533 printk(KERN_ERR
"%s: unable to set block size to %d: %d\n",
534 md
->disk
->disk_name
, cmd
.arg
, err
);
541 static int mmc_blk_probe(struct mmc_card
*card
)
543 struct mmc_blk_data
*md
;
547 * Check that the card supports the command class(es) we need.
549 if (!(card
->csd
.cmdclass
& CCC_BLOCK_READ
))
552 md
= mmc_blk_alloc(card
);
556 err
= mmc_blk_set_blksize(md
, card
);
560 printk(KERN_INFO
"%s: %s %s %lluKiB %s\n",
561 md
->disk
->disk_name
, mmc_card_id(card
), mmc_card_name(card
),
562 (unsigned long long)(get_capacity(md
->disk
) >> 1),
563 md
->read_only
? "(ro)" : "");
565 mmc_set_drvdata(card
, md
);
575 static void mmc_blk_remove(struct mmc_card
*card
)
577 struct mmc_blk_data
*md
= mmc_get_drvdata(card
);
580 /* Stop new requests from getting into the queue */
581 del_gendisk(md
->disk
);
583 /* Then flush out any already in there */
584 mmc_cleanup_queue(&md
->queue
);
588 mmc_set_drvdata(card
, NULL
);
592 static int mmc_blk_suspend(struct mmc_card
*card
, pm_message_t state
)
594 struct mmc_blk_data
*md
= mmc_get_drvdata(card
);
597 mmc_queue_suspend(&md
->queue
);
602 static int mmc_blk_resume(struct mmc_card
*card
)
604 struct mmc_blk_data
*md
= mmc_get_drvdata(card
);
607 mmc_blk_set_blksize(md
, card
);
608 mmc_queue_resume(&md
->queue
);
613 #define mmc_blk_suspend NULL
614 #define mmc_blk_resume NULL
617 static struct mmc_driver mmc_driver
= {
621 .probe
= mmc_blk_probe
,
622 .remove
= mmc_blk_remove
,
623 .suspend
= mmc_blk_suspend
,
624 .resume
= mmc_blk_resume
,
627 static int __init
mmc_blk_init(void)
631 res
= register_blkdev(MMC_BLOCK_MAJOR
, "mmc");
635 return mmc_register_driver(&mmc_driver
);
641 static void __exit
mmc_blk_exit(void)
643 mmc_unregister_driver(&mmc_driver
);
644 unregister_blkdev(MMC_BLOCK_MAJOR
, "mmc");
647 module_init(mmc_blk_init
);
648 module_exit(mmc_blk_exit
);
650 MODULE_LICENSE("GPL");
651 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");