mmc: sdio: remember new card RCA when redetecting card
[pandora-kernel.git] / drivers / mmc / core / sdio.c
1 /*
2  *  linux/drivers/mmc/sdio.c
3  *
4  *  Copyright 2006-2007 Pierre Ossman
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or (at
9  * your option) any later version.
10  */
11
12 #include <linux/err.h>
13 #include <linux/pm_runtime.h>
14
15 #include <linux/mmc/host.h>
16 #include <linux/mmc/card.h>
17 #include <linux/mmc/sdio.h>
18 #include <linux/mmc/sdio_func.h>
19
20 #include "core.h"
21 #include "bus.h"
22 #include "sd.h"
23 #include "sdio_bus.h"
24 #include "mmc_ops.h"
25 #include "sd_ops.h"
26 #include "sdio_ops.h"
27 #include "sdio_cis.h"
28
29 static int sdio_read_fbr(struct sdio_func *func)
30 {
31         int ret;
32         unsigned char data;
33
34         ret = mmc_io_rw_direct(func->card, 0, 0,
35                 SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF, 0, &data);
36         if (ret)
37                 goto out;
38
39         data &= 0x0f;
40
41         if (data == 0x0f) {
42                 ret = mmc_io_rw_direct(func->card, 0, 0,
43                         SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF_EXT, 0, &data);
44                 if (ret)
45                         goto out;
46         }
47
48         func->class = data;
49
50 out:
51         return ret;
52 }
53
54 static int sdio_init_func(struct mmc_card *card, unsigned int fn)
55 {
56         int ret;
57         struct sdio_func *func;
58
59         BUG_ON(fn > SDIO_MAX_FUNCS);
60
61         func = sdio_alloc_func(card);
62         if (IS_ERR(func))
63                 return PTR_ERR(func);
64
65         func->num = fn;
66
67         if (!(card->quirks & MMC_QUIRK_NONSTD_SDIO)) {
68                 ret = sdio_read_fbr(func);
69                 if (ret)
70                         goto fail;
71
72                 ret = sdio_read_func_cis(func);
73                 if (ret)
74                         goto fail;
75         } else {
76                 func->vendor = func->card->cis.vendor;
77                 func->device = func->card->cis.device;
78                 func->max_blksize = func->card->cis.blksize;
79         }
80
81         card->sdio_func[fn - 1] = func;
82
83         return 0;
84
85 fail:
86         /*
87          * It is okay to remove the function here even though we hold
88          * the host lock as we haven't registered the device yet.
89          */
90         sdio_remove_func(func);
91         return ret;
92 }
93
94 static int sdio_read_cccr(struct mmc_card *card)
95 {
96         int ret;
97         int cccr_vsn;
98         unsigned char data;
99
100         memset(&card->cccr, 0, sizeof(struct sdio_cccr));
101
102         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CCCR, 0, &data);
103         if (ret)
104                 goto out;
105
106         cccr_vsn = data & 0x0f;
107
108         if (cccr_vsn > SDIO_CCCR_REV_1_20) {
109                 printk(KERN_ERR "%s: unrecognised CCCR structure version %d\n",
110                         mmc_hostname(card->host), cccr_vsn);
111                 return -EINVAL;
112         }
113
114         card->cccr.sdio_vsn = (data & 0xf0) >> 4;
115
116         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CAPS, 0, &data);
117         if (ret)
118                 goto out;
119
120         if (data & SDIO_CCCR_CAP_SMB)
121                 card->cccr.multi_block = 1;
122         if (data & SDIO_CCCR_CAP_LSC)
123                 card->cccr.low_speed = 1;
124         if (data & SDIO_CCCR_CAP_4BLS)
125                 card->cccr.wide_bus = 1;
126
127         if (cccr_vsn >= SDIO_CCCR_REV_1_10) {
128                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_POWER, 0, &data);
129                 if (ret)
130                         goto out;
131
132                 if (data & SDIO_POWER_SMPC)
133                         card->cccr.high_power = 1;
134         }
135
136         if (cccr_vsn >= SDIO_CCCR_REV_1_20) {
137                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &data);
138                 if (ret)
139                         goto out;
140
141                 if (data & SDIO_SPEED_SHS)
142                         card->cccr.high_speed = 1;
143         }
144
145 out:
146         return ret;
147 }
148
149 static int sdio_enable_wide(struct mmc_card *card)
150 {
151         int ret;
152         u8 ctrl;
153
154         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
155                 return 0;
156
157         if (card->cccr.low_speed && !card->cccr.wide_bus)
158                 return 0;
159
160         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
161         if (ret)
162                 return ret;
163
164         ctrl |= SDIO_BUS_WIDTH_4BIT;
165
166         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
167         if (ret)
168                 return ret;
169
170         return 1;
171 }
172
173 /*
174  * If desired, disconnect the pull-up resistor on CD/DAT[3] (pin 1)
175  * of the card. This may be required on certain setups of boards,
176  * controllers and embedded sdio device which do not need the card's
177  * pull-up. As a result, card detection is disabled and power is saved.
178  */
179 static int sdio_disable_cd(struct mmc_card *card)
180 {
181         int ret;
182         u8 ctrl;
183
184         if (!card->cccr.disable_cd)
185                 return 0;
186
187         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
188         if (ret)
189                 return ret;
190
191         ctrl |= SDIO_BUS_CD_DISABLE;
192
193         return mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
194 }
195
196 /*
197  * Devices that remain active during a system suspend are
198  * put back into 1-bit mode.
199  */
200 static int sdio_disable_wide(struct mmc_card *card)
201 {
202         int ret;
203         u8 ctrl;
204
205         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
206                 return 0;
207
208         if (card->cccr.low_speed && !card->cccr.wide_bus)
209                 return 0;
210
211         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
212         if (ret)
213                 return ret;
214
215         if (!(ctrl & SDIO_BUS_WIDTH_4BIT))
216                 return 0;
217
218         ctrl &= ~SDIO_BUS_WIDTH_4BIT;
219         ctrl |= SDIO_BUS_ASYNC_INT;
220
221         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
222         if (ret)
223                 return ret;
224
225         mmc_set_bus_width(card->host, MMC_BUS_WIDTH_1);
226
227         return 0;
228 }
229
230
231 static int sdio_enable_4bit_bus(struct mmc_card *card)
232 {
233         int err;
234
235         if (card->type == MMC_TYPE_SDIO)
236                 return sdio_enable_wide(card);
237
238         if ((card->host->caps & MMC_CAP_4_BIT_DATA) &&
239                 (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
240                 err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
241                 if (err)
242                         return err;
243         } else
244                 return 0;
245
246         err = sdio_enable_wide(card);
247         if (err <= 0)
248                 mmc_app_set_bus_width(card, MMC_BUS_WIDTH_1);
249
250         return err;
251 }
252
253
254 /*
255  * Test if the card supports high-speed mode and, if so, switch to it.
256  */
257 static int mmc_sdio_switch_hs(struct mmc_card *card, int enable)
258 {
259         int ret;
260         u8 speed;
261
262         if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
263                 return 0;
264
265         if (!card->cccr.high_speed)
266                 return 0;
267
268         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
269         if (ret)
270                 return ret;
271
272         if (enable)
273                 speed |= SDIO_SPEED_EHS;
274         else
275                 speed &= ~SDIO_SPEED_EHS;
276
277         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
278         if (ret)
279                 return ret;
280
281         return 1;
282 }
283
284 /*
285  * Enable SDIO/combo card's high-speed mode. Return 0/1 if [not]supported.
286  */
287 static int sdio_enable_hs(struct mmc_card *card)
288 {
289         int ret;
290
291         ret = mmc_sdio_switch_hs(card, true);
292         if (ret <= 0 || card->type == MMC_TYPE_SDIO)
293                 return ret;
294
295         ret = mmc_sd_switch_hs(card);
296         if (ret <= 0)
297                 mmc_sdio_switch_hs(card, false);
298
299         return ret;
300 }
301
302 static unsigned mmc_sdio_get_max_clock(struct mmc_card *card)
303 {
304         unsigned max_dtr;
305
306         if (mmc_card_highspeed(card)) {
307                 /*
308                  * The SDIO specification doesn't mention how
309                  * the CIS transfer speed register relates to
310                  * high-speed, but it seems that 50 MHz is
311                  * mandatory.
312                  */
313                 max_dtr = 50000000;
314         } else {
315                 max_dtr = card->cis.max_dtr;
316         }
317
318         if (card->type == MMC_TYPE_SD_COMBO)
319                 max_dtr = min(max_dtr, mmc_sd_get_max_clock(card));
320
321         return max_dtr;
322 }
323
324 /*
325  * Handle the detection and initialisation of a card.
326  *
327  * In the case of a resume, "oldcard" will contain the card
328  * we're trying to reinitialise.
329  */
330 static int mmc_sdio_init_card(struct mmc_host *host, u32 ocr,
331                               struct mmc_card *oldcard, int powered_resume)
332 {
333         struct mmc_card *card;
334         int err;
335
336         BUG_ON(!host);
337         WARN_ON(!host->claimed);
338
339         /*
340          * Inform the card of the voltage
341          */
342         if (!powered_resume) {
343                 err = mmc_send_io_op_cond(host, host->ocr, &ocr);
344                 if (err)
345                         goto err;
346         }
347
348         /*
349          * For SPI, enable CRC as appropriate.
350          */
351         if (mmc_host_is_spi(host)) {
352                 err = mmc_spi_set_crc(host, use_spi_crc);
353                 if (err)
354                         goto err;
355         }
356
357         /*
358          * Allocate card structure.
359          */
360         card = mmc_alloc_card(host, NULL);
361         if (IS_ERR(card)) {
362                 err = PTR_ERR(card);
363                 goto err;
364         }
365
366         if (ocr & R4_MEMORY_PRESENT
367             && mmc_sd_get_cid(host, host->ocr & ocr, card->raw_cid) == 0) {
368                 card->type = MMC_TYPE_SD_COMBO;
369
370                 if (oldcard && (oldcard->type != MMC_TYPE_SD_COMBO ||
371                     memcmp(card->raw_cid, oldcard->raw_cid, sizeof(card->raw_cid)) != 0)) {
372                         mmc_remove_card(card);
373                         return -ENOENT;
374                 }
375         } else {
376                 card->type = MMC_TYPE_SDIO;
377
378                 if (oldcard && oldcard->type != MMC_TYPE_SDIO) {
379                         mmc_remove_card(card);
380                         return -ENOENT;
381                 }
382         }
383
384         /*
385          * Call the optional HC's init_card function to handle quirks.
386          */
387         if (host->ops->init_card)
388                 host->ops->init_card(host, card);
389
390         /*
391          * For native busses:  set card RCA and quit open drain mode.
392          */
393         if (!powered_resume && !mmc_host_is_spi(host)) {
394                 err = mmc_send_relative_addr(host, &card->rca);
395                 if (err)
396                         goto remove;
397
398                 /*
399                  * Update oldcard with the new RCA received from the SDIO
400                  * device -- we're doing this so that it's updated in the
401                  * "card" struct when oldcard overwrites that later.
402                  */
403                 if (oldcard)
404                         oldcard->rca = card->rca;
405
406                 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
407         }
408
409         /*
410          * Read CSD, before selecting the card
411          */
412         if (!oldcard && card->type == MMC_TYPE_SD_COMBO) {
413                 err = mmc_sd_get_csd(host, card);
414                 if (err)
415                         return err;
416
417                 mmc_decode_cid(card);
418         }
419
420         /*
421          * Select card, as all following commands rely on that.
422          */
423         if (!powered_resume && !mmc_host_is_spi(host)) {
424                 err = mmc_select_card(card);
425                 if (err)
426                         goto remove;
427         }
428
429         if (card->quirks & MMC_QUIRK_NONSTD_SDIO) {
430                 /*
431                  * This is non-standard SDIO device, meaning it doesn't
432                  * have any CIA (Common I/O area) registers present.
433                  * It's host's responsibility to fill cccr and cis
434                  * structures in init_card().
435                  */
436                 mmc_set_clock(host, card->cis.max_dtr);
437
438                 if (card->cccr.high_speed) {
439                         mmc_card_set_highspeed(card);
440                         mmc_set_timing(card->host, MMC_TIMING_SD_HS);
441                 }
442
443                 goto finish;
444         }
445
446         /*
447          * Read the common registers.
448          */
449         err = sdio_read_cccr(card);
450         if (err)
451                 goto remove;
452
453         /*
454          * Read the common CIS tuples.
455          */
456         err = sdio_read_common_cis(card);
457         if (err)
458                 goto remove;
459
460         if (oldcard) {
461                 int same = (card->cis.vendor == oldcard->cis.vendor &&
462                             card->cis.device == oldcard->cis.device);
463                 mmc_remove_card(card);
464                 if (!same)
465                         return -ENOENT;
466
467                 card = oldcard;
468         }
469
470         if (card->type == MMC_TYPE_SD_COMBO) {
471                 err = mmc_sd_setup_card(host, card, oldcard != NULL);
472                 /* handle as SDIO-only card if memory init failed */
473                 if (err) {
474                         mmc_go_idle(host);
475                         if (mmc_host_is_spi(host))
476                                 /* should not fail, as it worked previously */
477                                 mmc_spi_set_crc(host, use_spi_crc);
478                         card->type = MMC_TYPE_SDIO;
479                 } else
480                         card->dev.type = &sd_type;
481         }
482
483         /*
484          * If needed, disconnect card detection pull-up resistor.
485          */
486         err = sdio_disable_cd(card);
487         if (err)
488                 goto remove;
489
490         /*
491          * Switch to high-speed (if supported).
492          */
493         err = sdio_enable_hs(card);
494         if (err > 0)
495                 mmc_sd_go_highspeed(card);
496         else if (err)
497                 goto remove;
498
499         /*
500          * Change to the card's maximum speed.
501          */
502         mmc_set_clock(host, mmc_sdio_get_max_clock(card));
503
504         /*
505          * Switch to wider bus (if supported).
506          */
507         err = sdio_enable_4bit_bus(card);
508         if (err > 0)
509                 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
510         else if (err)
511                 goto remove;
512
513 finish:
514         if (!oldcard)
515                 host->card = card;
516         return 0;
517
518 remove:
519         if (!oldcard)
520                 mmc_remove_card(card);
521
522 err:
523         return err;
524 }
525
526 /*
527  * Host is being removed. Free up the current card.
528  */
529 static void mmc_sdio_remove(struct mmc_host *host)
530 {
531         int i;
532
533         BUG_ON(!host);
534         BUG_ON(!host->card);
535
536         for (i = 0;i < host->card->sdio_funcs;i++) {
537                 if (host->card->sdio_func[i]) {
538                         sdio_remove_func(host->card->sdio_func[i]);
539                         host->card->sdio_func[i] = NULL;
540                 }
541         }
542
543         mmc_remove_card(host->card);
544         host->card = NULL;
545 }
546
547 /*
548  * Card detection callback from host.
549  */
550 static void mmc_sdio_detect(struct mmc_host *host)
551 {
552         int err;
553
554         BUG_ON(!host);
555         BUG_ON(!host->card);
556
557         /* Make sure card is powered before detecting it */
558         if (host->caps & MMC_CAP_POWER_OFF_CARD) {
559                 err = pm_runtime_get_sync(&host->card->dev);
560                 if (err < 0)
561                         goto out;
562         }
563
564         mmc_claim_host(host);
565
566         /*
567          * Just check if our card has been removed.
568          */
569         err = mmc_select_card(host->card);
570
571         mmc_release_host(host);
572
573         /*
574          * Tell PM core it's OK to power off the card now.
575          *
576          * The _sync variant is used in order to ensure that the card
577          * is left powered off in case an error occurred, and the card
578          * is going to be removed.
579          *
580          * Since there is no specific reason to believe a new user
581          * is about to show up at this point, the _sync variant is
582          * desirable anyway.
583          */
584         if (host->caps & MMC_CAP_POWER_OFF_CARD)
585                 pm_runtime_put_sync(&host->card->dev);
586
587 out:
588         if (err) {
589                 mmc_sdio_remove(host);
590
591                 mmc_claim_host(host);
592                 mmc_detach_bus(host);
593                 mmc_release_host(host);
594         }
595 }
596
597 /*
598  * SDIO suspend.  We need to suspend all functions separately.
599  * Therefore all registered functions must have drivers with suspend
600  * and resume methods.  Failing that we simply remove the whole card.
601  */
602 static int mmc_sdio_suspend(struct mmc_host *host)
603 {
604         int i, err = 0;
605
606         for (i = 0; i < host->card->sdio_funcs; i++) {
607                 struct sdio_func *func = host->card->sdio_func[i];
608                 if (func && sdio_func_present(func) && func->dev.driver) {
609                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
610                         if (!pmops || !pmops->suspend || !pmops->resume) {
611                                 /* force removal of entire card in that case */
612                                 err = -ENOSYS;
613                         } else
614                                 err = pmops->suspend(&func->dev);
615                         if (err)
616                                 break;
617                 }
618         }
619         while (err && --i >= 0) {
620                 struct sdio_func *func = host->card->sdio_func[i];
621                 if (func && sdio_func_present(func) && func->dev.driver) {
622                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
623                         pmops->resume(&func->dev);
624                 }
625         }
626
627         if (!err && host->pm_flags & MMC_PM_KEEP_POWER) {
628                 mmc_claim_host(host);
629                 sdio_disable_wide(host->card);
630                 mmc_release_host(host);
631         }
632
633         return err;
634 }
635
636 static int mmc_sdio_resume(struct mmc_host *host)
637 {
638         int i, err;
639
640         BUG_ON(!host);
641         BUG_ON(!host->card);
642
643         /* Basic card reinitialization. */
644         mmc_claim_host(host);
645         err = mmc_sdio_init_card(host, host->ocr, host->card,
646                                  (host->pm_flags & MMC_PM_KEEP_POWER));
647         if (!err && host->sdio_irqs)
648                 mmc_signal_sdio_irq(host);
649         mmc_release_host(host);
650
651         /*
652          * If the card looked to be the same as before suspending, then
653          * we proceed to resume all card functions.  If one of them returns
654          * an error then we simply return that error to the core and the
655          * card will be redetected as new.  It is the responsibility of
656          * the function driver to perform further tests with the extra
657          * knowledge it has of the card to confirm the card is indeed the
658          * same as before suspending (same MAC address for network cards,
659          * etc.) and return an error otherwise.
660          */
661         for (i = 0; !err && i < host->card->sdio_funcs; i++) {
662                 struct sdio_func *func = host->card->sdio_func[i];
663                 if (func && sdio_func_present(func) && func->dev.driver) {
664                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
665                         err = pmops->resume(&func->dev);
666                 }
667         }
668
669         return err;
670 }
671
672 static int mmc_sdio_power_restore(struct mmc_host *host)
673 {
674         int ret;
675
676         BUG_ON(!host);
677         BUG_ON(!host->card);
678
679         mmc_claim_host(host);
680         ret = mmc_sdio_init_card(host, host->ocr, host->card,
681                         (host->pm_flags & MMC_PM_KEEP_POWER));
682         if (!ret && host->sdio_irqs)
683                 mmc_signal_sdio_irq(host);
684         mmc_release_host(host);
685
686         return ret;
687 }
688
689 static const struct mmc_bus_ops mmc_sdio_ops = {
690         .remove = mmc_sdio_remove,
691         .detect = mmc_sdio_detect,
692         .suspend = mmc_sdio_suspend,
693         .resume = mmc_sdio_resume,
694         .power_restore = mmc_sdio_power_restore,
695 };
696
697
698 /*
699  * Starting point for SDIO card init.
700  */
701 int mmc_attach_sdio(struct mmc_host *host, u32 ocr)
702 {
703         int err;
704         int i, funcs;
705         struct mmc_card *card;
706
707         BUG_ON(!host);
708         WARN_ON(!host->claimed);
709
710         mmc_attach_bus(host, &mmc_sdio_ops);
711
712         /*
713          * Sanity check the voltages that the card claims to
714          * support.
715          */
716         if (ocr & 0x7F) {
717                 printk(KERN_WARNING "%s: card claims to support voltages "
718                        "below the defined range. These will be ignored.\n",
719                        mmc_hostname(host));
720                 ocr &= ~0x7F;
721         }
722
723         host->ocr = mmc_select_voltage(host, ocr);
724
725         /*
726          * Can we support the voltage(s) of the card(s)?
727          */
728         if (!host->ocr) {
729                 err = -EINVAL;
730                 goto err;
731         }
732
733         /*
734          * Detect and init the card.
735          */
736         err = mmc_sdio_init_card(host, host->ocr, NULL, 0);
737         if (err)
738                 goto err;
739         card = host->card;
740
741         /*
742          * Enable runtime PM only if supported by host+card+board
743          */
744         if (host->caps & MMC_CAP_POWER_OFF_CARD) {
745                 /*
746                  * Let runtime PM core know our card is active
747                  */
748                 err = pm_runtime_set_active(&card->dev);
749                 if (err)
750                         goto remove;
751
752                 /*
753                  * Enable runtime PM for this card
754                  */
755                 pm_runtime_enable(&card->dev);
756         }
757
758         /*
759          * The number of functions on the card is encoded inside
760          * the ocr.
761          */
762         funcs = (ocr & 0x70000000) >> 28;
763         card->sdio_funcs = 0;
764
765         /*
766          * Initialize (but don't add) all present functions.
767          */
768         for (i = 0; i < funcs; i++, card->sdio_funcs++) {
769                 err = sdio_init_func(host->card, i + 1);
770                 if (err)
771                         goto remove;
772
773                 /*
774                  * Enable Runtime PM for this func (if supported)
775                  */
776                 if (host->caps & MMC_CAP_POWER_OFF_CARD)
777                         pm_runtime_enable(&card->sdio_func[i]->dev);
778         }
779
780         mmc_release_host(host);
781
782         /*
783          * First add the card to the driver model...
784          */
785         err = mmc_add_card(host->card);
786         if (err)
787                 goto remove_added;
788
789         /*
790          * ...then the SDIO functions.
791          */
792         for (i = 0;i < funcs;i++) {
793                 err = sdio_add_func(host->card->sdio_func[i]);
794                 if (err)
795                         goto remove_added;
796         }
797
798         return 0;
799
800
801 remove_added:
802         /* Remove without lock if the device has been added. */
803         mmc_sdio_remove(host);
804         mmc_claim_host(host);
805 remove:
806         /* And with lock if it hasn't been added. */
807         if (host->card)
808                 mmc_sdio_remove(host);
809 err:
810         mmc_detach_bus(host);
811         mmc_release_host(host);
812
813         printk(KERN_ERR "%s: error %d whilst initialising SDIO card\n",
814                 mmc_hostname(host), err);
815
816         return err;
817 }
818