Merge remote branch 'linux-2.6.32.y/master' into develop
[firefly-linux-kernel-4.4.55.git] / 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 #include <linux/string_helpers.h>
33
34 #include <linux/mmc/card.h>
35 #include <linux/mmc/host.h>
36 #include <linux/mmc/mmc.h>
37 #include <linux/mmc/sd.h>
38
39 #include <asm/system.h>
40 #include <asm/uaccess.h>
41
42 #include "queue.h"
43
44 MODULE_ALIAS("mmc:block");
45
46 /*
47  * max 8 partitions per card
48  */
49 #define MMC_SHIFT       3
50 #define MMC_NUM_MINORS  (256 >> MMC_SHIFT)
51
52 static DECLARE_BITMAP(dev_use, MMC_NUM_MINORS);
53
54 /*
55  * There is one mmc_blk_data per slot.
56  */
57 struct mmc_blk_data {
58         spinlock_t      lock;
59         struct gendisk  *disk;
60         struct mmc_queue queue;
61
62         unsigned int    usage;
63         unsigned int    read_only;
64 };
65
66 static DEFINE_MUTEX(open_lock);
67
68 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
69 {
70         struct mmc_blk_data *md;
71
72         mutex_lock(&open_lock);
73         md = disk->private_data;
74         if (md && md->usage == 0)
75                 md = NULL;
76         if (md)
77                 md->usage++;
78         mutex_unlock(&open_lock);
79
80         return md;
81 }
82
83 static void mmc_blk_put(struct mmc_blk_data *md)
84 {
85         mutex_lock(&open_lock);
86         md->usage--;
87         if (md->usage == 0) {
88                 int devmaj = MAJOR(disk_devt(md->disk));
89                 int devidx = MINOR(disk_devt(md->disk)) >> MMC_SHIFT;
90
91                 if (!devmaj)
92                         devidx = md->disk->first_minor >> MMC_SHIFT;
93
94                 blk_cleanup_queue(md->queue.queue);
95
96                 __clear_bit(devidx, dev_use);
97
98                 put_disk(md->disk);
99                 kfree(md);
100         }
101         mutex_unlock(&open_lock);
102 }
103
104 static int mmc_blk_open(struct block_device *bdev, fmode_t mode)
105 {
106         struct mmc_blk_data *md = mmc_blk_get(bdev->bd_disk);
107         int ret = -ENXIO;
108
109         if (md) {
110                 if (md->usage == 2)
111                         check_disk_change(bdev);
112                 ret = 0;
113
114                 if ((mode & FMODE_WRITE) && md->read_only) {
115                         mmc_blk_put(md);
116                         ret = -EROFS;
117                 }
118         }
119
120         return ret;
121 }
122
123 static int mmc_blk_release(struct gendisk *disk, fmode_t mode)
124 {
125         struct mmc_blk_data *md = disk->private_data;
126
127         mmc_blk_put(md);
128         return 0;
129 }
130
131 static int
132 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
133 {
134         geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
135         geo->heads = 4;
136         geo->sectors = 16;
137         return 0;
138 }
139
140 static const struct block_device_operations mmc_bdops = {
141         .open                   = mmc_blk_open,
142         .release                = mmc_blk_release,
143         .getgeo                 = mmc_blk_getgeo,
144         .owner                  = THIS_MODULE,
145 };
146
147 struct mmc_blk_request {
148         struct mmc_request      mrq;
149         struct mmc_command      cmd;
150         struct mmc_command      stop;
151         struct mmc_data         data;
152 };
153
154 static u32 mmc_sd_num_wr_blocks(struct mmc_card *card)
155 {
156         int err;
157         u32 result;
158         __be32 *blocks;
159
160         struct mmc_request mrq;
161         struct mmc_command cmd;
162         struct mmc_data data;
163         unsigned int timeout_us;
164
165         struct scatterlist sg;
166
167         memset(&cmd, 0, sizeof(struct mmc_command));
168
169         cmd.opcode = MMC_APP_CMD;
170         cmd.arg = card->rca << 16;
171         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
172
173         err = mmc_wait_for_cmd(card->host, &cmd, 0);
174         if (err)
175                 return (u32)-1;
176         if (!mmc_host_is_spi(card->host) && !(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_SPI_R1 | 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         blocks = kmalloc(4, GFP_KERNEL);
211         if (!blocks)
212                 return (u32)-1;
213
214         sg_init_one(&sg, blocks, 4);
215
216         mmc_wait_for_req(card->host, &mrq);
217
218         result = ntohl(*blocks);
219         kfree(blocks);
220
221         if (cmd.error || data.error)
222                 result = (u32)-1;
223
224         return result;
225 }
226
227 static u32 get_card_status(struct mmc_card *card, struct request *req)
228 {
229         struct mmc_command cmd;
230         int err;
231
232         memset(&cmd, 0, sizeof(struct mmc_command));
233         cmd.opcode = MMC_SEND_STATUS;
234         if (!mmc_host_is_spi(card->host))
235                 cmd.arg = card->rca << 16;
236         cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
237         err = mmc_wait_for_cmd(card->host, &cmd, 0);
238         if (err)
239                 printk(KERN_ERR "%s: error %d sending status comand",
240                        req->rq_disk->disk_name, err);
241         return cmd.resp[0];
242 }
243
244 static int
245 mmc_blk_set_blksize(struct mmc_blk_data *md, struct mmc_card *card)
246 {
247         struct mmc_command cmd;
248         int err;
249
250         /* Block-addressed cards ignore MMC_SET_BLOCKLEN. */
251         if (mmc_card_blockaddr(card))
252                 return 0;
253
254         mmc_claim_host(card->host);
255         cmd.opcode = MMC_SET_BLOCKLEN;
256         cmd.arg = 512;
257         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
258         err = mmc_wait_for_cmd(card->host, &cmd, 5);
259         mmc_release_host(card->host);
260
261         if (err) {
262                 printk(KERN_ERR "%s: unable to set block size to %d: %d\n",
263                         md->disk->disk_name, cmd.arg, err);
264                 return -EINVAL;
265         }
266
267         return 0;
268 }
269
270
271 static int mmc_blk_issue_rq(struct mmc_queue *mq, struct request *req)
272 {
273         struct mmc_blk_data *md = mq->data;
274         struct mmc_card *card = md->queue.card;
275         struct mmc_blk_request brq;
276         int ret = 1, disable_multi = 0;
277
278 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
279         if (mmc_bus_needs_resume(card->host)) {
280                 mmc_resume_bus(card->host);
281                 mmc_blk_set_blksize(md, card);
282         }
283 #endif
284
285         mmc_claim_host(card->host);
286
287         do {
288                 struct mmc_command cmd;
289                 u32 readcmd, writecmd, status = 0;
290
291                 memset(&brq, 0, sizeof(struct mmc_blk_request));
292                 brq.mrq.cmd = &brq.cmd;
293                 brq.mrq.data = &brq.data;
294
295                 brq.cmd.arg = blk_rq_pos(req);
296                 if (!mmc_card_blockaddr(card))
297                         brq.cmd.arg <<= 9;
298                 brq.cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
299                 brq.data.blksz = 512;
300                 brq.stop.opcode = MMC_STOP_TRANSMISSION;
301                 brq.stop.arg = 0;
302                 brq.stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
303                 brq.data.blocks = blk_rq_sectors(req);
304
305                 /*
306                  * The block layer doesn't support all sector count
307                  * restrictions, so we need to be prepared for too big
308                  * requests.
309                  */
310                 if (brq.data.blocks > card->host->max_blk_count)
311                         brq.data.blocks = card->host->max_blk_count;
312
313                 /*
314                  * After a read error, we redo the request one sector at a time
315                  * in order to accurately determine which sectors can be read
316                  * successfully.
317                  */
318                 if (disable_multi && brq.data.blocks > 1)
319                         brq.data.blocks = 1;
320
321                 if (brq.data.blocks > 1) {
322                         /* SPI multiblock writes terminate using a special
323                          * token, not a STOP_TRANSMISSION request.
324                          */
325                         if (!mmc_host_is_spi(card->host)
326                                         || rq_data_dir(req) == READ)
327                                 brq.mrq.stop = &brq.stop;
328                         readcmd = MMC_READ_MULTIPLE_BLOCK;
329                         writecmd = MMC_WRITE_MULTIPLE_BLOCK;
330                 } else {
331                         brq.mrq.stop = NULL;
332                         readcmd = MMC_READ_SINGLE_BLOCK;
333                         writecmd = MMC_WRITE_BLOCK;
334                 }
335
336                 if (rq_data_dir(req) == READ) {
337                         brq.cmd.opcode = readcmd;
338                         brq.data.flags |= MMC_DATA_READ;
339                 } else {
340                         brq.cmd.opcode = writecmd;
341                         brq.data.flags |= MMC_DATA_WRITE;
342                 }
343
344                 mmc_set_data_timeout(&brq.data, card);
345
346                 brq.data.sg = mq->sg;
347                 brq.data.sg_len = mmc_queue_map_sg(mq);
348
349                 /*
350                  * Adjust the sg list so it is the same size as the
351                  * request.
352                  */
353                 if (brq.data.blocks != blk_rq_sectors(req)) {
354                         int i, data_size = brq.data.blocks << 9;
355                         struct scatterlist *sg;
356
357                         for_each_sg(brq.data.sg, sg, brq.data.sg_len, i) {
358                                 data_size -= sg->length;
359                                 if (data_size <= 0) {
360                                         sg->length += data_size;
361                                         i++;
362                                         break;
363                                 }
364                         }
365                         brq.data.sg_len = i;
366                 }
367
368                 mmc_queue_bounce_pre(mq);
369
370                 mmc_wait_for_req(card->host, &brq.mrq);
371
372                 mmc_queue_bounce_post(mq);
373
374                 /*
375                  * Check for errors here, but don't jump to cmd_err
376                  * until later as we need to wait for the card to leave
377                  * programming mode even when things go wrong.
378                  */
379                 if (brq.cmd.error || brq.data.error || brq.stop.error) {
380                         if (brq.data.blocks > 1 && rq_data_dir(req) == READ) {
381                                 /* Redo read one sector at a time */
382                                 printk(KERN_WARNING "%s: retrying using single "
383                                        "block read\n", req->rq_disk->disk_name);
384                                 disable_multi = 1;
385                                 continue;
386                         }
387                         status = get_card_status(card, req);
388                 } else if (disable_multi == 1) {
389                         disable_multi = 0;
390                 }
391
392                 if (brq.cmd.error) {
393                         printk(KERN_ERR "%s: error %d sending read/write "
394                                "command, response %#x, card status %#x\n",
395                                req->rq_disk->disk_name, brq.cmd.error,
396                                brq.cmd.resp[0], status);
397                 }
398
399                 if (brq.data.error) {
400                         if (brq.data.error == -ETIMEDOUT && brq.mrq.stop)
401                                 /* 'Stop' response contains card status */
402                                 status = brq.mrq.stop->resp[0];
403                         printk(KERN_ERR "%s: error %d transferring data,"
404                                " sector %u, nr %u, card status %#x\n",
405                                req->rq_disk->disk_name, brq.data.error,
406                                (unsigned)blk_rq_pos(req),
407                                (unsigned)blk_rq_sectors(req), status);
408                 }
409
410                 if (brq.stop.error) {
411                         printk(KERN_ERR "%s: error %d sending stop command, "
412                                "response %#x, card status %#x\n",
413                                req->rq_disk->disk_name, brq.stop.error,
414                                brq.stop.resp[0], status);
415                 }
416
417                 if (!mmc_host_is_spi(card->host) && rq_data_dir(req) != READ) {
418                         do {
419                                 int err;
420
421                                 cmd.opcode = MMC_SEND_STATUS;
422                                 cmd.arg = card->rca << 16;
423                                 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
424                                 err = mmc_wait_for_cmd(card->host, &cmd, 5);
425                                 if (err) {
426                                         printk(KERN_ERR "%s: error %d requesting status\n",
427                                                req->rq_disk->disk_name, err);
428                                         goto cmd_err;
429                                 }
430                                 /*
431                                  * Some cards mishandle the status bits,
432                                  * so make sure to check both the busy
433                                  * indication and the card state.
434                                  */
435                         } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
436                                 (R1_CURRENT_STATE(cmd.resp[0]) == 7));
437
438 #if 0
439                         if (cmd.resp[0] & ~0x00000900)
440                                 printk(KERN_ERR "%s: status = %08x\n",
441                                        req->rq_disk->disk_name, cmd.resp[0]);
442                         if (mmc_decode_status(cmd.resp))
443                                 goto cmd_err;
444 #endif
445                 }
446
447                 if (brq.cmd.error || brq.stop.error || brq.data.error) {
448                         if (rq_data_dir(req) == READ) {
449                                 /*
450                                  * After an error, we redo I/O one sector at a
451                                  * time, so we only reach here after trying to
452                                  * read a single sector.
453                                  */
454                                 spin_lock_irq(&md->lock);
455                                 ret = __blk_end_request(req, -EIO, brq.data.blksz);
456                                 spin_unlock_irq(&md->lock);
457                                 continue;
458                         }
459                         goto cmd_err;
460                 }
461
462                 /*
463                  * A block was successfully transferred.
464                  */
465                 spin_lock_irq(&md->lock);
466                 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
467                 spin_unlock_irq(&md->lock);
468         } while (ret);
469
470         mmc_release_host(card->host);
471
472         return 1;
473
474  cmd_err:
475         /*
476          * If this is an SD card and we're writing, we can first
477          * mark the known good sectors as ok.
478          *
479          * If the card is not SD, we can still ok written sectors
480          * as reported by the controller (which might be less than
481          * the real number of written sectors, but never more).
482          */
483         if (mmc_card_sd(card)) {
484                 u32 blocks;
485
486                 blocks = mmc_sd_num_wr_blocks(card);
487                 if (blocks != (u32)-1) {
488                         spin_lock_irq(&md->lock);
489                         ret = __blk_end_request(req, 0, blocks << 9);
490                         spin_unlock_irq(&md->lock);
491                 }
492         } else {
493                 spin_lock_irq(&md->lock);
494                 ret = __blk_end_request(req, 0, brq.data.bytes_xfered);
495                 spin_unlock_irq(&md->lock);
496         }
497
498         mmc_release_host(card->host);
499
500         spin_lock_irq(&md->lock);
501         while (ret)
502                 ret = __blk_end_request(req, -EIO, blk_rq_cur_bytes(req));
503         spin_unlock_irq(&md->lock);
504
505         return 0;
506 }
507
508
509 static inline int mmc_blk_readonly(struct mmc_card *card)
510 {
511         return mmc_card_readonly(card) ||
512                !(card->csd.cmdclass & CCC_BLOCK_WRITE);
513 }
514
515 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
516 {
517         struct mmc_blk_data *md;
518         int devidx, ret;
519
520         devidx = find_first_zero_bit(dev_use, MMC_NUM_MINORS);
521         if (devidx >= MMC_NUM_MINORS)
522                 return ERR_PTR(-ENOSPC);
523         __set_bit(devidx, dev_use);
524
525         md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
526         if (!md) {
527                 ret = -ENOMEM;
528                 goto out;
529         }
530
531
532         /*
533          * Set the read-only status based on the supported commands
534          * and the write protect switch.
535          */
536         md->read_only = mmc_blk_readonly(card);
537
538         md->disk = alloc_disk(1 << MMC_SHIFT);
539         if (md->disk == NULL) {
540                 ret = -ENOMEM;
541                 goto err_kfree;
542         }
543
544         spin_lock_init(&md->lock);
545         md->usage = 1;
546
547         ret = mmc_init_queue(&md->queue, card, &md->lock);
548         if (ret)
549                 goto err_putdisk;
550
551         md->queue.issue_fn = mmc_blk_issue_rq;
552         md->queue.data = md;
553
554         md->disk->major = MMC_BLOCK_MAJOR;
555         md->disk->first_minor = devidx << MMC_SHIFT;
556         md->disk->fops = &mmc_bdops;
557         md->disk->private_data = md;
558         md->disk->queue = md->queue.queue;
559         md->disk->driverfs_dev = &card->dev;
560
561         /*
562          * As discussed on lkml, GENHD_FL_REMOVABLE should:
563          *
564          * - be set for removable media with permanent block devices
565          * - be unset for removable block devices with permanent media
566          *
567          * Since MMC block devices clearly fall under the second
568          * case, we do not set GENHD_FL_REMOVABLE.  Userspace
569          * should use the block device creation/destruction hotplug
570          * messages to tell when the card is present.
571          */
572
573         sprintf(md->disk->disk_name, "mmcblk%d", devidx);
574
575         blk_queue_logical_block_size(md->queue.queue, 512);
576
577         if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
578                 /*
579                  * The EXT_CSD sector count is in number or 512 byte
580                  * sectors.
581                  */
582                 set_capacity(md->disk, card->ext_csd.sectors);
583         } else {
584                 /*
585                  * The CSD capacity field is in units of read_blkbits.
586                  * set_capacity takes units of 512 bytes.
587                  */
588                 set_capacity(md->disk,
589                         card->csd.capacity << (card->csd.read_blkbits - 9));
590         }
591         return md;
592
593  err_putdisk:
594         put_disk(md->disk);
595  err_kfree:
596         kfree(md);
597  out:
598         return ERR_PTR(ret);
599 }
600
601 static int mmc_blk_probe(struct mmc_card *card)
602 {
603         struct mmc_blk_data *md;
604         int err;
605
606         char cap_str[10];
607
608         /*
609          * Check that the card supports the command class(es) we need.
610          */
611         if (!(card->csd.cmdclass & CCC_BLOCK_READ))
612                 return -ENODEV;
613
614         md = mmc_blk_alloc(card);
615         if (IS_ERR(md))
616                 return PTR_ERR(md);
617
618         err = mmc_blk_set_blksize(md, card);
619         if (err)
620                 goto out;
621
622         string_get_size((u64)get_capacity(md->disk) << 9, STRING_UNITS_2,
623                         cap_str, sizeof(cap_str));
624         printk(KERN_INFO "%s: %s %s %s %s\n",
625                 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
626                 cap_str, md->read_only ? "(ro)" : "");
627
628         mmc_set_drvdata(card, md);
629 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
630         mmc_set_bus_resume_policy(card->host, 1);
631 #endif
632         add_disk(md->disk);
633         return 0;
634
635  out:
636         mmc_cleanup_queue(&md->queue);
637         mmc_blk_put(md);
638
639         return err;
640 }
641
642 static void mmc_blk_remove(struct mmc_card *card)
643 {
644         struct mmc_blk_data *md = mmc_get_drvdata(card);
645
646         if (md) {
647                 /* Stop new requests from getting into the queue */
648                 del_gendisk(md->disk);
649
650                 /* Then flush out any already in there */
651                 mmc_cleanup_queue(&md->queue);
652
653                 mmc_blk_put(md);
654         }
655         mmc_set_drvdata(card, NULL);
656 #ifdef CONFIG_MMC_BLOCK_DEFERRED_RESUME
657         mmc_set_bus_resume_policy(card->host, 0);
658 #endif
659 }
660
661 #ifdef CONFIG_PM
662 static int mmc_blk_suspend(struct mmc_card *card, pm_message_t state)
663 {
664         struct mmc_blk_data *md = mmc_get_drvdata(card);
665
666         if (md) {
667                 mmc_queue_suspend(&md->queue);
668         }
669         return 0;
670 }
671
672 static int mmc_blk_resume(struct mmc_card *card)
673 {
674         struct mmc_blk_data *md = mmc_get_drvdata(card);
675
676         if (md) {
677 #ifndef CONFIG_MMC_BLOCK_DEFERRED_RESUME
678                 mmc_blk_set_blksize(md, card);
679 #endif
680                 mmc_queue_resume(&md->queue);
681         }
682         return 0;
683 }
684 #else
685 #define mmc_blk_suspend NULL
686 #define mmc_blk_resume  NULL
687 #endif
688
689 static struct mmc_driver mmc_driver = {
690         .drv            = {
691                 .name   = "mmcblk",
692         },
693         .probe          = mmc_blk_probe,
694         .remove         = mmc_blk_remove,
695         .suspend        = mmc_blk_suspend,
696         .resume         = mmc_blk_resume,
697 };
698
699 static int __init mmc_blk_init(void)
700 {
701         int res;
702
703         res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
704         if (res)
705                 goto out;
706
707         res = mmc_register_driver(&mmc_driver);
708         if (res)
709                 goto out2;
710
711         return 0;
712  out2:
713         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
714  out:
715         return res;
716 }
717
718 static void __exit mmc_blk_exit(void)
719 {
720         mmc_unregister_driver(&mmc_driver);
721         unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
722 }
723
724 module_init(mmc_blk_init);
725 module_exit(mmc_blk_exit);
726
727 MODULE_LICENSE("GPL");
728 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");
729