2 * linux/drivers/mmc/sdio.c
4 * Copyright 2006-2007 Pierre Ossman
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.
12 #include <linux/err.h>
13 #include <linux/pm_runtime.h>
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 #include <linux/mmc/sdio_ids.h>
30 static int sdio_read_fbr(struct sdio_func *func)
35 if (mmc_card_nonstd_func_interface(func->card)) {
36 func->class = SDIO_CLASS_NONE;
40 ret = mmc_io_rw_direct(func->card, 0, 0,
41 SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF, 0, &data);
48 ret = mmc_io_rw_direct(func->card, 0, 0,
49 SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF_EXT, 0, &data);
60 static int sdio_init_func(struct mmc_card *card, unsigned int fn)
63 struct sdio_func *func;
65 BUG_ON(fn > SDIO_MAX_FUNCS);
67 func = sdio_alloc_func(card);
73 if (!(card->quirks & MMC_QUIRK_NONSTD_SDIO)) {
74 ret = sdio_read_fbr(func);
78 ret = sdio_read_func_cis(func);
82 func->vendor = func->card->cis.vendor;
83 func->device = func->card->cis.device;
84 func->max_blksize = func->card->cis.blksize;
87 card->sdio_func[fn - 1] = func;
93 * It is okay to remove the function here even though we hold
94 * the host lock as we haven't registered the device yet.
96 sdio_remove_func(func);
100 static int sdio_read_cccr(struct mmc_card *card)
106 memset(&card->cccr, 0, sizeof(struct sdio_cccr));
108 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CCCR, 0, &data);
112 cccr_vsn = data & 0x0f;
114 if (cccr_vsn > SDIO_CCCR_REV_1_20) {
115 printk(KERN_ERR "%s: unrecognised CCCR structure version %d\n",
116 mmc_hostname(card->host), cccr_vsn);
120 card->cccr.sdio_vsn = (data & 0xf0) >> 4;
122 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CAPS, 0, &data);
126 if (data & SDIO_CCCR_CAP_SMB)
127 card->cccr.multi_block = 1;
128 if (data & SDIO_CCCR_CAP_LSC)
129 card->cccr.low_speed = 1;
130 if (data & SDIO_CCCR_CAP_4BLS)
131 card->cccr.wide_bus = 1;
133 if (cccr_vsn >= SDIO_CCCR_REV_1_10) {
134 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_POWER, 0, &data);
138 if (data & SDIO_POWER_SMPC)
139 card->cccr.high_power = 1;
142 if (cccr_vsn >= SDIO_CCCR_REV_1_20) {
143 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &data);
147 if (data & SDIO_SPEED_SHS)
148 card->cccr.high_speed = 1;
155 static int sdio_enable_wide(struct mmc_card *card)
160 if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
163 if (card->cccr.low_speed && !card->cccr.wide_bus)
166 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
170 ctrl |= SDIO_BUS_WIDTH_4BIT;
172 ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
180 * If desired, disconnect the pull-up resistor on CD/DAT[3] (pin 1)
181 * of the card. This may be required on certain setups of boards,
182 * controllers and embedded sdio device which do not need the card's
183 * pull-up. As a result, card detection is disabled and power is saved.
185 static int sdio_disable_cd(struct mmc_card *card)
190 if (!mmc_card_disable_cd(card))
193 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
197 ctrl |= SDIO_BUS_CD_DISABLE;
199 return mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
203 * Devices that remain active during a system suspend are
204 * put back into 1-bit mode.
206 static int sdio_disable_wide(struct mmc_card *card)
211 if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
214 if (card->cccr.low_speed && !card->cccr.wide_bus)
217 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
221 if (!(ctrl & SDIO_BUS_WIDTH_4BIT))
224 ctrl &= ~SDIO_BUS_WIDTH_4BIT;
225 ctrl |= SDIO_BUS_ASYNC_INT;
227 ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
231 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_1);
237 static int sdio_enable_4bit_bus(struct mmc_card *card)
241 if (card->type == MMC_TYPE_SDIO)
242 return sdio_enable_wide(card);
244 if ((card->host->caps & MMC_CAP_4_BIT_DATA) &&
245 (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
246 err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
252 err = sdio_enable_wide(card);
254 mmc_app_set_bus_width(card, MMC_BUS_WIDTH_1);
261 * Test if the card supports high-speed mode and, if so, switch to it.
263 static int mmc_sdio_switch_hs(struct mmc_card *card, int enable)
268 if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
271 if (!card->cccr.high_speed)
274 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
279 speed |= SDIO_SPEED_EHS;
281 speed &= ~SDIO_SPEED_EHS;
283 ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
291 * Enable SDIO/combo card's high-speed mode. Return 0/1 if [not]supported.
293 static int sdio_enable_hs(struct mmc_card *card)
297 ret = mmc_sdio_switch_hs(card, true);
298 if (ret <= 0 || card->type == MMC_TYPE_SDIO)
301 ret = mmc_sd_switch_hs(card);
303 mmc_sdio_switch_hs(card, false);
308 static unsigned mmc_sdio_get_max_clock(struct mmc_card *card)
312 if (mmc_card_highspeed(card)) {
314 * The SDIO specification doesn't mention how
315 * the CIS transfer speed register relates to
316 * high-speed, but it seems that 50 MHz is
321 max_dtr = card->cis.max_dtr;
324 if (card->type == MMC_TYPE_SD_COMBO)
325 max_dtr = min(max_dtr, mmc_sd_get_max_clock(card));
331 * Handle the detection and initialisation of a card.
333 * In the case of a resume, "oldcard" will contain the card
334 * we're trying to reinitialise.
336 static int mmc_sdio_init_card(struct mmc_host *host, u32 ocr,
337 struct mmc_card *oldcard, int powered_resume)
339 struct mmc_card *card;
343 WARN_ON(!host->claimed);
346 * Inform the card of the voltage
348 if (!powered_resume) {
349 err = mmc_send_io_op_cond(host, host->ocr, &ocr);
355 * For SPI, enable CRC as appropriate.
357 if (mmc_host_is_spi(host)) {
358 err = mmc_spi_set_crc(host, use_spi_crc);
364 * Allocate card structure.
366 card = mmc_alloc_card(host, NULL);
372 if ((ocr & R4_MEMORY_PRESENT) &&
373 mmc_sd_get_cid(host, host->ocr & ocr, card->raw_cid, NULL) == 0) {
374 card->type = MMC_TYPE_SD_COMBO;
376 if (oldcard && (oldcard->type != MMC_TYPE_SD_COMBO ||
377 memcmp(card->raw_cid, oldcard->raw_cid, sizeof(card->raw_cid)) != 0)) {
378 mmc_remove_card(card);
382 card->type = MMC_TYPE_SDIO;
384 if (oldcard && oldcard->type != MMC_TYPE_SDIO) {
385 mmc_remove_card(card);
391 * Call the optional HC's init_card function to handle quirks.
393 if (host->ops->init_card)
394 host->ops->init_card(host, card);
397 * For native busses: set card RCA and quit open drain mode.
399 if (!powered_resume && !mmc_host_is_spi(host)) {
400 err = mmc_send_relative_addr(host, &card->rca);
405 * Update oldcard with the new RCA received from the SDIO
406 * device -- we're doing this so that it's updated in the
407 * "card" struct when oldcard overwrites that later.
410 oldcard->rca = card->rca;
412 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
416 * Read CSD, before selecting the card
418 if (!oldcard && card->type == MMC_TYPE_SD_COMBO) {
419 err = mmc_sd_get_csd(host, card);
423 mmc_decode_cid(card);
427 * Select card, as all following commands rely on that.
429 if (!powered_resume && !mmc_host_is_spi(host)) {
430 err = mmc_select_card(card);
435 if (card->quirks & MMC_QUIRK_NONSTD_SDIO) {
437 * This is non-standard SDIO device, meaning it doesn't
438 * have any CIA (Common I/O area) registers present.
439 * It's host's responsibility to fill cccr and cis
440 * structures in init_card().
442 mmc_set_clock(host, card->cis.max_dtr);
444 if (card->cccr.high_speed) {
445 mmc_card_set_highspeed(card);
446 mmc_set_timing(card->host, MMC_TIMING_SD_HS);
453 * Read the common registers.
455 err = sdio_read_cccr(card);
460 * Read the common CIS tuples.
462 err = sdio_read_common_cis(card);
467 int same = (card->cis.vendor == oldcard->cis.vendor &&
468 card->cis.device == oldcard->cis.device);
469 mmc_remove_card(card);
475 mmc_fixup_device(card, NULL);
477 if (card->type == MMC_TYPE_SD_COMBO) {
478 err = mmc_sd_setup_card(host, card, oldcard != NULL);
479 /* handle as SDIO-only card if memory init failed */
482 if (mmc_host_is_spi(host))
483 /* should not fail, as it worked previously */
484 mmc_spi_set_crc(host, use_spi_crc);
485 card->type = MMC_TYPE_SDIO;
487 card->dev.type = &sd_type;
491 * If needed, disconnect card detection pull-up resistor.
493 err = sdio_disable_cd(card);
498 * Switch to high-speed (if supported).
500 err = sdio_enable_hs(card);
502 mmc_sd_go_highspeed(card);
507 * Change to the card's maximum speed.
509 mmc_set_clock(host, mmc_sdio_get_max_clock(card));
512 * Switch to wider bus (if supported).
514 err = sdio_enable_4bit_bus(card);
516 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
527 mmc_remove_card(card);
534 * Host is being removed. Free up the current card.
536 static void mmc_sdio_remove(struct mmc_host *host)
543 for (i = 0;i < host->card->sdio_funcs;i++) {
544 if (host->card->sdio_func[i]) {
545 sdio_remove_func(host->card->sdio_func[i]);
546 host->card->sdio_func[i] = NULL;
550 mmc_remove_card(host->card);
555 * Card detection callback from host.
557 static void mmc_sdio_detect(struct mmc_host *host)
564 /* Make sure card is powered before detecting it */
565 if (host->caps & MMC_CAP_POWER_OFF_CARD) {
566 err = pm_runtime_get_sync(&host->card->dev);
571 mmc_claim_host(host);
574 * Just check if our card has been removed.
576 err = mmc_select_card(host->card);
578 mmc_release_host(host);
581 * Tell PM core it's OK to power off the card now.
583 * The _sync variant is used in order to ensure that the card
584 * is left powered off in case an error occurred, and the card
585 * is going to be removed.
587 * Since there is no specific reason to believe a new user
588 * is about to show up at this point, the _sync variant is
591 if (host->caps & MMC_CAP_POWER_OFF_CARD)
592 pm_runtime_put_sync(&host->card->dev);
596 mmc_sdio_remove(host);
598 mmc_claim_host(host);
599 mmc_detach_bus(host);
600 mmc_release_host(host);
605 * SDIO suspend. We need to suspend all functions separately.
606 * Therefore all registered functions must have drivers with suspend
607 * and resume methods. Failing that we simply remove the whole card.
609 static int mmc_sdio_suspend(struct mmc_host *host)
613 for (i = 0; i < host->card->sdio_funcs; i++) {
614 struct sdio_func *func = host->card->sdio_func[i];
615 if (func && sdio_func_present(func) && func->dev.driver) {
616 const struct dev_pm_ops *pmops = func->dev.driver->pm;
617 if (!pmops || !pmops->suspend || !pmops->resume) {
618 /* force removal of entire card in that case */
621 err = pmops->suspend(&func->dev);
626 while (err && --i >= 0) {
627 struct sdio_func *func = host->card->sdio_func[i];
628 if (func && sdio_func_present(func) && func->dev.driver) {
629 const struct dev_pm_ops *pmops = func->dev.driver->pm;
630 pmops->resume(&func->dev);
634 if (!err && mmc_card_keep_power(host) && mmc_card_wake_sdio_irq(host)) {
635 mmc_claim_host(host);
636 sdio_disable_wide(host->card);
637 mmc_release_host(host);
643 static int mmc_sdio_resume(struct mmc_host *host)
650 /* Basic card reinitialization. */
651 mmc_claim_host(host);
653 /* No need to reinitialize powered-resumed nonremovable cards */
654 if (mmc_card_is_removable(host) || !mmc_card_keep_power(host))
655 err = mmc_sdio_init_card(host, host->ocr, host->card,
656 mmc_card_keep_power(host));
657 else if (mmc_card_keep_power(host) && mmc_card_wake_sdio_irq(host)) {
658 /* We may have switched to 1-bit mode during suspend */
659 err = sdio_enable_4bit_bus(host->card);
661 mmc_set_bus_width(host, MMC_BUS_WIDTH_4);
666 if (!err && host->sdio_irqs)
667 mmc_signal_sdio_irq(host);
668 mmc_release_host(host);
671 * If the card looked to be the same as before suspending, then
672 * we proceed to resume all card functions. If one of them returns
673 * an error then we simply return that error to the core and the
674 * card will be redetected as new. It is the responsibility of
675 * the function driver to perform further tests with the extra
676 * knowledge it has of the card to confirm the card is indeed the
677 * same as before suspending (same MAC address for network cards,
678 * etc.) and return an error otherwise.
680 for (i = 0; !err && i < host->card->sdio_funcs; i++) {
681 struct sdio_func *func = host->card->sdio_func[i];
682 if (func && sdio_func_present(func) && func->dev.driver) {
683 const struct dev_pm_ops *pmops = func->dev.driver->pm;
684 err = pmops->resume(&func->dev);
691 static int mmc_sdio_power_restore(struct mmc_host *host)
699 mmc_claim_host(host);
702 * Reset the card by performing the same steps that are taken by
703 * mmc_rescan_try_freq() and mmc_attach_sdio() during a "normal" probe.
705 * sdio_reset() is technically not needed. Having just powered up the
706 * hardware, it should already be in reset state. However, some
707 * platforms (such as SD8686 on OLPC) do not instantly cut power,
708 * meaning that a reset is required when restoring power soon after
709 * powering off. It is harmless in other cases.
711 * The CMD5 reset (mmc_send_io_op_cond()), according to the SDIO spec,
712 * is not necessary for non-removable cards. However, it is required
713 * for OLPC SD8686 (which expects a [CMD5,5,3,7] init sequence), and
714 * harmless in other situations.
716 * With these steps taken, mmc_select_voltage() is also required to
717 * restore the correct voltage setting of the card.
721 mmc_send_if_cond(host, host->ocr_avail);
723 ret = mmc_send_io_op_cond(host, 0, &ocr);
727 if (host->ocr_avail_sdio)
728 host->ocr_avail = host->ocr_avail_sdio;
730 host->ocr = mmc_select_voltage(host, ocr & ~0x7F);
736 ret = mmc_sdio_init_card(host, host->ocr, host->card,
737 mmc_card_keep_power(host));
738 if (!ret && host->sdio_irqs)
739 mmc_signal_sdio_irq(host);
742 mmc_release_host(host);
747 static const struct mmc_bus_ops mmc_sdio_ops = {
748 .remove = mmc_sdio_remove,
749 .detect = mmc_sdio_detect,
750 .suspend = mmc_sdio_suspend,
751 .resume = mmc_sdio_resume,
752 .power_restore = mmc_sdio_power_restore,
757 * Starting point for SDIO card init.
759 int mmc_attach_sdio(struct mmc_host *host)
763 struct mmc_card *card;
766 WARN_ON(!host->claimed);
768 err = mmc_send_io_op_cond(host, 0, &ocr);
772 mmc_attach_bus(host, &mmc_sdio_ops);
773 if (host->ocr_avail_sdio)
774 host->ocr_avail = host->ocr_avail_sdio;
777 * Sanity check the voltages that the card claims to
781 printk(KERN_WARNING "%s: card claims to support voltages "
782 "below the defined range. These will be ignored.\n",
787 host->ocr = mmc_select_voltage(host, ocr);
790 * Can we support the voltage(s) of the card(s)?
798 * Detect and init the card.
800 err = mmc_sdio_init_card(host, host->ocr, NULL, 0);
806 * Enable runtime PM only if supported by host+card+board
808 if (host->caps & MMC_CAP_POWER_OFF_CARD) {
810 * Let runtime PM core know our card is active
812 err = pm_runtime_set_active(&card->dev);
817 * Enable runtime PM for this card
819 pm_runtime_enable(&card->dev);
823 * The number of functions on the card is encoded inside
826 funcs = (ocr & 0x70000000) >> 28;
827 card->sdio_funcs = 0;
830 * Initialize (but don't add) all present functions.
832 for (i = 0; i < funcs; i++, card->sdio_funcs++) {
833 err = sdio_init_func(host->card, i + 1);
838 * Enable Runtime PM for this func (if supported)
840 if (host->caps & MMC_CAP_POWER_OFF_CARD)
841 pm_runtime_enable(&card->sdio_func[i]->dev);
845 * First add the card to the driver model...
847 mmc_release_host(host);
848 err = mmc_add_card(host->card);
853 * ...then the SDIO functions.
855 for (i = 0;i < funcs;i++) {
856 err = sdio_add_func(host->card->sdio_func[i]);
861 mmc_claim_host(host);
866 /* Remove without lock if the device has been added. */
867 mmc_sdio_remove(host);
868 mmc_claim_host(host);
870 /* And with lock if it hasn't been added. */
871 mmc_release_host(host);
873 mmc_sdio_remove(host);
874 mmc_claim_host(host);
876 mmc_detach_bus(host);
878 printk(KERN_ERR "%s: error %d whilst initialising SDIO card\n",
879 mmc_hostname(host), err);