MMC: Consolidate voltage definitions
[linux-2.6] / drivers / mmc / core / sd.c
1 /*
2  *  linux/drivers/mmc/sd.c
3  *
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.
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"
20 #include "sysfs.h"
21 #include "mmc_ops.h"
22 #include "sd_ops.h"
23
24 #include "core.h"
25
26 static const unsigned int tran_exp[] = {
27         10000,          100000,         1000000,        10000000,
28         0,              0,              0,              0
29 };
30
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,
34 };
35
36 static const unsigned int tacc_exp[] = {
37         1,      10,     100,    1000,   10000,  100000, 1000000, 10000000,
38 };
39
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,
43 };
44
45 #define UNSTUFF_BITS(resp,start,size)                                   \
46         ({                                                              \
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;                        \
51                 u32 __res;                                              \
52                                                                         \
53                 __res = resp[__off] >> __shft;                          \
54                 if (__size + __shft > 32)                               \
55                         __res |= resp[__off-1] << ((32 - __shft) % 32); \
56                 __res & __mask;                                         \
57         })
58
59 /*
60  * Given the decoded CSD structure, decode the raw CID to our CID structure.
61  */
62 static void mmc_decode_cid(struct mmc_card *card)
63 {
64         u32 *resp = card->raw_cid;
65
66         memset(&card->cid, 0, sizeof(struct mmc_cid));
67
68         /*
69          * SD doesn't currently have a version field so we will
70          * have to assume we can parse this.
71          */
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);
84
85         card->cid.year += 2000; /* SD cards year offset */
86 }
87
88 /*
89  * Given a 128-bit response, decode to our card CSD structure.
90  */
91 static void mmc_decode_csd(struct mmc_card *card)
92 {
93         struct mmc_csd *csd = &card->csd;
94         unsigned int e, m, csd_struct;
95         u32 *resp = card->raw_csd;
96
97         csd_struct = UNSTUFF_BITS(resp, 126, 2);
98
99         switch (csd_struct) {
100         case 0:
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;
105
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);
110
111                 e = UNSTUFF_BITS(resp, 47, 3);
112                 m = UNSTUFF_BITS(resp, 62, 12);
113                 csd->capacity     = (1 + m) << (e + 2);
114
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);
122                 break;
123         case 1:
124                 /*
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.
129                  */
130                 mmc_card_set_blockaddr(card);
131
132                 csd->tacc_ns     = 0; /* Unused */
133                 csd->tacc_clks   = 0; /* Unused */
134
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);
139
140                 m = UNSTUFF_BITS(resp, 48, 22);
141                 csd->capacity     = (1 + m) << 10;
142
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;
150                 break;
151         default:
152                 printk("%s: unrecognised CSD structure version %d\n",
153                         mmc_hostname(card->host), csd_struct);
154                 mmc_card_set_bad(card);
155                 return;
156         }
157 }
158
159 /*
160  * Given a 64-bit response, decode to our card SCR structure.
161  */
162 static void mmc_decode_scr(struct mmc_card *card)
163 {
164         struct sd_scr *scr = &card->scr;
165         unsigned int scr_struct;
166         u32 resp[4];
167
168         BUG_ON(!mmc_card_sd(card));
169
170         resp[3] = card->raw_scr[1];
171         resp[2] = card->raw_scr[0];
172
173         scr_struct = UNSTUFF_BITS(resp, 60, 4);
174         if (scr_struct != 0) {
175                 printk("%s: unrecognised SCR structure version %d\n",
176                         mmc_hostname(card->host), scr_struct);
177                 mmc_card_set_bad(card);
178                 return;
179         }
180
181         scr->sda_vsn = UNSTUFF_BITS(resp, 56, 4);
182         scr->bus_widths = UNSTUFF_BITS(resp, 48, 4);
183 }
184
185 /*
186  * Test if the card supports high-speed mode and, if so, switch to it.
187  */
188 static int mmc_switch_hs(struct mmc_card *card)
189 {
190         int err;
191         u8 *status;
192
193         if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
194                 return MMC_ERR_NONE;
195
196         err = MMC_ERR_FAILED;
197
198         status = kmalloc(64, GFP_KERNEL);
199         if (!status) {
200                 printk("%s: could not allocate a buffer for switch "
201                        "capabilities.\n",
202                         mmc_hostname(card->host));
203                 return err;
204         }
205
206         err = mmc_sd_switch(card, 0, 0, 1, status);
207         if (err != MMC_ERR_NONE) {
208                 /*
209                  * Card not supporting high-speed will ignore the
210                  * command.
211                  */
212                 if (err == MMC_ERR_TIMEOUT)
213                         err = MMC_ERR_NONE;
214                 goto out;
215         }
216
217         if (status[13] & 0x02)
218                 card->sw_caps.hs_max_dtr = 50000000;
219
220         err = mmc_sd_switch(card, 1, 0, 1, status);
221         if (err != MMC_ERR_NONE)
222                 goto out;
223
224         if ((status[16] & 0xF) != 1) {
225                 printk(KERN_WARNING "%s: Problem switching card "
226                         "into high-speed mode!\n",
227                         mmc_hostname(card->host));
228         } else {
229                 mmc_card_set_highspeed(card);
230                 mmc_set_timing(card->host, MMC_TIMING_SD_HS);
231         }
232
233 out:
234         kfree(status);
235
236         return err;
237 }
238
239 /*
240  * Host is being removed. Free up the current card.
241  */
242 static void mmc_sd_remove(struct mmc_host *host)
243 {
244         BUG_ON(!host);
245         BUG_ON(!host->card);
246
247         mmc_remove_card(host->card);
248         host->card = NULL;
249 }
250
251 /*
252  * Card detection callback from host.
253  */
254 static void mmc_sd_detect(struct mmc_host *host)
255 {
256         int err;
257
258         BUG_ON(!host);
259         BUG_ON(!host->card);
260
261         mmc_claim_host(host);
262
263         /*
264          * Just check if our card has been removed.
265          */
266         err = mmc_send_status(host->card, NULL);
267
268         mmc_release_host(host);
269
270         if (err != MMC_ERR_NONE) {
271                 mmc_remove_card(host->card);
272                 host->card = NULL;
273
274                 mmc_claim_host(host);
275                 mmc_detach_bus(host);
276                 mmc_release_host(host);
277         }
278 }
279
280 static const struct mmc_bus_ops mmc_sd_ops = {
281         .remove = mmc_sd_remove,
282         .detect = mmc_sd_detect,
283 };
284
285 /*
286  * Starting point for SD card init.
287  */
288 int mmc_attach_sd(struct mmc_host *host, u32 ocr)
289 {
290         struct mmc_card *card;
291         int err;
292         u32 cid[4];
293         unsigned int max_dtr;
294
295         BUG_ON(!host);
296         BUG_ON(!host->claimed);
297
298         mmc_attach_bus(host, &mmc_sd_ops);
299
300         host->ocr = mmc_select_voltage(host, ocr);
301
302         /*
303          * Can we support the voltage(s) of the card(s)?
304          */
305         if (!host->ocr)
306                 goto err;
307
308         /*
309          * Since we're changing the OCR value, we seem to
310          * need to tell some cards to go back to the idle
311          * state.  We wait 1ms to give cards time to
312          * respond.
313          */
314         mmc_go_idle(host);
315
316         /*
317          * If SD_SEND_IF_COND indicates an SD 2.0
318          * compliant card and we should set bit 30
319          * of the ocr to indicate that we can handle
320          * block-addressed SDHC cards.
321          */
322         err = mmc_send_if_cond(host, host->ocr);
323         if (err == MMC_ERR_NONE)
324                 ocr = host->ocr | (1 << 30);
325
326         mmc_send_app_op_cond(host, ocr, NULL);
327
328         /*
329          * Fetch CID from card.
330          */
331         err = mmc_all_send_cid(host, cid);
332         if (err != MMC_ERR_NONE)
333                 goto err;
334
335         /*
336          * Allocate card structure.
337          */
338         card = mmc_alloc_card(host);
339         if (IS_ERR(card))
340                 goto err;
341
342         card->type = MMC_TYPE_SD;
343         memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
344
345         /*
346          * Set card RCA.
347          */
348         err = mmc_send_relative_addr(host, &card->rca);
349         if (err != MMC_ERR_NONE)
350                 goto free_card;
351
352         mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
353
354         /*
355          * Fetch CSD from card.
356          */
357         err = mmc_send_csd(card, card->raw_csd);
358         if (err != MMC_ERR_NONE)
359                 goto free_card;
360
361         mmc_decode_csd(card);
362         mmc_decode_cid(card);
363
364         /*
365          * Fetch SCR from card.
366          */
367         err = mmc_select_card(card);
368         if (err != MMC_ERR_NONE)
369                 goto free_card;
370
371         err = mmc_app_send_scr(card, card->raw_scr);
372         if (err != MMC_ERR_NONE)
373                 goto free_card;
374
375         mmc_decode_scr(card);
376
377         /*
378          * Check if card can be switched into high-speed mode.
379          */
380         err = mmc_switch_hs(card);
381         if (err != MMC_ERR_NONE)
382                 goto free_card;
383
384         /*
385          * Compute bus speed.
386          */
387         max_dtr = (unsigned int)-1;
388
389         if (mmc_card_highspeed(card)) {
390                 if (max_dtr > card->sw_caps.hs_max_dtr)
391                         max_dtr = card->sw_caps.hs_max_dtr;
392         } else if (max_dtr > card->csd.max_dtr) {
393                 max_dtr = card->csd.max_dtr;
394         }
395
396         mmc_set_clock(host, max_dtr);
397
398         /*
399          * Switch to wider bus (if supported).
400          */
401         if ((host->caps && MMC_CAP_4_BIT_DATA) &&
402                 (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
403                 err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
404                 if (err != MMC_ERR_NONE)
405                         goto free_card;
406
407                 mmc_set_bus_width(host, MMC_BUS_WIDTH_4);
408         }
409
410         host->card = card;
411
412         mmc_release_host(host);
413
414         err = mmc_register_card(card);
415         if (err)
416                 goto reclaim_host;
417
418         return 0;
419
420 reclaim_host:
421         mmc_claim_host(host);
422 free_card:
423         mmc_remove_card(card);
424         host->card = NULL;
425 err:
426         mmc_detach_bus(host);
427         mmc_release_host(host);
428
429         return 0;
430 }
431