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