mmc: sdio: enable runtime PM for SDIO cards
[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                 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
399         }
400
401         /*
402          * Read CSD, before selecting the card
403          */
404         if (!oldcard && card->type == MMC_TYPE_SD_COMBO) {
405                 err = mmc_sd_get_csd(host, card);
406                 if (err)
407                         return err;
408
409                 mmc_decode_cid(card);
410         }
411
412         /*
413          * Select card, as all following commands rely on that.
414          */
415         if (!powered_resume && !mmc_host_is_spi(host)) {
416                 err = mmc_select_card(card);
417                 if (err)
418                         goto remove;
419         }
420
421         if (card->quirks & MMC_QUIRK_NONSTD_SDIO) {
422                 /*
423                  * This is non-standard SDIO device, meaning it doesn't
424                  * have any CIA (Common I/O area) registers present.
425                  * It's host's responsibility to fill cccr and cis
426                  * structures in init_card().
427                  */
428                 mmc_set_clock(host, card->cis.max_dtr);
429
430                 if (card->cccr.high_speed) {
431                         mmc_card_set_highspeed(card);
432                         mmc_set_timing(card->host, MMC_TIMING_SD_HS);
433                 }
434
435                 goto finish;
436         }
437
438         /*
439          * Read the common registers.
440          */
441         err = sdio_read_cccr(card);
442         if (err)
443                 goto remove;
444
445         /*
446          * Read the common CIS tuples.
447          */
448         err = sdio_read_common_cis(card);
449         if (err)
450                 goto remove;
451
452         if (oldcard) {
453                 int same = (card->cis.vendor == oldcard->cis.vendor &&
454                             card->cis.device == oldcard->cis.device);
455                 mmc_remove_card(card);
456                 if (!same)
457                         return -ENOENT;
458
459                 card = oldcard;
460         }
461
462         if (card->type == MMC_TYPE_SD_COMBO) {
463                 err = mmc_sd_setup_card(host, card, oldcard != NULL);
464                 /* handle as SDIO-only card if memory init failed */
465                 if (err) {
466                         mmc_go_idle(host);
467                         if (mmc_host_is_spi(host))
468                                 /* should not fail, as it worked previously */
469                                 mmc_spi_set_crc(host, use_spi_crc);
470                         card->type = MMC_TYPE_SDIO;
471                 } else
472                         card->dev.type = &sd_type;
473         }
474
475         /*
476          * If needed, disconnect card detection pull-up resistor.
477          */
478         err = sdio_disable_cd(card);
479         if (err)
480                 goto remove;
481
482         /*
483          * Switch to high-speed (if supported).
484          */
485         err = sdio_enable_hs(card);
486         if (err > 0)
487                 mmc_sd_go_highspeed(card);
488         else if (err)
489                 goto remove;
490
491         /*
492          * Change to the card's maximum speed.
493          */
494         mmc_set_clock(host, mmc_sdio_get_max_clock(card));
495
496         /*
497          * Switch to wider bus (if supported).
498          */
499         err = sdio_enable_4bit_bus(card);
500         if (err > 0)
501                 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
502         else if (err)
503                 goto remove;
504
505 finish:
506         if (!oldcard)
507                 host->card = card;
508         return 0;
509
510 remove:
511         if (!oldcard)
512                 mmc_remove_card(card);
513
514 err:
515         return err;
516 }
517
518 /*
519  * Host is being removed. Free up the current card.
520  */
521 static void mmc_sdio_remove(struct mmc_host *host)
522 {
523         int i;
524
525         BUG_ON(!host);
526         BUG_ON(!host->card);
527
528         for (i = 0;i < host->card->sdio_funcs;i++) {
529                 if (host->card->sdio_func[i]) {
530                         sdio_remove_func(host->card->sdio_func[i]);
531                         host->card->sdio_func[i] = NULL;
532                 }
533         }
534
535         mmc_remove_card(host->card);
536         host->card = NULL;
537 }
538
539 /*
540  * Card detection callback from host.
541  */
542 static void mmc_sdio_detect(struct mmc_host *host)
543 {
544         int err;
545
546         BUG_ON(!host);
547         BUG_ON(!host->card);
548
549         mmc_claim_host(host);
550
551         /*
552          * Just check if our card has been removed.
553          */
554         err = mmc_select_card(host->card);
555
556         mmc_release_host(host);
557
558         if (err) {
559                 mmc_sdio_remove(host);
560
561                 mmc_claim_host(host);
562                 mmc_detach_bus(host);
563                 mmc_release_host(host);
564         }
565 }
566
567 /*
568  * SDIO suspend.  We need to suspend all functions separately.
569  * Therefore all registered functions must have drivers with suspend
570  * and resume methods.  Failing that we simply remove the whole card.
571  */
572 static int mmc_sdio_suspend(struct mmc_host *host)
573 {
574         int i, err = 0;
575
576         for (i = 0; i < host->card->sdio_funcs; i++) {
577                 struct sdio_func *func = host->card->sdio_func[i];
578                 if (func && sdio_func_present(func) && func->dev.driver) {
579                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
580                         if (!pmops || !pmops->suspend || !pmops->resume) {
581                                 /* force removal of entire card in that case */
582                                 err = -ENOSYS;
583                         } else
584                                 err = pmops->suspend(&func->dev);
585                         if (err)
586                                 break;
587                 }
588         }
589         while (err && --i >= 0) {
590                 struct sdio_func *func = host->card->sdio_func[i];
591                 if (func && sdio_func_present(func) && func->dev.driver) {
592                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
593                         pmops->resume(&func->dev);
594                 }
595         }
596
597         if (!err && host->pm_flags & MMC_PM_KEEP_POWER) {
598                 mmc_claim_host(host);
599                 sdio_disable_wide(host->card);
600                 mmc_release_host(host);
601         }
602
603         return err;
604 }
605
606 static int mmc_sdio_resume(struct mmc_host *host)
607 {
608         int i, err;
609
610         BUG_ON(!host);
611         BUG_ON(!host->card);
612
613         /* Basic card reinitialization. */
614         mmc_claim_host(host);
615         err = mmc_sdio_init_card(host, host->ocr, host->card,
616                                  (host->pm_flags & MMC_PM_KEEP_POWER));
617         if (!err && host->sdio_irqs)
618                 mmc_signal_sdio_irq(host);
619         mmc_release_host(host);
620
621         /*
622          * If the card looked to be the same as before suspending, then
623          * we proceed to resume all card functions.  If one of them returns
624          * an error then we simply return that error to the core and the
625          * card will be redetected as new.  It is the responsibility of
626          * the function driver to perform further tests with the extra
627          * knowledge it has of the card to confirm the card is indeed the
628          * same as before suspending (same MAC address for network cards,
629          * etc.) and return an error otherwise.
630          */
631         for (i = 0; !err && i < host->card->sdio_funcs; i++) {
632                 struct sdio_func *func = host->card->sdio_func[i];
633                 if (func && sdio_func_present(func) && func->dev.driver) {
634                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
635                         err = pmops->resume(&func->dev);
636                 }
637         }
638
639         return err;
640 }
641
642 static int mmc_sdio_power_restore(struct mmc_host *host)
643 {
644         int ret;
645
646         BUG_ON(!host);
647         BUG_ON(!host->card);
648
649         mmc_claim_host(host);
650         ret = mmc_sdio_init_card(host, host->ocr, host->card,
651                         (host->pm_flags & MMC_PM_KEEP_POWER));
652         if (!ret && host->sdio_irqs)
653                 mmc_signal_sdio_irq(host);
654         mmc_release_host(host);
655
656         return ret;
657 }
658
659 static const struct mmc_bus_ops mmc_sdio_ops = {
660         .remove = mmc_sdio_remove,
661         .detect = mmc_sdio_detect,
662         .suspend = mmc_sdio_suspend,
663         .resume = mmc_sdio_resume,
664         .power_restore = mmc_sdio_power_restore,
665 };
666
667
668 /*
669  * Starting point for SDIO card init.
670  */
671 int mmc_attach_sdio(struct mmc_host *host, u32 ocr)
672 {
673         int err;
674         int i, funcs;
675         struct mmc_card *card;
676
677         BUG_ON(!host);
678         WARN_ON(!host->claimed);
679
680         mmc_attach_bus(host, &mmc_sdio_ops);
681
682         /*
683          * Sanity check the voltages that the card claims to
684          * support.
685          */
686         if (ocr & 0x7F) {
687                 printk(KERN_WARNING "%s: card claims to support voltages "
688                        "below the defined range. These will be ignored.\n",
689                        mmc_hostname(host));
690                 ocr &= ~0x7F;
691         }
692
693         host->ocr = mmc_select_voltage(host, ocr);
694
695         /*
696          * Can we support the voltage(s) of the card(s)?
697          */
698         if (!host->ocr) {
699                 err = -EINVAL;
700                 goto err;
701         }
702
703         /*
704          * Detect and init the card.
705          */
706         err = mmc_sdio_init_card(host, host->ocr, NULL, 0);
707         if (err)
708                 goto err;
709         card = host->card;
710
711         /*
712          * Let runtime PM core know our card is active
713          */
714         err = pm_runtime_set_active(&card->dev);
715         if (err)
716                 goto remove;
717
718         /*
719          * Enable runtime PM for this card
720          */
721         pm_runtime_enable(&card->dev);
722
723         /*
724          * The number of functions on the card is encoded inside
725          * the ocr.
726          */
727         funcs = (ocr & 0x70000000) >> 28;
728         card->sdio_funcs = 0;
729
730         /*
731          * Initialize (but don't add) all present functions.
732          */
733         for (i = 0; i < funcs; i++, card->sdio_funcs++) {
734                 err = sdio_init_func(host->card, i + 1);
735                 if (err)
736                         goto remove;
737         }
738
739         mmc_release_host(host);
740
741         /*
742          * First add the card to the driver model...
743          */
744         err = mmc_add_card(host->card);
745         if (err)
746                 goto remove_added;
747
748         /*
749          * ...then the SDIO functions.
750          */
751         for (i = 0;i < funcs;i++) {
752                 err = sdio_add_func(host->card->sdio_func[i]);
753                 if (err)
754                         goto remove_added;
755         }
756
757         return 0;
758
759
760 remove_added:
761         /* Remove without lock if the device has been added. */
762         mmc_sdio_remove(host);
763         mmc_claim_host(host);
764 remove:
765         /* And with lock if it hasn't been added. */
766         if (host->card)
767                 mmc_sdio_remove(host);
768 err:
769         mmc_detach_bus(host);
770         mmc_release_host(host);
771
772         printk(KERN_ERR "%s: error %d whilst initialising SDIO card\n",
773                 mmc_hostname(host), err);
774
775         return err;
776 }
777