Merge branch 'linus' into x86/step
[linux-2.6] / drivers / mmc / card / block.c
1 /*
2  * Block driver for media (i.e., flash cards)
3  *
4  * Copyright 2002 Hewlett-Packard Company
5  * Copyright 2005-2008 Pierre Ossman
6  *
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.
10  *
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.
14  *
15  * Many thanks to Alessandro Rubini and Jonathan Corbet!
16  *
17  * Author:  Andrew Christian
18  *          28 May 2002
19  */
20 #include <linux/moduleparam.h>
21 #include <linux/module.h>
22 #include <linux/init.h>
23
24 #include <linux/kernel.h>
25 #include <linux/fs.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
33 #include <linux/mmc/card.h>
34 #include <linux/mmc/host.h>
35 #include <linux/mmc/mmc.h>
36 #include <linux/mmc/sd.h>
37
38 #include <asm/system.h>
39 #include <asm/uaccess.h>
40
41 #include "queue.h"
42
43 /*
44  * max 8 partitions per card
45  */
46 #define MMC_SHIFT       3
47 #define MMC_NUM_MINORS  (256 >> MMC_SHIFT)
48
49 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
50
51 /*
52  * There is one mmc_blk_data per slot.
53  */
54 struct mmc_blk_data {
55         spinlock_t      lock;
56         struct gendisk  *disk;
57         struct mmc_queue queue;
58
59         unsigned int    usage;
60         unsigned int    block_bits;
61         unsigned int    read_only;
62 };
63
64 static DEFINE_MUTEX(open_lock);
65
66 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
67 {
68         struct mmc_blk_data *md;
69
70         mutex_lock(&open_lock);
71         md = disk->private_data;
72         if (md && md->usage == 0)
73                 md = NULL;
74         if (md)
75                 md->usage++;
76         mutex_unlock(&open_lock);
77
78         return md;
79 }
80
81 static void mmc_blk_put(struct mmc_blk_data *md)
82 {
83         mutex_lock(&open_lock);
84         md->usage--;
85         if (md->usage == 0) {
86                 int devidx = md->disk->first_minor >> MMC_SHIFT;
87                 __clear_bit(devidx, dev_use);
88
89                 put_disk(md->disk);
90                 kfree(md);
91         }
92         mutex_unlock(&open_lock);
93 }
94
95 static int mmc_blk_open(struct inode *inode, struct file *filp)
96 {
97         struct mmc_blk_data *md;
98         int ret = -ENXIO;
99
100         md = mmc_blk_get(inode->i_bdev->bd_disk);
101         if (md) {
102                 if (md->usage == 2)
103                         check_disk_change(inode->i_bdev);
104                 ret = 0;
105
106                 if ((filp->f_mode & FMODE_WRITE) && md->read_only)
107                         ret = -EROFS;
108         }
109
110         return ret;
111 }
112
113 static int mmc_blk_release(struct inode *inode, struct file *filp)
114 {
115         struct mmc_blk_data *md = inode->i_bdev->bd_disk->private_data;
116
117         mmc_blk_put(md);
118         return 0;
119 }
120
121 static int
122 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
123 {
124         geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
125         geo->heads = 4;
126         geo->sectors = 16;
127         return 0;
128 }
129
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,
135 };
136
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;
142 };
143
144 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
145 {
146         int err;
147         u32 blocks;
148
149         struct mmc_request mrq;
150         struct mmc_command cmd;
151         struct mmc_data data;
152         unsigned int timeout_us;
153
154         struct scatterlist sg;
155
156         memset(&cmd, 0, sizeof(struct mmc_command));
157
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;
161
162         err = mmc_wait_for_cmd(card->host, &cmd, 0);
163         if (err)
164                 return (u32)-1;
165         if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
166                 return (u32)-1;
167
168         memset(&cmd, 0, sizeof(struct mmc_command));
169
170         cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
171         cmd.arg = 0;
172         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
173
174         memset(&data, 0, sizeof(struct mmc_data));
175
176         data.timeout_ns = card->csd.tacc_ns * 100;
177         data.timeout_clks = card->csd.tacc_clks * 100;
178
179         timeout_us = data.timeout_ns / 1000;
180         timeout_us += data.timeout_clks * 1000 /
181                 (card->host->ios.clock / 1000);
182
183         if (timeout_us > 100000) {
184                 data.timeout_ns = 100000000;
185                 data.timeout_clks = 0;
186         }
187
188         data.blksz = 4;
189         data.blocks = 1;
190         data.flags = MMC_DATA_READ;
191         data.sg = &sg;
192         data.sg_len = 1;
193
194         memset(&mrq, 0, sizeof(struct mmc_request));
195
196         mrq.cmd = &cmd;
197         mrq.data = &data;
198
199         sg_init_one(&sg, &blocks, 4);
200
201         mmc_wait_for_req(card->host, &mrq);
202
203         if (cmd.error || data.error)
204                 return (u32)-1;
205
206         blocks = ntohl(blocks);
207
208         return blocks;
209 }
210
211 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
212 {
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;
217
218         mmc_claim_host(card->host);
219
220         do {
221                 struct mmc_command cmd;
222                 u32 readcmd, writecmd;
223
224                 memset(&brq, 0, sizeof(struct mmc_blk_request));
225                 brq.mrq.cmd = &brq.cmd;
226                 brq.mrq.data = &brq.data;
227
228                 brq.cmd.arg = req->sector;
229                 if (!mmc_card_blockaddr(card))
230                         brq.cmd.arg <<= 9;
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;
234                 brq.stop.arg = 0;
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;
239
240                 if (brq.data.blocks > 1) {
241                         /* SPI multiblock writes terminate using a special
242                          * token, not a STOP_TRANSMISSION request.
243                          */
244                         if (!mmc_host_is_spi(card->host)
245                                         || rq_data_dir(req) == READ)
246                                 brq.mrq.stop = &brq.stop;
247                         readcmd = MMC_READ_MULTIPLE_BLOCK;
248                         writecmd = MMC_WRITE_MULTIPLE_BLOCK;
249                 } else {
250                         brq.mrq.stop = NULL;
251                         readcmd = MMC_READ_SINGLE_BLOCK;
252                         writecmd = MMC_WRITE_BLOCK;
253                 }
254
255                 if (rq_data_dir(req) == READ) {
256                         brq.cmd.opcode = readcmd;
257                         brq.data.flags |= MMC_DATA_READ;
258                 } else {
259                         brq.cmd.opcode = writecmd;
260                         brq.data.flags |= MMC_DATA_WRITE;
261                 }
262
263                 mmc_set_data_timeout(&brq.data, card);
264
265                 brq.data.sg = mq->sg;
266                 brq.data.sg_len = mmc_queue_map_sg(mq);
267
268                 mmc_queue_bounce_pre(mq);
269
270                 if (brq.data.blocks !=
271                     (req->nr_sectors >> (md->block_bits - 9))) {
272                         data_size = brq.data.blocks * brq.data.blksz;
273                         for (sg_pos = 0; sg_pos < brq.data.sg_len; sg_pos++) {
274                                 data_size -= mq->sg[sg_pos].length;
275                                 if (data_size <= 0) {
276                                         mq->sg[sg_pos].length += data_size;
277                                         sg_pos++;
278                                         break;
279                                 }
280                         }
281                         brq.data.sg_len = sg_pos;
282                 }
283
284                 mmc_wait_for_req(card->host, &brq.mrq);
285
286                 mmc_queue_bounce_post(mq);
287
288                 /*
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.
292                  */
293                 if (brq.cmd.error) {
294                         printk(KERN_ERR "%s: error %d sending read/write command\n",
295                                req->rq_disk->disk_name, brq.cmd.error);
296                 }
297
298                 if (brq.data.error) {
299                         printk(KERN_ERR "%s: error %d transferring data\n",
300                                req->rq_disk->disk_name, brq.data.error);
301                 }
302
303                 if (brq.stop.error) {
304                         printk(KERN_ERR "%s: error %d sending stop command\n",
305                                req->rq_disk->disk_name, brq.stop.error);
306                 }
307
308                 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
309                         do {
310                                 int err;
311
312                                 cmd.opcode = MMC_SEND_STATUS;
313                                 cmd.arg = card->rca << 16;
314                                 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
315                                 err = mmc_wait_for_cmd(card->host, &cmd, 5);
316                                 if (err) {
317                                         printk(KERN_ERR "%s: error %d requesting status\n",
318                                                req->rq_disk->disk_name, err);
319                                         goto cmd_err;
320                                 }
321                                 /*
322                                  * Some cards mishandle the status bits,
323                                  * so make sure to check both the busy
324                                  * indication and the card state.
325                                  */
326                         } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
327                                 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
328
329 #if 0
330                         if (cmd.resp[0] & ~0x00000900)
331                                 printk(KERN_ERR "%s: status = %08x\n",
332                                        req->rq_disk->disk_name, cmd.resp[0]);
333                         if (mmc_decode_status(cmd.resp))
334                                 goto cmd_err;
335 #endif
336                 }
337
338                 if (brq.cmd.error || brq.data.error || brq.stop.error)
339                         goto cmd_err;
340
341                 /*
342                  * A block was successfully transferred.
343                  */
344                 spin_lock_irq(&md->lock);
345                 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
346                 spin_unlock_irq(&md->lock);
347         } while (ret);
348
349         mmc_release_host(card->host);
350
351         return 1;
352
353  cmd_err:
354         /*
355          * If this is an SD card and we're writing, we can first
356          * mark the known good sectors as ok.
357          *
358          * If the card is not SD, we can still ok written sectors
359          * as reported by the controller (which might be less than
360          * the real number of written sectors, but never more).
361          *
362          * For reads we just fail the entire chunk as that should
363          * be safe in all cases.
364          */
365         if (rq_data_dir(req) != READ) {
366                 if (mmc_card_sd(card)) {
367                         u32 blocks;
368                         unsigned int bytes;
369
370                         blocks = mmc_sd_num_wr_blocks(card);
371                         if (blocks != (u32)-1) {
372                                 if (card->csd.write_partial)
373                                         bytes = blocks << md->block_bits;
374                                 else
375                                         bytes = blocks << 9;
376                                 spin_lock_irq(&md->lock);
377                                 ret = __blk_end_request(req, 0, bytes);
378                                 spin_unlock_irq(&md->lock);
379                         }
380                 } else {
381                         spin_lock_irq(&md->lock);
382                         ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
383                         spin_unlock_irq(&md->lock);
384                 }
385         }
386
387         mmc_release_host(card->host);
388
389         spin_lock_irq(&md->lock);
390         while (ret)
391                 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
392         spin_unlock_irq(&md->lock);
393
394         return 0;
395 }
396
397
398 static inline int mmc_blk_readonly(struct mmc_card *card)
399 {
400         return mmc_card_readonly(card) ||
401                !(card->csd.cmdclass & CCC_BLOCK_WRITE);
402 }
403
404 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
405 {
406         struct mmc_blk_data *md;
407         int devidx, ret;
408
409         devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
410         if (devidx >= MMC_NUM_MINORS)
411                 return ERR_PTR(-ENOSPC);
412         __set_bit(devidx, dev_use);
413
414         md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
415         if (!md) {
416                 ret = -ENOMEM;
417                 goto out;
418         }
419
420
421         /*
422          * Set the read-only status based on the supported commands
423          * and the write protect switch.
424          */
425         md->read_only = mmc_blk_readonly(card);
426
427         /*
428          * Both SD and MMC specifications state (although a bit
429          * unclearly in the MMC case) that a block size of 512
430          * bytes must always be supported by the card.
431          */
432         md->block_bits = 9;
433
434         md->disk = alloc_disk(1 << MMC_SHIFT);
435         if (md->disk == NULL) {
436                 ret = -ENOMEM;
437                 goto err_kfree;
438         }
439
440         spin_lock_init(&md->lock);
441         md->usage = 1;
442
443         ret = mmc_init_queue(&md->queue, card, &md->lock);
444         if (ret)
445                 goto err_putdisk;
446
447         md->queue.issue_fn = mmc_blk_issue_rq;
448         md->queue.data = md;
449
450         md->disk->major = MMC_BLOCK_MAJOR;
451         md->disk->first_minor = devidx << MMC_SHIFT;
452         md->disk->fops = &mmc_bdops;
453         md->disk->private_data = md;
454         md->disk->queue = md->queue.queue;
455         md->disk->driverfs_dev = &card->dev;
456
457         /*
458          * As discussed on lkml, GENHD_FL_REMOVABLE should:
459          *
460          * - be set for removable media with permanent block devices
461          * - be unset for removable block devices with permanent media
462          *
463          * Since MMC block devices clearly fall under the second
464          * case, we do not set GENHD_FL_REMOVABLE.  Userspace
465          * should use the block device creation/destruction hotplug
466          * messages to tell when the card is present.
467          */
468
469         sprintf(md->disk->disk_name, "mmcblk%d", devidx);
470
471         blk_queue_hardsect_size(md->queue.queue, 1 << md->block_bits);
472
473         if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
474                 /*
475                  * The EXT_CSD sector count is in number or 512 byte
476                  * sectors.
477                  */
478                 set_capacity(md->disk, card->ext_csd.sectors);
479         } else {
480                 /*
481                  * The CSD capacity field is in units of read_blkbits.
482                  * set_capacity takes units of 512 bytes.
483                  */
484                 set_capacity(md->disk,
485                         card->csd.capacity << (card->csd.read_blkbits - 9));
486         }
487         return md;
488
489  err_putdisk:
490         put_disk(md->disk);
491  err_kfree:
492         kfree(md);
493  out:
494         return ERR_PTR(ret);
495 }
496
497 static int
498 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
499 {
500         struct mmc_command cmd;
501         int err;
502
503         /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
504         if (mmc_card_blockaddr(card))
505                 return 0;
506
507         mmc_claim_host(card->host);
508         cmd.opcode = MMC_SET_BLOCKLEN;
509         cmd.arg = 1 << md->block_bits;
510         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
511         err = mmc_wait_for_cmd(card->host, &cmd, 5);
512         mmc_release_host(card->host);
513
514         if (err) {
515                 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
516                         md->disk->disk_name, cmd.arg, err);
517                 return -EINVAL;
518         }
519
520         return 0;
521 }
522
523 static int mmc_blk_probe(struct mmc_card *card)
524 {
525         struct mmc_blk_data *md;
526         int err;
527
528         /*
529          * Check that the card supports the command class(es) we need.
530          */
531         if (!(card->csd.cmdclass & CCC_BLOCK_READ))
532                 return -ENODEV;
533
534         md = mmc_blk_alloc(card);
535         if (IS_ERR(md))
536                 return PTR_ERR(md);
537
538         err = mmc_blk_set_blksize(md, card);
539         if (err)
540                 goto out;
541
542         printk(KERN_INFO "%s: %s %s %lluKiB %s\n",
543                 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
544                 (unsigned long long)(get_capacity(md->disk) >> 1),
545                 md->read_only ? "(ro)" : "");
546
547         mmc_set_drvdata(card, md);
548         add_disk(md->disk);
549         return 0;
550
551  out:
552         mmc_blk_put(md);
553
554         return err;
555 }
556
557 static void mmc_blk_remove(struct mmc_card *card)
558 {
559         struct mmc_blk_data *md = mmc_get_drvdata(card);
560
561         if (md) {
562                 /* Stop new requests from getting into the queue */
563                 del_gendisk(md->disk);
564
565                 /* Then flush out any already in there */
566                 mmc_cleanup_queue(&md->queue);
567
568                 mmc_blk_put(md);
569         }
570         mmc_set_drvdata(card, NULL);
571 }
572
573 #ifdef CONFIG_PM
574 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
575 {
576         struct mmc_blk_data *md = mmc_get_drvdata(card);
577
578         if (md) {
579                 mmc_queue_suspend(&md->queue);
580         }
581         return 0;
582 }
583
584 static int mmc_blk_resume(struct mmc_card *card)
585 {
586         struct mmc_blk_data *md = mmc_get_drvdata(card);
587
588         if (md) {
589                 mmc_blk_set_blksize(md, card);
590                 mmc_queue_resume(&md->queue);
591         }
592         return 0;
593 }
594 #else
595 #define mmc_blk_suspend NULL
596 #define mmc_blk_resume  NULL
597 #endif
598
599 static struct mmc_driver mmc_driver = {
600         .drv            = {
601                 .name   = "mmcblk",
602         },
603         .probe          = mmc_blk_probe,
604         .remove         = mmc_blk_remove,
605         .suspend        = mmc_blk_suspend,
606         .resume         = mmc_blk_resume,
607 };
608
609 static int __init mmc_blk_init(void)
610 {
611         int res = -ENOMEM;
612
613         res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
614         if (res)
615                 goto out;
616
617         return mmc_register_driver(&mmc_driver);
618
619  out:
620         return res;
621 }
622
623 static void __exit mmc_blk_exit(void)
624 {
625         mmc_unregister_driver(&mmc_driver);
626         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
627 }
628
629 module_init(mmc_blk_init);
630 module_exit(mmc_blk_exit);
631
632 MODULE_LICENSE("GPL");
633 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
634