drivers/mmc/core/host.c

   1 /*
   2  *  linux/drivers/mmc/core/host.c
   3  *
   4  *  Copyright (C) 2003 Russell King, All Rights Reserved.
   5  *  Copyright (C) 2007-2008 Pierre Ossman
   6  *  Copyright (C) 2010 Linus Walleij
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  *  MMC host class device management
  13  */
  14
  15 #include <linux/device.h>
  16 #include <linux/err.h>
  17 #include <linux/idr.h>
  18 #include <linux/of.h>
  19 #include <linux/of_gpio.h>
  20 #include <linux/pagemap.h>
  21 #include <linux/export.h>
  22 #include <linux/leds.h>
  23 #include <linux/slab.h>
  24 #include <linux/suspend.h>
  25
  26 #include <linux/mmc/host.h>
  27 #include <linux/mmc/card.h>
  28 #include <linux/mmc/slot-gpio.h>
  29
  30 #include "core.h"
  31 #include "host.h"
  32 #include "slot-gpio.h"
  33 #include "pwrseq.h"
  34
  35 static DEFINE_IDR(mmc_host_idr);
  36 static DEFINE_SPINLOCK(mmc_host_lock);
  37
  38 static void mmc_host_classdev_release(struct device *dev)
  39 {
  40         struct mmc_host *host = cls_dev_to_mmc_host(dev);
  41         spin_lock(&mmc_host_lock);
  42         idr_remove(&mmc_host_idr, host->index);
  43         spin_unlock(&mmc_host_lock);
  44         kfree(host);
  45 }
  46
  47 static struct class mmc_host_class = {
  48         .name           = "mmc_host",
  49         .dev_release    = mmc_host_classdev_release,
  50 };
  51
  52 int mmc_register_host_class(void)
  53 {
  54         return class_register(&mmc_host_class);
  55 }
  56
  57 void mmc_unregister_host_class(void)
  58 {
  59         class_unregister(&mmc_host_class);
  60 }
  61
  62 void mmc_retune_enable(struct mmc_host *host)
  63 {
  64         host->can_retune = 1;
  65         if (host->retune_period)
  66                 mod_timer(&host->retune_timer,
  67                           jiffies + host->retune_period * HZ);
  68 }
  69
  70 void mmc_retune_disable(struct mmc_host *host)
  71 {
  72         host->can_retune = 0;
  73         del_timer_sync(&host->retune_timer);
  74         host->retune_now = 0;
  75         host->need_retune = 0;
  76 }
  77
  78 void mmc_retune_timer_stop(struct mmc_host *host)
  79 {
  80         del_timer_sync(&host->retune_timer);
  81 }
  82 EXPORT_SYMBOL(mmc_retune_timer_stop);
  83
  84 void mmc_retune_hold(struct mmc_host *host)
  85 {
  86         if (!host->hold_retune)
  87                 host->retune_now = 1;
  88         host->hold_retune += 1;
  89 }
  90
  91 void mmc_retune_release(struct mmc_host *host)
  92 {
  93         if (host->hold_retune)
  94                 host->hold_retune -= 1;
  95         else
  96                 WARN_ON(1);
  97 }
  98
  99 int mmc_retune(struct mmc_host *host)
 100 {
 101         bool return_to_hs400 = false;
 102         int err;
 103
 104         if (host->retune_now)
 105                 host->retune_now = 0;
 106         else
 107                 return 0;
 108
 109         if (!host->need_retune || host->doing_retune || !host->card)
 110                 return 0;
 111
 112         host->need_retune = 0;
 113
 114         host->doing_retune = 1;
 115
 116         if (host->ios.timing == MMC_TIMING_MMC_HS400) {
 117                 err = mmc_hs400_to_hs200(host->card);
 118                 if (err)
 119                         goto out;
 120
 121                 return_to_hs400 = true;
 122
 123                 if (host->ops->prepare_hs400_tuning)
 124                         host->ops->prepare_hs400_tuning(host, &host->ios);
 125         }
 126
 127         err = mmc_execute_tuning(host->card);
 128         if (err)
 129                 goto out;
 130
 131         if (return_to_hs400)
 132                 err = mmc_hs200_to_hs400(host->card);
 133 out:
 134         host->doing_retune = 0;
 135
 136         return err;
 137 }
 138
 139 static void mmc_retune_timer(unsigned long data)
 140 {
 141         struct mmc_host *host = (struct mmc_host *)data;
 142
 143         mmc_retune_needed(host);
 144 }
 145
 146 /**
 147  *      mmc_of_parse() - parse host's device-tree node
 148  *      @host: host whose node should be parsed.
 149  *
 150  * To keep the rest of the MMC subsystem unaware of whether DT has been
 151  * used to to instantiate and configure this host instance or not, we
 152  * parse the properties and set respective generic mmc-host flags and
 153  * parameters.
 154  */
 155 int mmc_of_parse(struct mmc_host *host)
 156 {
 157         struct device_node *np;
 158         u32 bus_width;
 159         int ret;
 160         bool cd_cap_invert, cd_gpio_invert = false;
 161         bool ro_cap_invert, ro_gpio_invert = false;
 162         enum of_gpio_flags pwrseq_flags;
 163         int pwrseq_gpio;
 164
 165         if (!host->parent || !host->parent->of_node)
 166                 return 0;
 167
 168         np = host->parent->of_node;
 169
 170         pwrseq_gpio = of_get_named_gpio_flags(np, "pwrseq-gpio", 0, &pwrseq_flags);
 171         if ( gpio_is_valid(pwrseq_gpio) ) {
 172                 ret = devm_gpio_request_one(&host->class_dev, pwrseq_gpio, (pwrseq_flags & OF_GPIO_ACTIVE_LOW) ? GPIOF_OUT_INIT_LOW : GPIOF_OUT_INIT_HIGH, "sdpwr-gpio");
 173                 if (ret != 0) {
 174                         dev_err(&host->class_dev, "request sdcard pwrseq gpio error\n");
 175                         return -EIO;
 176                 }
 177         };
 178
 179         /* "bus-width" is translated to MMC_CAP_*_BIT_DATA flags */
 180         if (of_property_read_u32(np, "bus-width", &bus_width) < 0) {
 181                 dev_dbg(host->parent,
 182                         "\"bus-width\" property is missing, assuming 1 bit.\n");
 183                 bus_width = 1;
 184         }
 185
 186         switch (bus_width) {
 187         case 8:
 188                 host->caps |= MMC_CAP_8_BIT_DATA;
 189                 /* Hosts capable of 8-bit transfers can also do 4 bits */
 190         case 4:
 191                 host->caps |= MMC_CAP_4_BIT_DATA;
 192                 break;
 193         case 1:
 194                 break;
 195         default:
 196                 dev_err(host->parent,
 197                         "Invalid \"bus-width\" value %u!\n", bus_width);
 198                 return -EINVAL;
 199         }
 200
 201         /* f_max is obtained from the optional "max-frequency" property */
 202         of_property_read_u32(np, "max-frequency", &host->f_max);
 203
 204         /*
 205          * Configure CD and WP pins. They are both by default active low to
 206          * match the SDHCI spec. If GPIOs are provided for CD and / or WP, the
 207          * mmc-gpio helpers are used to attach, configure and use them. If
 208          * polarity inversion is specified in DT, one of MMC_CAP2_CD_ACTIVE_HIGH
 209          * and MMC_CAP2_RO_ACTIVE_HIGH capability-2 flags is set. If the
 210          * "broken-cd" property is provided, the MMC_CAP_NEEDS_POLL capability
 211          * is set. If the "non-removable" property is found, the
 212          * MMC_CAP_NONREMOVABLE capability is set and no card-detection
 213          * configuration is performed.
 214          */
 215
 216         /* Parse Card Detection */
 217         if (of_property_read_bool(np, "non-removable")) {
 218                 host->caps |= MMC_CAP_NONREMOVABLE;
 219         } else {
 220                 cd_cap_invert = of_property_read_bool(np, "cd-inverted");
 221
 222                 if (of_property_read_bool(np, "broken-cd"))
 223                         host->caps |= MMC_CAP_NEEDS_POLL;
 224
 225                 ret = mmc_gpiod_request_cd(host, "cd", 0, true,
 226                                            0, &cd_gpio_invert);
 227                 if (!ret)
 228                         dev_info(host->parent, "Got CD GPIO\n");
 229                 else if (ret != -ENOENT && ret != -ENOSYS)
 230                         return ret;
 231
 232                 /*
 233                  * There are two ways to flag that the CD line is inverted:
 234                  * through the cd-inverted flag and by the GPIO line itself
 235                  * being inverted from the GPIO subsystem. This is a leftover
 236                  * from the times when the GPIO subsystem did not make it
 237                  * possible to flag a line as inverted.
 238                  *
 239                  * If the capability on the host AND the GPIO line are
 240                  * both inverted, the end result is that the CD line is
 241                  * not inverted.
 242                  */
 243                 if (cd_cap_invert ^ cd_gpio_invert)
 244                         host->caps2 |= MMC_CAP2_CD_ACTIVE_HIGH;
 245         }
 246
 247         /* Parse Write Protection */
 248         ro_cap_invert = of_property_read_bool(np, "wp-inverted");
 249
 250         ret = mmc_gpiod_request_ro(host, "wp", 0, false, 0, &ro_gpio_invert);
 251         if (!ret)
 252                 dev_info(host->parent, "Got WP GPIO\n");
 253         else if (ret != -ENOENT && ret != -ENOSYS)
 254                 return ret;
 255
 256         if (of_property_read_bool(np, "disable-wp"))
 257                 host->caps2 |= MMC_CAP2_NO_WRITE_PROTECT;
 258
 259         /* See the comment on CD inversion above */
 260         if (ro_cap_invert ^ ro_gpio_invert)
 261                 host->caps2 |= MMC_CAP2_RO_ACTIVE_HIGH;
 262
 263         if (of_property_read_bool(np, "cap-sd-highspeed"))
 264                 host->caps |= MMC_CAP_SD_HIGHSPEED;
 265         if (of_property_read_bool(np, "cap-mmc-highspeed"))
 266                 host->caps |= MMC_CAP_MMC_HIGHSPEED;
 267         if (of_property_read_bool(np, "sd-uhs-sdr12"))
 268                 host->caps |= MMC_CAP_UHS_SDR12;
 269         if (of_property_read_bool(np, "sd-uhs-sdr25"))
 270                 host->caps |= MMC_CAP_UHS_SDR25;
 271         if (of_property_read_bool(np, "sd-uhs-sdr50"))
 272                 host->caps |= MMC_CAP_UHS_SDR50;
 273         if (of_property_read_bool(np, "sd-uhs-sdr104"))
 274                 host->caps |= MMC_CAP_UHS_SDR104;
 275         if (of_property_read_bool(np, "sd-uhs-ddr50"))
 276                 host->caps |= MMC_CAP_UHS_DDR50;
 277         if (of_property_read_bool(np, "cap-power-off-card"))
 278                 host->caps |= MMC_CAP_POWER_OFF_CARD;
 279         if (of_property_read_bool(np, "cap-mmc-hw-reset"))
 280                 host->caps |= MMC_CAP_HW_RESET;
 281         if (of_property_read_bool(np, "cap-sdio-irq"))
 282                 host->caps |= MMC_CAP_SDIO_IRQ;
 283         if (of_property_read_bool(np, "full-pwr-cycle"))
 284                 host->caps2 |= MMC_CAP2_FULL_PWR_CYCLE;
 285         if (of_property_read_bool(np, "keep-power-in-suspend"))
 286                 host->pm_caps |= MMC_PM_KEEP_POWER;
 287         if (of_property_read_bool(np, "enable-sdio-wakeup"))
 288                 host->pm_caps |= MMC_PM_WAKE_SDIO_IRQ;
 289         if (of_property_read_bool(np, "mmc-ddr-1_8v"))
 290                 host->caps |= MMC_CAP_1_8V_DDR;
 291         if (of_property_read_bool(np, "mmc-ddr-1_2v"))
 292                 host->caps |= MMC_CAP_1_2V_DDR;
 293         if (of_property_read_bool(np, "mmc-hs200-1_8v"))
 294                 host->caps2 |= MMC_CAP2_HS200_1_8V_SDR;
 295         if (of_property_read_bool(np, "mmc-hs200-1_2v"))
 296                 host->caps2 |= MMC_CAP2_HS200_1_2V_SDR;
 297         if (of_property_read_bool(np, "mmc-hs400-1_8v"))
 298                 host->caps2 |= MMC_CAP2_HS400_1_8V | MMC_CAP2_HS200_1_8V_SDR;
 299         if (of_property_read_bool(np, "mmc-hs400-1_2v"))
 300                 host->caps2 |= MMC_CAP2_HS400_1_2V | MMC_CAP2_HS200_1_2V_SDR;
 301         if (of_property_read_bool(np, "mmc-hs400-enhanced-strobe"))
 302                 host->caps2 |= MMC_CAP2_HS400_ES;
 303
 304         if (of_property_read_bool(np, "supports-sd"))
 305                 host->restrict_caps |= RESTRICT_CARD_TYPE_SD;
 306         if (of_property_read_bool(np, "supports-sdio"))
 307                 host->restrict_caps |= RESTRICT_CARD_TYPE_SDIO;
 308         if (of_property_read_bool(np, "supports-emmc"))
 309                 host->restrict_caps |= RESTRICT_CARD_TYPE_EMMC;
 310
 311         host->dsr_req = !of_property_read_u32(np, "dsr", &host->dsr);
 312         if (host->dsr_req && (host->dsr & ~0xffff)) {
 313                 dev_err(host->parent,
 314                         "device tree specified broken value for DSR: 0x%x, ignoring\n",
 315                         host->dsr);
 316                 host->dsr_req = 0;
 317         }
 318
 319         return mmc_pwrseq_alloc(host);
 320 }
 321
 322 EXPORT_SYMBOL(mmc_of_parse);
 323
 324 /**
 325  *      mmc_alloc_host - initialise the per-host structure.
 326  *      @extra: sizeof private data structure
 327  *      @dev: pointer to host device model structure
 328  *
 329  *      Initialise the per-host structure.
 330  */
 331 struct mmc_host *mmc_alloc_host(int extra, struct device *dev)
 332 {
 333         int err;
 334         struct mmc_host *host;
 335
 336         host = kzalloc(sizeof(struct mmc_host) + extra, GFP_KERNEL);
 337         if (!host)
 338                 return NULL;
 339
 340         /* scanning will be enabled when we're ready */
 341         host->rescan_disable = 1;
 342         idr_preload(GFP_KERNEL);
 343         spin_lock(&mmc_host_lock);
 344         err = idr_alloc(&mmc_host_idr, host, 0, 0, GFP_NOWAIT);
 345         if (err >= 0)
 346                 host->index = err;
 347         spin_unlock(&mmc_host_lock);
 348         idr_preload_end();
 349         if (err < 0) {
 350                 kfree(host);
 351                 return NULL;
 352         }
 353
 354         dev_set_name(&host->class_dev, "mmc%d", host->index);
 355
 356         host->parent = dev;
 357         host->class_dev.parent = dev;
 358         host->class_dev.class = &mmc_host_class;
 359         device_initialize(&host->class_dev);
 360
 361         if (mmc_gpio_alloc(host)) {
 362                 put_device(&host->class_dev);
 363                 return NULL;
 364         }
 365
 366         spin_lock_init(&host->lock);
 367         init_waitqueue_head(&host->wq);
 368         INIT_DELAYED_WORK(&host->detect, mmc_rescan);
 369 #ifdef CONFIG_PM
 370         host->pm_notify.notifier_call = mmc_pm_notify;
 371 #endif
 372         setup_timer(&host->retune_timer, mmc_retune_timer, (unsigned long)host);
 373
 374         /*
 375          * By default, hosts do not support SGIO or large requests.
 376          * They have to set these according to their abilities.
 377          */
 378         host->max_segs = 1;
 379         host->max_seg_size = PAGE_CACHE_SIZE;
 380
 381         host->max_req_size = PAGE_CACHE_SIZE;
 382         host->max_blk_size = 512;
 383         host->max_blk_count = PAGE_CACHE_SIZE / 512;
 384
 385         return host;
 386 }
 387
 388 EXPORT_SYMBOL(mmc_alloc_host);
 389
 390 /**
 391  *      mmc_add_host - initialise host hardware
 392  *      @host: mmc host
 393  *
 394  *      Register the host with the driver model. The host must be
 395  *      prepared to start servicing requests before this function
 396  *      completes.
 397  */
 398 struct mmc_host *primary_sdio_host;
 399 int mmc_add_host(struct mmc_host *host)
 400 {
 401         int err;
 402
 403         WARN_ON((host->caps & MMC_CAP_SDIO_IRQ) &&
 404                 !host->ops->enable_sdio_irq);
 405
 406         err = device_add(&host->class_dev);
 407         if (err)
 408                 return err;
 409
 410         led_trigger_register_simple(dev_name(&host->class_dev), &host->led);
 411
 412 #ifdef CONFIG_DEBUG_FS
 413         mmc_add_host_debugfs(host);
 414 #endif
 415
 416 #ifdef CONFIG_BLOCK
 417         mmc_latency_hist_sysfs_init(host);
 418 #endif
 419
 420         mmc_start_host(host);
 421         if (!(host->pm_flags & MMC_PM_IGNORE_PM_NOTIFY))
 422                 register_pm_notifier(&host->pm_notify);
 423
 424         if (host->restrict_caps & RESTRICT_CARD_TYPE_SDIO)
 425                 primary_sdio_host = host;
 426
 427         return 0;
 428 }
 429
 430 EXPORT_SYMBOL(mmc_add_host);
 431
 432 /**
 433  *      mmc_remove_host - remove host hardware
 434  *      @host: mmc host
 435  *
 436  *      Unregister and remove all cards associated with this host,
 437  *      and power down the MMC bus. No new requests will be issued
 438  *      after this function has returned.
 439  */
 440 void mmc_remove_host(struct mmc_host *host)
 441 {
 442         if (!(host->pm_flags & MMC_PM_IGNORE_PM_NOTIFY))
 443                 unregister_pm_notifier(&host->pm_notify);
 444
 445         mmc_stop_host(host);
 446
 447 #ifdef CONFIG_DEBUG_FS
 448         mmc_remove_host_debugfs(host);
 449 #endif
 450
 451 #ifdef CONFIG_BLOCK
 452         mmc_latency_hist_sysfs_exit(host);
 453 #endif
 454
 455         device_del(&host->class_dev);
 456
 457         led_trigger_unregister_simple(host->led);
 458 }
 459
 460 EXPORT_SYMBOL(mmc_remove_host);
 461
 462 /**
 463  *      mmc_free_host - free the host structure
 464  *      @host: mmc host
 465  *
 466  *      Free the host once all references to it have been dropped.
 467  */
 468 void mmc_free_host(struct mmc_host *host)
 469 {
 470         mmc_pwrseq_free(host);
 471         put_device(&host->class_dev);
 472 }
 473
 474 EXPORT_SYMBOL(mmc_free_host);
 475
 476 /**
 477  * mmc_host_rescan - triger software rescan flow
 478  * @host: mmc host
 479  *
 480  * rescan slot attach in the assigned host.
 481  * If @host is NULL, default rescan primary_sdio_host
 482  * saved by mmc_add_host().
 483  * OR, rescan host from argument.
 484  *
 485  */
 486 int mmc_host_rescan(struct mmc_host *host, int val, int is_cap_sdio_irq)
 487 {
 488         if (NULL != primary_sdio_host) {
 489                 if (!host)
 490                           host = primary_sdio_host;
 491                 else
 492                         pr_info("%s: mmc_host_rescan pass in host from argument!\n",
 493                                 mmc_hostname(host));
 494         } else {
 495                 pr_err("sdio: host isn't  initialization successfully.\n");
 496                 return -ENOMEDIUM;
 497         }
 498
 499         pr_info("%s:mmc host rescan start!\n", mmc_hostname(host));
 500
 501         /*  0: oob  1:cap-sdio-irq */
 502         if (is_cap_sdio_irq == 1) {
 503                 host->caps |= MMC_CAP_SDIO_IRQ;
 504         } else if (is_cap_sdio_irq == 0) {
 505                 host->caps &= ~MMC_CAP_SDIO_IRQ;
 506         } else {
 507                 dev_err(&host->class_dev, "sdio: host doesn't identify oob or sdio_irq mode!\n");
 508                 return -ENOMEDIUM;
 509         }
 510
 511         if (!(host->caps & MMC_CAP_NONREMOVABLE) && host->ops->set_sdio_status)
 512                 host->ops->set_sdio_status(host, val);
 513
 514         return 0;
 515 }
 516 EXPORT_SYMBOL(mmc_host_rescan);