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>
14 #include <linux/slab.h>
16 #include <linux/mmc/host.h>
17 #include <linux/mmc/card.h>
18 #include <linux/mmc/mmc.h>
19 #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(KERN_ERR
"%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 resp
[3] = card
->raw_scr
[1];
170 resp
[2] = card
->raw_scr
[0];
172 scr_struct
= UNSTUFF_BITS(resp
, 60, 4);
173 if (scr_struct
!= 0) {
174 printk(KERN_ERR
"%s: unrecognised SCR structure version %d\n",
175 mmc_hostname(card
->host
), scr_struct
);
179 scr
->sda_vsn
= UNSTUFF_BITS(resp
, 56, 4);
180 scr
->bus_widths
= UNSTUFF_BITS(resp
, 48, 4);
186 * Fetches and decodes switch information
188 static int mmc_read_switch(struct mmc_card
*card
)
193 if (card
->scr
.sda_vsn
< SCR_SPEC_VER_1
)
196 if (!(card
->csd
.cmdclass
& CCC_SWITCH
)) {
197 printk(KERN_WARNING
"%s: card lacks mandatory switch "
198 "function, performance might suffer.\n",
199 mmc_hostname(card
->host
));
205 status
= kmalloc(64, GFP_KERNEL
);
207 printk(KERN_ERR
"%s: could not allocate a buffer for "
208 "switch capabilities.\n", mmc_hostname(card
->host
));
212 err
= mmc_sd_switch(card
, 0, 0, 1, status
);
214 /* If the host or the card can't do the switch,
215 * fail more gracefully. */
221 printk(KERN_WARNING
"%s: problem reading switch "
222 "capabilities, performance might suffer.\n",
223 mmc_hostname(card
->host
));
229 if (status
[13] & 0x02)
230 card
->sw_caps
.hs_max_dtr
= 50000000;
239 * Test if the card supports high-speed mode and, if so, switch to it.
241 static int mmc_switch_hs(struct mmc_card
*card
)
246 if (card
->scr
.sda_vsn
< SCR_SPEC_VER_1
)
249 if (!(card
->csd
.cmdclass
& CCC_SWITCH
))
252 if (!(card
->host
->caps
& MMC_CAP_SD_HIGHSPEED
))
255 if (card
->sw_caps
.hs_max_dtr
== 0)
260 status
= kmalloc(64, GFP_KERNEL
);
262 printk(KERN_ERR
"%s: could not allocate a buffer for "
263 "switch capabilities.\n", mmc_hostname(card
->host
));
267 err
= mmc_sd_switch(card
, 1, 0, 1, status
);
271 if ((status
[16] & 0xF) != 1) {
272 printk(KERN_WARNING
"%s: Problem switching card "
273 "into high-speed mode!\n",
274 mmc_hostname(card
->host
));
276 mmc_card_set_highspeed(card
);
277 mmc_set_timing(card
->host
, MMC_TIMING_SD_HS
);
286 MMC_DEV_ATTR(cid
, "%08x%08x%08x%08x\n", card
->raw_cid
[0], card
->raw_cid
[1],
287 card
->raw_cid
[2], card
->raw_cid
[3]);
288 MMC_DEV_ATTR(csd
, "%08x%08x%08x%08x\n", card
->raw_csd
[0], card
->raw_csd
[1],
289 card
->raw_csd
[2], card
->raw_csd
[3]);
290 MMC_DEV_ATTR(scr
, "%08x%08x\n", card
->raw_scr
[0], card
->raw_scr
[1]);
291 MMC_DEV_ATTR(date
, "%02d/%04d\n", card
->cid
.month
, card
->cid
.year
);
292 MMC_DEV_ATTR(fwrev
, "0x%x\n", card
->cid
.fwrev
);
293 MMC_DEV_ATTR(hwrev
, "0x%x\n", card
->cid
.hwrev
);
294 MMC_DEV_ATTR(manfid
, "0x%06x\n", card
->cid
.manfid
);
295 MMC_DEV_ATTR(name
, "%s\n", card
->cid
.prod_name
);
296 MMC_DEV_ATTR(oemid
, "0x%04x\n", card
->cid
.oemid
);
297 MMC_DEV_ATTR(serial
, "0x%08x\n", card
->cid
.serial
);
300 static struct attribute
*sd_std_attrs
[] = {
305 &dev_attr_fwrev
.attr
,
306 &dev_attr_hwrev
.attr
,
307 &dev_attr_manfid
.attr
,
309 &dev_attr_oemid
.attr
,
310 &dev_attr_serial
.attr
,
314 static struct attribute_group sd_std_attr_group
= {
315 .attrs
= sd_std_attrs
,
318 static const struct attribute_group
*sd_attr_groups
[] = {
323 static struct device_type sd_type
= {
324 .groups
= sd_attr_groups
,
328 * Handle the detection and initialisation of a card.
330 * In the case of a resume, "oldcard" will contain the card
331 * we're trying to reinitialise.
333 static int mmc_sd_init_card(struct mmc_host
*host
, u32 ocr
,
334 struct mmc_card
*oldcard
)
336 struct mmc_card
*card
;
339 unsigned int max_dtr
;
342 WARN_ON(!host
->claimed
);
345 * Since we're changing the OCR value, we seem to
346 * need to tell some cards to go back to the idle
347 * state. We wait 1ms to give cards time to
353 * If SD_SEND_IF_COND indicates an SD 2.0
354 * compliant card and we should set bit 30
355 * of the ocr to indicate that we can handle
356 * block-addressed SDHC cards.
358 err
= mmc_send_if_cond(host
, ocr
);
362 err
= mmc_send_app_op_cond(host
, ocr
, NULL
);
367 * Fetch CID from card.
369 if (mmc_host_is_spi(host
))
370 err
= mmc_send_cid(host
, cid
);
372 err
= mmc_all_send_cid(host
, cid
);
377 if (memcmp(cid
, oldcard
->raw_cid
, sizeof(cid
)) != 0) {
385 * Allocate card structure.
387 card
= mmc_alloc_card(host
, &sd_type
);
393 card
->type
= MMC_TYPE_SD
;
394 memcpy(card
->raw_cid
, cid
, sizeof(card
->raw_cid
));
398 * For native busses: get card RCA and quit open drain mode.
400 if (!mmc_host_is_spi(host
)) {
401 err
= mmc_send_relative_addr(host
, &card
->rca
);
405 mmc_set_bus_mode(host
, MMC_BUSMODE_PUSHPULL
);
410 * Fetch CSD from card.
412 err
= mmc_send_csd(card
, card
->raw_csd
);
416 err
= mmc_decode_csd(card
);
420 mmc_decode_cid(card
);
424 * Select card, as all following commands rely on that.
426 if (!mmc_host_is_spi(host
)) {
427 err
= mmc_select_card(card
);
434 * Fetch SCR from card.
436 err
= mmc_app_send_scr(card
, card
->raw_scr
);
440 err
= mmc_decode_scr(card
);
445 * Fetch switch information from card.
447 err
= mmc_read_switch(card
);
453 * For SPI, enable CRC as appropriate.
454 * This CRC enable is located AFTER the reading of the
455 * card registers because some SDHC cards are not able
456 * to provide valid CRCs for non-512-byte blocks.
458 if (mmc_host_is_spi(host
)) {
459 err
= mmc_spi_set_crc(host
, use_spi_crc
);
465 * Attempt to change to high-speed (if supported)
467 err
= mmc_switch_hs(card
);
474 max_dtr
= (unsigned int)-1;
476 if (mmc_card_highspeed(card
)) {
477 if (max_dtr
> card
->sw_caps
.hs_max_dtr
)
478 max_dtr
= card
->sw_caps
.hs_max_dtr
;
479 } else if (max_dtr
> card
->csd
.max_dtr
) {
480 max_dtr
= card
->csd
.max_dtr
;
483 mmc_set_clock(host
, max_dtr
);
486 * Switch to wider bus (if supported).
488 if ((host
->caps
& MMC_CAP_4_BIT_DATA
) &&
489 (card
->scr
.bus_widths
& SD_SCR_BUS_WIDTH_4
)) {
490 err
= mmc_app_set_bus_width(card
, MMC_BUS_WIDTH_4
);
494 mmc_set_bus_width(host
, MMC_BUS_WIDTH_4
);
498 * Check if read-only switch is active.
501 if (!host
->ops
->get_ro
|| host
->ops
->get_ro(host
) < 0) {
502 printk(KERN_WARNING
"%s: host does not "
503 "support reading read-only "
504 "switch. assuming write-enable.\n",
507 if (host
->ops
->get_ro(host
) > 0)
508 mmc_card_set_readonly(card
);
519 mmc_remove_card(card
);
526 * Host is being removed. Free up the current card.
528 static void mmc_sd_remove(struct mmc_host
*host
)
533 mmc_remove_card(host
->card
);
538 * Card detection callback from host.
540 static void mmc_sd_detect(struct mmc_host
*host
)
547 mmc_claim_host(host
);
550 * Just check if our card has been removed.
552 err
= mmc_send_status(host
->card
, NULL
);
554 mmc_release_host(host
);
559 mmc_claim_host(host
);
560 mmc_detach_bus(host
);
561 mmc_release_host(host
);
566 * Suspend callback from host.
568 static int mmc_sd_suspend(struct mmc_host
*host
)
573 mmc_claim_host(host
);
574 if (!mmc_host_is_spi(host
))
575 mmc_deselect_cards(host
);
576 host
->card
->state
&= ~MMC_STATE_HIGHSPEED
;
577 mmc_release_host(host
);
583 * Resume callback from host.
585 * This function tries to determine if the same card is still present
586 * and, if so, restore all state to it.
588 static int mmc_sd_resume(struct mmc_host
*host
)
595 mmc_claim_host(host
);
596 err
= mmc_sd_init_card(host
, host
->ocr
, host
->card
);
597 mmc_release_host(host
);
602 static void mmc_sd_power_restore(struct mmc_host
*host
)
604 host
->card
->state
&= ~MMC_STATE_HIGHSPEED
;
605 mmc_claim_host(host
);
606 mmc_sd_init_card(host
, host
->ocr
, host
->card
);
607 mmc_release_host(host
);
610 static const struct mmc_bus_ops mmc_sd_ops
= {
611 .remove
= mmc_sd_remove
,
612 .detect
= mmc_sd_detect
,
615 .power_restore
= mmc_sd_power_restore
,
618 static const struct mmc_bus_ops mmc_sd_ops_unsafe
= {
619 .remove
= mmc_sd_remove
,
620 .detect
= mmc_sd_detect
,
621 .suspend
= mmc_sd_suspend
,
622 .resume
= mmc_sd_resume
,
623 .power_restore
= mmc_sd_power_restore
,
626 static void mmc_sd_attach_bus_ops(struct mmc_host
*host
)
628 const struct mmc_bus_ops
*bus_ops
;
630 if (host
->caps
& MMC_CAP_NONREMOVABLE
|| !mmc_assume_removable
)
631 bus_ops
= &mmc_sd_ops_unsafe
;
633 bus_ops
= &mmc_sd_ops
;
634 mmc_attach_bus(host
, bus_ops
);
638 * Starting point for SD card init.
640 int mmc_attach_sd(struct mmc_host
*host
, u32 ocr
)
645 WARN_ON(!host
->claimed
);
647 mmc_sd_attach_bus_ops(host
);
650 * We need to get OCR a different way for SPI.
652 if (mmc_host_is_spi(host
)) {
655 err
= mmc_spi_read_ocr(host
, 0, &ocr
);
661 * Sanity check the voltages that the card claims to
665 printk(KERN_WARNING
"%s: card claims to support voltages "
666 "below the defined range. These will be ignored.\n",
671 if (ocr
& MMC_VDD_165_195
) {
672 printk(KERN_WARNING
"%s: SD card claims to support the "
673 "incompletely defined 'low voltage range'. This "
674 "will be ignored.\n", mmc_hostname(host
));
675 ocr
&= ~MMC_VDD_165_195
;
678 host
->ocr
= mmc_select_voltage(host
, ocr
);
681 * Can we support the voltage(s) of the card(s)?
689 * Detect and init the card.
691 err
= mmc_sd_init_card(host
, host
->ocr
, NULL
);
695 mmc_release_host(host
);
697 err
= mmc_add_card(host
->card
);
704 mmc_remove_card(host
->card
);
706 mmc_claim_host(host
);
708 mmc_detach_bus(host
);
709 mmc_release_host(host
);
711 printk(KERN_ERR
"%s: error %d whilst initialising SD card\n",
712 mmc_hostname(host
), err
);