2 * linux/drivers/mmc/core/sd.c
4 * Copyright (C) 2003-2004 Russell King, All Rights Reserved.
5 * SD support Copyright (C) 2004 Ian Molton, All Rights Reserved.
6 * Copyright (C) 2005-2007 Pierre Ossman, 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>
18 #include <linux/mmc/sd.h>
26 static const unsigned int tran_exp[] = {
27 10000, 100000, 1000000, 10000000,
31 static const unsigned char tran_mant[] = {
32 0, 10, 12, 13, 15, 20, 25, 30,
33 35, 40, 45, 50, 55, 60, 70, 80,
36 static const unsigned int tacc_exp[] = {
37 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000,
40 static const unsigned int tacc_mant[] = {
41 0, 10, 12, 13, 15, 20, 25, 30,
42 35, 40, 45, 50, 55, 60, 70, 80,
45 #define UNSTUFF_BITS(resp,start,size) \
47 const int __size = size; \
48 const u32 __mask = (__size < 32 ? 1 << __size : 0) - 1; \
49 const int __off = 3 - ((start) / 32); \
50 const int __shft = (start) & 31; \
53 __res = resp[__off] >> __shft; \
54 if (__size + __shft > 32) \
55 __res |= resp[__off-1] << ((32 - __shft) % 32); \
60 * Given the decoded CSD structure, decode the raw CID to our CID structure.
62 static void mmc_decode_cid(struct mmc_card *card)
64 u32 *resp = card->raw_cid;
66 memset(&card->cid, 0, sizeof(struct mmc_cid));
69 * SD doesn't currently have a version field so we will
70 * have to assume we can parse this.
72 card->cid.manfid = UNSTUFF_BITS(resp, 120, 8);
73 card->cid.oemid = UNSTUFF_BITS(resp, 104, 16);
74 card->cid.prod_name[0] = UNSTUFF_BITS(resp, 96, 8);
75 card->cid.prod_name[1] = UNSTUFF_BITS(resp, 88, 8);
76 card->cid.prod_name[2] = UNSTUFF_BITS(resp, 80, 8);
77 card->cid.prod_name[3] = UNSTUFF_BITS(resp, 72, 8);
78 card->cid.prod_name[4] = UNSTUFF_BITS(resp, 64, 8);
79 card->cid.hwrev = UNSTUFF_BITS(resp, 60, 4);
80 card->cid.fwrev = UNSTUFF_BITS(resp, 56, 4);
81 card->cid.serial = UNSTUFF_BITS(resp, 24, 32);
82 card->cid.year = UNSTUFF_BITS(resp, 12, 8);
83 card->cid.month = UNSTUFF_BITS(resp, 8, 4);
85 card->cid.year += 2000; /* SD cards year offset */
89 * Given a 128-bit response, decode to our card CSD structure.
91 static int mmc_decode_csd(struct mmc_card *card)
93 struct mmc_csd *csd = &card->csd;
94 unsigned int e, m, csd_struct;
95 u32 *resp = card->raw_csd;
97 csd_struct = UNSTUFF_BITS(resp, 126, 2);
101 m = UNSTUFF_BITS(resp, 115, 4);
102 e = UNSTUFF_BITS(resp, 112, 3);
103 csd->tacc_ns = (tacc_exp[e] * tacc_mant[m] + 9) / 10;
104 csd->tacc_clks = UNSTUFF_BITS(resp, 104, 8) * 100;
106 m = UNSTUFF_BITS(resp, 99, 4);
107 e = UNSTUFF_BITS(resp, 96, 3);
108 csd->max_dtr = tran_exp[e] * tran_mant[m];
109 csd->cmdclass = UNSTUFF_BITS(resp, 84, 12);
111 e = UNSTUFF_BITS(resp, 47, 3);
112 m = UNSTUFF_BITS(resp, 62, 12);
113 csd->capacity = (1 + m) << (e + 2);
115 csd->read_blkbits = UNSTUFF_BITS(resp, 80, 4);
116 csd->read_partial = UNSTUFF_BITS(resp, 79, 1);
117 csd->write_misalign = UNSTUFF_BITS(resp, 78, 1);
118 csd->read_misalign = UNSTUFF_BITS(resp, 77, 1);
119 csd->r2w_factor = UNSTUFF_BITS(resp, 26, 3);
120 csd->write_blkbits = UNSTUFF_BITS(resp, 22, 4);
121 csd->write_partial = UNSTUFF_BITS(resp, 21, 1);
125 * This is a block-addressed SDHC card. Most
126 * interesting fields are unused and have fixed
127 * values. To avoid getting tripped by buggy cards,
128 * we assume those fixed values ourselves.
130 mmc_card_set_blockaddr(card);
132 csd->tacc_ns = 0; /* Unused */
133 csd->tacc_clks = 0; /* Unused */
135 m = UNSTUFF_BITS(resp, 99, 4);
136 e = UNSTUFF_BITS(resp, 96, 3);
137 csd->max_dtr = tran_exp[e] * tran_mant[m];
138 csd->cmdclass = UNSTUFF_BITS(resp, 84, 12);
140 m = UNSTUFF_BITS(resp, 48, 22);
141 csd->capacity = (1 + m) << 10;
143 csd->read_blkbits = 9;
144 csd->read_partial = 0;
145 csd->write_misalign = 0;
146 csd->read_misalign = 0;
147 csd->r2w_factor = 4; /* Unused */
148 csd->write_blkbits = 9;
149 csd->write_partial = 0;
152 printk("%s: unrecognised CSD structure version %d\n",
153 mmc_hostname(card->host), csd_struct);
161 * Given a 64-bit response, decode to our card SCR structure.
163 static int mmc_decode_scr(struct mmc_card *card)
165 struct sd_scr *scr = &card->scr;
166 unsigned int scr_struct;
169 BUG_ON(!mmc_card_sd(card));
171 resp[3] = card->raw_scr[1];
172 resp[2] = card->raw_scr[0];
174 scr_struct = UNSTUFF_BITS(resp, 60, 4);
175 if (scr_struct != 0) {
176 printk("%s: unrecognised SCR structure version %d\n",
177 mmc_hostname(card->host), scr_struct);
181 scr->sda_vsn = UNSTUFF_BITS(resp, 56, 4);
182 scr->bus_widths = UNSTUFF_BITS(resp, 48, 4);
188 * Fetches and decodes switch information
190 static int mmc_read_switch(struct mmc_card *card)
195 if (card->scr.sda_vsn < SCR_SPEC_VER_1)
198 if (!(card->csd.cmdclass & CCC_SWITCH)) {
199 printk(KERN_WARNING "%s: card lacks mandatory switch "
200 "function, performance might suffer.\n",
201 mmc_hostname(card->host));
205 err = MMC_ERR_FAILED;
207 status = kmalloc(64, GFP_KERNEL);
209 printk("%s: could not allocate a buffer for switch "
211 mmc_hostname(card->host));
215 err = mmc_sd_switch(card, 0, 0, 1, status);
216 if (err != MMC_ERR_NONE) {
217 printk(KERN_WARNING "%s: problem reading switch "
218 "capabilities, performance might suffer.\n",
219 mmc_hostname(card->host));
224 if (status[13] & 0x02)
225 card->sw_caps.hs_max_dtr = 50000000;
234 * Test if the card supports high-speed mode and, if so, switch to it.
236 static int mmc_switch_hs(struct mmc_card *card)
241 if (card->scr.sda_vsn < SCR_SPEC_VER_1)
244 if (!(card->csd.cmdclass & CCC_SWITCH))
247 if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
250 if (card->sw_caps.hs_max_dtr == 0)
253 err = MMC_ERR_FAILED;
255 status = kmalloc(64, GFP_KERNEL);
257 printk("%s: could not allocate a buffer for switch "
259 mmc_hostname(card->host));
263 err = mmc_sd_switch(card, 1, 0, 1, status);
264 if (err != MMC_ERR_NONE)
267 if ((status[16] & 0xF) != 1) {
268 printk(KERN_WARNING "%s: Problem switching card "
269 "into high-speed mode!\n",
270 mmc_hostname(card->host));
272 mmc_card_set_highspeed(card);
273 mmc_set_timing(card->host, MMC_TIMING_SD_HS);
283 * Handle the detection and initialisation of a card.
285 * In the case of a resume, "curcard" will contain the card
286 * we're trying to reinitialise.
288 static int mmc_sd_init_card(struct mmc_host *host, u32 ocr,
289 struct mmc_card *oldcard)
291 struct mmc_card *card;
294 unsigned int max_dtr;
297 BUG_ON(!host->claimed);
300 * Since we're changing the OCR value, we seem to
301 * need to tell some cards to go back to the idle
302 * state. We wait 1ms to give cards time to
308 * If SD_SEND_IF_COND indicates an SD 2.0
309 * compliant card and we should set bit 30
310 * of the ocr to indicate that we can handle
311 * block-addressed SDHC cards.
313 err = mmc_send_if_cond(host, ocr);
314 if (err == MMC_ERR_NONE)
317 err = mmc_send_app_op_cond(host, ocr, NULL);
318 if (err != MMC_ERR_NONE)
322 * Fetch CID from card.
324 err = mmc_all_send_cid(host, cid);
325 if (err != MMC_ERR_NONE)
329 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0)
335 * Allocate card structure.
337 card = mmc_alloc_card(host);
341 card->type = MMC_TYPE_SD;
342 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
348 err = mmc_send_relative_addr(host, &card->rca);
349 if (err != MMC_ERR_NONE)
352 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
356 * Fetch CSD from card.
358 err = mmc_send_csd(card, card->raw_csd);
359 if (err != MMC_ERR_NONE)
362 err = mmc_decode_csd(card);
366 mmc_decode_cid(card);
370 * Select card, as all following commands rely on that.
372 err = mmc_select_card(card);
373 if (err != MMC_ERR_NONE)
378 * Fetch SCR from card.
380 err = mmc_app_send_scr(card, card->raw_scr);
381 if (err != MMC_ERR_NONE)
384 err = mmc_decode_scr(card);
389 * Fetch switch information from card.
391 err = mmc_read_switch(card);
392 if (err != MMC_ERR_NONE)
397 * Attempt to change to high-speed (if supported)
399 err = mmc_switch_hs(card);
400 if (err != MMC_ERR_NONE)
406 max_dtr = (unsigned int)-1;
408 if (mmc_card_highspeed(card)) {
409 if (max_dtr > card->sw_caps.hs_max_dtr)
410 max_dtr = card->sw_caps.hs_max_dtr;
411 } else if (max_dtr > card->csd.max_dtr) {
412 max_dtr = card->csd.max_dtr;
415 mmc_set_clock(host, max_dtr);
418 * Switch to wider bus (if supported).
420 if ((host->caps & MMC_CAP_4_BIT_DATA) &&
421 (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
422 err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
423 if (err != MMC_ERR_NONE)
426 mmc_set_bus_width(host, MMC_BUS_WIDTH_4);
430 * Check if read-only switch is active.
433 if (!host->ops->get_ro) {
434 printk(KERN_WARNING "%s: host does not "
435 "support reading read-only "
436 "switch. assuming write-enable.\n",
439 if (host->ops->get_ro(host))
440 mmc_card_set_readonly(card);
451 mmc_remove_card(card);
454 return MMC_ERR_FAILED;
458 * Host is being removed. Free up the current card.
460 static void mmc_sd_remove(struct mmc_host *host)
465 mmc_remove_card(host->card);
470 * Card detection callback from host.
472 static void mmc_sd_detect(struct mmc_host *host)
479 mmc_claim_host(host);
482 * Just check if our card has been removed.
484 err = mmc_send_status(host->card, NULL);
486 mmc_release_host(host);
488 if (err != MMC_ERR_NONE) {
491 mmc_claim_host(host);
492 mmc_detach_bus(host);
493 mmc_release_host(host);
497 MMC_ATTR_FN(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
498 card->raw_cid[2], card->raw_cid[3]);
499 MMC_ATTR_FN(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
500 card->raw_csd[2], card->raw_csd[3]);
501 MMC_ATTR_FN(scr, "%08x%08x\n", card->raw_scr[0], card->raw_scr[1]);
502 MMC_ATTR_FN(date, "%02d/%04d\n", card->cid.month, card->cid.year);
503 MMC_ATTR_FN(fwrev, "0x%x\n", card->cid.fwrev);
504 MMC_ATTR_FN(hwrev, "0x%x\n", card->cid.hwrev);
505 MMC_ATTR_FN(manfid, "0x%06x\n", card->cid.manfid);
506 MMC_ATTR_FN(name, "%s\n", card->cid.prod_name);
507 MMC_ATTR_FN(oemid, "0x%04x\n", card->cid.oemid);
508 MMC_ATTR_FN(serial, "0x%08x\n", card->cid.serial);
510 static struct device_attribute mmc_sd_dev_attrs[] = {
525 * Adds sysfs entries as relevant.
527 static int mmc_sd_sysfs_add(struct mmc_host *host, struct mmc_card *card)
531 ret = mmc_add_attrs(card, mmc_sd_dev_attrs);
539 * Removes the sysfs entries added by mmc_sysfs_add().
541 static void mmc_sd_sysfs_remove(struct mmc_host *host, struct mmc_card *card)
543 mmc_remove_attrs(card, mmc_sd_dev_attrs);
546 #ifdef CONFIG_MMC_UNSAFE_RESUME
549 * Suspend callback from host.
551 static void mmc_sd_suspend(struct mmc_host *host)
556 mmc_claim_host(host);
557 mmc_deselect_cards(host);
558 host->card->state &= ~MMC_STATE_HIGHSPEED;
559 mmc_release_host(host);
563 * Resume callback from host.
565 * This function tries to determine if the same card is still present
566 * and, if so, restore all state to it.
568 static void mmc_sd_resume(struct mmc_host *host)
575 mmc_claim_host(host);
576 err = mmc_sd_init_card(host, host->ocr, host->card);
577 mmc_release_host(host);
579 if (err != MMC_ERR_NONE) {
582 mmc_claim_host(host);
583 mmc_detach_bus(host);
584 mmc_release_host(host);
591 #define mmc_sd_suspend NULL
592 #define mmc_sd_resume NULL
596 static const struct mmc_bus_ops mmc_sd_ops = {
597 .remove = mmc_sd_remove,
598 .detect = mmc_sd_detect,
599 .sysfs_add = mmc_sd_sysfs_add,
600 .sysfs_remove = mmc_sd_sysfs_remove,
601 .suspend = mmc_sd_suspend,
602 .resume = mmc_sd_resume,
606 * Starting point for SD card init.
608 int mmc_attach_sd(struct mmc_host *host, u32 ocr)
613 BUG_ON(!host->claimed);
615 mmc_attach_bus(host, &mmc_sd_ops);
618 * Sanity check the voltages that the card claims to
622 printk(KERN_WARNING "%s: card claims to support voltages "
623 "below the defined range. These will be ignored.\n",
628 if (ocr & MMC_VDD_165_195) {
629 printk(KERN_WARNING "%s: SD card claims to support the "
630 "incompletely defined 'low voltage range'. This "
631 "will be ignored.\n", mmc_hostname(host));
632 ocr &= ~MMC_VDD_165_195;
635 host->ocr = mmc_select_voltage(host, ocr);
638 * Can we support the voltage(s) of the card(s)?
646 * Detect and init the card.
648 err = mmc_sd_init_card(host, host->ocr, NULL);
649 if (err != MMC_ERR_NONE)
652 mmc_release_host(host);
654 err = mmc_add_card(host->card);
661 mmc_remove_card(host->card);
663 mmc_claim_host(host);
665 mmc_detach_bus(host);
666 mmc_release_host(host);
668 printk(KERN_ERR "%s: error %d whilst initialising SD card\n",
669 mmc_hostname(host), err);