drivers/mmc/host/sdhci-acpi.c

   1 /*
   2  * Secure Digital Host Controller Interface ACPI driver.
   3  *
   4  * Copyright (c) 2012, Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  */
  20
  21 #include <linux/init.h>
  22 #include <linux/export.h>
  23 #include <linux/module.h>
  24 #include <linux/device.h>
  25 #include <linux/platform_device.h>
  26 #include <linux/ioport.h>
  27 #include <linux/io.h>
  28 #include <linux/dma-mapping.h>
  29 #include <linux/compiler.h>
  30 #include <linux/stddef.h>
  31 #include <linux/bitops.h>
  32 #include <linux/types.h>
  33 #include <linux/err.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/acpi.h>
  36 #include <linux/pm.h>
  37 #include <linux/pm_runtime.h>
  38 #include <linux/delay.h>
  39
  40 #include <linux/mmc/host.h>
  41 #include <linux/mmc/pm.h>
  42 #include <linux/mmc/slot-gpio.h>
  43
  44 #ifdef CONFIG_X86
  45 #include <asm/cpu_device_id.h>
  46 #include <asm/iosf_mbi.h>
  47 #endif
  48
  49 #include "sdhci.h"
  50
  51 enum {
  52         SDHCI_ACPI_SD_CD                = BIT(0),
  53         SDHCI_ACPI_RUNTIME_PM           = BIT(1),
  54         SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL = BIT(2),
  55 };
  56
  57 struct sdhci_acpi_chip {
  58         const struct    sdhci_ops *ops;
  59         unsigned int    quirks;
  60         unsigned int    quirks2;
  61         unsigned long   caps;
  62         unsigned int    caps2;
  63         mmc_pm_flag_t   pm_caps;
  64 };
  65
  66 struct sdhci_acpi_slot {
  67         const struct    sdhci_acpi_chip *chip;
  68         unsigned int    quirks;
  69         unsigned int    quirks2;
  70         unsigned long   caps;
  71         unsigned int    caps2;
  72         mmc_pm_flag_t   pm_caps;
  73         unsigned int    flags;
  74         int (*probe_slot)(struct platform_device *, const char *, const char *);
  75         int (*remove_slot)(struct platform_device *);
  76 };
  77
  78 struct sdhci_acpi_host {
  79         struct sdhci_host               *host;
  80         const struct sdhci_acpi_slot    *slot;
  81         struct platform_device          *pdev;
  82         bool                            use_runtime_pm;
  83 };
  84
  85 static inline bool sdhci_acpi_flag(struct sdhci_acpi_host *c, unsigned int flag)
  86 {
  87         return c->slot && (c->slot->flags & flag);
  88 }
  89
  90 static void sdhci_acpi_int_hw_reset(struct sdhci_host *host)
  91 {
  92         u8 reg;
  93
  94         reg = sdhci_readb(host, SDHCI_POWER_CONTROL);
  95         reg |= 0x10;
  96         sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
  97         /* For eMMC, minimum is 1us but give it 9us for good measure */
  98         udelay(9);
  99         reg &= ~0x10;
 100         sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
 101         /* For eMMC, minimum is 200us but give it 300us for good measure */
 102         usleep_range(300, 1000);
 103 }
 104
 105 static const struct sdhci_ops sdhci_acpi_ops_dflt = {
 106         .set_clock = sdhci_set_clock,
 107         .set_bus_width = sdhci_set_bus_width,
 108         .reset = sdhci_reset,
 109         .set_uhs_signaling = sdhci_set_uhs_signaling,
 110 };
 111
 112 static const struct sdhci_ops sdhci_acpi_ops_int = {
 113         .set_clock = sdhci_set_clock,
 114         .set_bus_width = sdhci_set_bus_width,
 115         .reset = sdhci_reset,
 116         .set_uhs_signaling = sdhci_set_uhs_signaling,
 117         .hw_reset   = sdhci_acpi_int_hw_reset,
 118 };
 119
 120 static const struct sdhci_acpi_chip sdhci_acpi_chip_int = {
 121         .ops = &sdhci_acpi_ops_int,
 122 };
 123
 124 #ifdef CONFIG_X86
 125
 126 static bool sdhci_acpi_byt(void)
 127 {
 128         static const struct x86_cpu_id byt[] = {
 129                 { X86_VENDOR_INTEL, 6, 0x37 },
 130                 {}
 131         };
 132
 133         return x86_match_cpu(byt);
 134 }
 135
 136 #define BYT_IOSF_SCCEP                  0x63
 137 #define BYT_IOSF_OCP_NETCTRL0           0x1078
 138 #define BYT_IOSF_OCP_TIMEOUT_BASE       GENMASK(10, 8)
 139
 140 static void sdhci_acpi_byt_setting(struct device *dev)
 141 {
 142         u32 val = 0;
 143
 144         if (!sdhci_acpi_byt())
 145                 return;
 146
 147         if (iosf_mbi_read(BYT_IOSF_SCCEP, MBI_CR_READ, BYT_IOSF_OCP_NETCTRL0,
 148                           &val)) {
 149                 dev_err(dev, "%s read error\n", __func__);
 150                 return;
 151         }
 152
 153         if (!(val & BYT_IOSF_OCP_TIMEOUT_BASE))
 154                 return;
 155
 156         val &= ~BYT_IOSF_OCP_TIMEOUT_BASE;
 157
 158         if (iosf_mbi_write(BYT_IOSF_SCCEP, MBI_CR_WRITE, BYT_IOSF_OCP_NETCTRL0,
 159                            val)) {
 160                 dev_err(dev, "%s write error\n", __func__);
 161                 return;
 162         }
 163
 164         dev_dbg(dev, "%s completed\n", __func__);
 165 }
 166
 167 static bool sdhci_acpi_byt_defer(struct device *dev)
 168 {
 169         if (!sdhci_acpi_byt())
 170                 return false;
 171
 172         if (!iosf_mbi_available())
 173                 return true;
 174
 175         sdhci_acpi_byt_setting(dev);
 176
 177         return false;
 178 }
 179
 180 #else
 181
 182 static inline void sdhci_acpi_byt_setting(struct device *dev)
 183 {
 184 }
 185
 186 static inline bool sdhci_acpi_byt_defer(struct device *dev)
 187 {
 188         return false;
 189 }
 190
 191 #endif
 192
 193 static int bxt_get_cd(struct mmc_host *mmc)
 194 {
 195         int gpio_cd = mmc_gpio_get_cd(mmc);
 196         struct sdhci_host *host = mmc_priv(mmc);
 197         unsigned long flags;
 198         int ret = 0;
 199
 200         if (!gpio_cd)
 201                 return 0;
 202
 203         spin_lock_irqsave(&host->lock, flags);
 204
 205         if (host->flags & SDHCI_DEVICE_DEAD)
 206                 goto out;
 207
 208         ret = !!(sdhci_readl(host, SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT);
 209 out:
 210         spin_unlock_irqrestore(&host->lock, flags);
 211
 212         return ret;
 213 }
 214
 215 static int sdhci_acpi_emmc_probe_slot(struct platform_device *pdev,
 216                                       const char *hid, const char *uid)
 217 {
 218         struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
 219         struct sdhci_host *host;
 220
 221         if (!c || !c->host)
 222                 return 0;
 223
 224         host = c->host;
 225
 226         /* Platform specific code during emmc probe slot goes here */
 227
 228         if (hid && uid && !strcmp(hid, "80860F14") && !strcmp(uid, "1") &&
 229             sdhci_readl(host, SDHCI_CAPABILITIES) == 0x446cc8b2 &&
 230             sdhci_readl(host, SDHCI_CAPABILITIES_1) == 0x00000807)
 231                 host->timeout_clk = 1000; /* 1000 kHz i.e. 1 MHz */
 232
 233         return 0;
 234 }
 235
 236 static int sdhci_acpi_sdio_probe_slot(struct platform_device *pdev,
 237                                       const char *hid, const char *uid)
 238 {
 239         struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
 240         struct sdhci_host *host;
 241
 242         if (!c || !c->host)
 243                 return 0;
 244
 245         host = c->host;
 246
 247         /* Platform specific code during sdio probe slot goes here */
 248
 249         return 0;
 250 }
 251
 252 static int sdhci_acpi_sd_probe_slot(struct platform_device *pdev,
 253                                     const char *hid, const char *uid)
 254 {
 255         struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
 256         struct sdhci_host *host;
 257
 258         if (!c || !c->host || !c->slot)
 259                 return 0;
 260
 261         host = c->host;
 262
 263         /* Platform specific code during sd probe slot goes here */
 264
 265         if (hid && !strcmp(hid, "80865ACA")) {
 266                 host->mmc_host_ops.get_cd = bxt_get_cd;
 267                 host->mmc->caps |= MMC_CAP_AGGRESSIVE_PM;
 268         }
 269
 270         return 0;
 271 }
 272
 273 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_emmc = {
 274         .chip    = &sdhci_acpi_chip_int,
 275         .caps    = MMC_CAP_8_BIT_DATA | MMC_CAP_NONREMOVABLE |
 276                    MMC_CAP_HW_RESET | MMC_CAP_1_8V_DDR |
 277                    MMC_CAP_WAIT_WHILE_BUSY,
 278         .caps2   = MMC_CAP2_HC_ERASE_SZ,
 279         .flags   = SDHCI_ACPI_RUNTIME_PM,
 280         .quirks  = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
 281         .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN |
 282                    SDHCI_QUIRK2_STOP_WITH_TC |
 283                    SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400,
 284         .probe_slot     = sdhci_acpi_emmc_probe_slot,
 285 };
 286
 287 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sdio = {
 288         .quirks  = SDHCI_QUIRK_BROKEN_CARD_DETECTION |
 289                    SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
 290         .quirks2 = SDHCI_QUIRK2_HOST_OFF_CARD_ON,
 291         .caps    = MMC_CAP_NONREMOVABLE | MMC_CAP_POWER_OFF_CARD |
 292                    MMC_CAP_WAIT_WHILE_BUSY,
 293         .flags   = SDHCI_ACPI_RUNTIME_PM,
 294         .pm_caps = MMC_PM_KEEP_POWER,
 295         .probe_slot     = sdhci_acpi_sdio_probe_slot,
 296 };
 297
 298 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sd = {
 299         .flags   = SDHCI_ACPI_SD_CD | SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL |
 300                    SDHCI_ACPI_RUNTIME_PM,
 301         .quirks  = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
 302         .quirks2 = SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON |
 303                    SDHCI_QUIRK2_STOP_WITH_TC,
 304         .caps    = MMC_CAP_WAIT_WHILE_BUSY,
 305         .probe_slot     = sdhci_acpi_sd_probe_slot,
 306 };
 307
 308 static const struct sdhci_acpi_slot sdhci_acpi_slot_qcom_sd_3v = {
 309         .quirks  = SDHCI_QUIRK_BROKEN_CARD_DETECTION,
 310         .quirks2 = SDHCI_QUIRK2_NO_1_8_V,
 311         .caps    = MMC_CAP_NONREMOVABLE,
 312 };
 313
 314 static const struct sdhci_acpi_slot sdhci_acpi_slot_qcom_sd = {
 315         .quirks  = SDHCI_QUIRK_BROKEN_CARD_DETECTION,
 316         .caps    = MMC_CAP_NONREMOVABLE,
 317 };
 318
 319 struct sdhci_acpi_uid_slot {
 320         const char *hid;
 321         const char *uid;
 322         const struct sdhci_acpi_slot *slot;
 323 };
 324
 325 static const struct sdhci_acpi_uid_slot sdhci_acpi_uids[] = {
 326         { "80865ACA", NULL, &sdhci_acpi_slot_int_sd },
 327         { "80865ACC", NULL, &sdhci_acpi_slot_int_emmc },
 328         { "80865AD0", NULL, &sdhci_acpi_slot_int_sdio },
 329         { "80860F14" , "1" , &sdhci_acpi_slot_int_emmc },
 330         { "80860F14" , "3" , &sdhci_acpi_slot_int_sd   },
 331         { "80860F16" , NULL, &sdhci_acpi_slot_int_sd   },
 332         { "INT33BB"  , "2" , &sdhci_acpi_slot_int_sdio },
 333         { "INT33BB"  , "3" , &sdhci_acpi_slot_int_sd },
 334         { "INT33C6"  , NULL, &sdhci_acpi_slot_int_sdio },
 335         { "INT3436"  , NULL, &sdhci_acpi_slot_int_sdio },
 336         { "INT344D"  , NULL, &sdhci_acpi_slot_int_sdio },
 337         { "PNP0FFF"  , "3" , &sdhci_acpi_slot_int_sd   },
 338         { "PNP0D40"  },
 339         { "QCOM8051", NULL, &sdhci_acpi_slot_qcom_sd_3v },
 340         { "QCOM8052", NULL, &sdhci_acpi_slot_qcom_sd },
 341         { },
 342 };
 343
 344 static const struct acpi_device_id sdhci_acpi_ids[] = {
 345         { "80865ACA" },
 346         { "80865ACC" },
 347         { "80865AD0" },
 348         { "80860F14" },
 349         { "80860F16" },
 350         { "INT33BB"  },
 351         { "INT33C6"  },
 352         { "INT3436"  },
 353         { "INT344D"  },
 354         { "PNP0D40"  },
 355         { "QCOM8051" },
 356         { "QCOM8052" },
 357         { },
 358 };
 359 MODULE_DEVICE_TABLE(acpi, sdhci_acpi_ids);
 360
 361 static const struct sdhci_acpi_slot *sdhci_acpi_get_slot(const char *hid,
 362                                                          const char *uid)
 363 {
 364         const struct sdhci_acpi_uid_slot *u;
 365
 366         for (u = sdhci_acpi_uids; u->hid; u++) {
 367                 if (strcmp(u->hid, hid))
 368                         continue;
 369                 if (!u->uid)
 370                         return u->slot;
 371                 if (uid && !strcmp(u->uid, uid))
 372                         return u->slot;
 373         }
 374         return NULL;
 375 }
 376
 377 static int sdhci_acpi_probe(struct platform_device *pdev)
 378 {
 379         struct device *dev = &pdev->dev;
 380         acpi_handle handle = ACPI_HANDLE(dev);
 381         struct acpi_device *device, *child;
 382         struct sdhci_acpi_host *c;
 383         struct sdhci_host *host;
 384         struct resource *iomem;
 385         resource_size_t len;
 386         const char *hid;
 387         const char *uid;
 388         int err;
 389
 390         if (acpi_bus_get_device(handle, &device))
 391                 return -ENODEV;
 392
 393         /* Power on the SDHCI controller and its children */
 394         acpi_device_fix_up_power(device);
 395         list_for_each_entry(child, &device->children, node)
 396                 acpi_device_fix_up_power(child);
 397
 398         if (acpi_bus_get_status(device) || !device->status.present)
 399                 return -ENODEV;
 400
 401         if (sdhci_acpi_byt_defer(dev))
 402                 return -EPROBE_DEFER;
 403
 404         hid = acpi_device_hid(device);
 405         uid = device->pnp.unique_id;
 406
 407         iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 408         if (!iomem)
 409                 return -ENOMEM;
 410
 411         len = resource_size(iomem);
 412         if (len < 0x100)
 413                 dev_err(dev, "Invalid iomem size!\n");
 414
 415         if (!devm_request_mem_region(dev, iomem->start, len, dev_name(dev)))
 416                 return -ENOMEM;
 417
 418         host = sdhci_alloc_host(dev, sizeof(struct sdhci_acpi_host));
 419         if (IS_ERR(host))
 420                 return PTR_ERR(host);
 421
 422         c = sdhci_priv(host);
 423         c->host = host;
 424         c->slot = sdhci_acpi_get_slot(hid, uid);
 425         c->pdev = pdev;
 426         c->use_runtime_pm = sdhci_acpi_flag(c, SDHCI_ACPI_RUNTIME_PM);
 427
 428         platform_set_drvdata(pdev, c);
 429
 430         host->hw_name   = "ACPI";
 431         host->ops       = &sdhci_acpi_ops_dflt;
 432         host->irq       = platform_get_irq(pdev, 0);
 433
 434         host->ioaddr = devm_ioremap_nocache(dev, iomem->start,
 435                                             resource_size(iomem));
 436         if (host->ioaddr == NULL) {
 437                 err = -ENOMEM;
 438                 goto err_free;
 439         }
 440
 441         if (c->slot) {
 442                 if (c->slot->probe_slot) {
 443                         err = c->slot->probe_slot(pdev, hid, uid);
 444                         if (err)
 445                                 goto err_free;
 446                 }
 447                 if (c->slot->chip) {
 448                         host->ops            = c->slot->chip->ops;
 449                         host->quirks        |= c->slot->chip->quirks;
 450                         host->quirks2       |= c->slot->chip->quirks2;
 451                         host->mmc->caps     |= c->slot->chip->caps;
 452                         host->mmc->caps2    |= c->slot->chip->caps2;
 453                         host->mmc->pm_caps  |= c->slot->chip->pm_caps;
 454                 }
 455                 host->quirks        |= c->slot->quirks;
 456                 host->quirks2       |= c->slot->quirks2;
 457                 host->mmc->caps     |= c->slot->caps;
 458                 host->mmc->caps2    |= c->slot->caps2;
 459                 host->mmc->pm_caps  |= c->slot->pm_caps;
 460         }
 461
 462         host->mmc->caps2 |= MMC_CAP2_NO_PRESCAN_POWERUP;
 463
 464         if (sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD)) {
 465                 bool v = sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL);
 466
 467                 if (mmc_gpiod_request_cd(host->mmc, NULL, 0, v, 0, NULL)) {
 468                         dev_warn(dev, "failed to setup card detect gpio\n");
 469                         c->use_runtime_pm = false;
 470                 }
 471         }
 472
 473         err = sdhci_add_host(host);
 474         if (err)
 475                 goto err_free;
 476
 477         if (c->use_runtime_pm) {
 478                 pm_runtime_set_active(dev);
 479                 pm_suspend_ignore_children(dev, 1);
 480                 pm_runtime_set_autosuspend_delay(dev, 50);
 481                 pm_runtime_use_autosuspend(dev);
 482                 pm_runtime_enable(dev);
 483         }
 484
 485         device_enable_async_suspend(dev);
 486
 487         return 0;
 488
 489 err_free:
 490         sdhci_free_host(c->host);
 491         return err;
 492 }
 493
 494 static int sdhci_acpi_remove(struct platform_device *pdev)
 495 {
 496         struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
 497         struct device *dev = &pdev->dev;
 498         int dead;
 499
 500         if (c->use_runtime_pm) {
 501                 pm_runtime_get_sync(dev);
 502                 pm_runtime_disable(dev);
 503                 pm_runtime_put_noidle(dev);
 504         }
 505
 506         if (c->slot && c->slot->remove_slot)
 507                 c->slot->remove_slot(pdev);
 508
 509         dead = (sdhci_readl(c->host, SDHCI_INT_STATUS) == ~0);
 510         sdhci_remove_host(c->host, dead);
 511         sdhci_free_host(c->host);
 512
 513         return 0;
 514 }
 515
 516 #ifdef CONFIG_PM_SLEEP
 517
 518 static int sdhci_acpi_suspend(struct device *dev)
 519 {
 520         struct sdhci_acpi_host *c = dev_get_drvdata(dev);
 521
 522         return sdhci_suspend_host(c->host);
 523 }
 524
 525 static int sdhci_acpi_resume(struct device *dev)
 526 {
 527         struct sdhci_acpi_host *c = dev_get_drvdata(dev);
 528
 529         sdhci_acpi_byt_setting(&c->pdev->dev);
 530
 531         return sdhci_resume_host(c->host);
 532 }
 533
 534 #else
 535
 536 #define sdhci_acpi_suspend      NULL
 537 #define sdhci_acpi_resume       NULL
 538
 539 #endif
 540
 541 #ifdef CONFIG_PM
 542
 543 static int sdhci_acpi_runtime_suspend(struct device *dev)
 544 {
 545         struct sdhci_acpi_host *c = dev_get_drvdata(dev);
 546
 547         return sdhci_runtime_suspend_host(c->host);
 548 }
 549
 550 static int sdhci_acpi_runtime_resume(struct device *dev)
 551 {
 552         struct sdhci_acpi_host *c = dev_get_drvdata(dev);
 553
 554         sdhci_acpi_byt_setting(&c->pdev->dev);
 555
 556         return sdhci_runtime_resume_host(c->host);
 557 }
 558
 559 #endif
 560
 561 static const struct dev_pm_ops sdhci_acpi_pm_ops = {
 562         .suspend                = sdhci_acpi_suspend,
 563         .resume                 = sdhci_acpi_resume,
 564         SET_RUNTIME_PM_OPS(sdhci_acpi_runtime_suspend,
 565                         sdhci_acpi_runtime_resume, NULL)
 566 };
 567
 568 static struct platform_driver sdhci_acpi_driver = {
 569         .driver = {
 570                 .name                   = "sdhci-acpi",
 571                 .acpi_match_table       = sdhci_acpi_ids,
 572                 .pm                     = &sdhci_acpi_pm_ops,
 573         },
 574         .probe  = sdhci_acpi_probe,
 575         .remove = sdhci_acpi_remove,
 576 };
 577
 578 module_platform_driver(sdhci_acpi_driver);
 579
 580 MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver");
 581 MODULE_AUTHOR("Adrian Hunter");
 582 MODULE_LICENSE("GPL v2");