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