Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/percpu
[sfrench/cifs-2.6.git] / drivers / mmc / core / mmc.c
1 /*
2  *  linux/drivers/mmc/core/mmc.c
3  *
4  *  Copyright (C) 2003-2004 Russell King, All Rights Reserved.
5  *  Copyright (C) 2005-2007 Pierre Ossman, All Rights Reserved.
6  *  MMCv4 support Copyright (C) 2006 Philip Langdale, All Rights Reserved.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12
13 #include <linux/err.h>
14
15 #include <linux/mmc/host.h>
16 #include <linux/mmc/card.h>
17 #include <linux/mmc/mmc.h>
18
19 #include "core.h"
20 #include "bus.h"
21 #include "mmc_ops.h"
22
23 static const unsigned int tran_exp[] = {
24         10000,          100000,         1000000,        10000000,
25         0,              0,              0,              0
26 };
27
28 static const unsigned char tran_mant[] = {
29         0,      10,     12,     13,     15,     20,     25,     30,
30         35,     40,     45,     50,     55,     60,     70,     80,
31 };
32
33 static const unsigned int tacc_exp[] = {
34         1,      10,     100,    1000,   10000,  100000, 1000000, 10000000,
35 };
36
37 static const unsigned int tacc_mant[] = {
38         0,      10,     12,     13,     15,     20,     25,     30,
39         35,     40,     45,     50,     55,     60,     70,     80,
40 };
41
42 #define UNSTUFF_BITS(resp,start,size)                                   \
43         ({                                                              \
44                 const int __size = size;                                \
45                 const u32 __mask = (__size < 32 ? 1 << __size : 0) - 1; \
46                 const int __off = 3 - ((start) / 32);                   \
47                 const int __shft = (start) & 31;                        \
48                 u32 __res;                                              \
49                                                                         \
50                 __res = resp[__off] >> __shft;                          \
51                 if (__size + __shft > 32)                               \
52                         __res |= resp[__off-1] << ((32 - __shft) % 32); \
53                 __res & __mask;                                         \
54         })
55
56 /*
57  * Given the decoded CSD structure, decode the raw CID to our CID structure.
58  */
59 static int mmc_decode_cid(struct mmc_card *card)
60 {
61         u32 *resp = card->raw_cid;
62
63         /*
64          * The selection of the format here is based upon published
65          * specs from sandisk and from what people have reported.
66          */
67         switch (card->csd.mmca_vsn) {
68         case 0: /* MMC v1.0 - v1.2 */
69         case 1: /* MMC v1.4 */
70                 card->cid.manfid        = UNSTUFF_BITS(resp, 104, 24);
71                 card->cid.prod_name[0]  = UNSTUFF_BITS(resp, 96, 8);
72                 card->cid.prod_name[1]  = UNSTUFF_BITS(resp, 88, 8);
73                 card->cid.prod_name[2]  = UNSTUFF_BITS(resp, 80, 8);
74                 card->cid.prod_name[3]  = UNSTUFF_BITS(resp, 72, 8);
75                 card->cid.prod_name[4]  = UNSTUFF_BITS(resp, 64, 8);
76                 card->cid.prod_name[5]  = UNSTUFF_BITS(resp, 56, 8);
77                 card->cid.prod_name[6]  = UNSTUFF_BITS(resp, 48, 8);
78                 card->cid.hwrev         = UNSTUFF_BITS(resp, 44, 4);
79                 card->cid.fwrev         = UNSTUFF_BITS(resp, 40, 4);
80                 card->cid.serial        = UNSTUFF_BITS(resp, 16, 24);
81                 card->cid.month         = UNSTUFF_BITS(resp, 12, 4);
82                 card->cid.year          = UNSTUFF_BITS(resp, 8, 4) + 1997;
83                 break;
84
85         case 2: /* MMC v2.0 - v2.2 */
86         case 3: /* MMC v3.1 - v3.3 */
87         case 4: /* MMC v4 */
88                 card->cid.manfid        = UNSTUFF_BITS(resp, 120, 8);
89                 card->cid.oemid         = UNSTUFF_BITS(resp, 104, 16);
90                 card->cid.prod_name[0]  = UNSTUFF_BITS(resp, 96, 8);
91                 card->cid.prod_name[1]  = UNSTUFF_BITS(resp, 88, 8);
92                 card->cid.prod_name[2]  = UNSTUFF_BITS(resp, 80, 8);
93                 card->cid.prod_name[3]  = UNSTUFF_BITS(resp, 72, 8);
94                 card->cid.prod_name[4]  = UNSTUFF_BITS(resp, 64, 8);
95                 card->cid.prod_name[5]  = UNSTUFF_BITS(resp, 56, 8);
96                 card->cid.serial        = UNSTUFF_BITS(resp, 16, 32);
97                 card->cid.month         = UNSTUFF_BITS(resp, 12, 4);
98                 card->cid.year          = UNSTUFF_BITS(resp, 8, 4) + 1997;
99                 break;
100
101         default:
102                 printk(KERN_ERR "%s: card has unknown MMCA version %d\n",
103                         mmc_hostname(card->host), card->csd.mmca_vsn);
104                 return -EINVAL;
105         }
106
107         return 0;
108 }
109
110 /*
111  * Given a 128-bit response, decode to our card CSD structure.
112  */
113 static int mmc_decode_csd(struct mmc_card *card)
114 {
115         struct mmc_csd *csd = &card->csd;
116         unsigned int e, m, csd_struct;
117         u32 *resp = card->raw_csd;
118
119         /*
120          * We only understand CSD structure v1.1 and v1.2.
121          * v1.2 has extra information in bits 15, 11 and 10.
122          */
123         csd_struct = UNSTUFF_BITS(resp, 126, 2);
124         if (csd_struct != 1 && csd_struct != 2) {
125                 printk(KERN_ERR "%s: unrecognised CSD structure version %d\n",
126                         mmc_hostname(card->host), csd_struct);
127                 return -EINVAL;
128         }
129
130         csd->mmca_vsn    = UNSTUFF_BITS(resp, 122, 4);
131         m = UNSTUFF_BITS(resp, 115, 4);
132         e = UNSTUFF_BITS(resp, 112, 3);
133         csd->tacc_ns     = (tacc_exp[e] * tacc_mant[m] + 9) / 10;
134         csd->tacc_clks   = UNSTUFF_BITS(resp, 104, 8) * 100;
135
136         m = UNSTUFF_BITS(resp, 99, 4);
137         e = UNSTUFF_BITS(resp, 96, 3);
138         csd->max_dtr      = tran_exp[e] * tran_mant[m];
139         csd->cmdclass     = UNSTUFF_BITS(resp, 84, 12);
140
141         e = UNSTUFF_BITS(resp, 47, 3);
142         m = UNSTUFF_BITS(resp, 62, 12);
143         csd->capacity     = (1 + m) << (e + 2);
144
145         csd->read_blkbits = UNSTUFF_BITS(resp, 80, 4);
146         csd->read_partial = UNSTUFF_BITS(resp, 79, 1);
147         csd->write_misalign = UNSTUFF_BITS(resp, 78, 1);
148         csd->read_misalign = UNSTUFF_BITS(resp, 77, 1);
149         csd->r2w_factor = UNSTUFF_BITS(resp, 26, 3);
150         csd->write_blkbits = UNSTUFF_BITS(resp, 22, 4);
151         csd->write_partial = UNSTUFF_BITS(resp, 21, 1);
152
153         return 0;
154 }
155
156 /*
157  * Read and decode extended CSD.
158  */
159 static int mmc_read_ext_csd(struct mmc_card *card)
160 {
161         int err;
162         u8 *ext_csd;
163
164         BUG_ON(!card);
165
166         if (card->csd.mmca_vsn < CSD_SPEC_VER_4)
167                 return 0;
168
169         /*
170          * As the ext_csd is so large and mostly unused, we don't store the
171          * raw block in mmc_card.
172          */
173         ext_csd = kmalloc(512, GFP_KERNEL);
174         if (!ext_csd) {
175                 printk(KERN_ERR "%s: could not allocate a buffer to "
176                         "receive the ext_csd.\n", mmc_hostname(card->host));
177                 return -ENOMEM;
178         }
179
180         err = mmc_send_ext_csd(card, ext_csd);
181         if (err) {
182                 /* If the host or the card can't do the switch,
183                  * fail more gracefully. */
184                 if ((err != -EINVAL)
185                  && (err != -ENOSYS)
186                  && (err != -EFAULT))
187                         goto out;
188
189                 /*
190                  * High capacity cards should have this "magic" size
191                  * stored in their CSD.
192                  */
193                 if (card->csd.capacity == (4096 * 512)) {
194                         printk(KERN_ERR "%s: unable to read EXT_CSD "
195                                 "on a possible high capacity card. "
196                                 "Card will be ignored.\n",
197                                 mmc_hostname(card->host));
198                 } else {
199                         printk(KERN_WARNING "%s: unable to read "
200                                 "EXT_CSD, performance might "
201                                 "suffer.\n",
202                                 mmc_hostname(card->host));
203                         err = 0;
204                 }
205
206                 goto out;
207         }
208
209         card->ext_csd.rev = ext_csd[EXT_CSD_REV];
210         if (card->ext_csd.rev > 5) {
211                 printk(KERN_ERR "%s: unrecognised EXT_CSD structure "
212                         "version %d\n", mmc_hostname(card->host),
213                         card->ext_csd.rev);
214                 err = -EINVAL;
215                 goto out;
216         }
217
218         if (card->ext_csd.rev >= 2) {
219                 card->ext_csd.sectors =
220                         ext_csd[EXT_CSD_SEC_CNT + 0] << 0 |
221                         ext_csd[EXT_CSD_SEC_CNT + 1] << 8 |
222                         ext_csd[EXT_CSD_SEC_CNT + 2] << 16 |
223                         ext_csd[EXT_CSD_SEC_CNT + 3] << 24;
224                 if (card->ext_csd.sectors)
225                         mmc_card_set_blockaddr(card);
226         }
227
228         switch (ext_csd[EXT_CSD_CARD_TYPE] & EXT_CSD_CARD_TYPE_MASK) {
229         case EXT_CSD_CARD_TYPE_52 | EXT_CSD_CARD_TYPE_26:
230                 card->ext_csd.hs_max_dtr = 52000000;
231                 break;
232         case EXT_CSD_CARD_TYPE_26:
233                 card->ext_csd.hs_max_dtr = 26000000;
234                 break;
235         default:
236                 /* MMC v4 spec says this cannot happen */
237                 printk(KERN_WARNING "%s: card is mmc v4 but doesn't "
238                         "support any high-speed modes.\n",
239                         mmc_hostname(card->host));
240         }
241
242         if (card->ext_csd.rev >= 3) {
243                 u8 sa_shift = ext_csd[EXT_CSD_S_A_TIMEOUT];
244
245                 /* Sleep / awake timeout in 100ns units */
246                 if (sa_shift > 0 && sa_shift <= 0x17)
247                         card->ext_csd.sa_timeout =
248                                         1 << ext_csd[EXT_CSD_S_A_TIMEOUT];
249         }
250
251 out:
252         kfree(ext_csd);
253
254         return err;
255 }
256
257 MMC_DEV_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
258         card->raw_cid[2], card->raw_cid[3]);
259 MMC_DEV_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
260         card->raw_csd[2], card->raw_csd[3]);
261 MMC_DEV_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
262 MMC_DEV_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
263 MMC_DEV_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
264 MMC_DEV_ATTR(manfid, "0x%06x\n", card->cid.manfid);
265 MMC_DEV_ATTR(name, "%s\n", card->cid.prod_name);
266 MMC_DEV_ATTR(oemid, "0x%04x\n", card->cid.oemid);
267 MMC_DEV_ATTR(serial, "0x%08x\n", card->cid.serial);
268
269 static struct attribute *mmc_std_attrs[] = {
270         &dev_attr_cid.attr,
271         &dev_attr_csd.attr,
272         &dev_attr_date.attr,
273         &dev_attr_fwrev.attr,
274         &dev_attr_hwrev.attr,
275         &dev_attr_manfid.attr,
276         &dev_attr_name.attr,
277         &dev_attr_oemid.attr,
278         &dev_attr_serial.attr,
279         NULL,
280 };
281
282 static struct attribute_group mmc_std_attr_group = {
283         .attrs = mmc_std_attrs,
284 };
285
286 static const struct attribute_group *mmc_attr_groups[] = {
287         &mmc_std_attr_group,
288         NULL,
289 };
290
291 static struct device_type mmc_type = {
292         .groups = mmc_attr_groups,
293 };
294
295 /*
296  * Handle the detection and initialisation of a card.
297  *
298  * In the case of a resume, "oldcard" will contain the card
299  * we're trying to reinitialise.
300  */
301 static int mmc_init_card(struct mmc_host *host, u32 ocr,
302         struct mmc_card *oldcard)
303 {
304         struct mmc_card *card;
305         int err;
306         u32 cid[4];
307         unsigned int max_dtr;
308
309         BUG_ON(!host);
310         WARN_ON(!host->claimed);
311
312         /*
313          * Since we're changing the OCR value, we seem to
314          * need to tell some cards to go back to the idle
315          * state.  We wait 1ms to give cards time to
316          * respond.
317          */
318         mmc_go_idle(host);
319
320         /* The extra bit indicates that we support high capacity */
321         err = mmc_send_op_cond(host, ocr | (1 << 30), NULL);
322         if (err)
323                 goto err;
324
325         /*
326          * For SPI, enable CRC as appropriate.
327          */
328         if (mmc_host_is_spi(host)) {
329                 err = mmc_spi_set_crc(host, use_spi_crc);
330                 if (err)
331                         goto err;
332         }
333
334         /*
335          * Fetch CID from card.
336          */
337         if (mmc_host_is_spi(host))
338                 err = mmc_send_cid(host, cid);
339         else
340                 err = mmc_all_send_cid(host, cid);
341         if (err)
342                 goto err;
343
344         if (oldcard) {
345                 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) {
346                         err = -ENOENT;
347                         goto err;
348                 }
349
350                 card = oldcard;
351         } else {
352                 /*
353                  * Allocate card structure.
354                  */
355                 card = mmc_alloc_card(host, &mmc_type);
356                 if (IS_ERR(card)) {
357                         err = PTR_ERR(card);
358                         goto err;
359                 }
360
361                 card->type = MMC_TYPE_MMC;
362                 card->rca = 1;
363                 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
364         }
365
366         /*
367          * For native busses:  set card RCA and quit open drain mode.
368          */
369         if (!mmc_host_is_spi(host)) {
370                 err = mmc_set_relative_addr(card);
371                 if (err)
372                         goto free_card;
373
374                 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
375         }
376
377         if (!oldcard) {
378                 /*
379                  * Fetch CSD from card.
380                  */
381                 err = mmc_send_csd(card, card->raw_csd);
382                 if (err)
383                         goto free_card;
384
385                 err = mmc_decode_csd(card);
386                 if (err)
387                         goto free_card;
388                 err = mmc_decode_cid(card);
389                 if (err)
390                         goto free_card;
391         }
392
393         /*
394          * Select card, as all following commands rely on that.
395          */
396         if (!mmc_host_is_spi(host)) {
397                 err = mmc_select_card(card);
398                 if (err)
399                         goto free_card;
400         }
401
402         if (!oldcard) {
403                 /*
404                  * Fetch and process extended CSD.
405                  */
406                 err = mmc_read_ext_csd(card);
407                 if (err)
408                         goto free_card;
409         }
410
411         /*
412          * Activate high speed (if supported)
413          */
414         if ((card->ext_csd.hs_max_dtr != 0) &&
415                 (host->caps & MMC_CAP_MMC_HIGHSPEED)) {
416                 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
417                         EXT_CSD_HS_TIMING, 1);
418                 if (err && err != -EBADMSG)
419                         goto free_card;
420
421                 if (err) {
422                         printk(KERN_WARNING "%s: switch to highspeed failed\n",
423                                mmc_hostname(card->host));
424                         err = 0;
425                 } else {
426                         mmc_card_set_highspeed(card);
427                         mmc_set_timing(card->host, MMC_TIMING_MMC_HS);
428                 }
429         }
430
431         /*
432          * Compute bus speed.
433          */
434         max_dtr = (unsigned int)-1;
435
436         if (mmc_card_highspeed(card)) {
437                 if (max_dtr > card->ext_csd.hs_max_dtr)
438                         max_dtr = card->ext_csd.hs_max_dtr;
439         } else if (max_dtr > card->csd.max_dtr) {
440                 max_dtr = card->csd.max_dtr;
441         }
442
443         mmc_set_clock(host, max_dtr);
444
445         /*
446          * Activate wide bus (if supported).
447          */
448         if ((card->csd.mmca_vsn >= CSD_SPEC_VER_4) &&
449             (host->caps & (MMC_CAP_4_BIT_DATA | MMC_CAP_8_BIT_DATA))) {
450                 unsigned ext_csd_bit, bus_width;
451
452                 if (host->caps & MMC_CAP_8_BIT_DATA) {
453                         ext_csd_bit = EXT_CSD_BUS_WIDTH_8;
454                         bus_width = MMC_BUS_WIDTH_8;
455                 } else {
456                         ext_csd_bit = EXT_CSD_BUS_WIDTH_4;
457                         bus_width = MMC_BUS_WIDTH_4;
458                 }
459
460                 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
461                                  EXT_CSD_BUS_WIDTH, ext_csd_bit);
462
463                 if (err && err != -EBADMSG)
464                         goto free_card;
465
466                 if (err) {
467                         printk(KERN_WARNING "%s: switch to bus width %d "
468                                "failed\n", mmc_hostname(card->host),
469                                1 << bus_width);
470                         err = 0;
471                 } else {
472                         mmc_set_bus_width(card->host, bus_width);
473                 }
474         }
475
476         if (!oldcard)
477                 host->card = card;
478
479         return 0;
480
481 free_card:
482         if (!oldcard)
483                 mmc_remove_card(card);
484 err:
485
486         return err;
487 }
488
489 /*
490  * Host is being removed. Free up the current card.
491  */
492 static void mmc_remove(struct mmc_host *host)
493 {
494         BUG_ON(!host);
495         BUG_ON(!host->card);
496
497         mmc_remove_card(host->card);
498         host->card = NULL;
499 }
500
501 /*
502  * Card detection callback from host.
503  */
504 static void mmc_detect(struct mmc_host *host)
505 {
506         int err;
507
508         BUG_ON(!host);
509         BUG_ON(!host->card);
510
511         mmc_claim_host(host);
512
513         /*
514          * Just check if our card has been removed.
515          */
516         err = mmc_send_status(host->card, NULL);
517
518         mmc_release_host(host);
519
520         if (err) {
521                 mmc_remove(host);
522
523                 mmc_claim_host(host);
524                 mmc_detach_bus(host);
525                 mmc_release_host(host);
526         }
527 }
528
529 /*
530  * Suspend callback from host.
531  */
532 static int mmc_suspend(struct mmc_host *host)
533 {
534         BUG_ON(!host);
535         BUG_ON(!host->card);
536
537         mmc_claim_host(host);
538         if (!mmc_host_is_spi(host))
539                 mmc_deselect_cards(host);
540         host->card->state &= ~MMC_STATE_HIGHSPEED;
541         mmc_release_host(host);
542
543         return 0;
544 }
545
546 /*
547  * Resume callback from host.
548  *
549  * This function tries to determine if the same card is still present
550  * and, if so, restore all state to it.
551  */
552 static int mmc_resume(struct mmc_host *host)
553 {
554         int err;
555
556         BUG_ON(!host);
557         BUG_ON(!host->card);
558
559         mmc_claim_host(host);
560         err = mmc_init_card(host, host->ocr, host->card);
561         mmc_release_host(host);
562
563         return err;
564 }
565
566 static void mmc_power_restore(struct mmc_host *host)
567 {
568         host->card->state &= ~MMC_STATE_HIGHSPEED;
569         mmc_claim_host(host);
570         mmc_init_card(host, host->ocr, host->card);
571         mmc_release_host(host);
572 }
573
574 static int mmc_sleep(struct mmc_host *host)
575 {
576         struct mmc_card *card = host->card;
577         int err = -ENOSYS;
578
579         if (card && card->ext_csd.rev >= 3) {
580                 err = mmc_card_sleepawake(host, 1);
581                 if (err < 0)
582                         pr_debug("%s: Error %d while putting card into sleep",
583                                  mmc_hostname(host), err);
584         }
585
586         return err;
587 }
588
589 static int mmc_awake(struct mmc_host *host)
590 {
591         struct mmc_card *card = host->card;
592         int err = -ENOSYS;
593
594         if (card && card->ext_csd.rev >= 3) {
595                 err = mmc_card_sleepawake(host, 0);
596                 if (err < 0)
597                         pr_debug("%s: Error %d while awaking sleeping card",
598                                  mmc_hostname(host), err);
599         }
600
601         return err;
602 }
603
604 static const struct mmc_bus_ops mmc_ops = {
605         .awake = mmc_awake,
606         .sleep = mmc_sleep,
607         .remove = mmc_remove,
608         .detect = mmc_detect,
609         .suspend = NULL,
610         .resume = NULL,
611         .power_restore = mmc_power_restore,
612 };
613
614 static const struct mmc_bus_ops mmc_ops_unsafe = {
615         .awake = mmc_awake,
616         .sleep = mmc_sleep,
617         .remove = mmc_remove,
618         .detect = mmc_detect,
619         .suspend = mmc_suspend,
620         .resume = mmc_resume,
621         .power_restore = mmc_power_restore,
622 };
623
624 static void mmc_attach_bus_ops(struct mmc_host *host)
625 {
626         const struct mmc_bus_ops *bus_ops;
627
628         if (host->caps & MMC_CAP_NONREMOVABLE || !mmc_assume_removable)
629                 bus_ops = &mmc_ops_unsafe;
630         else
631                 bus_ops = &mmc_ops;
632         mmc_attach_bus(host, bus_ops);
633 }
634
635 /*
636  * Starting point for MMC card init.
637  */
638 int mmc_attach_mmc(struct mmc_host *host, u32 ocr)
639 {
640         int err;
641
642         BUG_ON(!host);
643         WARN_ON(!host->claimed);
644
645         mmc_attach_bus_ops(host);
646
647         /*
648          * We need to get OCR a different way for SPI.
649          */
650         if (mmc_host_is_spi(host)) {
651                 err = mmc_spi_read_ocr(host, 1, &ocr);
652                 if (err)
653                         goto err;
654         }
655
656         /*
657          * Sanity check the voltages that the card claims to
658          * support.
659          */
660         if (ocr & 0x7F) {
661                 printk(KERN_WARNING "%s: card claims to support voltages "
662                        "below the defined range. These will be ignored.\n",
663                        mmc_hostname(host));
664                 ocr &= ~0x7F;
665         }
666
667         host->ocr = mmc_select_voltage(host, ocr);
668
669         /*
670          * Can we support the voltage of the card?
671          */
672         if (!host->ocr) {
673                 err = -EINVAL;
674                 goto err;
675         }
676
677         /*
678          * Detect and init the card.
679          */
680         err = mmc_init_card(host, host->ocr, NULL);
681         if (err)
682                 goto err;
683
684         mmc_release_host(host);
685
686         err = mmc_add_card(host->card);
687         if (err)
688                 goto remove_card;
689
690         return 0;
691
692 remove_card:
693         mmc_remove_card(host->card);
694         host->card = NULL;
695         mmc_claim_host(host);
696 err:
697         mmc_detach_bus(host);
698         mmc_release_host(host);
699
700         printk(KERN_ERR "%s: error %d whilst initialising MMC card\n",
701                 mmc_hostname(host), err);
702
703         return err;
704 }