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