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