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/mmc.h>
  18 #include <linux/mmc/sdio.h>
  19 #include <linux/mmc/sdio_func.h>
  20 #include <linux/mmc/sdio_ids.h>
  21
  22 #include "core.h"
  23 #include "card.h"
  24 #include "host.h"
  25 #include "bus.h"
  26 #include "quirks.h"
  27 #include "sd.h"
  28 #include "sdio_bus.h"
  29 #include "mmc_ops.h"
  30 #include "sd_ops.h"
  31 #include "sdio_ops.h"
  32 #include "sdio_cis.h"
  33
  34 static int sdio_read_fbr(struct sdio_func *func)
  35 {
  36         int ret;
  37         unsigned char data;
  38
  39         if (mmc_card_nonstd_func_interface(func->card)) {
  40                 func->class = SDIO_CLASS_NONE;
  41                 return 0;
  42         }
  43
  44         ret = mmc_io_rw_direct(func->card, 0, 0,
  45                 SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF, 0, &data);
  46         if (ret)
  47                 goto out;
  48
  49         data &= 0x0f;
  50
  51         if (data == 0x0f) {
  52                 ret = mmc_io_rw_direct(func->card, 0, 0,
  53                         SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF_EXT, 0, &data);
  54                 if (ret)
  55                         goto out;
  56         }
  57
  58         func->class = data;
  59
  60 out:
  61         return ret;
  62 }
  63
  64 static int sdio_init_func(struct mmc_card *card, unsigned int fn)
  65 {
  66         int ret;
  67         struct sdio_func *func;
  68
  69         if (WARN_ON(fn > SDIO_MAX_FUNCS))
  70                 return -EINVAL;
  71
  72         func = sdio_alloc_func(card);
  73         if (IS_ERR(func))
  74                 return PTR_ERR(func);
  75
  76         func->num = fn;
  77
  78         if (!(card->quirks & MMC_QUIRK_NONSTD_SDIO)) {
  79                 ret = sdio_read_fbr(func);
  80                 if (ret)
  81                         goto fail;
  82
  83                 ret = sdio_read_func_cis(func);
  84                 if (ret)
  85                         goto fail;
  86         } else {
  87                 func->vendor = func->card->cis.vendor;
  88                 func->device = func->card->cis.device;
  89                 func->max_blksize = func->card->cis.blksize;
  90         }
  91
  92         card->sdio_func[fn - 1] = func;
  93
  94         return 0;
  95
  96 fail:
  97         /*
  98          * It is okay to remove the function here even though we hold
  99          * the host lock as we haven't registered the device yet.
 100          */
 101         sdio_remove_func(func);
 102         return ret;
 103 }
 104
 105 static int sdio_read_cccr(struct mmc_card *card, u32 ocr)
 106 {
 107         int ret;
 108         int cccr_vsn;
 109         int uhs = ocr & R4_18V_PRESENT;
 110         unsigned char data;
 111         unsigned char speed;
 112
 113         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CCCR, 0, &data);
 114         if (ret)
 115                 goto out;
 116
 117         cccr_vsn = data & 0x0f;
 118
 119         if (cccr_vsn > SDIO_CCCR_REV_3_00) {
 120                 pr_err("%s: unrecognised CCCR structure version %d\n",
 121                         mmc_hostname(card->host), cccr_vsn);
 122                 return -EINVAL;
 123         }
 124
 125         card->cccr.sdio_vsn = (data & 0xf0) >> 4;
 126
 127         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CAPS, 0, &data);
 128         if (ret)
 129                 goto out;
 130
 131         if (data & SDIO_CCCR_CAP_SMB)
 132                 card->cccr.multi_block = 1;
 133         if (data & SDIO_CCCR_CAP_LSC)
 134                 card->cccr.low_speed = 1;
 135         if (data & SDIO_CCCR_CAP_4BLS)
 136                 card->cccr.wide_bus = 1;
 137
 138         if (cccr_vsn >= SDIO_CCCR_REV_1_10) {
 139                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_POWER, 0, &data);
 140                 if (ret)
 141                         goto out;
 142
 143                 if (data & SDIO_POWER_SMPC)
 144                         card->cccr.high_power = 1;
 145         }
 146
 147         if (cccr_vsn >= SDIO_CCCR_REV_1_20) {
 148                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
 149                 if (ret)
 150                         goto out;
 151
 152                 card->scr.sda_spec3 = 0;
 153                 card->sw_caps.sd3_bus_mode = 0;
 154                 card->sw_caps.sd3_drv_type = 0;
 155                 if (cccr_vsn >= SDIO_CCCR_REV_3_00 && uhs) {
 156                         card->scr.sda_spec3 = 1;
 157                         ret = mmc_io_rw_direct(card, 0, 0,
 158                                 SDIO_CCCR_UHS, 0, &data);
 159                         if (ret)
 160                                 goto out;
 161
 162                         if (mmc_host_uhs(card->host)) {
 163                                 if (data & SDIO_UHS_DDR50)
 164                                         card->sw_caps.sd3_bus_mode
 165                                                 |= SD_MODE_UHS_DDR50;
 166
 167                                 if (data & SDIO_UHS_SDR50)
 168                                         card->sw_caps.sd3_bus_mode
 169                                                 |= SD_MODE_UHS_SDR50;
 170
 171                                 if (data & SDIO_UHS_SDR104)
 172                                         card->sw_caps.sd3_bus_mode
 173                                                 |= SD_MODE_UHS_SDR104;
 174                         }
 175
 176                         ret = mmc_io_rw_direct(card, 0, 0,
 177                                 SDIO_CCCR_DRIVE_STRENGTH, 0, &data);
 178                         if (ret)
 179                                 goto out;
 180
 181                         if (data & SDIO_DRIVE_SDTA)
 182                                 card->sw_caps.sd3_drv_type |= SD_DRIVER_TYPE_A;
 183                         if (data & SDIO_DRIVE_SDTC)
 184                                 card->sw_caps.sd3_drv_type |= SD_DRIVER_TYPE_C;
 185                         if (data & SDIO_DRIVE_SDTD)
 186                                 card->sw_caps.sd3_drv_type |= SD_DRIVER_TYPE_D;
 187                 }
 188
 189                 /* if no uhs mode ensure we check for high speed */
 190                 if (!card->sw_caps.sd3_bus_mode) {
 191                         if (speed & SDIO_SPEED_SHS) {
 192                                 card->cccr.high_speed = 1;
 193                                 card->sw_caps.hs_max_dtr = 50000000;
 194                         } else {
 195                                 card->cccr.high_speed = 0;
 196                                 card->sw_caps.hs_max_dtr = 25000000;
 197                         }
 198                 }
 199         }
 200
 201 out:
 202         return ret;
 203 }
 204
 205 static int sdio_enable_wide(struct mmc_card *card)
 206 {
 207         int ret;
 208         u8 ctrl;
 209
 210         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
 211                 return 0;
 212
 213         if (card->cccr.low_speed && !card->cccr.wide_bus)
 214                 return 0;
 215
 216         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 217         if (ret)
 218                 return ret;
 219
 220         if ((ctrl & SDIO_BUS_WIDTH_MASK) == SDIO_BUS_WIDTH_RESERVED)
 221                 pr_warn("%s: SDIO_CCCR_IF is invalid: 0x%02x\n",
 222                         mmc_hostname(card->host), ctrl);
 223
 224         /* set as 4-bit bus width */
 225         ctrl &= ~SDIO_BUS_WIDTH_MASK;
 226         ctrl |= SDIO_BUS_WIDTH_4BIT;
 227
 228         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 229         if (ret)
 230                 return ret;
 231
 232         return 1;
 233 }
 234
 235 /*
 236  * If desired, disconnect the pull-up resistor on CD/DAT[3] (pin 1)
 237  * of the card. This may be required on certain setups of boards,
 238  * controllers and embedded sdio device which do not need the card's
 239  * pull-up. As a result, card detection is disabled and power is saved.
 240  */
 241 static int sdio_disable_cd(struct mmc_card *card)
 242 {
 243         int ret;
 244         u8 ctrl;
 245
 246         if (!mmc_card_disable_cd(card))
 247                 return 0;
 248
 249         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 250         if (ret)
 251                 return ret;
 252
 253         ctrl |= SDIO_BUS_CD_DISABLE;
 254
 255         return mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 256 }
 257
 258 /*
 259  * Devices that remain active during a system suspend are
 260  * put back into 1-bit mode.
 261  */
 262 static int sdio_disable_wide(struct mmc_card *card)
 263 {
 264         int ret;
 265         u8 ctrl;
 266
 267         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
 268                 return 0;
 269
 270         if (card->cccr.low_speed && !card->cccr.wide_bus)
 271                 return 0;
 272
 273         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 274         if (ret)
 275                 return ret;
 276
 277         if (!(ctrl & SDIO_BUS_WIDTH_4BIT))
 278                 return 0;
 279
 280         ctrl &= ~SDIO_BUS_WIDTH_4BIT;
 281         ctrl |= SDIO_BUS_ASYNC_INT;
 282
 283         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 284         if (ret)
 285                 return ret;
 286
 287         mmc_set_bus_width(card->host, MMC_BUS_WIDTH_1);
 288
 289         return 0;
 290 }
 291
 292
 293 static int sdio_enable_4bit_bus(struct mmc_card *card)
 294 {
 295         int err;
 296
 297         if (card->type == MMC_TYPE_SDIO)
 298                 err = sdio_enable_wide(card);
 299         else if ((card->host->caps & MMC_CAP_4_BIT_DATA) &&
 300                  (card->scr.bus_widths & SD_SCR_BUS_WIDTH_4)) {
 301                 err = mmc_app_set_bus_width(card, MMC_BUS_WIDTH_4);
 302                 if (err)
 303                         return err;
 304                 err = sdio_enable_wide(card);
 305                 if (err <= 0)
 306                         mmc_app_set_bus_width(card, MMC_BUS_WIDTH_1);
 307         } else
 308                 return 0;
 309
 310         if (err > 0) {
 311                 mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
 312                 err = 0;
 313         }
 314
 315         return err;
 316 }
 317
 318
 319 /*
 320  * Test if the card supports high-speed mode and, if so, switch to it.
 321  */
 322 static int mmc_sdio_switch_hs(struct mmc_card *card, int enable)
 323 {
 324         int ret;
 325         u8 speed;
 326
 327         if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
 328                 return 0;
 329
 330         if (!card->cccr.high_speed)
 331                 return 0;
 332
 333         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
 334         if (ret)
 335                 return ret;
 336
 337         if (enable)
 338                 speed |= SDIO_SPEED_EHS;
 339         else
 340                 speed &= ~SDIO_SPEED_EHS;
 341
 342         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
 343         if (ret)
 344                 return ret;
 345
 346         return 1;
 347 }
 348
 349 /*
 350  * Enable SDIO/combo card's high-speed mode. Return 0/1 if [not]supported.
 351  */
 352 static int sdio_enable_hs(struct mmc_card *card)
 353 {
 354         int ret;
 355
 356         ret = mmc_sdio_switch_hs(card, true);
 357         if (ret <= 0 || card->type == MMC_TYPE_SDIO)
 358                 return ret;
 359
 360         ret = mmc_sd_switch_hs(card);
 361         if (ret <= 0)
 362                 mmc_sdio_switch_hs(card, false);
 363
 364         return ret;
 365 }
 366
 367 static unsigned mmc_sdio_get_max_clock(struct mmc_card *card)
 368 {
 369         unsigned max_dtr;
 370
 371         if (mmc_card_hs(card)) {
 372                 /*
 373                  * The SDIO specification doesn't mention how
 374                  * the CIS transfer speed register relates to
 375                  * high-speed, but it seems that 50 MHz is
 376                  * mandatory.
 377                  */
 378                 max_dtr = 50000000;
 379         } else {
 380                 max_dtr = card->cis.max_dtr;
 381         }
 382
 383         if (card->type == MMC_TYPE_SD_COMBO)
 384                 max_dtr = min(max_dtr, mmc_sd_get_max_clock(card));
 385
 386         return max_dtr;
 387 }
 388
 389 static unsigned char host_drive_to_sdio_drive(int host_strength)
 390 {
 391         switch (host_strength) {
 392         case MMC_SET_DRIVER_TYPE_A:
 393                 return SDIO_DTSx_SET_TYPE_A;
 394         case MMC_SET_DRIVER_TYPE_B:
 395                 return SDIO_DTSx_SET_TYPE_B;
 396         case MMC_SET_DRIVER_TYPE_C:
 397                 return SDIO_DTSx_SET_TYPE_C;
 398         case MMC_SET_DRIVER_TYPE_D:
 399                 return SDIO_DTSx_SET_TYPE_D;
 400         default:
 401                 return SDIO_DTSx_SET_TYPE_B;
 402         }
 403 }
 404
 405 static void sdio_select_driver_type(struct mmc_card *card)
 406 {
 407         int card_drv_type, drive_strength, drv_type;
 408         unsigned char card_strength;
 409         int err;
 410
 411         card->drive_strength = 0;
 412
 413         card_drv_type = card->sw_caps.sd3_drv_type | SD_DRIVER_TYPE_B;
 414
 415         drive_strength = mmc_select_drive_strength(card,
 416                                                    card->sw_caps.uhs_max_dtr,
 417                                                    card_drv_type, &drv_type);
 418
 419         if (drive_strength) {
 420                 /* if error just use default for drive strength B */
 421                 err = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_DRIVE_STRENGTH, 0,
 422                                        &card_strength);
 423                 if (err)
 424                         return;
 425
 426                 card_strength &= ~(SDIO_DRIVE_DTSx_MASK<<SDIO_DRIVE_DTSx_SHIFT);
 427                 card_strength |= host_drive_to_sdio_drive(drive_strength);
 428
 429                 /* if error default to drive strength B */
 430                 err = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_DRIVE_STRENGTH,
 431                                        card_strength, NULL);
 432                 if (err)
 433                         return;
 434                 card->drive_strength = drive_strength;
 435         }
 436
 437         if (drv_type)
 438                 mmc_set_driver_type(card->host, drv_type);
 439 }
 440
 441
 442 static int sdio_set_bus_speed_mode(struct mmc_card *card)
 443 {
 444         unsigned int bus_speed, timing;
 445         int err;
 446         unsigned char speed;
 447         unsigned int max_rate;
 448
 449         /*
 450          * If the host doesn't support any of the UHS-I modes, fallback on
 451          * default speed.
 452          */
 453         if (!mmc_host_uhs(card->host))
 454                 return 0;
 455
 456         bus_speed = SDIO_SPEED_SDR12;
 457         timing = MMC_TIMING_UHS_SDR12;
 458         if ((card->host->caps & MMC_CAP_UHS_SDR104) &&
 459             (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR104)) {
 460                         bus_speed = SDIO_SPEED_SDR104;
 461                         timing = MMC_TIMING_UHS_SDR104;
 462                         card->sw_caps.uhs_max_dtr = UHS_SDR104_MAX_DTR;
 463                         card->sd_bus_speed = UHS_SDR104_BUS_SPEED;
 464         } else if ((card->host->caps & MMC_CAP_UHS_DDR50) &&
 465                    (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_DDR50)) {
 466                         bus_speed = SDIO_SPEED_DDR50;
 467                         timing = MMC_TIMING_UHS_DDR50;
 468                         card->sw_caps.uhs_max_dtr = UHS_DDR50_MAX_DTR;
 469                         card->sd_bus_speed = UHS_DDR50_BUS_SPEED;
 470         } else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
 471                     MMC_CAP_UHS_SDR50)) && (card->sw_caps.sd3_bus_mode &
 472                     SD_MODE_UHS_SDR50)) {
 473                         bus_speed = SDIO_SPEED_SDR50;
 474                         timing = MMC_TIMING_UHS_SDR50;
 475                         card->sw_caps.uhs_max_dtr = UHS_SDR50_MAX_DTR;
 476                         card->sd_bus_speed = UHS_SDR50_BUS_SPEED;
 477         } else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
 478                     MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25)) &&
 479                    (card->sw_caps.sd3_bus_mode & SD_MODE_UHS_SDR25)) {
 480                         bus_speed = SDIO_SPEED_SDR25;
 481                         timing = MMC_TIMING_UHS_SDR25;
 482                         card->sw_caps.uhs_max_dtr = UHS_SDR25_MAX_DTR;
 483                         card->sd_bus_speed = UHS_SDR25_BUS_SPEED;
 484         } else if ((card->host->caps & (MMC_CAP_UHS_SDR104 |
 485                     MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR25 |
 486                     MMC_CAP_UHS_SDR12)) && (card->sw_caps.sd3_bus_mode &
 487                     SD_MODE_UHS_SDR12)) {
 488                         bus_speed = SDIO_SPEED_SDR12;
 489                         timing = MMC_TIMING_UHS_SDR12;
 490                         card->sw_caps.uhs_max_dtr = UHS_SDR12_MAX_DTR;
 491                         card->sd_bus_speed = UHS_SDR12_BUS_SPEED;
 492         }
 493
 494         err = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
 495         if (err)
 496                 return err;
 497
 498         speed &= ~SDIO_SPEED_BSS_MASK;
 499         speed |= bus_speed;
 500         err = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
 501         if (err)
 502                 return err;
 503
 504         max_rate = min_not_zero(card->quirk_max_rate,
 505                                 card->sw_caps.uhs_max_dtr);
 506
 507         if (bus_speed) {
 508                 mmc_set_timing(card->host, timing);
 509                 mmc_set_clock(card->host, max_rate);
 510         }
 511
 512         return 0;
 513 }
 514
 515 /*
 516  * UHS-I specific initialization procedure
 517  */
 518 static int mmc_sdio_init_uhs_card(struct mmc_card *card)
 519 {
 520         int err;
 521
 522         if (!card->scr.sda_spec3)
 523                 return 0;
 524
 525         /* Switch to wider bus */
 526         err = sdio_enable_4bit_bus(card);
 527         if (err)
 528                 goto out;
 529
 530         /* Set the driver strength for the card */
 531         sdio_select_driver_type(card);
 532
 533         /* Set bus speed mode of the card */
 534         err = sdio_set_bus_speed_mode(card);
 535         if (err)
 536                 goto out;
 537
 538         /*
 539          * SPI mode doesn't define CMD19 and tuning is only valid for SDR50 and
 540          * SDR104 mode SD-cards. Note that tuning is mandatory for SDR104.
 541          */
 542         if (!mmc_host_is_spi(card->host) &&
 543             ((card->host->ios.timing == MMC_TIMING_UHS_SDR50) ||
 544               (card->host->ios.timing == MMC_TIMING_UHS_SDR104)))
 545                 err = mmc_execute_tuning(card);
 546 out:
 547         return err;
 548 }
 549
 550 static void mmc_sdio_resend_if_cond(struct mmc_host *host,
 551                                     struct mmc_card *card)
 552 {
 553         sdio_reset(host);
 554         mmc_go_idle(host);
 555         mmc_send_if_cond(host, host->ocr_avail);
 556         mmc_remove_card(card);
 557 }
 558
 559 /*
 560  * Handle the detection and initialisation of a card.
 561  *
 562  * In the case of a resume, "oldcard" will contain the card
 563  * we're trying to reinitialise.
 564  */
 565 static int mmc_sdio_init_card(struct mmc_host *host, u32 ocr,
 566                               struct mmc_card *oldcard, int powered_resume)
 567 {
 568         struct mmc_card *card;
 569         int err;
 570         int retries = 10;
 571         u32 rocr = 0;
 572         u32 ocr_card = ocr;
 573
 574         WARN_ON(!host->claimed);
 575
 576         /* to query card if 1.8V signalling is supported */
 577         if (mmc_host_uhs(host))
 578                 ocr |= R4_18V_PRESENT;
 579
 580 try_again:
 581         if (!retries) {
 582                 pr_warn("%s: Skipping voltage switch\n", mmc_hostname(host));
 583                 ocr &= ~R4_18V_PRESENT;
 584         }
 585
 586         /*
 587          * Inform the card of the voltage
 588          */
 589         if (!powered_resume) {
 590                 err = mmc_send_io_op_cond(host, ocr, &rocr);
 591                 if (err)
 592                         goto err;
 593         }
 594
 595         /*
 596          * For SPI, enable CRC as appropriate.
 597          */
 598         if (mmc_host_is_spi(host)) {
 599                 err = mmc_spi_set_crc(host, use_spi_crc);
 600                 if (err)
 601                         goto err;
 602         }
 603
 604         /*
 605          * Allocate card structure.
 606          */
 607         card = mmc_alloc_card(host, NULL);
 608         if (IS_ERR(card)) {
 609                 err = PTR_ERR(card);
 610                 goto err;
 611         }
 612
 613         if ((rocr & R4_MEMORY_PRESENT) &&
 614             mmc_sd_get_cid(host, ocr & rocr, card->raw_cid, NULL) == 0) {
 615                 card->type = MMC_TYPE_SD_COMBO;
 616
 617                 if (oldcard && (oldcard->type != MMC_TYPE_SD_COMBO ||
 618                     memcmp(card->raw_cid, oldcard->raw_cid, sizeof(card->raw_cid)) != 0)) {
 619                         mmc_remove_card(card);
 620                         pr_debug("%s: Perhaps the card was replaced\n",
 621                                 mmc_hostname(host));
 622                         return -ENOENT;
 623                 }
 624         } else {
 625                 card->type = MMC_TYPE_SDIO;
 626
 627                 if (oldcard && oldcard->type != MMC_TYPE_SDIO) {
 628                         mmc_remove_card(card);
 629                         pr_debug("%s: Perhaps the card was replaced\n",
 630                                 mmc_hostname(host));
 631                         return -ENOENT;
 632                 }
 633         }
 634
 635         /*
 636          * Call the optional HC's init_card function to handle quirks.
 637          */
 638         if (host->ops->init_card)
 639                 host->ops->init_card(host, card);
 640
 641         /*
 642          * If the host and card support UHS-I mode request the card
 643          * to switch to 1.8V signaling level.  No 1.8v signalling if
 644          * UHS mode is not enabled to maintain compatibility and some
 645          * systems that claim 1.8v signalling in fact do not support
 646          * it. Per SDIO spec v3, section 3.1.2, if the voltage is already
 647          * 1.8v, the card sets S18A to 0 in the R4 response. So it will
 648          * fails to check rocr & R4_18V_PRESENT,  but we still need to
 649          * try to init uhs card. sdio_read_cccr will take over this task
 650          * to make sure which speed mode should work.
 651          */
 652         if (!powered_resume && (rocr & ocr & R4_18V_PRESENT)) {
 653                 err = mmc_set_uhs_voltage(host, ocr_card);
 654                 if (err == -EAGAIN) {
 655                         mmc_sdio_resend_if_cond(host, card);
 656                         retries--;
 657                         goto try_again;
 658                 } else if (err) {
 659                         ocr &= ~R4_18V_PRESENT;
 660                 }
 661         }
 662
 663         /*
 664          * For native busses:  set card RCA and quit open drain mode.
 665          */
 666         if (!powered_resume && !mmc_host_is_spi(host)) {
 667                 err = mmc_send_relative_addr(host, &card->rca);
 668                 if (err)
 669                         goto remove;
 670
 671                 /*
 672                  * Update oldcard with the new RCA received from the SDIO
 673                  * device -- we're doing this so that it's updated in the
 674                  * "card" struct when oldcard overwrites that later.
 675                  */
 676                 if (oldcard)
 677                         oldcard->rca = card->rca;
 678         }
 679
 680         /*
 681          * Read CSD, before selecting the card
 682          */
 683         if (!oldcard && card->type == MMC_TYPE_SD_COMBO) {
 684                 err = mmc_sd_get_csd(host, card);
 685                 if (err)
 686                         return err;
 687
 688                 mmc_decode_cid(card);
 689         }
 690
 691         /*
 692          * Select card, as all following commands rely on that.
 693          */
 694         if (!powered_resume && !mmc_host_is_spi(host)) {
 695                 err = mmc_select_card(card);
 696                 if (err)
 697                         goto remove;
 698         }
 699
 700         if (card->quirks & MMC_QUIRK_NONSTD_SDIO) {
 701                 /*
 702                  * This is non-standard SDIO device, meaning it doesn't
 703                  * have any CIA (Common I/O area) registers present.
 704                  * It's host's responsibility to fill cccr and cis
 705                  * structures in init_card().
 706                  */
 707                 mmc_set_clock(host, card->cis.max_dtr);
 708
 709                 if (card->cccr.high_speed) {
 710                         mmc_set_timing(card->host, MMC_TIMING_SD_HS);
 711                 }
 712
 713                 goto finish;
 714         }
 715
 716         /*
 717          * Read the common registers. Note that we should try to
 718          * validate whether UHS would work or not.
 719          */
 720         err = sdio_read_cccr(card, ocr);
 721         if (err) {
 722                 mmc_sdio_resend_if_cond(host, card);
 723                 if (ocr & R4_18V_PRESENT) {
 724                         /* Retry init sequence, but without R4_18V_PRESENT. */
 725                         retries = 0;
 726                         goto try_again;
 727                 } else {
 728                         goto remove;
 729                 }
 730         }
 731
 732         /*
 733          * Read the common CIS tuples.
 734          */
 735         err = sdio_read_common_cis(card);
 736         if (err)
 737                 goto remove;
 738
 739         if (oldcard) {
 740                 int same = (card->cis.vendor == oldcard->cis.vendor &&
 741                             card->cis.device == oldcard->cis.device);
 742                 mmc_remove_card(card);
 743                 if (!same) {
 744                         pr_debug("%s: Perhaps the card was replaced\n",
 745                                 mmc_hostname(host));
 746                         return -ENOENT;
 747                 }
 748
 749                 card = oldcard;
 750         }
 751         card->ocr = ocr_card;
 752         mmc_fixup_device(card, sdio_fixup_methods);
 753
 754         if (card->type == MMC_TYPE_SD_COMBO) {
 755                 err = mmc_sd_setup_card(host, card, oldcard != NULL);
 756                 /* handle as SDIO-only card if memory init failed */
 757                 if (err) {
 758                         mmc_go_idle(host);
 759                         if (mmc_host_is_spi(host))
 760                                 /* should not fail, as it worked previously */
 761                                 mmc_spi_set_crc(host, use_spi_crc);
 762                         card->type = MMC_TYPE_SDIO;
 763                 } else
 764                         card->dev.type = &sd_type;
 765         }
 766
 767         /*
 768          * If needed, disconnect card detection pull-up resistor.
 769          */
 770         err = sdio_disable_cd(card);
 771         if (err)
 772                 goto remove;
 773
 774         /* Initialization sequence for UHS-I cards */
 775         /* Only if card supports 1.8v and UHS signaling */
 776         if ((ocr & R4_18V_PRESENT) && card->sw_caps.sd3_bus_mode) {
 777                 err = mmc_sdio_init_uhs_card(card);
 778                 if (err)
 779                         goto remove;
 780         } else {
 781                 /*
 782                  * Switch to high-speed (if supported).
 783                  */
 784                 err = sdio_enable_hs(card);
 785                 if (err > 0)
 786                         mmc_set_timing(card->host, MMC_TIMING_SD_HS);
 787                 else if (err)
 788                         goto remove;
 789
 790                 /*
 791                  * Change to the card's maximum speed.
 792                  */
 793                 mmc_set_clock(host, mmc_sdio_get_max_clock(card));
 794
 795                 /*
 796                  * Switch to wider bus (if supported).
 797                  */
 798                 err = sdio_enable_4bit_bus(card);
 799                 if (err)
 800                         goto remove;
 801         }
 802
 803         if (host->caps2 & MMC_CAP2_AVOID_3_3V &&
 804             host->ios.signal_voltage == MMC_SIGNAL_VOLTAGE_330) {
 805                 pr_err("%s: Host failed to negotiate down from 3.3V\n",
 806                         mmc_hostname(host));
 807                 err = -EINVAL;
 808                 goto remove;
 809         }
 810 finish:
 811         if (!oldcard)
 812                 host->card = card;
 813         return 0;
 814
 815 remove:
 816         if (!oldcard)
 817                 mmc_remove_card(card);
 818
 819 err:
 820         return err;
 821 }
 822
 823 static int mmc_sdio_reinit_card(struct mmc_host *host, bool powered_resume)
 824 {
 825         int ret;
 826
 827         sdio_reset(host);
 828         mmc_go_idle(host);
 829         mmc_send_if_cond(host, host->card->ocr);
 830
 831         ret = mmc_send_io_op_cond(host, 0, NULL);
 832         if (ret)
 833                 return ret;
 834
 835         return mmc_sdio_init_card(host, host->card->ocr, host->card,
 836                                   powered_resume);
 837 }
 838
 839 /*
 840  * Host is being removed. Free up the current card.
 841  */
 842 static void mmc_sdio_remove(struct mmc_host *host)
 843 {
 844         int i;
 845
 846         for (i = 0;i < host->card->sdio_funcs;i++) {
 847                 if (host->card->sdio_func[i]) {
 848                         sdio_remove_func(host->card->sdio_func[i]);
 849                         host->card->sdio_func[i] = NULL;
 850                 }
 851         }
 852
 853         mmc_remove_card(host->card);
 854         host->card = NULL;
 855 }
 856
 857 /*
 858  * Card detection - card is alive.
 859  */
 860 static int mmc_sdio_alive(struct mmc_host *host)
 861 {
 862         return mmc_select_card(host->card);
 863 }
 864
 865 /*
 866  * Card detection callback from host.
 867  */
 868 static void mmc_sdio_detect(struct mmc_host *host)
 869 {
 870         int err;
 871
 872         /* Make sure card is powered before detecting it */
 873         if (host->caps & MMC_CAP_POWER_OFF_CARD) {
 874                 err = pm_runtime_get_sync(&host->card->dev);
 875                 if (err < 0) {
 876                         pm_runtime_put_noidle(&host->card->dev);
 877                         goto out;
 878                 }
 879         }
 880
 881         mmc_claim_host(host);
 882
 883         /*
 884          * Just check if our card has been removed.
 885          */
 886         err = _mmc_detect_card_removed(host);
 887
 888         mmc_release_host(host);
 889
 890         /*
 891          * Tell PM core it's OK to power off the card now.
 892          *
 893          * The _sync variant is used in order to ensure that the card
 894          * is left powered off in case an error occurred, and the card
 895          * is going to be removed.
 896          *
 897          * Since there is no specific reason to believe a new user
 898          * is about to show up at this point, the _sync variant is
 899          * desirable anyway.
 900          */
 901         if (host->caps & MMC_CAP_POWER_OFF_CARD)
 902                 pm_runtime_put_sync(&host->card->dev);
 903
 904 out:
 905         if (err) {
 906                 mmc_sdio_remove(host);
 907
 908                 mmc_claim_host(host);
 909                 mmc_detach_bus(host);
 910                 mmc_power_off(host);
 911                 mmc_release_host(host);
 912         }
 913 }
 914
 915 /*
 916  * SDIO pre_suspend.  We need to suspend all functions separately.
 917  * Therefore all registered functions must have drivers with suspend
 918  * and resume methods.  Failing that we simply remove the whole card.
 919  */
 920 static int mmc_sdio_pre_suspend(struct mmc_host *host)
 921 {
 922         int i, err = 0;
 923
 924         for (i = 0; i < host->card->sdio_funcs; i++) {
 925                 struct sdio_func *func = host->card->sdio_func[i];
 926                 if (func && sdio_func_present(func) && func->dev.driver) {
 927                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
 928                         if (!pmops || !pmops->suspend || !pmops->resume) {
 929                                 /* force removal of entire card in that case */
 930                                 err = -ENOSYS;
 931                                 break;
 932                         }
 933                 }
 934         }
 935
 936         return err;
 937 }
 938
 939 /*
 940  * SDIO suspend.  Suspend all functions separately.
 941  */
 942 static int mmc_sdio_suspend(struct mmc_host *host)
 943 {
 944         mmc_claim_host(host);
 945
 946         if (mmc_card_keep_power(host) && mmc_card_wake_sdio_irq(host))
 947                 sdio_disable_wide(host->card);
 948
 949         if (!mmc_card_keep_power(host)) {
 950                 mmc_power_off(host);
 951         } else if (host->retune_period) {
 952                 mmc_retune_timer_stop(host);
 953                 mmc_retune_needed(host);
 954         }
 955
 956         mmc_release_host(host);
 957
 958         return 0;
 959 }
 960
 961 static int mmc_sdio_resume(struct mmc_host *host)
 962 {
 963         int err = 0;
 964
 965         /* Basic card reinitialization. */
 966         mmc_claim_host(host);
 967
 968         /* Restore power if needed */
 969         if (!mmc_card_keep_power(host)) {
 970                 mmc_power_up(host, host->card->ocr);
 971                 /*
 972                  * Tell runtime PM core we just powered up the card,
 973                  * since it still believes the card is powered off.
 974                  * Note that currently runtime PM is only enabled
 975                  * for SDIO cards that are MMC_CAP_POWER_OFF_CARD
 976                  */
 977                 if (host->caps & MMC_CAP_POWER_OFF_CARD) {
 978                         pm_runtime_disable(&host->card->dev);
 979                         pm_runtime_set_active(&host->card->dev);
 980                         pm_runtime_enable(&host->card->dev);
 981                 }
 982         }
 983
 984         /* No need to reinitialize powered-resumed nonremovable cards */
 985         if (mmc_card_is_removable(host) || !mmc_card_keep_power(host)) {
 986                 err = mmc_sdio_reinit_card(host, mmc_card_keep_power(host));
 987         } else if (mmc_card_keep_power(host) && mmc_card_wake_sdio_irq(host)) {
 988                 /* We may have switched to 1-bit mode during suspend */
 989                 err = sdio_enable_4bit_bus(host->card);
 990         }
 991
 992         if (!err && host->sdio_irqs) {
 993                 if (!(host->caps2 & MMC_CAP2_SDIO_IRQ_NOTHREAD))
 994                         wake_up_process(host->sdio_irq_thread);
 995                 else if (host->caps & MMC_CAP_SDIO_IRQ)
 996                         host->ops->enable_sdio_irq(host, 1);
 997         }
 998
 999         mmc_release_host(host);
1000
1001         host->pm_flags &= ~MMC_PM_KEEP_POWER;
1002         return err;
1003 }
1004
1005 static int mmc_sdio_power_restore(struct mmc_host *host)
1006 {
1007         int ret;
1008
1009         /*
1010          * Reset the card by performing the same steps that are taken by
1011          * mmc_rescan_try_freq() and mmc_attach_sdio() during a "normal" probe.
1012          *
1013          * sdio_reset() is technically not needed. Having just powered up the
1014          * hardware, it should already be in reset state. However, some
1015          * platforms (such as SD8686 on OLPC) do not instantly cut power,
1016          * meaning that a reset is required when restoring power soon after
1017          * powering off. It is harmless in other cases.
1018          *
1019          * The CMD5 reset (mmc_send_io_op_cond()), according to the SDIO spec,
1020          * is not necessary for non-removable cards. However, it is required
1021          * for OLPC SD8686 (which expects a [CMD5,5,3,7] init sequence), and
1022          * harmless in other situations.
1023          *
1024          */
1025
1026         mmc_claim_host(host);
1027
1028         ret = mmc_sdio_reinit_card(host, mmc_card_keep_power(host));
1029         if (!ret && host->sdio_irqs)
1030                 mmc_signal_sdio_irq(host);
1031
1032         mmc_release_host(host);
1033
1034         return ret;
1035 }
1036
1037 static int mmc_sdio_runtime_suspend(struct mmc_host *host)
1038 {
1039         /* No references to the card, cut the power to it. */
1040         mmc_claim_host(host);
1041         mmc_power_off(host);
1042         mmc_release_host(host);
1043
1044         return 0;
1045 }
1046
1047 static int mmc_sdio_runtime_resume(struct mmc_host *host)
1048 {
1049         int ret;
1050
1051         /* Restore power and re-initialize. */
1052         mmc_claim_host(host);
1053         mmc_power_up(host, host->card->ocr);
1054         ret = mmc_sdio_power_restore(host);
1055         mmc_release_host(host);
1056
1057         return ret;
1058 }
1059
1060 static int mmc_sdio_hw_reset(struct mmc_host *host)
1061 {
1062         mmc_power_cycle(host, host->card->ocr);
1063         return mmc_sdio_power_restore(host);
1064 }
1065
1066 static int mmc_sdio_sw_reset(struct mmc_host *host)
1067 {
1068         mmc_set_clock(host, host->f_init);
1069         sdio_reset(host);
1070         mmc_go_idle(host);
1071
1072         mmc_set_initial_state(host);
1073         mmc_set_initial_signal_voltage(host);
1074
1075         return mmc_sdio_reinit_card(host, 0);
1076 }
1077
1078 static const struct mmc_bus_ops mmc_sdio_ops = {
1079         .remove = mmc_sdio_remove,
1080         .detect = mmc_sdio_detect,
1081         .pre_suspend = mmc_sdio_pre_suspend,
1082         .suspend = mmc_sdio_suspend,
1083         .resume = mmc_sdio_resume,
1084         .runtime_suspend = mmc_sdio_runtime_suspend,
1085         .runtime_resume = mmc_sdio_runtime_resume,
1086         .alive = mmc_sdio_alive,
1087         .hw_reset = mmc_sdio_hw_reset,
1088         .sw_reset = mmc_sdio_sw_reset,
1089 };
1090
1091
1092 /*
1093  * Starting point for SDIO card init.
1094  */
1095 int mmc_attach_sdio(struct mmc_host *host)
1096 {
1097         int err, i, funcs;
1098         u32 ocr, rocr;
1099         struct mmc_card *card;
1100
1101         WARN_ON(!host->claimed);
1102
1103         err = mmc_send_io_op_cond(host, 0, &ocr);
1104         if (err)
1105                 return err;
1106
1107         mmc_attach_bus(host, &mmc_sdio_ops);
1108         if (host->ocr_avail_sdio)
1109                 host->ocr_avail = host->ocr_avail_sdio;
1110
1111
1112         rocr = mmc_select_voltage(host, ocr);
1113
1114         /*
1115          * Can we support the voltage(s) of the card(s)?
1116          */
1117         if (!rocr) {
1118                 err = -EINVAL;
1119                 goto err;
1120         }
1121
1122         /*
1123          * Detect and init the card.
1124          */
1125         err = mmc_sdio_init_card(host, rocr, NULL, 0);
1126         if (err)
1127                 goto err;
1128
1129         card = host->card;
1130
1131         /*
1132          * Enable runtime PM only if supported by host+card+board
1133          */
1134         if (host->caps & MMC_CAP_POWER_OFF_CARD) {
1135                 /*
1136                  * Do not allow runtime suspend until after SDIO function
1137                  * devices are added.
1138                  */
1139                 pm_runtime_get_noresume(&card->dev);
1140
1141                 /*
1142                  * Let runtime PM core know our card is active
1143                  */
1144                 err = pm_runtime_set_active(&card->dev);
1145                 if (err)
1146                         goto remove;
1147
1148                 /*
1149                  * Enable runtime PM for this card
1150                  */
1151                 pm_runtime_enable(&card->dev);
1152         }
1153
1154         /*
1155          * The number of functions on the card is encoded inside
1156          * the ocr.
1157          */
1158         funcs = (ocr & 0x70000000) >> 28;
1159         card->sdio_funcs = 0;
1160
1161         /*
1162          * Initialize (but don't add) all present functions.
1163          */
1164         for (i = 0; i < funcs; i++, card->sdio_funcs++) {
1165                 err = sdio_init_func(host->card, i + 1);
1166                 if (err)
1167                         goto remove;
1168
1169                 /*
1170                  * Enable Runtime PM for this func (if supported)
1171                  */
1172                 if (host->caps & MMC_CAP_POWER_OFF_CARD)
1173                         pm_runtime_enable(&card->sdio_func[i]->dev);
1174         }
1175
1176         /*
1177          * First add the card to the driver model...
1178          */
1179         mmc_release_host(host);
1180         err = mmc_add_card(host->card);
1181         if (err)
1182                 goto remove_added;
1183
1184         /*
1185          * ...then the SDIO functions.
1186          */
1187         for (i = 0;i < funcs;i++) {
1188                 err = sdio_add_func(host->card->sdio_func[i]);
1189                 if (err)
1190                         goto remove_added;
1191         }
1192
1193         if (host->caps & MMC_CAP_POWER_OFF_CARD)
1194                 pm_runtime_put(&card->dev);
1195
1196         mmc_claim_host(host);
1197         return 0;
1198
1199
1200 remove:
1201         mmc_release_host(host);
1202 remove_added:
1203         /*
1204          * The devices are being deleted so it is not necessary to disable
1205          * runtime PM. Similarly we also don't pm_runtime_put() the SDIO card
1206          * because it needs to be active to remove any function devices that
1207          * were probed, and after that it gets deleted.
1208          */
1209         mmc_sdio_remove(host);
1210         mmc_claim_host(host);
1211 err:
1212         mmc_detach_bus(host);
1213
1214         pr_err("%s: error %d whilst initialising SDIO card\n",
1215                 mmc_hostname(host), err);
1216
1217         return err;
1218 }
1219