drivers/mmc/core/host.c

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