Merge master.kernel.org:/home/rmk/linux-2.6-mmc
[linux-2.6.git] / 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/devfs_fs_kernel.h>
31
32 #include <linux/mmc/card.h>
33 #include <linux/mmc/protocol.h>
34
35 #include <asm/system.h>
36 #include <asm/uaccess.h>
37
38 #include "mmc_queue.h"
39
40 /*
41  * max 8 partitions per card
42  */
43 #define MMC_SHIFT       3
44
45 static int major;
46
47 /*
48  * There is one mmc_blk_data per slot.
49  */
50 struct mmc_blk_data {
51         spinlock_t      lock;
52         struct gendisk  *disk;
53         struct mmc_queue queue;
54
55         unsigned int    usage;
56         unsigned int    block_bits;
57         unsigned int    read_only;
58 };
59
60 static DECLARE_MUTEX(open_lock);
61
62 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
63 {
64         struct mmc_blk_data *md;
65
66         down(&open_lock);
67         md = disk->private_data;
68         if (md && md->usage == 0)
69                 md = NULL;
70         if (md)
71                 md->usage++;
72         up(&open_lock);
73
74         return md;
75 }
76
77 static void mmc_blk_put(struct mmc_blk_data *md)
78 {
79         down(&open_lock);
80         md->usage--;
81         if (md->usage == 0) {
82                 put_disk(md->disk);
83                 mmc_cleanup_queue(&md->queue);
84                 kfree(md);
85         }
86         up(&open_lock);
87 }
88
89 static int mmc_blk_open(struct inode *inode, struct file *filp)
90 {
91         struct mmc_blk_data *md;
92         int ret = -ENXIO;
93
94         md = mmc_blk_get(inode->i_bdev->bd_disk);
95         if (md) {
96                 if (md->usage == 2)
97                         check_disk_change(inode->i_bdev);
98                 ret = 0;
99
100                 if ((filp->f_mode & FMODE_WRITE) && md->read_only)
101                         ret = -EROFS;
102         }
103
104         return ret;
105 }
106
107 static int mmc_blk_release(struct inode *inode, struct file *filp)
108 {
109         struct mmc_blk_data *md = inode->i_bdev->bd_disk->private_data;
110
111         mmc_blk_put(md);
112         return 0;
113 }
114
115 static int
116 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
117 {
118         geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
119         geo->heads = 4;
120         geo->sectors = 16;
121         return 0;
122 }
123
124 static struct block_device_operations mmc_bdops = {
125         .open                   = mmc_blk_open,
126         .release                = mmc_blk_release,
127         .getgeo                 = mmc_blk_getgeo,
128         .owner                  = THIS_MODULE,
129 };
130
131 struct mmc_blk_request {
132         struct mmc_request      mrq;
133         struct mmc_command      cmd;
134         struct mmc_command      stop;
135         struct mmc_data         data;
136 };
137
138 static int mmc_blk_prep_rq(struct mmc_queue *mq, struct request *req)
139 {
140         struct mmc_blk_data *md = mq->data;
141         int stat = BLKPREP_OK;
142
143         /*
144          * If we have no device, we haven't finished initialising.
145          */
146         if (!md || !mq->card) {
147                 printk(KERN_ERR "%s: killing request - no device/host\n",
148                        req->rq_disk->disk_name);
149                 stat = BLKPREP_KILL;
150         }
151
152         return stat;
153 }
154
155 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
156 {
157         struct mmc_blk_data *md = mq->data;
158         struct mmc_card *card = md->queue.card;
159         int ret;
160
161         if (mmc_card_claim_host(card))
162                 goto cmd_err;
163
164         do {
165                 struct mmc_blk_request brq;
166                 struct mmc_command cmd;
167
168                 memset(&brq, 0, sizeof(struct mmc_blk_request));
169                 brq.mrq.cmd = &brq.cmd;
170                 brq.mrq.data = &brq.data;
171
172                 brq.cmd.arg = req->sector << 9;
173                 brq.cmd.flags = MMC_RSP_R1;
174                 brq.data.timeout_ns = card->csd.tacc_ns * 10;
175                 brq.data.timeout_clks = card->csd.tacc_clks * 10;
176                 brq.data.blksz_bits = md->block_bits;
177                 brq.data.blocks = req->nr_sectors >> (md->block_bits - 9);
178                 brq.stop.opcode = MMC_STOP_TRANSMISSION;
179                 brq.stop.arg = 0;
180                 brq.stop.flags = MMC_RSP_R1B;
181
182                 if (rq_data_dir(req) == READ) {
183                         brq.cmd.opcode = brq.data.blocks > 1 ? MMC_READ_MULTIPLE_BLOCK : MMC_READ_SINGLE_BLOCK;
184                         brq.data.flags |= MMC_DATA_READ;
185                 } else {
186                         brq.cmd.opcode = MMC_WRITE_BLOCK;
187                         brq.data.flags |= MMC_DATA_WRITE;
188                         brq.data.blocks = 1;
189                 }
190
191                 if (brq.data.blocks > 1) {
192                         brq.data.flags |= MMC_DATA_MULTI;
193                         brq.mrq.stop = &brq.stop;
194                 } else {
195                         brq.mrq.stop = NULL;
196                 }
197
198                 brq.data.sg = mq->sg;
199                 brq.data.sg_len = blk_rq_map_sg(req->q, req, brq.data.sg);
200
201                 mmc_wait_for_req(card->host, &brq.mrq);
202                 if (brq.cmd.error) {
203                         printk(KERN_ERR "%s: error %d sending read/write command\n",
204                                req->rq_disk->disk_name, brq.cmd.error);
205                         goto cmd_err;
206                 }
207
208                 if (brq.data.error) {
209                         printk(KERN_ERR "%s: error %d transferring data\n",
210                                req->rq_disk->disk_name, brq.data.error);
211                         goto cmd_err;
212                 }
213
214                 if (brq.stop.error) {
215                         printk(KERN_ERR "%s: error %d sending stop command\n",
216                                req->rq_disk->disk_name, brq.stop.error);
217                         goto cmd_err;
218                 }
219
220                 do {
221                         int err;
222
223                         cmd.opcode = MMC_SEND_STATUS;
224                         cmd.arg = card->rca << 16;
225                         cmd.flags = MMC_RSP_R1;
226                         err = mmc_wait_for_cmd(card->host, &cmd, 5);
227                         if (err) {
228                                 printk(KERN_ERR "%s: error %d requesting status\n",
229                                        req->rq_disk->disk_name, err);
230                                 goto cmd_err;
231                         }
232                 } while (!(cmd.resp[0] & R1_READY_FOR_DATA));
233
234 #if 0
235                 if (cmd.resp[0] & ~0x00000900)
236                         printk(KERN_ERR "%s: status = %08x\n",
237                                req->rq_disk->disk_name, cmd.resp[0]);
238                 if (mmc_decode_status(cmd.resp))
239                         goto cmd_err;
240 #endif
241
242                 /*
243                  * A block was successfully transferred.
244                  */
245                 spin_lock_irq(&md->lock);
246                 ret = end_that_request_chunk(req, 1, brq.data.bytes_xfered);
247                 if (!ret) {
248                         /*
249                          * The whole request completed successfully.
250                          */
251                         add_disk_randomness(req->rq_disk);
252                         blkdev_dequeue_request(req);
253                         end_that_request_last(req, 1);
254                 }
255                 spin_unlock_irq(&md->lock);
256         } while (ret);
257
258         mmc_card_release_host(card);
259
260         return 1;
261
262  cmd_err:
263         mmc_card_release_host(card);
264
265         /*
266          * This is a little draconian, but until we get proper
267          * error handling sorted out here, its the best we can
268          * do - especially as some hosts have no idea how much
269          * data was transferred before the error occurred.
270          */
271         spin_lock_irq(&md->lock);
272         do {
273                 ret = end_that_request_chunk(req, 0,
274                                 req->current_nr_sectors << 9);
275         } while (ret);
276
277         add_disk_randomness(req->rq_disk);
278         blkdev_dequeue_request(req);
279         end_that_request_last(req, 0);
280         spin_unlock_irq(&md->lock);
281
282         return 0;
283 }
284
285 #define MMC_NUM_MINORS  (256 >> MMC_SHIFT)
286
287 static unsigned long dev_use[MMC_NUM_MINORS/(8*sizeof(unsigned long))];
288
289 static inline int mmc_blk_readonly(struct mmc_card *card)
290 {
291         return mmc_card_readonly(card) ||
292                !(card->csd.cmdclass & CCC_BLOCK_WRITE);
293 }
294
295 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
296 {
297         struct mmc_blk_data *md;
298         int devidx, ret;
299
300         devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
301         if (devidx >= MMC_NUM_MINORS)
302                 return ERR_PTR(-ENOSPC);
303         __set_bit(devidx, dev_use);
304
305         md = kmalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
306         if (!md) {
307                 ret = -ENOMEM;
308                 goto out;
309         }
310
311         memset(md, 0, sizeof(struct mmc_blk_data));
312
313         /*
314          * Set the read-only status based on the supported commands
315          * and the write protect switch.
316          */
317         md->read_only = mmc_blk_readonly(card);
318
319         /*
320          * Figure out a workable block size.  MMC cards have:
321          *  - two block sizes, one for read and one for write.
322          *  - may support partial reads and/or writes
323          *    (allows block sizes smaller than specified)
324          */
325         md->block_bits = card->csd.read_blkbits;
326         if (card->csd.write_blkbits != card->csd.read_blkbits) {
327                 if (card->csd.write_blkbits < card->csd.read_blkbits &&
328                     card->csd.read_partial) {
329                         /*
330                          * write block size is smaller than read block
331                          * size, but we support partial reads, so choose
332                          * the smaller write block size.
333                          */
334                         md->block_bits = card->csd.write_blkbits;
335                 } else if (card->csd.write_blkbits > card->csd.read_blkbits &&
336                            card->csd.write_partial) {
337                         /*
338                          * read block size is smaller than write block
339                          * size, but we support partial writes.  Use read
340                          * block size.
341                          */
342                 } else {
343                         /*
344                          * We don't support this configuration for writes.
345                          */
346                         printk(KERN_ERR "%s: unable to select block size for "
347                                 "writing (rb%u wb%u rp%u wp%u)\n",
348                                 md->disk->disk_name,
349                                 1 << card->csd.read_blkbits,
350                                 1 << card->csd.write_blkbits,
351                                 card->csd.read_partial,
352                                 card->csd.write_partial);
353                         md->read_only = 1;
354                 }
355         }
356
357         /*
358          * Refuse to allow block sizes smaller than 512 bytes.
359          */
360         if (md->block_bits < 9) {
361                 printk(KERN_ERR "%s: unable to support block size %u\n",
362                         mmc_card_id(card), 1 << md->block_bits);
363                 ret = -EINVAL;
364                 goto err_kfree;
365         }
366
367         md->disk = alloc_disk(1 << MMC_SHIFT);
368         if (md->disk == NULL) {
369                 ret = -ENOMEM;
370                 goto err_kfree;
371         }
372
373         spin_lock_init(&md->lock);
374         md->usage = 1;
375
376         ret = mmc_init_queue(&md->queue, card, &md->lock);
377         if (ret)
378                 goto err_putdisk;
379
380         md->queue.prep_fn = mmc_blk_prep_rq;
381         md->queue.issue_fn = mmc_blk_issue_rq;
382         md->queue.data = md;
383
384         md->disk->major = major;
385         md->disk->first_minor = devidx << MMC_SHIFT;
386         md->disk->fops = &mmc_bdops;
387         md->disk->private_data = md;
388         md->disk->queue = md->queue.queue;
389         md->disk->driverfs_dev = &card->dev;
390
391         /*
392          * As discussed on lkml, GENHD_FL_REMOVABLE should:
393          *
394          * - be set for removable media with permanent block devices
395          * - be unset for removable block devices with permanent media
396          *
397          * Since MMC block devices clearly fall under the second
398          * case, we do not set GENHD_FL_REMOVABLE.  Userspace
399          * should use the block device creation/destruction hotplug
400          * messages to tell when the card is present.
401          */
402
403         sprintf(md->disk->disk_name, "mmcblk%d", devidx);
404         sprintf(md->disk->devfs_name, "mmc/blk%d", devidx);
405
406         blk_queue_hardsect_size(md->queue.queue, 1 << md->block_bits);
407
408         /*
409          * The CSD capacity field is in units of read_blkbits.
410          * set_capacity takes units of 512 bytes.
411          */
412         set_capacity(md->disk, card->csd.capacity << (card->csd.read_blkbits - 9));
413         return md;
414
415  err_putdisk:
416         put_disk(md->disk);
417  err_kfree:
418         kfree(md);
419  out:
420         return ERR_PTR(ret);
421 }
422
423 static int
424 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
425 {
426         struct mmc_command cmd;
427         int err;
428
429         mmc_card_claim_host(card);
430         cmd.opcode = MMC_SET_BLOCKLEN;
431         cmd.arg = 1 << md->block_bits;
432         cmd.flags = MMC_RSP_R1;
433         err = mmc_wait_for_cmd(card->host, &cmd, 5);
434         mmc_card_release_host(card);
435
436         if (err) {
437                 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
438                         md->disk->disk_name, cmd.arg, err);
439                 return -EINVAL;
440         }
441
442         return 0;
443 }
444
445 static int mmc_blk_probe(struct mmc_card *card)
446 {
447         struct mmc_blk_data *md;
448         int err;
449
450         /*
451          * Check that the card supports the command class(es) we need.
452          */
453         if (!(card->csd.cmdclass & CCC_BLOCK_READ))
454                 return -ENODEV;
455
456         md = mmc_blk_alloc(card);
457         if (IS_ERR(md))
458                 return PTR_ERR(md);
459
460         err = mmc_blk_set_blksize(md, card);
461         if (err)
462                 goto out;
463
464         printk(KERN_INFO "%s: %s %s %luKiB %s\n",
465                 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
466                 get_capacity(md->disk) >> 1, md->read_only ? "(ro)" : "");
467
468         mmc_set_drvdata(card, md);
469         add_disk(md->disk);
470         return 0;
471
472  out:
473         mmc_blk_put(md);
474
475         return err;
476 }
477
478 static void mmc_blk_remove(struct mmc_card *card)
479 {
480         struct mmc_blk_data *md = mmc_get_drvdata(card);
481
482         if (md) {
483                 int devidx;
484
485                 del_gendisk(md->disk);
486
487                 /*
488                  * I think this is needed.
489                  */
490                 md->disk->queue = NULL;
491
492                 devidx = md->disk->first_minor >> MMC_SHIFT;
493                 __clear_bit(devidx, dev_use);
494
495                 mmc_blk_put(md);
496         }
497         mmc_set_drvdata(card, NULL);
498 }
499
500 #ifdef CONFIG_PM
501 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
502 {
503         struct mmc_blk_data *md = mmc_get_drvdata(card);
504
505         if (md) {
506                 mmc_queue_suspend(&md->queue);
507         }
508         return 0;
509 }
510
511 static int mmc_blk_resume(struct mmc_card *card)
512 {
513         struct mmc_blk_data *md = mmc_get_drvdata(card);
514
515         if (md) {
516                 mmc_blk_set_blksize(md, card);
517                 mmc_queue_resume(&md->queue);
518         }
519         return 0;
520 }
521 #else
522 #define mmc_blk_suspend NULL
523 #define mmc_blk_resume  NULL
524 #endif
525
526 static struct mmc_driver mmc_driver = {
527         .drv            = {
528                 .name   = "mmcblk",
529         },
530         .probe          = mmc_blk_probe,
531         .remove         = mmc_blk_remove,
532         .suspend        = mmc_blk_suspend,
533         .resume         = mmc_blk_resume,
534 };
535
536 static int __init mmc_blk_init(void)
537 {
538         int res = -ENOMEM;
539
540         res = register_blkdev(major, "mmc");
541         if (res < 0) {
542                 printk(KERN_WARNING "Unable to get major %d for MMC media: %d\n",
543                        major, res);
544                 goto out;
545         }
546         if (major == 0)
547                 major = res;
548
549         devfs_mk_dir("mmc");
550         return mmc_register_driver(&mmc_driver);
551
552  out:
553         return res;
554 }
555
556 static void __exit mmc_blk_exit(void)
557 {
558         mmc_unregister_driver(&mmc_driver);
559         devfs_remove("mmc");
560         unregister_blkdev(major, "mmc");
561 }
562
563 module_init(mmc_blk_init);
564 module_exit(mmc_blk_exit);
565
566 MODULE_LICENSE("GPL");
567 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
568
569 module_param(major, int, 0444);
570 MODULE_PARM_DESC(major, "specify the major device number for MMC block driver");