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
  14 #include <linux/mmc/host.h>
  15 #include <linux/mmc/card.h>
  16 #include <linux/mmc/sdio.h>
  17 #include <linux/mmc/sdio_func.h>
  18
  19 #include "core.h"
  20 #include "bus.h"
  21 #include "sd.h"
  22 #include "sdio_bus.h"
  23 #include "mmc_ops.h"
  24 #include "sd_ops.h"
  25 #include "sdio_ops.h"
  26 #include "sdio_cis.h"
  27
  28 static int sdio_read_fbr(struct sdio_func *func)
  29 {
  30         int ret;
  31         unsigned char data;
  32
  33         ret = mmc_io_rw_direct(func->card, 0, 0,
  34                 SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF, 0, &data);
  35         if (ret)
  36                 goto out;
  37
  38         data &= 0x0f;
  39
  40         if (data == 0x0f) {
  41                 ret = mmc_io_rw_direct(func->card, 0, 0,
  42                         SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF_EXT, 0, &data);
  43                 if (ret)
  44                         goto out;
  45         }
  46
  47         func->class = data;
  48
  49 out:
  50         return ret;
  51 }
  52
  53 static int sdio_init_func(struct mmc_card *card, unsigned int fn)
  54 {
  55         int ret;
  56         struct sdio_func *func;
  57
  58         BUG_ON(fn > SDIO_MAX_FUNCS);
  59
  60         func = sdio_alloc_func(card);
  61         if (IS_ERR(func))
  62                 return PTR_ERR(func);
  63
  64         func->num = fn;
  65
  66         if (!(card->quirks & MMC_QUIRK_NONSTD_SDIO)) {
  67                 ret = sdio_read_fbr(func);
  68                 if (ret)
  69                         goto fail;
  70
  71                 ret = sdio_read_func_cis(func);
  72                 if (ret)
  73                         goto fail;
  74         } else {
  75                 func->vendor = func->card->cis.vendor;
  76                 func->device = func->card->cis.device;
  77                 func->max_blksize = func->card->cis.blksize;
  78         }
  79
  80         card->sdio_func[fn - 1] = func;
  81
  82         return 0;
  83
  84 fail:
  85         /*
  86          * It is okay to remove the function here even though we hold
  87          * the host lock as we haven't registered the device yet.
  88          */
  89         sdio_remove_func(func);
  90         return ret;
  91 }
  92
  93 static int sdio_read_cccr(struct mmc_card *card)
  94 {
  95         int ret;
  96         int cccr_vsn;
  97         unsigned char data;
  98
  99         memset(&card->cccr, 0, sizeof(struct sdio_cccr));
 100
 101         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CCCR, 0, &data);
 102         if (ret)
 103                 goto out;
 104
 105         cccr_vsn = data & 0x0f;
 106
 107         if (cccr_vsn > SDIO_CCCR_REV_1_20) {
 108                 printk(KERN_ERR "%s: unrecognised CCCR structure version %d\n",
 109                         mmc_hostname(card->host), cccr_vsn);
 110                 return -EINVAL;
 111         }
 112
 113         card->cccr.sdio_vsn = (data & 0xf0) >> 4;
 114
 115         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CAPS, 0, &data);
 116         if (ret)
 117                 goto out;
 118
 119         if (data & SDIO_CCCR_CAP_SMB)
 120                 card->cccr.multi_block = 1;
 121         if (data & SDIO_CCCR_CAP_LSC)
 122                 card->cccr.low_speed = 1;
 123         if (data & SDIO_CCCR_CAP_4BLS)
 124                 card->cccr.wide_bus = 1;
 125
 126         if (cccr_vsn >= SDIO_CCCR_REV_1_10) {
 127                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_POWER, 0, &data);
 128                 if (ret)
 129                         goto out;
 130
 131                 if (data & SDIO_POWER_SMPC)
 132                         card->cccr.high_power = 1;
 133         }
 134
 135         if (cccr_vsn >= SDIO_CCCR_REV_1_20) {
 136                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &data);
 137                 if (ret)
 138                         goto out;
 139
 140                 if (data & SDIO_SPEED_SHS)
 141                         card->cccr.high_speed = 1;
 142         }
 143
 144 out:
 145         return ret;
 146 }
 147
 148 static int sdio_enable_wide(struct mmc_card *card)
 149 {
 150         int ret;
 151         u8 ctrl;
 152
 153         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
 154                 return 0;
 155
 156         if (card->cccr.low_speed && !card->cccr.wide_bus)
 157                 return 0;
 158
 159         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 160         if (ret)
 161                 return ret;
 162
 163         ctrl |= SDIO_BUS_WIDTH_4BIT;
 164
 165         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 166         if (ret)
 167                 return ret;
 168
 169         return 1;
 170 }
 171
 172 /*
 173  * If desired, disconnect the pull-up resistor on CD/DAT[3] (pin 1)
 174  * of the card. This may be required on certain setups of boards,
 175  * controllers and embedded sdio device which do not need the card's
 176  * pull-up. As a result, card detection is disabled and power is saved.
 177  */
 178 static int sdio_disable_cd(struct mmc_card *card)
 179 {
 180         int ret;
 181         u8 ctrl;
 182
 183         if (!card->cccr.disable_cd)
 184                 return 0;
 185
 186         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 187         if (ret)
 188                 return ret;
 189
 190         ctrl |= SDIO_BUS_CD_DISABLE;
 191
 192         return mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 193 }
 194
 195 /*
 196  * Devices that remain active during a system suspend are
 197  * put back into 1-bit mode.
 198  */
 199 static int sdio_disable_wide(struct mmc_card *card)
 200 {
 201         int ret;
 202         u8 ctrl;
 203
 204         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
 205                 return 0;
 206
 207         if (card->cccr.low_speed && !card->cccr.wide_bus)
 208                 return 0;
 209
 210         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 211         if (ret)
 212                 return ret;
 213
 214         if (!(ctrl & SDIO_BUS_WIDTH_4BIT))
 215                 return 0;
 216
 217         ctrl &= ~SDIO_BUS_WIDTH_4BIT;
 218         ctrl |= SDIO_BUS_ASYNC_INT;
 219
 220         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 221         if (ret)
 222                 return ret;
 223
 224         mmc_set_bus_width(card->host, MMC_BUS_WIDTH_1);
 225
 226         return 0;
 227 }
 228
 229
 230 static int sdio_enable_4bit_bus(struct mmc_card *card)
 231 {
 232         int err;
 233
 234         if (card->type == MMC_TYPE_SDIO)
 235                 return sdio_enable_wide(card);
 236
 237         if ((card->host->caps & MMC_CAP_4_BIT_DATA) &&
 238                 (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
 239                 err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
 240                 if (err)
 241                         return err;
 242         } else
 243                 return 0;
 244
 245         err = sdio_enable_wide(card);
 246         if (err <= 0)
 247                 mmc_app_set_bus_width(card, MMC_BUS_WIDTH_1);
 248
 249         return err;
 250 }
 251
 252
 253 /*
 254  * Test if the card supports high-speed mode and, if so, switch to it.
 255  */
 256 static int mmc_sdio_switch_hs(struct mmc_card *card, int enable)
 257 {
 258         int ret;
 259         u8 speed;
 260
 261         if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
 262                 return 0;
 263
 264         if (!card->cccr.high_speed)
 265                 return 0;
 266
 267         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
 268         if (ret)
 269                 return ret;
 270
 271         if (enable)
 272                 speed |= SDIO_SPEED_EHS;
 273         else
 274                 speed &= ~SDIO_SPEED_EHS;
 275
 276         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
 277         if (ret)
 278                 return ret;
 279
 280         return 1;
 281 }
 282
 283 /*
 284  * Enable SDIO/combo card's high-speed mode. Return 0/1 if [not]supported.
 285  */
 286 static int sdio_enable_hs(struct mmc_card *card)
 287 {
 288         int ret;
 289
 290         ret = mmc_sdio_switch_hs(card, true);
 291         if (ret <= 0 || card->type == MMC_TYPE_SDIO)
 292                 return ret;
 293
 294         ret = mmc_sd_switch_hs(card);
 295         if (ret <= 0)
 296                 mmc_sdio_switch_hs(card, false);
 297
 298         return ret;
 299 }
 300
 301 static unsigned mmc_sdio_get_max_clock(struct mmc_card *card)
 302 {
 303         unsigned max_dtr;
 304
 305         if (mmc_card_highspeed(card)) {
 306                 /*
 307                  * The SDIO specification doesn't mention how
 308                  * the CIS transfer speed register relates to
 309                  * high-speed, but it seems that 50 MHz is
 310                  * mandatory.
 311                  */
 312                 max_dtr = 50000000;
 313         } else {
 314                 max_dtr = card->cis.max_dtr;
 315         }
 316
 317         if (card->type == MMC_TYPE_SD_COMBO)
 318                 max_dtr = min(max_dtr, mmc_sd_get_max_clock(card));
 319
 320         return max_dtr;
 321 }
 322
 323 /*
 324  * Handle the detection and initialisation of a card.
 325  *
 326  * In the case of a resume, "oldcard" will contain the card
 327  * we're trying to reinitialise.
 328  */
 329 static int mmc_sdio_init_card(struct mmc_host *host, u32 ocr,
 330                               struct mmc_card *oldcard, int powered_resume)
 331 {
 332         struct mmc_card *card;
 333         int err;
 334
 335         BUG_ON(!host);
 336         WARN_ON(!host->claimed);
 337
 338         /*
 339          * Inform the card of the voltage
 340          */
 341         if (!powered_resume) {
 342                 err = mmc_send_io_op_cond(host, host->ocr, &ocr);
 343                 if (err)
 344                         goto err;
 345         }
 346
 347         /*
 348          * For SPI, enable CRC as appropriate.
 349          */
 350         if (mmc_host_is_spi(host)) {
 351                 err = mmc_spi_set_crc(host, use_spi_crc);
 352                 if (err)
 353                         goto err;
 354         }
 355
 356         /*
 357          * Allocate card structure.
 358          */
 359         card = mmc_alloc_card(host, NULL);
 360         if (IS_ERR(card)) {
 361                 err = PTR_ERR(card);
 362                 goto err;
 363         }
 364
 365         err = mmc_sd_get_cid(host, host->ocr & ocr, card->raw_cid);
 366
 367         if (!err) {
 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                 return 0;
 461         }
 462
 463         if (card->type == MMC_TYPE_SD_COMBO) {
 464                 err = mmc_sd_setup_card(host, card, oldcard != NULL);
 465                 /* handle as SDIO-only card if memory init failed */
 466                 if (err) {
 467                         mmc_go_idle(host);
 468                         if (mmc_host_is_spi(host))
 469                                 /* should not fail, as it worked previously */
 470                                 mmc_spi_set_crc(host, use_spi_crc);
 471                         card->type = MMC_TYPE_SDIO;
 472                 } else
 473                         card->dev.type = &sd_type;
 474         }
 475
 476         /*
 477          * If needed, disconnect card detection pull-up resistor.
 478          */
 479         err = sdio_disable_cd(card);
 480         if (err)
 481                 goto remove;
 482
 483         /*
 484          * Switch to high-speed (if supported).
 485          */
 486         err = sdio_enable_hs(card);
 487         if (err > 0)
 488                 mmc_sd_go_highspeed(card);
 489         else if (err)
 490                 goto remove;
 491
 492         /*
 493          * Change to the card's maximum speed.
 494          */
 495         mmc_set_clock(host, mmc_sdio_get_max_clock(card));
 496
 497         /*
 498          * Switch to wider bus (if supported).
 499          */
 500         err = sdio_enable_4bit_bus(card);
 501         if (err > 0)
 502                 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
 503         else if (err)
 504                 goto remove;
 505
 506 finish:
 507         if (!oldcard)
 508                 host->card = card;
 509         return 0;
 510
 511 remove:
 512         if (!oldcard)
 513                 mmc_remove_card(card);
 514
 515 err:
 516         return err;
 517 }
 518
 519 /*
 520  * Host is being removed. Free up the current card.
 521  */
 522 static void mmc_sdio_remove(struct mmc_host *host)
 523 {
 524         int i;
 525
 526         BUG_ON(!host);
 527         BUG_ON(!host->card);
 528
 529         for (i = 0;i < host->card->sdio_funcs;i++) {
 530                 if (host->card->sdio_func[i]) {
 531                         sdio_remove_func(host->card->sdio_func[i]);
 532                         host->card->sdio_func[i] = NULL;
 533                 }
 534         }
 535
 536         mmc_remove_card(host->card);
 537         host->card = NULL;
 538 }
 539
 540 /*
 541  * Card detection callback from host.
 542  */
 543 static void mmc_sdio_detect(struct mmc_host *host)
 544 {
 545         int err;
 546
 547         BUG_ON(!host);
 548         BUG_ON(!host->card);
 549
 550         mmc_claim_host(host);
 551
 552         /*
 553          * Just check if our card has been removed.
 554          */
 555         err = mmc_select_card(host->card);
 556
 557         mmc_release_host(host);
 558
 559         if (err) {
 560                 mmc_sdio_remove(host);
 561
 562                 mmc_claim_host(host);
 563                 mmc_detach_bus(host);
 564                 mmc_release_host(host);
 565         }
 566 }
 567
 568 /*
 569  * SDIO suspend.  We need to suspend all functions separately.
 570  * Therefore all registered functions must have drivers with suspend
 571  * and resume methods.  Failing that we simply remove the whole card.
 572  */
 573 static int mmc_sdio_suspend(struct mmc_host *host)
 574 {
 575         int i, err = 0;
 576
 577         for (i = 0; i < host->card->sdio_funcs; i++) {
 578                 struct sdio_func *func = host->card->sdio_func[i];
 579                 if (func && sdio_func_present(func) && func->dev.driver) {
 580                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
 581                         if (!pmops || !pmops->suspend || !pmops->resume) {
 582                                 /* force removal of entire card in that case */
 583                                 err = -ENOSYS;
 584                         } else
 585                                 err = pmops->suspend(&func->dev);
 586                         if (err)
 587                                 break;
 588                 }
 589         }
 590         while (err && --i >= 0) {
 591                 struct sdio_func *func = host->card->sdio_func[i];
 592                 if (func && sdio_func_present(func) && func->dev.driver) {
 593                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
 594                         pmops->resume(&func->dev);
 595                 }
 596         }
 597
 598         if (!err && host->pm_flags & MMC_PM_KEEP_POWER) {
 599                 mmc_claim_host(host);
 600                 sdio_disable_wide(host->card);
 601                 mmc_release_host(host);
 602         }
 603
 604         return err;
 605 }
 606
 607 static int mmc_sdio_resume(struct mmc_host *host)
 608 {
 609         int i, err;
 610
 611         BUG_ON(!host);
 612         BUG_ON(!host->card);
 613
 614         /* Basic card reinitialization. */
 615         mmc_claim_host(host);
 616         err = mmc_sdio_init_card(host, host->ocr, host->card,
 617                                  (host->pm_flags & MMC_PM_KEEP_POWER));
 618         if (!err) {
 619                 /* We may have switched to 1-bit mode during suspend. */
 620                 err = sdio_enable_4bit_bus(host->card);
 621                 if (err > 0) {
 622                         mmc_set_bus_width(host, MMC_BUS_WIDTH_4);
 623                         err = 0;
 624                 }
 625         }
 626         if (!err && host->sdio_irqs)
 627                 mmc_signal_sdio_irq(host);
 628         mmc_release_host(host);
 629
 630         /*
 631          * If the card looked to be the same as before suspending, then
 632          * we proceed to resume all card functions.  If one of them returns
 633          * an error then we simply return that error to the core and the
 634          * card will be redetected as new.  It is the responsibility of
 635          * the function driver to perform further tests with the extra
 636          * knowledge it has of the card to confirm the card is indeed the
 637          * same as before suspending (same MAC address for network cards,
 638          * etc.) and return an error otherwise.
 639          */
 640         for (i = 0; !err && i < host->card->sdio_funcs; i++) {
 641                 struct sdio_func *func = host->card->sdio_func[i];
 642                 if (func && sdio_func_present(func) && func->dev.driver) {
 643                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
 644                         err = pmops->resume(&func->dev);
 645                 }
 646         }
 647
 648         return err;
 649 }
 650
 651 static const struct mmc_bus_ops mmc_sdio_ops = {
 652         .remove = mmc_sdio_remove,
 653         .detect = mmc_sdio_detect,
 654         .suspend = mmc_sdio_suspend,
 655         .resume = mmc_sdio_resume,
 656 };
 657
 658
 659 /*
 660  * Starting point for SDIO card init.
 661  */
 662 int mmc_attach_sdio(struct mmc_host *host, u32 ocr)
 663 {
 664         int err;
 665         int i, funcs;
 666         struct mmc_card *card;
 667
 668         BUG_ON(!host);
 669         WARN_ON(!host->claimed);
 670
 671         mmc_attach_bus(host, &mmc_sdio_ops);
 672
 673         /*
 674          * Sanity check the voltages that the card claims to
 675          * support.
 676          */
 677         if (ocr & 0x7F) {
 678                 printk(KERN_WARNING "%s: card claims to support voltages "
 679                        "below the defined range. These will be ignored.\n",
 680                        mmc_hostname(host));
 681                 ocr &= ~0x7F;
 682         }
 683
 684         host->ocr = mmc_select_voltage(host, ocr);
 685
 686         /*
 687          * Can we support the voltage(s) of the card(s)?
 688          */
 689         if (!host->ocr) {
 690                 err = -EINVAL;
 691                 goto err;
 692         }
 693
 694         /*
 695          * Detect and init the card.
 696          */
 697         err = mmc_sdio_init_card(host, host->ocr, NULL, 0);
 698         if (err)
 699                 goto err;
 700         card = host->card;
 701
 702         /*
 703          * The number of functions on the card is encoded inside
 704          * the ocr.
 705          */
 706         funcs = (ocr & 0x70000000) >> 28;
 707         card->sdio_funcs = 0;
 708
 709         /*
 710          * Initialize (but don't add) all present functions.
 711          */
 712         for (i = 0; i < funcs; i++, card->sdio_funcs++) {
 713                 err = sdio_init_func(host->card, i + 1);
 714                 if (err)
 715                         goto remove;
 716         }
 717
 718         mmc_release_host(host);
 719
 720         /*
 721          * First add the card to the driver model...
 722          */
 723         err = mmc_add_card(host->card);
 724         if (err)
 725                 goto remove_added;
 726
 727         /*
 728          * ...then the SDIO functions.
 729          */
 730         for (i = 0;i < funcs;i++) {
 731                 err = sdio_add_func(host->card->sdio_func[i]);
 732                 if (err)
 733                         goto remove_added;
 734         }
 735
 736         return 0;
 737
 738
 739 remove_added:
 740         /* Remove without lock if the device has been added. */
 741         mmc_sdio_remove(host);
 742         mmc_claim_host(host);
 743 remove:
 744         /* And with lock if it hasn't been added. */
 745         if (host->card)
 746                 mmc_sdio_remove(host);
 747 err:
 748         mmc_detach_bus(host);
 749         mmc_release_host(host);
 750
 751         printk(KERN_ERR "%s: error %d whilst initialising SDIO card\n",
 752                 mmc_hostname(host), err);
 753
 754         return err;
 755 }
 756