mmc: change .get_ro() callback semantics
[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"
4101c16a 20#include "bus.h"
7ea239d9
PO
21#include "mmc_ops.h"
22
23static const unsigned int tran_exp[] = {
24 10000, 100000, 1000000, 10000000,
25 0, 0, 0, 0
26};
27
28static 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
33static const unsigned int tacc_exp[] = {
34 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000,
35};
36
37static 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 */
bd766312 59static int mmc_decode_cid(struct mmc_card *card)
7ea239d9
PO
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:
facba917 102 printk(KERN_ERR "%s: card has unknown MMCA version %d\n",
7ea239d9 103 mmc_hostname(card->host), card->csd.mmca_vsn);
bd766312 104 return -EINVAL;
7ea239d9 105 }
bd766312
PO
106
107 return 0;
7ea239d9
PO
108}
109
110/*
111 * Given a 128-bit response, decode to our card CSD structure.
112 */
bd766312 113static int mmc_decode_csd(struct mmc_card *card)
7ea239d9
PO
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) {
facba917 125 printk(KERN_ERR "%s: unrecognised CSD structure version %d\n",
7ea239d9 126 mmc_hostname(card->host), csd_struct);
bd766312 127 return -EINVAL;
7ea239d9
PO
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);
bd766312
PO
152
153 return 0;
7ea239d9
PO
154}
155
156/*
89a73cf5 157 * Read and decode extended CSD.
7ea239d9 158 */
89a73cf5 159static int mmc_read_ext_csd(struct mmc_card *card)
7ea239d9
PO
160{
161 int err;
162 u8 *ext_csd;
d7604d76 163 unsigned int ext_csd_struct;
7ea239d9
PO
164
165 BUG_ON(!card);
166
7ea239d9 167 if (card->csd.mmca_vsn < CSD_SPEC_VER_4)
17b0429d 168 return 0;
7ea239d9
PO
169
170 /*
171 * As the ext_csd is so large and mostly unused, we don't store the
172 * raw block in mmc_card.
173 */
174 ext_csd = kmalloc(512, GFP_KERNEL);
175 if (!ext_csd) {
176 printk(KERN_ERR "%s: could not allocate a buffer to "
adf66a0d 177 "receive the ext_csd.\n", mmc_hostname(card->host));
17b0429d 178 return -ENOMEM;
7ea239d9
PO
179 }
180
181 err = mmc_send_ext_csd(card, ext_csd);
17b0429d 182 if (err) {
adf66a0d
PO
183 /*
184 * We all hosts that cannot perform the command
185 * to fail more gracefully
186 */
187 if (err != -EINVAL)
188 goto out;
189
7ea239d9
PO
190 /*
191 * High capacity cards should have this "magic" size
192 * stored in their CSD.
193 */
194 if (card->csd.capacity == (4096 * 512)) {
195 printk(KERN_ERR "%s: unable to read EXT_CSD "
196 "on a possible high capacity card. "
197 "Card will be ignored.\n",
198 mmc_hostname(card->host));
199 } else {
200 printk(KERN_WARNING "%s: unable to read "
201 "EXT_CSD, performance might "
202 "suffer.\n",
203 mmc_hostname(card->host));
17b0429d 204 err = 0;
7ea239d9 205 }
adf66a0d 206
7ea239d9
PO
207 goto out;
208 }
209
d7604d76
PO
210 ext_csd_struct = ext_csd[EXT_CSD_REV];
211 if (ext_csd_struct > 2) {
8fdd8521
PO
212 printk(KERN_ERR "%s: unrecognised EXT_CSD structure "
213 "version %d\n", mmc_hostname(card->host),
214 ext_csd_struct);
00cedfa6
FM
215 err = -EINVAL;
216 goto out;
d7604d76
PO
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
51ec92e2
PO
250MMC_DEV_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
251 card->raw_cid[2], card->raw_cid[3]);
252MMC_DEV_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
253 card->raw_csd[2], card->raw_csd[3]);
254MMC_DEV_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
255MMC_DEV_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
256MMC_DEV_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
257MMC_DEV_ATTR(manfid, "0x%06x\n", card->cid.manfid);
258MMC_DEV_ATTR(name, "%s\n", card->cid.prod_name);
259MMC_DEV_ATTR(oemid, "0x%04x\n", card->cid.oemid);
260MMC_DEV_ATTR(serial, "0x%08x\n", card->cid.serial);
261
262static struct attribute *mmc_std_attrs[] = {
263 &dev_attr_cid.attr,
264 &dev_attr_csd.attr,
265 &dev_attr_date.attr,
266 &dev_attr_fwrev.attr,
267 &dev_attr_hwrev.attr,
268 &dev_attr_manfid.attr,
269 &dev_attr_name.attr,
270 &dev_attr_oemid.attr,
271 &dev_attr_serial.attr,
272 NULL,
273};
274
275static struct attribute_group mmc_std_attr_group = {
276 .attrs = mmc_std_attrs,
277};
278
279static struct attribute_group *mmc_attr_groups[] = {
280 &mmc_std_attr_group,
281 NULL,
282};
283
284static struct device_type mmc_type = {
285 .groups = mmc_attr_groups,
286};
287
7ea239d9 288/*
6abaa0c9
PO
289 * Handle the detection and initialisation of a card.
290 *
291 * In the case of a resume, "curcard" will contain the card
292 * we're trying to reinitialise.
7ea239d9 293 */
8c75deae 294static int mmc_init_card(struct mmc_host *host, u32 ocr,
6abaa0c9 295 struct mmc_card *oldcard)
7ea239d9
PO
296{
297 struct mmc_card *card;
298 int err;
299 u32 cid[4];
300 unsigned int max_dtr;
301
302 BUG_ON(!host);
d84075c8 303 WARN_ON(!host->claimed);
7ea239d9 304
7ea239d9
PO
305 /*
306 * Since we're changing the OCR value, we seem to
307 * need to tell some cards to go back to the idle
308 * state. We wait 1ms to give cards time to
309 * respond.
310 */
311 mmc_go_idle(host);
312
313 /* The extra bit indicates that we support high capacity */
6abaa0c9 314 err = mmc_send_op_cond(host, ocr | (1 << 30), NULL);
17b0429d 315 if (err)
6abaa0c9 316 goto err;
7ea239d9 317
af517150
DB
318 /*
319 * For SPI, enable CRC as appropriate.
320 */
321 if (mmc_host_is_spi(host)) {
322 err = mmc_spi_set_crc(host, use_spi_crc);
323 if (err)
324 goto err;
325 }
326
7ea239d9
PO
327 /*
328 * Fetch CID from card.
329 */
af517150
DB
330 if (mmc_host_is_spi(host))
331 err = mmc_send_cid(host, cid);
332 else
333 err = mmc_all_send_cid(host, cid);
17b0429d 334 if (err)
7ea239d9
PO
335 goto err;
336
6abaa0c9 337 if (oldcard) {
adf66a0d
PO
338 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) {
339 err = -ENOENT;
6abaa0c9 340 goto err;
adf66a0d 341 }
6abaa0c9
PO
342
343 card = oldcard;
344 } else {
345 /*
346 * Allocate card structure.
347 */
51ec92e2 348 card = mmc_alloc_card(host, &mmc_type);
adf66a0d
PO
349 if (IS_ERR(card)) {
350 err = PTR_ERR(card);
6abaa0c9 351 goto err;
adf66a0d 352 }
7ea239d9 353
6abaa0c9
PO
354 card->type = MMC_TYPE_MMC;
355 card->rca = 1;
356 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
357 }
7ea239d9
PO
358
359 /*
af517150 360 * For native busses: set card RCA and quit open drain mode.
7ea239d9 361 */
af517150
DB
362 if (!mmc_host_is_spi(host)) {
363 err = mmc_set_relative_addr(card);
364 if (err)
365 goto free_card;
7ea239d9 366
af517150
DB
367 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
368 }
7ea239d9 369
6abaa0c9
PO
370 if (!oldcard) {
371 /*
372 * Fetch CSD from card.
373 */
374 err = mmc_send_csd(card, card->raw_csd);
17b0429d 375 if (err)
6abaa0c9 376 goto free_card;
7ea239d9 377
bd766312 378 err = mmc_decode_csd(card);
adf66a0d 379 if (err)
bd766312
PO
380 goto free_card;
381 err = mmc_decode_cid(card);
adf66a0d 382 if (err)
bd766312 383 goto free_card;
6abaa0c9 384 }
7ea239d9
PO
385
386 /*
89a73cf5 387 * Select card, as all following commands rely on that.
7ea239d9 388 */
af517150
DB
389 if (!mmc_host_is_spi(host)) {
390 err = mmc_select_card(card);
391 if (err)
392 goto free_card;
393 }
7ea239d9 394
6abaa0c9
PO
395 if (!oldcard) {
396 /*
af517150 397 * Fetch and process extended CSD.
6abaa0c9
PO
398 */
399 err = mmc_read_ext_csd(card);
17b0429d 400 if (err)
6abaa0c9
PO
401 goto free_card;
402 }
7ea239d9 403
89a73cf5
PO
404 /*
405 * Activate high speed (if supported)
406 */
407 if ((card->ext_csd.hs_max_dtr != 0) &&
408 (host->caps & MMC_CAP_MMC_HIGHSPEED)) {
409 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
410 EXT_CSD_HS_TIMING, 1);
17b0429d 411 if (err)
89a73cf5
PO
412 goto free_card;
413
414 mmc_card_set_highspeed(card);
415
416 mmc_set_timing(card->host, MMC_TIMING_MMC_HS);
417 }
418
7ea239d9
PO
419 /*
420 * Compute bus speed.
421 */
422 max_dtr = (unsigned int)-1;
423
424 if (mmc_card_highspeed(card)) {
425 if (max_dtr > card->ext_csd.hs_max_dtr)
426 max_dtr = card->ext_csd.hs_max_dtr;
427 } else if (max_dtr > card->csd.max_dtr) {
428 max_dtr = card->csd.max_dtr;
429 }
430
431 mmc_set_clock(host, max_dtr);
432
89a73cf5
PO
433 /*
434 * Activate wide bus (if supported).
435 */
436 if ((card->csd.mmca_vsn >= CSD_SPEC_VER_4) &&
437 (host->caps & MMC_CAP_4_BIT_DATA)) {
438 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
439 EXT_CSD_BUS_WIDTH, EXT_CSD_BUS_WIDTH_4);
17b0429d 440 if (err)
89a73cf5
PO
441 goto free_card;
442
443 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
444 }
445
6abaa0c9
PO
446 if (!oldcard)
447 host->card = card;
448
17b0429d 449 return 0;
6abaa0c9
PO
450
451free_card:
452 if (!oldcard)
453 mmc_remove_card(card);
454err:
455
adf66a0d 456 return err;
6abaa0c9
PO
457}
458
459/*
460 * Host is being removed. Free up the current card.
461 */
462static void mmc_remove(struct mmc_host *host)
463{
464 BUG_ON(!host);
465 BUG_ON(!host->card);
466
467 mmc_remove_card(host->card);
468 host->card = NULL;
469}
470
471/*
472 * Card detection callback from host.
473 */
474static void mmc_detect(struct mmc_host *host)
475{
476 int err;
477
478 BUG_ON(!host);
479 BUG_ON(!host->card);
480
481 mmc_claim_host(host);
482
483 /*
484 * Just check if our card has been removed.
485 */
486 err = mmc_send_status(host->card, NULL);
487
488 mmc_release_host(host);
489
17b0429d 490 if (err) {
4101c16a 491 mmc_remove(host);
6abaa0c9
PO
492
493 mmc_claim_host(host);
494 mmc_detach_bus(host);
495 mmc_release_host(host);
496 }
497}
498
499#ifdef CONFIG_MMC_UNSAFE_RESUME
500
501/*
502 * Suspend callback from host.
503 */
504static void mmc_suspend(struct mmc_host *host)
505{
506 BUG_ON(!host);
507 BUG_ON(!host->card);
7ea239d9 508
6abaa0c9 509 mmc_claim_host(host);
af517150
DB
510 if (!mmc_host_is_spi(host))
511 mmc_deselect_cards(host);
6abaa0c9 512 host->card->state &= ~MMC_STATE_HIGHSPEED;
7ea239d9 513 mmc_release_host(host);
6abaa0c9 514}
7ea239d9 515
6abaa0c9
PO
516/*
517 * Resume callback from host.
518 *
519 * This function tries to determine if the same card is still present
520 * and, if so, restore all state to it.
521 */
522static void mmc_resume(struct mmc_host *host)
523{
524 int err;
525
526 BUG_ON(!host);
527 BUG_ON(!host->card);
528
529 mmc_claim_host(host);
8c75deae 530 err = mmc_init_card(host, host->ocr, host->card);
2986d0bf
PO
531 mmc_release_host(host);
532
17b0429d 533 if (err) {
4101c16a 534 mmc_remove(host);
2986d0bf
PO
535
536 mmc_claim_host(host);
6abaa0c9 537 mmc_detach_bus(host);
2986d0bf 538 mmc_release_host(host);
6abaa0c9
PO
539 }
540
6abaa0c9
PO
541}
542
543#else
544
545#define mmc_suspend NULL
546#define mmc_resume NULL
547
548#endif
549
550static const struct mmc_bus_ops mmc_ops = {
551 .remove = mmc_remove,
552 .detect = mmc_detect,
553 .suspend = mmc_suspend,
554 .resume = mmc_resume,
555};
556
557/*
558 * Starting point for MMC card init.
559 */
560int mmc_attach_mmc(struct mmc_host *host, u32 ocr)
561{
562 int err;
563
564 BUG_ON(!host);
d84075c8 565 WARN_ON(!host->claimed);
6abaa0c9
PO
566
567 mmc_attach_bus(host, &mmc_ops);
568
af517150
DB
569 /*
570 * We need to get OCR a different way for SPI.
571 */
572 if (mmc_host_is_spi(host)) {
573 err = mmc_spi_read_ocr(host, 1, &ocr);
574 if (err)
575 goto err;
576 }
577
6abaa0c9
PO
578 /*
579 * Sanity check the voltages that the card claims to
580 * support.
581 */
582 if (ocr & 0x7F) {
583 printk(KERN_WARNING "%s: card claims to support voltages "
584 "below the defined range. These will be ignored.\n",
585 mmc_hostname(host));
586 ocr &= ~0x7F;
587 }
588
589 host->ocr = mmc_select_voltage(host, ocr);
590
591 /*
592 * Can we support the voltage of the card?
593 */
109b5bed
PO
594 if (!host->ocr) {
595 err = -EINVAL;
6abaa0c9 596 goto err;
109b5bed 597 }
6abaa0c9
PO
598
599 /*
600 * Detect and init the card.
601 */
8c75deae 602 err = mmc_init_card(host, host->ocr, NULL);
17b0429d 603 if (err)
6abaa0c9
PO
604 goto err;
605
606 mmc_release_host(host);
607
4101c16a 608 err = mmc_add_card(host->card);
7ea239d9 609 if (err)
2986d0bf 610 goto remove_card;
7ea239d9
PO
611
612 return 0;
613
2986d0bf 614remove_card:
6abaa0c9 615 mmc_remove_card(host->card);
7ea239d9 616 host->card = NULL;
2986d0bf 617 mmc_claim_host(host);
7ea239d9
PO
618err:
619 mmc_detach_bus(host);
620 mmc_release_host(host);
621
109b5bed
PO
622 printk(KERN_ERR "%s: error %d whilst initialising MMC card\n",
623 mmc_hostname(host), err);
624
adf66a0d 625 return err;
7ea239d9
PO
626}
627