GNU Linux-libre 4.14.266-gnu1
[releases.git] / drivers / mmc / core / sd.c
1 /*
2  *  linux/drivers/mmc/core/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 #include <linux/sizes.h>
15 #include <linux/slab.h>
16 #include <linux/stat.h>
17 #include <linux/pm_runtime.h>
18
19 #include <linux/mmc/host.h>
20 #include <linux/mmc/card.h>
21 #include <linux/mmc/mmc.h>
22 #include <linux/mmc/sd.h>
23
24 #include "core.h"
25 #include "card.h"
26 #include "host.h"
27 #include "bus.h"
28 #include "mmc_ops.h"
29 #include "sd.h"
30 #include "sd_ops.h"
31
32 static const unsigned int tran_exp[] = {
33         10000,          100000,         1000000,        10000000,
34         0,              0,              0,              0
35 };
36
37 static const unsigned char tran_mant[] = {
38         0,      10,     12,     13,     15,     20,     25,     30,
39         35,     40,     45,     50,     55,     60,     70,     80,
40 };
41
42 static const unsigned int taac_exp[] = {
43         1,      10,     100,    1000,   10000,  100000, 1000000, 10000000,
44 };
45
46 static const unsigned int taac_mant[] = {
47         0,      10,     12,     13,     15,     20,     25,     30,
48         35,     40,     45,     50,     55,     60,     70,     80,
49 };
50
51 static const unsigned int sd_au_size[] = {
52         0,              SZ_16K / 512,           SZ_32K / 512,   SZ_64K / 512,
53         SZ_128K / 512,  SZ_256K / 512,          SZ_512K / 512,  SZ_1M / 512,
54         SZ_2M / 512,    SZ_4M / 512,            SZ_8M / 512,    (SZ_8M + SZ_4M) / 512,
55         SZ_16M / 512,   (SZ_16M + SZ_8M) / 512, SZ_32M / 512,   SZ_64M / 512,
56 };
57
58 #define UNSTUFF_BITS(resp,start,size)                                   \
59         ({                                                              \
60                 const int __size = size;                                \
61                 const u32 __mask = (__size < 32 ? 1 << __size : 0) - 1; \
62                 const int __off = 3 - ((start) / 32);                   \
63                 const int __shft = (start) & 31;                        \
64                 u32 __res;                                              \
65                                                                         \
66                 __res = resp[__off] >> __shft;                          \
67                 if (__size + __shft > 32)                               \
68                         __res |= resp[__off-1] << ((32 - __shft) % 32); \
69                 __res & __mask;                                         \
70         })
71
72 /*
73  * Given the decoded CSD structure, decode the raw CID to our CID structure.
74  */
75 void mmc_decode_cid(struct mmc_card *card)
76 {
77         u32 *resp = card->raw_cid;
78
79         /*
80          * SD doesn't currently have a version field so we will
81          * have to assume we can parse this.
82          */
83         card->cid.manfid                = UNSTUFF_BITS(resp, 120, 8);
84         card->cid.oemid                 = UNSTUFF_BITS(resp, 104, 16);
85         card->cid.prod_name[0]          = UNSTUFF_BITS(resp, 96, 8);
86         card->cid.prod_name[1]          = UNSTUFF_BITS(resp, 88, 8);
87         card->cid.prod_name[2]          = UNSTUFF_BITS(resp, 80, 8);
88         card->cid.prod_name[3]          = UNSTUFF_BITS(resp, 72, 8);
89         card->cid.prod_name[4]          = UNSTUFF_BITS(resp, 64, 8);
90         card->cid.hwrev                 = UNSTUFF_BITS(resp, 60, 4);
91         card->cid.fwrev                 = UNSTUFF_BITS(resp, 56, 4);
92         card->cid.serial                = UNSTUFF_BITS(resp, 24, 32);
93         card->cid.year                  = UNSTUFF_BITS(resp, 12, 8);
94         card->cid.month                 = UNSTUFF_BITS(resp, 8, 4);
95
96         card->cid.year += 2000; /* SD cards year offset */
97 }
98
99 /*
100  * Given a 128-bit response, decode to our card CSD structure.
101  */
102 static int mmc_decode_csd(struct mmc_card *card)
103 {
104         struct mmc_csd *csd = &card->csd;
105         unsigned int e, m, csd_struct;
106         u32 *resp = card->raw_csd;
107
108         csd_struct = UNSTUFF_BITS(resp, 126, 2);
109
110         switch (csd_struct) {
111         case 0:
112                 m = UNSTUFF_BITS(resp, 115, 4);
113                 e = UNSTUFF_BITS(resp, 112, 3);
114                 csd->taac_ns     = (taac_exp[e] * taac_mant[m] + 9) / 10;
115                 csd->taac_clks   = UNSTUFF_BITS(resp, 104, 8) * 100;
116
117                 m = UNSTUFF_BITS(resp, 99, 4);
118                 e = UNSTUFF_BITS(resp, 96, 3);
119                 csd->max_dtr      = tran_exp[e] * tran_mant[m];
120                 csd->cmdclass     = UNSTUFF_BITS(resp, 84, 12);
121
122                 e = UNSTUFF_BITS(resp, 47, 3);
123                 m = UNSTUFF_BITS(resp, 62, 12);
124                 csd->capacity     = (1 + m) << (e + 2);
125
126                 csd->read_blkbits = UNSTUFF_BITS(resp, 80, 4);
127                 csd->read_partial = UNSTUFF_BITS(resp, 79, 1);
128                 csd->write_misalign = UNSTUFF_BITS(resp, 78, 1);
129                 csd->read_misalign = UNSTUFF_BITS(resp, 77, 1);
130                 csd->dsr_imp = UNSTUFF_BITS(resp, 76, 1);
131                 csd->r2w_factor = UNSTUFF_BITS(resp, 26, 3);
132                 csd->write_blkbits = UNSTUFF_BITS(resp, 22, 4);
133                 csd->write_partial = UNSTUFF_BITS(resp, 21, 1);
134
135                 if (UNSTUFF_BITS(resp, 46, 1)) {
136                         csd->erase_size = 1;
137                 } else if (csd->write_blkbits >= 9) {
138                         csd->erase_size = UNSTUFF_BITS(resp, 39, 7) + 1;
139                         csd->erase_size <<= csd->write_blkbits - 9;
140                 }
141
142                 if (UNSTUFF_BITS(resp, 13, 1))
143                         mmc_card_set_readonly(card);
144                 break;
145         case 1:
146                 /*
147                  * This is a block-addressed SDHC or SDXC card. Most
148                  * interesting fields are unused and have fixed
149                  * values. To avoid getting tripped by buggy cards,
150                  * we assume those fixed values ourselves.
151                  */
152                 mmc_card_set_blockaddr(card);
153
154                 csd->taac_ns     = 0; /* Unused */
155                 csd->taac_clks   = 0; /* Unused */
156
157                 m = UNSTUFF_BITS(resp, 99, 4);
158                 e = UNSTUFF_BITS(resp, 96, 3);
159                 csd->max_dtr      = tran_exp[e] * tran_mant[m];
160                 csd->cmdclass     = UNSTUFF_BITS(resp, 84, 12);
161                 csd->c_size       = UNSTUFF_BITS(resp, 48, 22);
162
163                 /* SDXC cards have a minimum C_SIZE of 0x00FFFF */
164                 if (csd->c_size >= 0xFFFF)
165                         mmc_card_set_ext_capacity(card);
166
167                 m = UNSTUFF_BITS(resp, 48, 22);
168                 csd->capacity     = (1 + m) << 10;
169
170                 csd->read_blkbits = 9;
171                 csd->read_partial = 0;
172                 csd->write_misalign = 0;
173                 csd->read_misalign = 0;
174                 csd->r2w_factor = 4; /* Unused */
175                 csd->write_blkbits = 9;
176                 csd->write_partial = 0;
177                 csd->erase_size = 1;
178
179                 if (UNSTUFF_BITS(resp, 13, 1))
180                         mmc_card_set_readonly(card);
181                 break;
182         default:
183                 pr_err("%s: unrecognised CSD structure version %d\n",
184                         mmc_hostname(card->host), csd_struct);
185                 return -EINVAL;
186         }
187
188         card->erase_size = csd->erase_size;
189
190         return 0;
191 }
192
193 /*
194  * Given a 64-bit response, decode to our card SCR structure.
195  */
196 static int mmc_decode_scr(struct mmc_card *card)
197 {
198         struct sd_scr *scr = &card->scr;
199         unsigned int scr_struct;
200         u32 resp[4];
201
202         resp[3] = card->raw_scr[1];
203         resp[2] = card->raw_scr[0];
204
205         scr_struct = UNSTUFF_BITS(resp, 60, 4);
206         if (scr_struct != 0) {
207                 pr_err("%s: unrecognised SCR structure version %d\n",
208                         mmc_hostname(card->host), scr_struct);
209                 return -EINVAL;
210         }
211
212         scr->sda_vsn = UNSTUFF_BITS(resp, 56, 4);
213         scr->bus_widths = UNSTUFF_BITS(resp, 48, 4);
214         if (scr->sda_vsn == SCR_SPEC_VER_2)
215                 /* Check if Physical Layer Spec v3.0 is supported */
216                 scr->sda_spec3 = UNSTUFF_BITS(resp, 47, 1);
217
218         if (UNSTUFF_BITS(resp, 55, 1))
219                 card->erased_byte = 0xFF;
220         else
221                 card->erased_byte = 0x0;
222
223         if (scr->sda_spec3)
224                 scr->cmds = UNSTUFF_BITS(resp, 32, 2);
225
226         /* SD Spec says: any SD Card shall set at least bits 0 and 2 */
227         if (!(scr->bus_widths & SD_SCR_BUS_WIDTH_1) ||
228             !(scr->bus_widths & SD_SCR_BUS_WIDTH_4)) {
229                 pr_err("%s: invalid bus width\n", mmc_hostname(card->host));
230                 return -EINVAL;
231         }
232
233         return 0;
234 }
235
236 /*
237  * Fetch and process SD Status register.
238  */
239 static int mmc_read_ssr(struct mmc_card *card)
240 {
241         unsigned int au, es, et, eo;
242         __be32 *raw_ssr;
243         int i;
244
245         if (!(card->csd.cmdclass & CCC_APP_SPEC)) {
246                 pr_warn("%s: card lacks mandatory SD Status function\n",
247                         mmc_hostname(card->host));
248                 return 0;
249         }
250
251         raw_ssr = kmalloc(sizeof(card->raw_ssr), GFP_KERNEL);
252         if (!raw_ssr)
253                 return -ENOMEM;
254
255         if (mmc_app_sd_status(card, raw_ssr)) {
256                 pr_warn("%s: problem reading SD Status register\n",
257                         mmc_hostname(card->host));
258                 kfree(raw_ssr);
259                 return 0;
260         }
261
262         for (i = 0; i < 16; i++)
263                 card->raw_ssr[i] = be32_to_cpu(raw_ssr[i]);
264
265         kfree(raw_ssr);
266
267         /*
268          * UNSTUFF_BITS only works with four u32s so we have to offset the
269          * bitfield positions accordingly.
270          */
271         au = UNSTUFF_BITS(card->raw_ssr, 428 - 384, 4);
272         if (au) {
273                 if (au <= 9 || card->scr.sda_spec3) {
274                         card->ssr.au = sd_au_size[au];
275                         es = UNSTUFF_BITS(card->raw_ssr, 408 - 384, 16);
276                         et = UNSTUFF_BITS(card->raw_ssr, 402 - 384, 6);
277                         if (es && et) {
278                                 eo = UNSTUFF_BITS(card->raw_ssr, 400 - 384, 2);
279                                 card->ssr.erase_timeout = (et * 1000) / es;
280                                 card->ssr.erase_offset = eo * 1000;
281                         }
282                 } else {
283                         pr_warn("%s: SD Status: Invalid Allocation Unit size\n",
284                                 mmc_hostname(card->host));
285                 }
286         }
287
288         return 0;
289 }
290
291 /*
292  * Fetches and decodes switch information
293  */
294 static int mmc_read_switch(struct mmc_card *card)
295 {
296         int err;
297         u8 *status;
298
299         if (card->scr.sda_vsn < SCR_SPEC_VER_1)
300                 return 0;
301
302         if (!(card->csd.cmdclass & CCC_SWITCH)) {
303                 pr_warn("%s: card lacks mandatory switch function, performance might suffer\n",
304                         mmc_hostname(card->host));
305                 return 0;
306         }
307
308         err = -EIO;
309
310         status = kmalloc(64, GFP_KERNEL);
311         if (!status)
312                 return -ENOMEM;
313
314         /*
315          * Find out the card's support bits with a mode 0 operation.
316          * The argument does not matter, as the support bits do not
317          * change with the arguments.
318          */
319         err = mmc_sd_switch(card, 0, 0, 0, status);
320         if (err) {
321                 /*
322                  * If the host or the card can't do the switch,
323                  * fail more gracefully.
324                  */
325                 if (err != -EINVAL && err != -ENOSYS && err != -EFAULT)
326                         goto out;
327
328                 pr_warn("%s: problem reading Bus Speed modes\n",
329                         mmc_hostname(card->host));
330                 err = 0;
331
332                 goto out;
333         }
334
335         if (status[13] & SD_MODE_HIGH_SPEED)
336                 card->sw_caps.hs_max_dtr = HIGH_SPEED_MAX_DTR;
337
338         if (card->scr.sda_spec3) {
339                 card->sw_caps.sd3_bus_mode = status[13];
340                 /* Driver Strengths supported by the card */
341                 card->sw_caps.sd3_drv_type = status[9];
342                 card->sw_caps.sd3_curr_limit = status[7] | status[6] << 8;
343         }
344
345 out:
346         kfree(status);
347
348         return err;
349 }
350
351 /*
352  * Test if the card supports high-speed mode and, if so, switch to it.
353  */
354 int mmc_sd_switch_hs(struct mmc_card *card)
355 {
356         int err;
357         u8 *status;
358
359         if (card->scr.sda_vsn < SCR_SPEC_VER_1)
360                 return 0;
361
362         if (!(card->csd.cmdclass & CCC_SWITCH))
363                 return 0;
364
365         if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
366                 return 0;
367
368         if (card->sw_caps.hs_max_dtr == 0)
369                 return 0;
370
371         status = kmalloc(64, GFP_KERNEL);
372         if (!status)
373                 return -ENOMEM;
374
375         err = mmc_sd_switch(card, 1, 0, 1, status);
376         if (err)
377                 goto out;
378
379         if ((status[16] & 0xF) != 1) {
380                 pr_warn("%s: Problem switching card into high-speed mode!\n",
381                         mmc_hostname(card->host));
382                 err = 0;
383         } else {
384                 err = 1;
385         }
386
387 out:
388         kfree(status);
389
390         return err;
391 }
392
393 static int sd_select_driver_type(struct mmc_card *card, u8 *status)
394 {
395         int card_drv_type, drive_strength, drv_type;
396         int err;
397
398         card->drive_strength = 0;
399
400         card_drv_type = card->sw_caps.sd3_drv_type | SD_DRIVER_TYPE_B;
401
402         drive_strength = mmc_select_drive_strength(card,
403                                                    card->sw_caps.uhs_max_dtr,
404                                                    card_drv_type, &drv_type);
405
406         if (drive_strength) {
407                 err = mmc_sd_switch(card, 1, 2, drive_strength, status);
408                 if (err)
409                         return err;
410                 if ((status[15] & 0xF) != drive_strength) {
411                         pr_warn("%s: Problem setting drive strength!\n",
412                                 mmc_hostname(card->host));
413                         return 0;
414                 }
415                 card->drive_strength = drive_strength;
416         }
417
418         if (drv_type)
419                 mmc_set_driver_type(card->host, drv_type);
420
421         return 0;
422 }
423
424 static void sd_update_bus_speed_mode(struct mmc_card *card)
425 {
426         /*
427          * If the host doesn't support any of the UHS-I modes, fallback on
428          * default speed.
429          */
430         if (!mmc_host_uhs(card->host)) {
431                 card->sd_bus_speed = 0;
432                 return;
433         }
434
435         if ((card->host->caps & MMC_CAP_UHS_SDR104) &&
436             (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR104)) {
437                         card->sd_bus_speed = UHS_SDR104_BUS_SPEED;
438         } else if ((card->host->caps & MMC_CAP_UHS_DDR50) &&
439                    (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_DDR50)) {
440                         card->sd_bus_speed = UHS_DDR50_BUS_SPEED;
441         } else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
442                     MMC_CAP_UHS_SDR50)) && (card->sw_caps.sd3_bus_mode &
443                     SD_MODE_UHS_SDR50)) {
444                         card->sd_bus_speed = UHS_SDR50_BUS_SPEED;
445         } else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
446                     MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25)) &&
447                    (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR25)) {
448                         card->sd_bus_speed = UHS_SDR25_BUS_SPEED;
449         } else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
450                     MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25 |
451                     MMC_CAP_UHS_SDR12)) && (card->sw_caps.sd3_bus_mode &
452                     SD_MODE_UHS_SDR12)) {
453                         card->sd_bus_speed = UHS_SDR12_BUS_SPEED;
454         }
455 }
456
457 static int sd_set_bus_speed_mode(struct mmc_card *card, u8 *status)
458 {
459         int err;
460         unsigned int timing = 0;
461
462         switch (card->sd_bus_speed) {
463         case UHS_SDR104_BUS_SPEED:
464                 timing = MMC_TIMING_UHS_SDR104;
465                 card->sw_caps.uhs_max_dtr = UHS_SDR104_MAX_DTR;
466                 break;
467         case UHS_DDR50_BUS_SPEED:
468                 timing = MMC_TIMING_UHS_DDR50;
469                 card->sw_caps.uhs_max_dtr = UHS_DDR50_MAX_DTR;
470                 break;
471         case UHS_SDR50_BUS_SPEED:
472                 timing = MMC_TIMING_UHS_SDR50;
473                 card->sw_caps.uhs_max_dtr = UHS_SDR50_MAX_DTR;
474                 break;
475         case UHS_SDR25_BUS_SPEED:
476                 timing = MMC_TIMING_UHS_SDR25;
477                 card->sw_caps.uhs_max_dtr = UHS_SDR25_MAX_DTR;
478                 break;
479         case UHS_SDR12_BUS_SPEED:
480                 timing = MMC_TIMING_UHS_SDR12;
481                 card->sw_caps.uhs_max_dtr = UHS_SDR12_MAX_DTR;
482                 break;
483         default:
484                 return 0;
485         }
486
487         err = mmc_sd_switch(card, 1, 0, card->sd_bus_speed, status);
488         if (err)
489                 return err;
490
491         if ((status[16] & 0xF) != card->sd_bus_speed)
492                 pr_warn("%s: Problem setting bus speed mode!\n",
493                         mmc_hostname(card->host));
494         else {
495                 mmc_set_timing(card->host, timing);
496                 mmc_set_clock(card->host, card->sw_caps.uhs_max_dtr);
497         }
498
499         return 0;
500 }
501
502 /* Get host's max current setting at its current voltage */
503 static u32 sd_get_host_max_current(struct mmc_host *host)
504 {
505         u32 voltage, max_current;
506
507         voltage = 1 << host->ios.vdd;
508         switch (voltage) {
509         case MMC_VDD_165_195:
510                 max_current = host->max_current_180;
511                 break;
512         case MMC_VDD_29_30:
513         case MMC_VDD_30_31:
514                 max_current = host->max_current_300;
515                 break;
516         case MMC_VDD_32_33:
517         case MMC_VDD_33_34:
518                 max_current = host->max_current_330;
519                 break;
520         default:
521                 max_current = 0;
522         }
523
524         return max_current;
525 }
526
527 static int sd_set_current_limit(struct mmc_card *card, u8 *status)
528 {
529         int current_limit = SD_SET_CURRENT_NO_CHANGE;
530         int err;
531         u32 max_current;
532
533         /*
534          * Current limit switch is only defined for SDR50, SDR104, and DDR50
535          * bus speed modes. For other bus speed modes, we do not change the
536          * current limit.
537          */
538         if ((card->sd_bus_speed != UHS_SDR50_BUS_SPEED) &&
539             (card->sd_bus_speed != UHS_SDR104_BUS_SPEED) &&
540             (card->sd_bus_speed != UHS_DDR50_BUS_SPEED))
541                 return 0;
542
543         /*
544          * Host has different current capabilities when operating at
545          * different voltages, so find out its max current first.
546          */
547         max_current = sd_get_host_max_current(card->host);
548
549         /*
550          * We only check host's capability here, if we set a limit that is
551          * higher than the card's maximum current, the card will be using its
552          * maximum current, e.g. if the card's maximum current is 300ma, and
553          * when we set current limit to 200ma, the card will draw 200ma, and
554          * when we set current limit to 400/600/800ma, the card will draw its
555          * maximum 300ma from the host.
556          *
557          * The above is incorrect: if we try to set a current limit that is
558          * not supported by the card, the card can rightfully error out the
559          * attempt, and remain at the default current limit.  This results
560          * in a 300mA card being limited to 200mA even though the host
561          * supports 800mA. Failures seen with SanDisk 8GB UHS cards with
562          * an iMX6 host. --rmk
563          */
564         if (max_current >= 800 &&
565             card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_800)
566                 current_limit = SD_SET_CURRENT_LIMIT_800;
567         else if (max_current >= 600 &&
568                  card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_600)
569                 current_limit = SD_SET_CURRENT_LIMIT_600;
570         else if (max_current >= 400 &&
571                  card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_400)
572                 current_limit = SD_SET_CURRENT_LIMIT_400;
573         else if (max_current >= 200 &&
574                  card->sw_caps.sd3_curr_limit & SD_MAX_CURRENT_200)
575                 current_limit = SD_SET_CURRENT_LIMIT_200;
576
577         if (current_limit != SD_SET_CURRENT_NO_CHANGE) {
578                 err = mmc_sd_switch(card, 1, 3, current_limit, status);
579                 if (err)
580                         return err;
581
582                 if (((status[15] >> 4) & 0x0F) != current_limit)
583                         pr_warn("%s: Problem setting current limit!\n",
584                                 mmc_hostname(card->host));
585
586         }
587
588         return 0;
589 }
590
591 /*
592  * UHS-I specific initialization procedure
593  */
594 static int mmc_sd_init_uhs_card(struct mmc_card *card)
595 {
596         int err;
597         u8 *status;
598
599         if (!card->scr.sda_spec3)
600                 return 0;
601
602         if (!(card->csd.cmdclass & CCC_SWITCH))
603                 return 0;
604
605         status = kmalloc(64, GFP_KERNEL);
606         if (!status)
607                 return -ENOMEM;
608
609         /* Set 4-bit bus width */
610         if ((card->host->caps & MMC_CAP_4_BIT_DATA) &&
611             (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
612                 err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
613                 if (err)
614                         goto out;
615
616                 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
617         }
618
619         /*
620          * Select the bus speed mode depending on host
621          * and card capability.
622          */
623         sd_update_bus_speed_mode(card);
624
625         /* Set the driver strength for the card */
626         err = sd_select_driver_type(card, status);
627         if (err)
628                 goto out;
629
630         /* Set current limit for the card */
631         err = sd_set_current_limit(card, status);
632         if (err)
633                 goto out;
634
635         /* Set bus speed mode of the card */
636         err = sd_set_bus_speed_mode(card, status);
637         if (err)
638                 goto out;
639
640         /*
641          * SPI mode doesn't define CMD19 and tuning is only valid for SDR50 and
642          * SDR104 mode SD-cards. Note that tuning is mandatory for SDR104.
643          */
644         if (!mmc_host_is_spi(card->host) &&
645                 (card->host->ios.timing == MMC_TIMING_UHS_SDR50 ||
646                  card->host->ios.timing == MMC_TIMING_UHS_DDR50 ||
647                  card->host->ios.timing == MMC_TIMING_UHS_SDR104)) {
648                 err = mmc_execute_tuning(card);
649
650                 /*
651                  * As SD Specifications Part1 Physical Layer Specification
652                  * Version 3.01 says, CMD19 tuning is available for unlocked
653                  * cards in transfer state of 1.8V signaling mode. The small
654                  * difference between v3.00 and 3.01 spec means that CMD19
655                  * tuning is also available for DDR50 mode.
656                  */
657                 if (err && card->host->ios.timing == MMC_TIMING_UHS_DDR50) {
658                         pr_warn("%s: ddr50 tuning failed\n",
659                                 mmc_hostname(card->host));
660                         err = 0;
661                 }
662         }
663
664 out:
665         kfree(status);
666
667         return err;
668 }
669
670 MMC_DEV_ATTR(cid, "%08x%08x%08x%08x\n", card->raw_cid[0], card->raw_cid[1],
671         card->raw_cid[2], card->raw_cid[3]);
672 MMC_DEV_ATTR(csd, "%08x%08x%08x%08x\n", card->raw_csd[0], card->raw_csd[1],
673         card->raw_csd[2], card->raw_csd[3]);
674 MMC_DEV_ATTR(scr, "%08x%08x\n", card->raw_scr[0], card->raw_scr[1]);
675 MMC_DEV_ATTR(ssr,
676         "%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x%08x\n",
677                 card->raw_ssr[0], card->raw_ssr[1], card->raw_ssr[2],
678                 card->raw_ssr[3], card->raw_ssr[4], card->raw_ssr[5],
679                 card->raw_ssr[6], card->raw_ssr[7], card->raw_ssr[8],
680                 card->raw_ssr[9], card->raw_ssr[10], card->raw_ssr[11],
681                 card->raw_ssr[12], card->raw_ssr[13], card->raw_ssr[14],
682                 card->raw_ssr[15]);
683 MMC_DEV_ATTR(date, "%02d/%04d\n", card->cid.month, card->cid.year);
684 MMC_DEV_ATTR(erase_size, "%u\n", card->erase_size << 9);
685 MMC_DEV_ATTR(preferred_erase_size, "%u\n", card->pref_erase << 9);
686 MMC_DEV_ATTR(fwrev, "0x%x\n", card->cid.fwrev);
687 MMC_DEV_ATTR(hwrev, "0x%x\n", card->cid.hwrev);
688 MMC_DEV_ATTR(manfid, "0x%06x\n", card->cid.manfid);
689 MMC_DEV_ATTR(name, "%s\n", card->cid.prod_name);
690 MMC_DEV_ATTR(oemid, "0x%04x\n", card->cid.oemid);
691 MMC_DEV_ATTR(serial, "0x%08x\n", card->cid.serial);
692 MMC_DEV_ATTR(ocr, "0x%08x\n", card->ocr);
693
694
695 static ssize_t mmc_dsr_show(struct device *dev,
696                            struct device_attribute *attr,
697                            char *buf)
698 {
699        struct mmc_card *card = mmc_dev_to_card(dev);
700        struct mmc_host *host = card->host;
701
702        if (card->csd.dsr_imp && host->dsr_req)
703                return sprintf(buf, "0x%x\n", host->dsr);
704        else
705                /* return default DSR value */
706                return sprintf(buf, "0x%x\n", 0x404);
707 }
708
709 static DEVICE_ATTR(dsr, S_IRUGO, mmc_dsr_show, NULL);
710
711 static struct attribute *sd_std_attrs[] = {
712         &dev_attr_cid.attr,
713         &dev_attr_csd.attr,
714         &dev_attr_scr.attr,
715         &dev_attr_ssr.attr,
716         &dev_attr_date.attr,
717         &dev_attr_erase_size.attr,
718         &dev_attr_preferred_erase_size.attr,
719         &dev_attr_fwrev.attr,
720         &dev_attr_hwrev.attr,
721         &dev_attr_manfid.attr,
722         &dev_attr_name.attr,
723         &dev_attr_oemid.attr,
724         &dev_attr_serial.attr,
725         &dev_attr_ocr.attr,
726         &dev_attr_dsr.attr,
727         NULL,
728 };
729 ATTRIBUTE_GROUPS(sd_std);
730
731 struct device_type sd_type = {
732         .groups = sd_std_groups,
733 };
734
735 /*
736  * Fetch CID from card.
737  */
738 int mmc_sd_get_cid(struct mmc_host *host, u32 ocr, u32 *cid, u32 *rocr)
739 {
740         int err;
741         u32 max_current;
742         int retries = 10;
743         u32 pocr = ocr;
744
745 try_again:
746         if (!retries) {
747                 ocr &= ~SD_OCR_S18R;
748                 pr_warn("%s: Skipping voltage switch\n", mmc_hostname(host));
749         }
750
751         /*
752          * Since we're changing the OCR value, we seem to
753          * need to tell some cards to go back to the idle
754          * state.  We wait 1ms to give cards time to
755          * respond.
756          */
757         mmc_go_idle(host);
758
759         /*
760          * If SD_SEND_IF_COND indicates an SD 2.0
761          * compliant card and we should set bit 30
762          * of the ocr to indicate that we can handle
763          * block-addressed SDHC cards.
764          */
765         err = mmc_send_if_cond(host, ocr);
766         if (!err)
767                 ocr |= SD_OCR_CCS;
768
769         /*
770          * If the host supports one of UHS-I modes, request the card
771          * to switch to 1.8V signaling level. If the card has failed
772          * repeatedly to switch however, skip this.
773          */
774         if (retries && mmc_host_uhs(host))
775                 ocr |= SD_OCR_S18R;
776
777         /*
778          * If the host can supply more than 150mA at current voltage,
779          * XPC should be set to 1.
780          */
781         max_current = sd_get_host_max_current(host);
782         if (max_current > 150)
783                 ocr |= SD_OCR_XPC;
784
785         err = mmc_send_app_op_cond(host, ocr, rocr);
786         if (err)
787                 return err;
788
789         /*
790          * In case the S18A bit is set in the response, let's start the signal
791          * voltage switch procedure. SPI mode doesn't support CMD11.
792          * Note that, according to the spec, the S18A bit is not valid unless
793          * the CCS bit is set as well. We deliberately deviate from the spec in
794          * regards to this, which allows UHS-I to be supported for SDSC cards.
795          */
796         if (!mmc_host_is_spi(host) && rocr && (*rocr & 0x01000000)) {
797                 err = mmc_set_uhs_voltage(host, pocr);
798                 if (err == -EAGAIN) {
799                         retries--;
800                         goto try_again;
801                 } else if (err) {
802                         retries = 0;
803                         goto try_again;
804                 }
805         }
806
807         err = mmc_send_cid(host, cid);
808         return err;
809 }
810
811 int mmc_sd_get_csd(struct mmc_host *host, struct mmc_card *card)
812 {
813         int err;
814
815         /*
816          * Fetch CSD from card.
817          */
818         err = mmc_send_csd(card, card->raw_csd);
819         if (err)
820                 return err;
821
822         err = mmc_decode_csd(card);
823         if (err)
824                 return err;
825
826         return 0;
827 }
828
829 static int mmc_sd_get_ro(struct mmc_host *host)
830 {
831         int ro;
832
833         /*
834          * Some systems don't feature a write-protect pin and don't need one.
835          * E.g. because they only have micro-SD card slot. For those systems
836          * assume that the SD card is always read-write.
837          */
838         if (host->caps2 & MMC_CAP2_NO_WRITE_PROTECT)
839                 return 0;
840
841         if (!host->ops->get_ro)
842                 return -1;
843
844         ro = host->ops->get_ro(host);
845
846         return ro;
847 }
848
849 int mmc_sd_setup_card(struct mmc_host *host, struct mmc_card *card,
850         bool reinit)
851 {
852         int err;
853
854         if (!reinit) {
855                 /*
856                  * Fetch SCR from card.
857                  */
858                 err = mmc_app_send_scr(card);
859                 if (err)
860                         return err;
861
862                 err = mmc_decode_scr(card);
863                 if (err)
864                         return err;
865
866                 /*
867                  * Fetch and process SD Status register.
868                  */
869                 err = mmc_read_ssr(card);
870                 if (err)
871                         return err;
872
873                 /* Erase init depends on CSD and SSR */
874                 mmc_init_erase(card);
875
876                 /*
877                  * Fetch switch information from card.
878                  */
879                 err = mmc_read_switch(card);
880                 if (err)
881                         return err;
882         }
883
884         /*
885          * For SPI, enable CRC as appropriate.
886          * This CRC enable is located AFTER the reading of the
887          * card registers because some SDHC cards are not able
888          * to provide valid CRCs for non-512-byte blocks.
889          */
890         if (mmc_host_is_spi(host)) {
891                 err = mmc_spi_set_crc(host, use_spi_crc);
892                 if (err)
893                         return err;
894         }
895
896         /*
897          * Check if read-only switch is active.
898          */
899         if (!reinit) {
900                 int ro = mmc_sd_get_ro(host);
901
902                 if (ro < 0) {
903                         pr_warn("%s: host does not support reading read-only switch, assuming write-enable\n",
904                                 mmc_hostname(host));
905                 } else if (ro > 0) {
906                         mmc_card_set_readonly(card);
907                 }
908         }
909
910         return 0;
911 }
912
913 unsigned mmc_sd_get_max_clock(struct mmc_card *card)
914 {
915         unsigned max_dtr = (unsigned int)-1;
916
917         if (mmc_card_hs(card)) {
918                 if (max_dtr > card->sw_caps.hs_max_dtr)
919                         max_dtr = card->sw_caps.hs_max_dtr;
920         } else if (max_dtr > card->csd.max_dtr) {
921                 max_dtr = card->csd.max_dtr;
922         }
923
924         return max_dtr;
925 }
926
927 /*
928  * Handle the detection and initialisation of a card.
929  *
930  * In the case of a resume, "oldcard" will contain the card
931  * we're trying to reinitialise.
932  */
933 static int mmc_sd_init_card(struct mmc_host *host, u32 ocr,
934         struct mmc_card *oldcard)
935 {
936         struct mmc_card *card;
937         int err;
938         u32 cid[4];
939         u32 rocr = 0;
940
941         WARN_ON(!host->claimed);
942
943         err = mmc_sd_get_cid(host, ocr, cid, &rocr);
944         if (err)
945                 return err;
946
947         if (oldcard) {
948                 if (memcmp(cid, oldcard->raw_cid, sizeof(cid)) != 0)
949                         return -ENOENT;
950
951                 card = oldcard;
952         } else {
953                 /*
954                  * Allocate card structure.
955                  */
956                 card = mmc_alloc_card(host, &sd_type);
957                 if (IS_ERR(card))
958                         return PTR_ERR(card);
959
960                 card->ocr = ocr;
961                 card->type = MMC_TYPE_SD;
962                 memcpy(card->raw_cid, cid, sizeof(card->raw_cid));
963         }
964
965         /*
966          * Call the optional HC's init_card function to handle quirks.
967          */
968         if (host->ops->init_card)
969                 host->ops->init_card(host, card);
970
971         /*
972          * For native busses:  get card RCA and quit open drain mode.
973          */
974         if (!mmc_host_is_spi(host)) {
975                 err = mmc_send_relative_addr(host, &card->rca);
976                 if (err)
977                         goto free_card;
978         }
979
980         if (!oldcard) {
981                 err = mmc_sd_get_csd(host, card);
982                 if (err)
983                         goto free_card;
984
985                 mmc_decode_cid(card);
986         }
987
988         /*
989          * handling only for cards supporting DSR and hosts requesting
990          * DSR configuration
991          */
992         if (card->csd.dsr_imp && host->dsr_req)
993                 mmc_set_dsr(host);
994
995         /*
996          * Select card, as all following commands rely on that.
997          */
998         if (!mmc_host_is_spi(host)) {
999                 err = mmc_select_card(card);
1000                 if (err)
1001                         goto free_card;
1002         }
1003
1004         err = mmc_sd_setup_card(host, card, oldcard != NULL);
1005         if (err)
1006                 goto free_card;
1007
1008         /* Initialization sequence for UHS-I cards */
1009         if (rocr & SD_ROCR_S18A) {
1010                 err = mmc_sd_init_uhs_card(card);
1011                 if (err)
1012                         goto free_card;
1013         } else {
1014                 /*
1015                  * Attempt to change to high-speed (if supported)
1016                  */
1017                 err = mmc_sd_switch_hs(card);
1018                 if (err > 0)
1019                         mmc_set_timing(card->host, MMC_TIMING_SD_HS);
1020                 else if (err)
1021                         goto free_card;
1022
1023                 /*
1024                  * Set bus speed.
1025                  */
1026                 mmc_set_clock(host, mmc_sd_get_max_clock(card));
1027
1028                 /*
1029                  * Switch to wider bus (if supported).
1030                  */
1031                 if ((host->caps & MMC_CAP_4_BIT_DATA) &&
1032                         (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
1033                         err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
1034                         if (err)
1035                                 goto free_card;
1036
1037                         mmc_set_bus_width(host, MMC_BUS_WIDTH_4);
1038                 }
1039         }
1040
1041         host->card = card;
1042         return 0;
1043
1044 free_card:
1045         if (!oldcard)
1046                 mmc_remove_card(card);
1047
1048         return err;
1049 }
1050
1051 /*
1052  * Host is being removed. Free up the current card.
1053  */
1054 static void mmc_sd_remove(struct mmc_host *host)
1055 {
1056         mmc_remove_card(host->card);
1057         host->card = NULL;
1058 }
1059
1060 /*
1061  * Card detection - card is alive.
1062  */
1063 static int mmc_sd_alive(struct mmc_host *host)
1064 {
1065         return mmc_send_status(host->card, NULL);
1066 }
1067
1068 /*
1069  * Card detection callback from host.
1070  */
1071 static void mmc_sd_detect(struct mmc_host *host)
1072 {
1073         int err;
1074
1075         mmc_get_card(host->card);
1076
1077         /*
1078          * Just check if our card has been removed.
1079          */
1080         err = _mmc_detect_card_removed(host);
1081
1082         mmc_put_card(host->card);
1083
1084         if (err) {
1085                 mmc_sd_remove(host);
1086
1087                 mmc_claim_host(host);
1088                 mmc_detach_bus(host);
1089                 mmc_power_off(host);
1090                 mmc_release_host(host);
1091         }
1092 }
1093
1094 static int _mmc_sd_suspend(struct mmc_host *host)
1095 {
1096         int err = 0;
1097
1098         mmc_claim_host(host);
1099
1100         if (mmc_card_suspended(host->card))
1101                 goto out;
1102
1103         if (!mmc_host_is_spi(host))
1104                 err = mmc_deselect_cards(host);
1105
1106         if (!err) {
1107                 mmc_power_off(host);
1108                 mmc_card_set_suspended(host->card);
1109         }
1110
1111 out:
1112         mmc_release_host(host);
1113         return err;
1114 }
1115
1116 /*
1117  * Callback for suspend
1118  */
1119 static int mmc_sd_suspend(struct mmc_host *host)
1120 {
1121         int err;
1122
1123         err = _mmc_sd_suspend(host);
1124         if (!err) {
1125                 pm_runtime_disable(&host->card->dev);
1126                 pm_runtime_set_suspended(&host->card->dev);
1127         }
1128
1129         return err;
1130 }
1131
1132 /*
1133  * This function tries to determine if the same card is still present
1134  * and, if so, restore all state to it.
1135  */
1136 static int _mmc_sd_resume(struct mmc_host *host)
1137 {
1138         int err = 0;
1139
1140         mmc_claim_host(host);
1141
1142         if (!mmc_card_suspended(host->card))
1143                 goto out;
1144
1145         mmc_power_up(host, host->card->ocr);
1146         err = mmc_sd_init_card(host, host->card->ocr, host->card);
1147         mmc_card_clr_suspended(host->card);
1148
1149 out:
1150         mmc_release_host(host);
1151         return err;
1152 }
1153
1154 /*
1155  * Callback for resume
1156  */
1157 static int mmc_sd_resume(struct mmc_host *host)
1158 {
1159         pm_runtime_enable(&host->card->dev);
1160         return 0;
1161 }
1162
1163 /*
1164  * Callback for runtime_suspend.
1165  */
1166 static int mmc_sd_runtime_suspend(struct mmc_host *host)
1167 {
1168         int err;
1169
1170         if (!(host->caps & MMC_CAP_AGGRESSIVE_PM))
1171                 return 0;
1172
1173         err = _mmc_sd_suspend(host);
1174         if (err)
1175                 pr_err("%s: error %d doing aggressive suspend\n",
1176                         mmc_hostname(host), err);
1177
1178         return err;
1179 }
1180
1181 /*
1182  * Callback for runtime_resume.
1183  */
1184 static int mmc_sd_runtime_resume(struct mmc_host *host)
1185 {
1186         int err;
1187
1188         err = _mmc_sd_resume(host);
1189         if (err && err != -ENOMEDIUM)
1190                 pr_err("%s: error %d doing runtime resume\n",
1191                         mmc_hostname(host), err);
1192
1193         return 0;
1194 }
1195
1196 static int mmc_sd_reset(struct mmc_host *host)
1197 {
1198         mmc_power_cycle(host, host->card->ocr);
1199         return mmc_sd_init_card(host, host->card->ocr, host->card);
1200 }
1201
1202 static const struct mmc_bus_ops mmc_sd_ops = {
1203         .remove = mmc_sd_remove,
1204         .detect = mmc_sd_detect,
1205         .runtime_suspend = mmc_sd_runtime_suspend,
1206         .runtime_resume = mmc_sd_runtime_resume,
1207         .suspend = mmc_sd_suspend,
1208         .resume = mmc_sd_resume,
1209         .alive = mmc_sd_alive,
1210         .shutdown = mmc_sd_suspend,
1211         .reset = mmc_sd_reset,
1212 };
1213
1214 /*
1215  * Starting point for SD card init.
1216  */
1217 int mmc_attach_sd(struct mmc_host *host)
1218 {
1219         int err;
1220         u32 ocr, rocr;
1221
1222         WARN_ON(!host->claimed);
1223
1224         err = mmc_send_app_op_cond(host, 0, &ocr);
1225         if (err)
1226                 return err;
1227
1228         mmc_attach_bus(host, &mmc_sd_ops);
1229         if (host->ocr_avail_sd)
1230                 host->ocr_avail = host->ocr_avail_sd;
1231
1232         /*
1233          * We need to get OCR a different way for SPI.
1234          */
1235         if (mmc_host_is_spi(host)) {
1236                 mmc_go_idle(host);
1237
1238                 err = mmc_spi_read_ocr(host, 0, &ocr);
1239                 if (err)
1240                         goto err;
1241         }
1242
1243         /*
1244          * Some SD cards claims an out of spec VDD voltage range. Let's treat
1245          * these bits as being in-valid and especially also bit7.
1246          */
1247         ocr &= ~0x7FFF;
1248
1249         rocr = mmc_select_voltage(host, ocr);
1250
1251         /*
1252          * Can we support the voltage(s) of the card(s)?
1253          */
1254         if (!rocr) {
1255                 err = -EINVAL;
1256                 goto err;
1257         }
1258
1259         /*
1260          * Detect and init the card.
1261          */
1262         err = mmc_sd_init_card(host, rocr, NULL);
1263         if (err)
1264                 goto err;
1265
1266         mmc_release_host(host);
1267         err = mmc_add_card(host->card);
1268         if (err)
1269                 goto remove_card;
1270
1271         mmc_claim_host(host);
1272         return 0;
1273
1274 remove_card:
1275         mmc_remove_card(host->card);
1276         host->card = NULL;
1277         mmc_claim_host(host);
1278 err:
1279         mmc_detach_bus(host);
1280
1281         pr_err("%s: error %d whilst initialising SD card\n",
1282                 mmc_hostname(host), err);
1283
1284         return err;
1285 }