2 * linux/drivers/mmc/core/mmc.c
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.
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.
13 #include <linux/err.h>
15 #include <linux/mmc/host.h>
16 #include <linux/mmc/card.h>
17 #include <linux/mmc/mmc.h>
24 static const unsigned int tran_exp[] = {
25 10000, 100000, 1000000, 10000000,
29 static const unsigned char tran_mant[] = {
30 0, 10, 12, 13, 15, 20, 25, 30,
31 35, 40, 45, 50, 55, 60, 70, 80,
34 static const unsigned int tacc_exp[] = {
35 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000,
38 static const unsigned int tacc_mant[] = {
39 0, 10, 12, 13, 15, 20, 25, 30,
40 35, 40, 45, 50, 55, 60, 70, 80,
43 #define UNSTUFF_BITS(resp,start,size) \
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; \
51 __res = resp[__off] >> __shft; \
52 if (__size + __shft > 32) \
53 __res |= resp[__off-1] << ((32 - __shft) % 32); \
58 * Given the decoded CSD structure, decode the raw CID to our CID structure.
60 static int mmc_decode_cid(struct mmc_card *card)
62 u32 *resp = card->raw_cid;
65 * The selection of the format here is based upon published
66 * specs from sandisk and from what people have reported.
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;
86 case 2: /* MMC v2.0 - v2.2 */
87 case 3: /* MMC v3.1 - v3.3 */
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;
103 printk(KERN_ERR "%s: card has unknown MMCA version %d\n",
104 mmc_hostname(card->host), card->csd.mmca_vsn);
112 * Given a 128-bit response, decode to our card CSD structure.
114 static int mmc_decode_csd(struct mmc_card *card)
116 struct mmc_csd *csd = &card->csd;
117 unsigned int e, m, csd_struct;
118 u32 *resp = card->raw_csd;
121 * We only understand CSD structure v1.1 and v1.2.
122 * v1.2 has extra information in bits 15, 11 and 10.
124 csd_struct = UNSTUFF_BITS(resp, 126, 2);
125 if (csd_struct != 1 && csd_struct != 2) {
126 printk(KERN_ERR "%s: unrecognised CSD structure version %d\n",
127 mmc_hostname(card->host), csd_struct);
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;
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);
142 e = UNSTUFF_BITS(resp, 47, 3);
143 m = UNSTUFF_BITS(resp, 62, 12);
144 csd->capacity = (1 + m) << (e + 2);
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);
158 * Read and decode extended CSD.
160 static int mmc_read_ext_csd(struct mmc_card *card)
164 unsigned int ext_csd_struct;
168 if (card->csd.mmca_vsn < CSD_SPEC_VER_4)
172 * As the ext_csd is so large and mostly unused, we don't store the
173 * raw block in mmc_card.
175 ext_csd = kmalloc(512, GFP_KERNEL);
177 printk(KERN_ERR "%s: could not allocate a buffer to "
178 "receive the ext_csd.\n", mmc_hostname(card->host));
182 err = mmc_send_ext_csd(card, ext_csd);
185 * We all hosts that cannot perform the command
186 * to fail more gracefully
192 * High capacity cards should have this "magic" size
193 * stored in their CSD.
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));
201 printk(KERN_WARNING "%s: unable to read "
202 "EXT_CSD, performance might "
204 mmc_hostname(card->host));
211 ext_csd_struct = ext_csd[EXT_CSD_REV];
212 if (ext_csd_struct > 2) {
213 printk(KERN_ERR "%s: unrecognised EXT_CSD structure "
214 "version %d\n", mmc_hostname(card->host),
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);
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;
233 case EXT_CSD_CARD_TYPE_26:
234 card->ext_csd.hs_max_dtr = 26000000;
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));
251 * Handle the detection and initialisation of a card.
253 * In the case of a resume, "curcard" will contain the card
254 * we're trying to reinitialise.
256 static int mmc_init_card(struct mmc_host *host, u32 ocr,
257 struct mmc_card *oldcard)
259 struct mmc_card *card;
262 unsigned int max_dtr;
265 WARN_ON(!host->claimed);
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
275 /* The extra bit indicates that we support high capacity */
276 err = mmc_send_op_cond(host, ocr | (1 << 30), NULL);
281 * For SPI, enable CRC as appropriate.
283 if (mmc_host_is_spi(host)) {
284 err = mmc_spi_set_crc(host, use_spi_crc);
290 * Fetch CID from card.
292 if (mmc_host_is_spi(host))
293 err = mmc_send_cid(host, cid);
295 err = mmc_all_send_cid(host, cid);
300 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) {
308 * Allocate card structure.
310 card = mmc_alloc_card(host);
316 card->type = MMC_TYPE_MMC;
318 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
322 * For native busses: set card RCA and quit open drain mode.
324 if (!mmc_host_is_spi(host)) {
325 err = mmc_set_relative_addr(card);
329 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
334 * Fetch CSD from card.
336 err = mmc_send_csd(card, card->raw_csd);
340 err = mmc_decode_csd(card);
343 err = mmc_decode_cid(card);
349 * Select card, as all following commands rely on that.
351 if (!mmc_host_is_spi(host)) {
352 err = mmc_select_card(card);
359 * Fetch and process extended CSD.
361 err = mmc_read_ext_csd(card);
367 * Activate high speed (if supported)
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);
376 mmc_card_set_highspeed(card);
378 mmc_set_timing(card->host, MMC_TIMING_MMC_HS);
384 max_dtr = (unsigned int)-1;
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;
393 mmc_set_clock(host, max_dtr);
396 * Activate wide bus (if supported).
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);
405 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
415 mmc_remove_card(card);
422 * Host is being removed. Free up the current card.
424 static void mmc_remove(struct mmc_host *host)
429 mmc_remove_card(host->card);
434 * Card detection callback from host.
436 static void mmc_detect(struct mmc_host *host)
443 mmc_claim_host(host);
446 * Just check if our card has been removed.
448 err = mmc_send_status(host->card, NULL);
450 mmc_release_host(host);
455 mmc_claim_host(host);
456 mmc_detach_bus(host);
457 mmc_release_host(host);
461 MMC_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]);
463 MMC_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]);
465 MMC_ATTR_FN(date, "%02d/%04d\n", card->cid.month, card->cid.year);
466 MMC_ATTR_FN(fwrev, "0x%x\n", card->cid.fwrev);
467 MMC_ATTR_FN(hwrev, "0x%x\n", card->cid.hwrev);
468 MMC_ATTR_FN(manfid, "0x%06x\n", card->cid.manfid);
469 MMC_ATTR_FN(name, "%s\n", card->cid.prod_name);
470 MMC_ATTR_FN(oemid, "0x%04x\n", card->cid.oemid);
471 MMC_ATTR_FN(serial, "0x%08x\n", card->cid.serial);
473 static struct device_attribute mmc_dev_attrs[] = {
487 * Adds sysfs entries as relevant.
489 static int mmc_sysfs_add(struct mmc_host *host, struct mmc_card *card)
493 ret = mmc_add_attrs(card, mmc_dev_attrs);
501 * Removes the sysfs entries added by mmc_sysfs_add().
503 static void mmc_sysfs_remove(struct mmc_host *host, struct mmc_card *card)
505 mmc_remove_attrs(card, mmc_dev_attrs);
508 #ifdef CONFIG_MMC_UNSAFE_RESUME
511 * Suspend callback from host.
513 static void mmc_suspend(struct mmc_host *host)
518 mmc_claim_host(host);
519 if (!mmc_host_is_spi(host))
520 mmc_deselect_cards(host);
521 host->card->state &= ~MMC_STATE_HIGHSPEED;
522 mmc_release_host(host);
526 * Resume callback from host.
528 * This function tries to determine if the same card is still present
529 * and, if so, restore all state to it.
531 static void mmc_resume(struct mmc_host *host)
538 mmc_claim_host(host);
539 err = mmc_init_card(host, host->ocr, host->card);
540 mmc_release_host(host);
545 mmc_claim_host(host);
546 mmc_detach_bus(host);
547 mmc_release_host(host);
554 #define mmc_suspend NULL
555 #define mmc_resume NULL
559 static const struct mmc_bus_ops mmc_ops = {
560 .remove = mmc_remove,
561 .detect = mmc_detect,
562 .sysfs_add = mmc_sysfs_add,
563 .sysfs_remove = mmc_sysfs_remove,
564 .suspend = mmc_suspend,
565 .resume = mmc_resume,
569 * Starting point for MMC card init.
571 int mmc_attach_mmc(struct mmc_host *host, u32 ocr)
576 WARN_ON(!host->claimed);
578 mmc_attach_bus(host, &mmc_ops);
581 * We need to get OCR a different way for SPI.
583 if (mmc_host_is_spi(host)) {
584 err = mmc_spi_read_ocr(host, 1, &ocr);
590 * Sanity check the voltages that the card claims to
594 printk(KERN_WARNING "%s: card claims to support voltages "
595 "below the defined range. These will be ignored.\n",
600 host->ocr = mmc_select_voltage(host, ocr);
603 * Can we support the voltage of the card?
611 * Detect and init the card.
613 err = mmc_init_card(host, host->ocr, NULL);
617 mmc_release_host(host);
619 err = mmc_add_card(host->card);
626 mmc_remove_card(host->card);
628 mmc_claim_host(host);
630 mmc_detach_bus(host);
631 mmc_release_host(host);
633 printk(KERN_ERR "%s: error %d whilst initialising MMC card\n",
634 mmc_hostname(host), err);