drivers/mmc/core/sdio.c

   1 /*
   2  *  linux/drivers/mmc/sdio.c
   3  *
   4  *  Copyright 2006-2007 Pierre Ossman
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or (at
   9  * your option) any later version.
  10  */
  11
  12 #include <linux/err.h>
  13
  14 #include <linux/mmc/host.h>
  15 #include <linux/mmc/card.h>
  16 #include <linux/mmc/sdio.h>
  17 #include <linux/mmc/sdio_func.h>
  18
  19 #include "core.h"
  20 #include "bus.h"
  21 #include "sdio_bus.h"
  22 #include "mmc_ops.h"
  23 #include "sd_ops.h"
  24 #include "sdio_ops.h"
  25 #include "sdio_cis.h"
  26
  27 static int sdio_read_fbr(struct sdio_func *func)
  28 {
  29         int ret;
  30         unsigned char data;
  31
  32         ret = mmc_io_rw_direct(func->card, 0, 0,
  33                 SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF, 0, &data);
  34         if (ret)
  35                 goto out;
  36
  37         data &= 0x0f;
  38
  39         if (data == 0x0f) {
  40                 ret = mmc_io_rw_direct(func->card, 0, 0,
  41                         SDIO_FBR_BASE(func->num) + SDIO_FBR_STD_IF_EXT, 0, &data);
  42                 if (ret)
  43                         goto out;
  44         }
  45
  46         func->class = data;
  47
  48 out:
  49         return ret;
  50 }
  51
  52 static int sdio_init_func(struct mmc_card *card, unsigned int fn)
  53 {
  54         int ret;
  55         struct sdio_func *func;
  56
  57         BUG_ON(fn > SDIO_MAX_FUNCS);
  58
  59         func = sdio_alloc_func(card);
  60         if (IS_ERR(func))
  61                 return PTR_ERR(func);
  62
  63         func->num = fn;
  64
  65         ret = sdio_read_fbr(func);
  66         if (ret)
  67                 goto fail;
  68
  69         ret = sdio_read_func_cis(func);
  70         if (ret)
  71                 goto fail;
  72
  73         card->sdio_func[fn - 1] = func;
  74
  75         return 0;
  76
  77 fail:
  78         /*
  79          * It is okay to remove the function here even though we hold
  80          * the host lock as we haven't registered the device yet.
  81          */
  82         sdio_remove_func(func);
  83         return ret;
  84 }
  85
  86 static int sdio_read_cccr(struct mmc_card *card)
  87 {
  88         int ret;
  89         int cccr_vsn;
  90         unsigned char data;
  91
  92         memset(&card->cccr, 0, sizeof(struct sdio_cccr));
  93
  94         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CCCR, 0, &data);
  95         if (ret)
  96                 goto out;
  97
  98         cccr_vsn = data & 0x0f;
  99
 100         if (cccr_vsn > SDIO_CCCR_REV_1_20) {
 101                 printk(KERN_ERR "%s: unrecognised CCCR structure version %d\n",
 102                         mmc_hostname(card->host), cccr_vsn);
 103                 return -EINVAL;
 104         }
 105
 106         card->cccr.sdio_vsn = (data & 0xf0) >> 4;
 107
 108         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_CAPS, 0, &data);
 109         if (ret)
 110                 goto out;
 111
 112         if (data & SDIO_CCCR_CAP_SMB)
 113                 card->cccr.multi_block = 1;
 114         if (data & SDIO_CCCR_CAP_LSC)
 115                 card->cccr.low_speed = 1;
 116         if (data & SDIO_CCCR_CAP_4BLS)
 117                 card->cccr.wide_bus = 1;
 118
 119         if (cccr_vsn >= SDIO_CCCR_REV_1_10) {
 120                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_POWER, 0, &data);
 121                 if (ret)
 122                         goto out;
 123
 124                 if (data & SDIO_POWER_SMPC)
 125                         card->cccr.high_power = 1;
 126         }
 127
 128         if (cccr_vsn >= SDIO_CCCR_REV_1_20) {
 129                 ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &data);
 130                 if (ret)
 131                         goto out;
 132
 133                 if (data & SDIO_SPEED_SHS)
 134                         card->cccr.high_speed = 1;
 135         }
 136
 137 out:
 138         return ret;
 139 }
 140
 141 static int sdio_enable_wide(struct mmc_card *card)
 142 {
 143         int ret;
 144         u8 ctrl;
 145
 146         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
 147                 return 0;
 148
 149         if (card->cccr.low_speed && !card->cccr.wide_bus)
 150                 return 0;
 151
 152         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 153         if (ret)
 154                 return ret;
 155
 156         ctrl |= SDIO_BUS_WIDTH_4BIT;
 157
 158         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 159         if (ret)
 160                 return ret;
 161
 162         mmc_set_bus_width(card->host, MMC_BUS_WIDTH_4);
 163
 164         return 0;
 165 }
 166
 167 /*
 168  * If desired, disconnect the pull-up resistor on CD/DAT[3] (pin 1)
 169  * of the card. This may be required on certain setups of boards,
 170  * controllers and embedded sdio device which do not need the card's
 171  * pull-up. As a result, card detection is disabled and power is saved.
 172  */
 173 static int sdio_disable_cd(struct mmc_card *card)
 174 {
 175         int ret;
 176         u8 ctrl;
 177
 178         if (!card->cccr.disable_cd)
 179                 return 0;
 180
 181         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 182         if (ret)
 183                 return ret;
 184
 185         ctrl |= SDIO_BUS_CD_DISABLE;
 186
 187         return mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 188 }
 189
 190 /*
 191  * Devices that remain active during a system suspend are
 192  * put back into 1-bit mode.
 193  */
 194 static int sdio_disable_wide(struct mmc_card *card)
 195 {
 196         int ret;
 197         u8 ctrl;
 198
 199         if (!(card->host->caps & MMC_CAP_4_BIT_DATA))
 200                 return 0;
 201
 202         if (card->cccr.low_speed && !card->cccr.wide_bus)
 203                 return 0;
 204
 205         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_IF, 0, &ctrl);
 206         if (ret)
 207                 return ret;
 208
 209         if (!(ctrl & SDIO_BUS_WIDTH_4BIT))
 210                 return 0;
 211
 212         ctrl &= ~SDIO_BUS_WIDTH_4BIT;
 213         ctrl |= SDIO_BUS_ASYNC_INT;
 214
 215         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_IF, ctrl, NULL);
 216         if (ret)
 217                 return ret;
 218
 219         mmc_set_bus_width(card->host, MMC_BUS_WIDTH_1);
 220
 221         return 0;
 222 }
 223
 224 /*
 225  * Test if the card supports high-speed mode and, if so, switch to it.
 226  */
 227 static int sdio_enable_hs(struct mmc_card *card)
 228 {
 229         int ret;
 230         u8 speed;
 231
 232         if (!(card->host->caps & MMC_CAP_SD_HIGHSPEED))
 233                 return 0;
 234
 235         if (!card->cccr.high_speed)
 236                 return 0;
 237
 238         ret = mmc_io_rw_direct(card, 0, 0, SDIO_CCCR_SPEED, 0, &speed);
 239         if (ret)
 240                 return ret;
 241
 242         speed |= SDIO_SPEED_EHS;
 243
 244         ret = mmc_io_rw_direct(card, 1, 0, SDIO_CCCR_SPEED, speed, NULL);
 245         if (ret)
 246                 return ret;
 247
 248         mmc_card_set_highspeed(card);
 249         mmc_set_timing(card->host, MMC_TIMING_SD_HS);
 250
 251         return 0;
 252 }
 253
 254 /*
 255  * Handle the detection and initialisation of a card.
 256  *
 257  * In the case of a resume, "oldcard" will contain the card
 258  * we're trying to reinitialise.
 259  */
 260 static int mmc_sdio_init_card(struct mmc_host *host, u32 ocr,
 261                               struct mmc_card *oldcard, int powered_resume)
 262 {
 263         struct mmc_card *card;
 264         int err;
 265
 266         BUG_ON(!host);
 267         WARN_ON(!host->claimed);
 268
 269         /*
 270          * Inform the card of the voltage
 271          */
 272         if (!powered_resume) {
 273                 err = mmc_send_io_op_cond(host, host->ocr, &ocr);
 274                 if (err)
 275                         goto err;
 276         }
 277
 278         /*
 279          * For SPI, enable CRC as appropriate.
 280          */
 281         if (mmc_host_is_spi(host)) {
 282                 err = mmc_spi_set_crc(host, use_spi_crc);
 283                 if (err)
 284                         goto err;
 285         }
 286
 287         /*
 288          * Allocate card structure.
 289          */
 290         card = mmc_alloc_card(host, NULL);
 291         if (IS_ERR(card)) {
 292                 err = PTR_ERR(card);
 293                 goto err;
 294         }
 295
 296         card->type = MMC_TYPE_SDIO;
 297
 298         /*
 299          * For native busses:  set card RCA and quit open drain mode.
 300          */
 301         if (!powered_resume && !mmc_host_is_spi(host)) {
 302                 err = mmc_send_relative_addr(host, &card->rca);
 303                 if (err)
 304                         goto remove;
 305
 306                 /*
 307                  * Update oldcard with the new RCA received from the SDIO
 308                  * device -- we're doing this so that it's updated in the
 309                  * "card" struct when oldcard overwrites that later.
 310                  */
 311                 if (oldcard)
 312                         oldcard->rca = card->rca;
 313
 314                 mmc_set_bus_mode(host, MMC_BUSMODE_PUSHPULL);
 315         }
 316
 317         /*
 318          * Select card, as all following commands rely on that.
 319          */
 320         if (!powered_resume && !mmc_host_is_spi(host)) {
 321                 err = mmc_select_card(card);
 322                 if (err)
 323                         goto remove;
 324         }
 325
 326         /*
 327          * Read the common registers.
 328          */
 329         err = sdio_read_cccr(card);
 330         if (err)
 331                 goto remove;
 332
 333         /*
 334          * Read the common CIS tuples.
 335          */
 336         err = sdio_read_common_cis(card);
 337         if (err)
 338                 goto remove;
 339
 340         if (oldcard) {
 341                 int same = (card->cis.vendor == oldcard->cis.vendor &&
 342                             card->cis.device == oldcard->cis.device);
 343                 mmc_remove_card(card);
 344                 if (!same) {
 345                         err = -ENOENT;
 346                         goto err;
 347                 }
 348                 card = oldcard;
 349                 return 0;
 350         }
 351
 352         /*
 353          * Switch to high-speed (if supported).
 354          */
 355         err = sdio_enable_hs(card);
 356         if (err)
 357                 goto remove;
 358
 359         /*
 360          * Change to the card's maximum speed.
 361          */
 362         if (mmc_card_highspeed(card)) {
 363                 /*
 364                  * The SDIO specification doesn't mention how
 365                  * the CIS transfer speed register relates to
 366                  * high-speed, but it seems that 50 MHz is
 367                  * mandatory.
 368                  */
 369                 mmc_set_clock(host, 50000000);
 370         } else {
 371                 mmc_set_clock(host, card->cis.max_dtr);
 372         }
 373
 374         /*
 375          * Switch to wider bus (if supported).
 376          */
 377         err = sdio_enable_wide(card);
 378         if (err)
 379                 goto remove;
 380
 381         if (!oldcard)
 382                 host->card = card;
 383         return 0;
 384
 385 remove:
 386         if (!oldcard)
 387                 mmc_remove_card(card);
 388
 389 err:
 390         return err;
 391 }
 392
 393 /*
 394  * Host is being removed. Free up the current card.
 395  */
 396 static void mmc_sdio_remove(struct mmc_host *host)
 397 {
 398         int i;
 399
 400         BUG_ON(!host);
 401         BUG_ON(!host->card);
 402
 403         for (i = 0;i < host->card->sdio_funcs;i++) {
 404                 if (host->card->sdio_func[i]) {
 405                         sdio_remove_func(host->card->sdio_func[i]);
 406                         host->card->sdio_func[i] = NULL;
 407                 }
 408         }
 409
 410         mmc_remove_card(host->card);
 411         host->card = NULL;
 412 }
 413
 414 /*
 415  * Card detection callback from host.
 416  */
 417 static void mmc_sdio_detect(struct mmc_host *host)
 418 {
 419         int err;
 420
 421         BUG_ON(!host);
 422         BUG_ON(!host->card);
 423
 424         mmc_claim_host(host);
 425
 426         /*
 427          * Just check if our card has been removed.
 428          */
 429         err = mmc_select_card(host->card);
 430
 431         mmc_release_host(host);
 432
 433         if (err) {
 434                 mmc_sdio_remove(host);
 435
 436                 mmc_claim_host(host);
 437                 mmc_detach_bus(host);
 438                 mmc_release_host(host);
 439         }
 440 }
 441
 442 /*
 443  * SDIO suspend.  We need to suspend all functions separately.
 444  * Therefore all registered functions must have drivers with suspend
 445  * and resume methods.  Failing that we simply remove the whole card.
 446  */
 447 static int mmc_sdio_suspend(struct mmc_host *host)
 448 {
 449         int i, err = 0;
 450
 451         for (i = 0; i < host->card->sdio_funcs; i++) {
 452                 struct sdio_func *func = host->card->sdio_func[i];
 453                 if (func && sdio_func_present(func) && func->dev.driver) {
 454                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
 455                         if (!pmops || !pmops->suspend || !pmops->resume) {
 456                                 /* force removal of entire card in that case */
 457                                 err = -ENOSYS;
 458                         } else
 459                                 err = pmops->suspend(&func->dev);
 460                         if (err)
 461                                 break;
 462                 }
 463         }
 464         while (err && --i >= 0) {
 465                 struct sdio_func *func = host->card->sdio_func[i];
 466                 if (func && sdio_func_present(func) && func->dev.driver) {
 467                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
 468                         pmops->resume(&func->dev);
 469                 }
 470         }
 471
 472         if (!err && host->pm_flags & MMC_PM_KEEP_POWER) {
 473                 mmc_claim_host(host);
 474                 sdio_disable_wide(host->card);
 475                 mmc_release_host(host);
 476         }
 477
 478         return err;
 479 }
 480
 481 static int mmc_sdio_resume(struct mmc_host *host)
 482 {
 483         int i, err;
 484
 485         BUG_ON(!host);
 486         BUG_ON(!host->card);
 487
 488         /* Basic card reinitialization. */
 489         mmc_claim_host(host);
 490         err = mmc_sdio_init_card(host, host->ocr, host->card,
 491                                  (host->pm_flags & MMC_PM_KEEP_POWER));
 492         if (!err)
 493                 /* We may have switched to 1-bit mode during suspend. */
 494                 err = sdio_enable_wide(host->card);
 495         if (!err && host->sdio_irqs)
 496                 mmc_signal_sdio_irq(host);
 497         mmc_release_host(host);
 498
 499         /*
 500          * If the card looked to be the same as before suspending, then
 501          * we proceed to resume all card functions.  If one of them returns
 502          * an error then we simply return that error to the core and the
 503          * card will be redetected as new.  It is the responsibility of
 504          * the function driver to perform further tests with the extra
 505          * knowledge it has of the card to confirm the card is indeed the
 506          * same as before suspending (same MAC address for network cards,
 507          * etc.) and return an error otherwise.
 508          */
 509         for (i = 0; !err && i < host->card->sdio_funcs; i++) {
 510                 struct sdio_func *func = host->card->sdio_func[i];
 511                 if (func && sdio_func_present(func) && func->dev.driver) {
 512                         const struct dev_pm_ops *pmops = func->dev.driver->pm;
 513                         err = pmops->resume(&func->dev);
 514                 }
 515         }
 516
 517         return err;
 518 }
 519
 520 static const struct mmc_bus_ops mmc_sdio_ops = {
 521         .remove = mmc_sdio_remove,
 522         .detect = mmc_sdio_detect,
 523         .suspend = mmc_sdio_suspend,
 524         .resume = mmc_sdio_resume,
 525 };
 526
 527
 528 /*
 529  * Starting point for SDIO card init.
 530  */
 531 int mmc_attach_sdio(struct mmc_host *host, u32 ocr)
 532 {
 533         int err;
 534         int i, funcs;
 535         struct mmc_card *card;
 536
 537         BUG_ON(!host);
 538         WARN_ON(!host->claimed);
 539
 540         mmc_attach_bus(host, &mmc_sdio_ops);
 541
 542         /*
 543          * Sanity check the voltages that the card claims to
 544          * support.
 545          */
 546         if (ocr & 0x7F) {
 547                 printk(KERN_WARNING "%s: card claims to support voltages "
 548                        "below the defined range. These will be ignored.\n",
 549                        mmc_hostname(host));
 550                 ocr &= ~0x7F;
 551         }
 552
 553         host->ocr = mmc_select_voltage(host, ocr);
 554
 555         /*
 556          * Can we support the voltage(s) of the card(s)?
 557          */
 558         if (!host->ocr) {
 559                 err = -EINVAL;
 560                 goto err;
 561         }
 562
 563         /*
 564          * Detect and init the card.
 565          */
 566         err = mmc_sdio_init_card(host, host->ocr, NULL, 0);
 567         if (err)
 568                 goto err;
 569         card = host->card;
 570
 571         /*
 572          * The number of functions on the card is encoded inside
 573          * the ocr.
 574          */
 575         funcs = (ocr & 0x70000000) >> 28;
 576         card->sdio_funcs = 0;
 577
 578         /*
 579          * If needed, disconnect card detection pull-up resistor.
 580          */
 581         err = sdio_disable_cd(card);
 582         if (err)
 583                 goto remove;
 584
 585         /*
 586          * Initialize (but don't add) all present functions.
 587          */
 588         for (i = 0; i < funcs; i++, card->sdio_funcs++) {
 589                 err = sdio_init_func(host->card, i + 1);
 590                 if (err)
 591                         goto remove;
 592         }
 593
 594         mmc_release_host(host);
 595
 596         /*
 597          * First add the card to the driver model...
 598          */
 599         err = mmc_add_card(host->card);
 600         if (err)
 601                 goto remove_added;
 602
 603         /*
 604          * ...then the SDIO functions.
 605          */
 606         for (i = 0;i < funcs;i++) {
 607                 err = sdio_add_func(host->card->sdio_func[i]);
 608                 if (err)
 609                         goto remove_added;
 610         }
 611
 612         return 0;
 613
 614
 615 remove_added:
 616         /* Remove without lock if the device has been added. */
 617         mmc_sdio_remove(host);
 618         mmc_claim_host(host);
 619 remove:
 620         /* And with lock if it hasn't been added. */
 621         if (host->card)
 622                 mmc_sdio_remove(host);
 623 err:
 624         mmc_detach_bus(host);
 625         mmc_release_host(host);
 626
 627         printk(KERN_ERR "%s: error %d whilst initialising SDIO card\n",
 628                 mmc_hostname(host), err);
 629
 630         return err;
 631 }
 632