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>
23 static const unsigned int tran_exp[] = {
24 10000, 100000, 1000000, 10000000,
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,
33 static const unsigned int tacc_exp[] = {
34 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000,
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,
42 #define UNSTUFF_BITS(resp,start,size) \
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; \
50 __res = resp[__off] >> __shft; \
51 if (__size + __shft > 32) \
52 __res |= resp[__off-1] << ((32 - __shft) % 32); \
57 * Given the decoded CSD structure, decode the raw CID to our CID structure.
59 static int mmc_decode_cid(struct mmc_card *card)
61 u32 *resp = card->raw_cid;
64 * The selection of the format here is based upon published
65 * specs from sandisk and from what people have reported.
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;
85 case 2: /* MMC v2.0 - v2.2 */
86 case 3: /* MMC v3.1 - v3.3 */
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;
102 printk(KERN_ERR "%s: card has unknown MMCA version %d\n",
103 mmc_hostname(card->host), card->csd.mmca_vsn);
111 * Given a 128-bit response, decode to our card CSD structure.
113 static int mmc_decode_csd(struct mmc_card *card)
115 struct mmc_csd *csd = &card->csd;
116 unsigned int e, m, csd_struct;
117 u32 *resp = card->raw_csd;
120 * We only understand CSD structure v1.1 and v1.2.
121 * v1.2 has extra information in bits 15, 11 and 10.
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);
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;
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);
141 e = UNSTUFF_BITS(resp, 47, 3);
142 m = UNSTUFF_BITS(resp, 62, 12);
143 csd->capacity = (1 + m) << (e + 2);
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);
157 * Read and decode extended CSD.
159 static int mmc_read_ext_csd(struct mmc_card *card)
166 if (card->csd.mmca_vsn < CSD_SPEC_VER_4)
170 * As the ext_csd is so large and mostly unused, we don't store the
171 * raw block in mmc_card.
173 ext_csd = kmalloc(512, GFP_KERNEL);
175 printk(KERN_ERR "%s: could not allocate a buffer to "
176 "receive the ext_csd.\n", mmc_hostname(card->host));
180 err = mmc_send_ext_csd(card, ext_csd);
182 /* If the host or the card can't do the switch,
183 * fail more gracefully. */
190 * High capacity cards should have this "magic" size
191 * stored in their CSD.
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));
199 printk(KERN_WARNING "%s: unable to read "
200 "EXT_CSD, performance might "
202 mmc_hostname(card->host));
209 card->ext_csd.rev = ext_csd[EXT_CSD_REV];
210 if (card->ext_csd.rev > 3) {
211 printk(KERN_ERR "%s: unrecognised EXT_CSD structure "
212 "version %d\n", mmc_hostname(card->host),
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);
228 switch (ext_csd[EXT_CSD_CARD_TYPE]) {
229 case EXT_CSD_CARD_TYPE_52 | EXT_CSD_CARD_TYPE_26:
230 card->ext_csd.hs_max_dtr = 52000000;
232 case EXT_CSD_CARD_TYPE_26:
233 card->ext_csd.hs_max_dtr = 26000000;
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));
243 if (card->ext_csd.rev >= 3) {
244 u8 sa_shift = ext_csd[EXT_CSD_S_A_TIMEOUT];
246 /* Sleep / awake timeout in 100ns units */
247 if (sa_shift > 0 && sa_shift <= 0x17)
248 card->ext_csd.sa_timeout =
249 1 << ext_csd[EXT_CSD_S_A_TIMEOUT];
258 MMC_DEV_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
259 card->raw_cid[2], card->raw_cid[3]);
260 MMC_DEV_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
261 card->raw_csd[2], card->raw_csd[3]);
262 MMC_DEV_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
263 MMC_DEV_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
264 MMC_DEV_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
265 MMC_DEV_ATTR(manfid, "0x%06x\n", card->cid.manfid);
266 MMC_DEV_ATTR(name, "%s\n", card->cid.prod_name);
267 MMC_DEV_ATTR(oemid, "0x%04x\n", card->cid.oemid);
268 MMC_DEV_ATTR(serial, "0x%08x\n", card->cid.serial);
270 static struct attribute *mmc_std_attrs[] = {
274 &dev_attr_fwrev.attr,
275 &dev_attr_hwrev.attr,
276 &dev_attr_manfid.attr,
278 &dev_attr_oemid.attr,
279 &dev_attr_serial.attr,
283 static struct attribute_group mmc_std_attr_group = {
284 .attrs = mmc_std_attrs,
287 static const struct attribute_group *mmc_attr_groups[] = {
292 static struct device_type mmc_type = {
293 .groups = mmc_attr_groups,
297 * Handle the detection and initialisation of a card.
299 * In the case of a resume, "oldcard" will contain the card
300 * we're trying to reinitialise.
302 static int mmc_init_card(struct mmc_host *host, u32 ocr,
303 struct mmc_card *oldcard)
305 struct mmc_card *card;
308 unsigned int max_dtr;
311 WARN_ON(!host->claimed);
314 * Since we're changing the OCR value, we seem to
315 * need to tell some cards to go back to the idle
316 * state. We wait 1ms to give cards time to
321 /* The extra bit indicates that we support high capacity */
322 err = mmc_send_op_cond(host, ocr | (1 << 30), NULL);
327 * For SPI, enable CRC as appropriate.
329 if (mmc_host_is_spi(host)) {
330 err = mmc_spi_set_crc(host, use_spi_crc);
336 * Fetch CID from card.
338 if (mmc_host_is_spi(host))
339 err = mmc_send_cid(host, cid);
341 err = mmc_all_send_cid(host, cid);
346 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0) {
354 * Allocate card structure.
356 card = mmc_alloc_card(host, &mmc_type);
362 card->type = MMC_TYPE_MMC;
364 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
368 * For native busses: set card RCA and quit open drain mode.
370 if (!mmc_host_is_spi(host)) {
371 err = mmc_set_relative_addr(card);
375 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
380 * Fetch CSD from card.
382 err = mmc_send_csd(card, card->raw_csd);
386 err = mmc_decode_csd(card);
389 err = mmc_decode_cid(card);
395 * Select card, as all following commands rely on that.
397 if (!mmc_host_is_spi(host)) {
398 err = mmc_select_card(card);
405 * Fetch and process extended CSD.
407 err = mmc_read_ext_csd(card);
413 * Activate high speed (if supported)
415 if ((card->ext_csd.hs_max_dtr != 0) &&
416 (host->caps & MMC_CAP_MMC_HIGHSPEED)) {
417 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
418 EXT_CSD_HS_TIMING, 1);
419 if (err && err != -EBADMSG)
423 printk(KERN_WARNING "%s: switch to highspeed failed\n",
424 mmc_hostname(card->host));
427 mmc_card_set_highspeed(card);
428 mmc_set_timing(card->host, MMC_TIMING_MMC_HS);
435 max_dtr = (unsigned int)-1;
437 if (mmc_card_highspeed(card)) {
438 if (max_dtr > card->ext_csd.hs_max_dtr)
439 max_dtr = card->ext_csd.hs_max_dtr;
440 } else if (max_dtr > card->csd.max_dtr) {
441 max_dtr = card->csd.max_dtr;
444 mmc_set_clock(host, max_dtr);
447 * Activate wide bus (if supported).
449 if ((card->csd.mmca_vsn >= CSD_SPEC_VER_4) &&
450 (host->caps & (MMC_CAP_4_BIT_DATA | MMC_CAP_8_BIT_DATA))) {
451 unsigned ext_csd_bit, bus_width;
453 if (host->caps & MMC_CAP_8_BIT_DATA) {
454 ext_csd_bit = EXT_CSD_BUS_WIDTH_8;
455 bus_width = MMC_BUS_WIDTH_8;
457 ext_csd_bit = EXT_CSD_BUS_WIDTH_4;
458 bus_width = MMC_BUS_WIDTH_4;
461 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
462 EXT_CSD_BUS_WIDTH, ext_csd_bit);
464 if (err && err != -EBADMSG)
468 printk(KERN_WARNING "%s: switch to bus width %d "
469 "failed\n", mmc_hostname(card->host),
473 mmc_set_bus_width(card->host, bus_width);
484 mmc_remove_card(card);
491 * Host is being removed. Free up the current card.
493 static void mmc_remove(struct mmc_host *host)
498 mmc_remove_card(host->card);
503 * Card detection callback from host.
505 static void mmc_detect(struct mmc_host *host)
512 mmc_claim_host(host);
515 * Just check if our card has been removed.
517 err = mmc_send_status(host->card, NULL);
519 mmc_release_host(host);
524 mmc_claim_host(host);
525 mmc_detach_bus(host);
526 mmc_release_host(host);
531 * Suspend callback from host.
533 static int mmc_suspend(struct mmc_host *host)
538 mmc_claim_host(host);
539 if (!mmc_host_is_spi(host))
540 mmc_deselect_cards(host);
541 host->card->state &= ~MMC_STATE_HIGHSPEED;
542 mmc_release_host(host);
548 * Resume callback from host.
550 * This function tries to determine if the same card is still present
551 * and, if so, restore all state to it.
553 static int mmc_resume(struct mmc_host *host)
560 mmc_claim_host(host);
561 err = mmc_init_card(host, host->ocr, host->card);
562 mmc_release_host(host);
567 static void mmc_power_restore(struct mmc_host *host)
569 host->card->state &= ~MMC_STATE_HIGHSPEED;
570 mmc_claim_host(host);
571 mmc_init_card(host, host->ocr, host->card);
572 mmc_release_host(host);
575 static int mmc_sleep(struct mmc_host *host)
577 struct mmc_card *card = host->card;
580 if (card && card->ext_csd.rev >= 3) {
581 err = mmc_card_sleepawake(host, 1);
583 pr_debug("%s: Error %d while putting card into sleep",
584 mmc_hostname(host), err);
590 static int mmc_awake(struct mmc_host *host)
592 struct mmc_card *card = host->card;
595 if (card && card->ext_csd.rev >= 3) {
596 err = mmc_card_sleepawake(host, 0);
598 pr_debug("%s: Error %d while awaking sleeping card",
599 mmc_hostname(host), err);
605 #ifdef CONFIG_MMC_UNSAFE_RESUME
607 static const struct mmc_bus_ops mmc_ops = {
610 .remove = mmc_remove,
611 .detect = mmc_detect,
612 .suspend = mmc_suspend,
613 .resume = mmc_resume,
614 .power_restore = mmc_power_restore,
617 static void mmc_attach_bus_ops(struct mmc_host *host)
619 mmc_attach_bus(host, &mmc_ops);
624 static const struct mmc_bus_ops mmc_ops = {
627 .remove = mmc_remove,
628 .detect = mmc_detect,
631 .power_restore = mmc_power_restore,
634 static const struct mmc_bus_ops mmc_ops_unsafe = {
637 .remove = mmc_remove,
638 .detect = mmc_detect,
639 .suspend = mmc_suspend,
640 .resume = mmc_resume,
641 .power_restore = mmc_power_restore,
644 static void mmc_attach_bus_ops(struct mmc_host *host)
646 const struct mmc_bus_ops *bus_ops;
648 if (host->caps & MMC_CAP_NONREMOVABLE)
649 bus_ops = &mmc_ops_unsafe;
652 mmc_attach_bus(host, bus_ops);
658 * Starting point for MMC card init.
660 int mmc_attach_mmc(struct mmc_host *host, u32 ocr)
665 WARN_ON(!host->claimed);
667 mmc_attach_bus_ops(host);
670 * We need to get OCR a different way for SPI.
672 if (mmc_host_is_spi(host)) {
673 err = mmc_spi_read_ocr(host, 1, &ocr);
679 * Sanity check the voltages that the card claims to
683 printk(KERN_WARNING "%s: card claims to support voltages "
684 "below the defined range. These will be ignored.\n",
689 host->ocr = mmc_select_voltage(host, ocr);
692 * Can we support the voltage of the card?
700 * Detect and init the card.
702 err = mmc_init_card(host, host->ocr, NULL);
706 mmc_release_host(host);
708 err = mmc_add_card(host->card);
715 mmc_remove_card(host->card);
717 mmc_claim_host(host);
719 mmc_detach_bus(host);
720 mmc_release_host(host);
722 printk(KERN_ERR "%s: error %d whilst initialising MMC card\n",
723 mmc_hostname(host), err);