drivers/mmc/core/sdio.c

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