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 #include <linux/mmc/sdhci.h> 44 45 #include "sdhci.h" 46 47 enum { 48 SDHCI_ACPI_SD_CD = BIT(0), 49 SDHCI_ACPI_RUNTIME_PM = BIT(1), 50 SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL = BIT(2), 51 }; 52 53 struct sdhci_acpi_chip { 54 const struct sdhci_ops *ops; 55 unsigned int quirks; 56 unsigned int quirks2; 57 unsigned long caps; 58 unsigned int caps2; 59 mmc_pm_flag_t pm_caps; 60 }; 61 62 struct sdhci_acpi_slot { 63 const struct sdhci_acpi_chip *chip; 64 unsigned int quirks; 65 unsigned int quirks2; 66 unsigned long caps; 67 unsigned int caps2; 68 mmc_pm_flag_t pm_caps; 69 unsigned int flags; 70 int (*probe_slot)(struct platform_device *, const char *, const char *); 71 int (*remove_slot)(struct platform_device *); 72 }; 73 74 struct sdhci_acpi_host { 75 struct sdhci_host *host; 76 const struct sdhci_acpi_slot *slot; 77 struct platform_device *pdev; 78 bool use_runtime_pm; 79 bool dma_setup; 80 }; 81 82 static inline bool sdhci_acpi_flag(struct sdhci_acpi_host *c, unsigned int flag) 83 { 84 return c->slot && (c->slot->flags & flag); 85 } 86 87 static int sdhci_acpi_enable_dma(struct sdhci_host *host) 88 { 89 struct sdhci_acpi_host *c = sdhci_priv(host); 90 struct device *dev = &c->pdev->dev; 91 int err = -1; 92 93 if (c->dma_setup) 94 return 0; 95 96 if (host->flags & SDHCI_USE_64_BIT_DMA) { 97 if (host->quirks2 & SDHCI_QUIRK2_BROKEN_64_BIT_DMA) { 98 host->flags &= ~SDHCI_USE_64_BIT_DMA; 99 } else { 100 err = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(64)); 101 if (err) 102 dev_warn(dev, "Failed to set 64-bit DMA mask\n"); 103 } 104 } 105 106 if (err) 107 err = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32)); 108 109 c->dma_setup = !err; 110 111 return err; 112 } 113 114 static void sdhci_acpi_int_hw_reset(struct sdhci_host *host) 115 { 116 u8 reg; 117 118 reg = sdhci_readb(host, SDHCI_POWER_CONTROL); 119 reg |= 0x10; 120 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL); 121 /* For eMMC, minimum is 1us but give it 9us for good measure */ 122 udelay(9); 123 reg &= ~0x10; 124 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL); 125 /* For eMMC, minimum is 200us but give it 300us for good measure */ 126 usleep_range(300, 1000); 127 } 128 129 static const struct sdhci_ops sdhci_acpi_ops_dflt = { 130 .set_clock = sdhci_set_clock, 131 .enable_dma = sdhci_acpi_enable_dma, 132 .set_bus_width = sdhci_set_bus_width, 133 .reset = sdhci_reset, 134 .set_uhs_signaling = sdhci_set_uhs_signaling, 135 }; 136 137 static const struct sdhci_ops sdhci_acpi_ops_int = { 138 .set_clock = sdhci_set_clock, 139 .enable_dma = sdhci_acpi_enable_dma, 140 .set_bus_width = sdhci_set_bus_width, 141 .reset = sdhci_reset, 142 .set_uhs_signaling = sdhci_set_uhs_signaling, 143 .hw_reset = sdhci_acpi_int_hw_reset, 144 }; 145 146 static const struct sdhci_acpi_chip sdhci_acpi_chip_int = { 147 .ops = &sdhci_acpi_ops_int, 148 }; 149 150 static int sdhci_acpi_emmc_probe_slot(struct platform_device *pdev, 151 const char *hid, const char *uid) 152 { 153 struct sdhci_acpi_host *c = platform_get_drvdata(pdev); 154 struct sdhci_host *host; 155 156 if (!c || !c->host) 157 return 0; 158 159 host = c->host; 160 161 /* Platform specific code during emmc proble slot goes here */ 162 163 if (hid && uid && !strcmp(hid, "80860F14") && !strcmp(uid, "1") && 164 sdhci_readl(host, SDHCI_CAPABILITIES) == 0x446cc8b2 && 165 sdhci_readl(host, SDHCI_CAPABILITIES_1) == 0x00000807) 166 host->timeout_clk = 1000; /* 1000 kHz i.e. 1 MHz */ 167 168 return 0; 169 } 170 171 static int sdhci_acpi_sdio_probe_slot(struct platform_device *pdev, 172 const char *hid, const char *uid) 173 { 174 struct sdhci_acpi_host *c = platform_get_drvdata(pdev); 175 struct sdhci_host *host; 176 177 if (!c || !c->host) 178 return 0; 179 180 host = c->host; 181 182 /* Platform specific code during emmc proble slot goes here */ 183 184 return 0; 185 } 186 187 static int sdhci_acpi_sd_probe_slot(struct platform_device *pdev, 188 const char *hid, const char *uid) 189 { 190 struct sdhci_acpi_host *c = platform_get_drvdata(pdev); 191 struct sdhci_host *host; 192 193 if (!c || !c->host || !c->slot) 194 return 0; 195 196 host = c->host; 197 198 /* Platform specific code during emmc proble slot goes here */ 199 200 return 0; 201 } 202 203 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_emmc = { 204 .chip = &sdhci_acpi_chip_int, 205 .caps = MMC_CAP_8_BIT_DATA | MMC_CAP_NONREMOVABLE | 206 MMC_CAP_HW_RESET | MMC_CAP_1_8V_DDR | 207 MMC_CAP_BUS_WIDTH_TEST | MMC_CAP_WAIT_WHILE_BUSY, 208 .caps2 = MMC_CAP2_HC_ERASE_SZ, 209 .flags = SDHCI_ACPI_RUNTIME_PM, 210 .quirks = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC, 211 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN | SDHCI_QUIRK2_STOP_WITH_TC, 212 .probe_slot = sdhci_acpi_emmc_probe_slot, 213 }; 214 215 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sdio = { 216 .quirks = SDHCI_QUIRK_BROKEN_CARD_DETECTION | 217 SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC, 218 .quirks2 = SDHCI_QUIRK2_HOST_OFF_CARD_ON, 219 .caps = MMC_CAP_NONREMOVABLE | MMC_CAP_POWER_OFF_CARD | 220 MMC_CAP_BUS_WIDTH_TEST | MMC_CAP_WAIT_WHILE_BUSY, 221 .flags = SDHCI_ACPI_RUNTIME_PM, 222 .pm_caps = MMC_PM_KEEP_POWER, 223 .probe_slot = sdhci_acpi_sdio_probe_slot, 224 }; 225 226 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sd = { 227 .flags = SDHCI_ACPI_SD_CD | SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL | 228 SDHCI_ACPI_RUNTIME_PM, 229 .quirks = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC, 230 .quirks2 = SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON | 231 SDHCI_QUIRK2_STOP_WITH_TC, 232 .caps = MMC_CAP_BUS_WIDTH_TEST | MMC_CAP_WAIT_WHILE_BUSY, 233 .probe_slot = sdhci_acpi_sd_probe_slot, 234 }; 235 236 struct sdhci_acpi_uid_slot { 237 const char *hid; 238 const char *uid; 239 const struct sdhci_acpi_slot *slot; 240 }; 241 242 static const struct sdhci_acpi_uid_slot sdhci_acpi_uids[] = { 243 { "80860F14" , "1" , &sdhci_acpi_slot_int_emmc }, 244 { "80860F14" , "3" , &sdhci_acpi_slot_int_sd }, 245 { "80860F16" , NULL, &sdhci_acpi_slot_int_sd }, 246 { "INT33BB" , "2" , &sdhci_acpi_slot_int_sdio }, 247 { "INT33BB" , "3" , &sdhci_acpi_slot_int_sd }, 248 { "INT33C6" , NULL, &sdhci_acpi_slot_int_sdio }, 249 { "INT3436" , NULL, &sdhci_acpi_slot_int_sdio }, 250 { "PNP0D40" }, 251 { }, 252 }; 253 254 static const struct acpi_device_id sdhci_acpi_ids[] = { 255 { "80860F14" }, 256 { "80860F16" }, 257 { "INT33BB" }, 258 { "INT33C6" }, 259 { "INT3436" }, 260 { "PNP0D40" }, 261 { }, 262 }; 263 MODULE_DEVICE_TABLE(acpi, sdhci_acpi_ids); 264 265 static const struct sdhci_acpi_slot *sdhci_acpi_get_slot(const char *hid, 266 const char *uid) 267 { 268 const struct sdhci_acpi_uid_slot *u; 269 270 for (u = sdhci_acpi_uids; u->hid; u++) { 271 if (strcmp(u->hid, hid)) 272 continue; 273 if (!u->uid) 274 return u->slot; 275 if (uid && !strcmp(u->uid, uid)) 276 return u->slot; 277 } 278 return NULL; 279 } 280 281 static int sdhci_acpi_probe(struct platform_device *pdev) 282 { 283 struct device *dev = &pdev->dev; 284 acpi_handle handle = ACPI_HANDLE(dev); 285 struct acpi_device *device; 286 struct sdhci_acpi_host *c; 287 struct sdhci_host *host; 288 struct resource *iomem; 289 resource_size_t len; 290 const char *hid; 291 const char *uid; 292 int err; 293 294 if (acpi_bus_get_device(handle, &device)) 295 return -ENODEV; 296 297 if (acpi_bus_get_status(device) || !device->status.present) 298 return -ENODEV; 299 300 hid = acpi_device_hid(device); 301 uid = device->pnp.unique_id; 302 303 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0); 304 if (!iomem) 305 return -ENOMEM; 306 307 len = resource_size(iomem); 308 if (len < 0x100) 309 dev_err(dev, "Invalid iomem size!\n"); 310 311 if (!devm_request_mem_region(dev, iomem->start, len, dev_name(dev))) 312 return -ENOMEM; 313 314 host = sdhci_alloc_host(dev, sizeof(struct sdhci_acpi_host)); 315 if (IS_ERR(host)) 316 return PTR_ERR(host); 317 318 c = sdhci_priv(host); 319 c->host = host; 320 c->slot = sdhci_acpi_get_slot(hid, uid); 321 c->pdev = pdev; 322 c->use_runtime_pm = sdhci_acpi_flag(c, SDHCI_ACPI_RUNTIME_PM); 323 324 platform_set_drvdata(pdev, c); 325 326 host->hw_name = "ACPI"; 327 host->ops = &sdhci_acpi_ops_dflt; 328 host->irq = platform_get_irq(pdev, 0); 329 330 host->ioaddr = devm_ioremap_nocache(dev, iomem->start, 331 resource_size(iomem)); 332 if (host->ioaddr == NULL) { 333 err = -ENOMEM; 334 goto err_free; 335 } 336 337 if (c->slot) { 338 if (c->slot->probe_slot) { 339 err = c->slot->probe_slot(pdev, hid, uid); 340 if (err) 341 goto err_free; 342 } 343 if (c->slot->chip) { 344 host->ops = c->slot->chip->ops; 345 host->quirks |= c->slot->chip->quirks; 346 host->quirks2 |= c->slot->chip->quirks2; 347 host->mmc->caps |= c->slot->chip->caps; 348 host->mmc->caps2 |= c->slot->chip->caps2; 349 host->mmc->pm_caps |= c->slot->chip->pm_caps; 350 } 351 host->quirks |= c->slot->quirks; 352 host->quirks2 |= c->slot->quirks2; 353 host->mmc->caps |= c->slot->caps; 354 host->mmc->caps2 |= c->slot->caps2; 355 host->mmc->pm_caps |= c->slot->pm_caps; 356 } 357 358 host->mmc->caps2 |= MMC_CAP2_NO_PRESCAN_POWERUP; 359 360 if (sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD)) { 361 bool v = sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL); 362 363 if (mmc_gpiod_request_cd(host->mmc, NULL, 0, v, 0, NULL)) { 364 dev_warn(dev, "failed to setup card detect gpio\n"); 365 c->use_runtime_pm = false; 366 } 367 } 368 369 err = sdhci_add_host(host); 370 if (err) 371 goto err_free; 372 373 if (c->use_runtime_pm) { 374 pm_runtime_set_active(dev); 375 pm_suspend_ignore_children(dev, 1); 376 pm_runtime_set_autosuspend_delay(dev, 50); 377 pm_runtime_use_autosuspend(dev); 378 pm_runtime_enable(dev); 379 } 380 381 return 0; 382 383 err_free: 384 sdhci_free_host(c->host); 385 return err; 386 } 387 388 static int sdhci_acpi_remove(struct platform_device *pdev) 389 { 390 struct sdhci_acpi_host *c = platform_get_drvdata(pdev); 391 struct device *dev = &pdev->dev; 392 int dead; 393 394 if (c->use_runtime_pm) { 395 pm_runtime_get_sync(dev); 396 pm_runtime_disable(dev); 397 pm_runtime_put_noidle(dev); 398 } 399 400 if (c->slot && c->slot->remove_slot) 401 c->slot->remove_slot(pdev); 402 403 dead = (sdhci_readl(c->host, SDHCI_INT_STATUS) == ~0); 404 sdhci_remove_host(c->host, dead); 405 sdhci_free_host(c->host); 406 407 return 0; 408 } 409 410 #ifdef CONFIG_PM_SLEEP 411 412 static int sdhci_acpi_suspend(struct device *dev) 413 { 414 struct sdhci_acpi_host *c = dev_get_drvdata(dev); 415 416 return sdhci_suspend_host(c->host); 417 } 418 419 static int sdhci_acpi_resume(struct device *dev) 420 { 421 struct sdhci_acpi_host *c = dev_get_drvdata(dev); 422 423 return sdhci_resume_host(c->host); 424 } 425 426 #else 427 428 #define sdhci_acpi_suspend NULL 429 #define sdhci_acpi_resume NULL 430 431 #endif 432 433 #ifdef CONFIG_PM 434 435 static int sdhci_acpi_runtime_suspend(struct device *dev) 436 { 437 struct sdhci_acpi_host *c = dev_get_drvdata(dev); 438 439 return sdhci_runtime_suspend_host(c->host); 440 } 441 442 static int sdhci_acpi_runtime_resume(struct device *dev) 443 { 444 struct sdhci_acpi_host *c = dev_get_drvdata(dev); 445 446 return sdhci_runtime_resume_host(c->host); 447 } 448 449 static int sdhci_acpi_runtime_idle(struct device *dev) 450 { 451 return 0; 452 } 453 454 #endif 455 456 static const struct dev_pm_ops sdhci_acpi_pm_ops = { 457 .suspend = sdhci_acpi_suspend, 458 .resume = sdhci_acpi_resume, 459 SET_RUNTIME_PM_OPS(sdhci_acpi_runtime_suspend, 460 sdhci_acpi_runtime_resume, sdhci_acpi_runtime_idle) 461 }; 462 463 static struct platform_driver sdhci_acpi_driver = { 464 .driver = { 465 .name = "sdhci-acpi", 466 .acpi_match_table = sdhci_acpi_ids, 467 .pm = &sdhci_acpi_pm_ops, 468 }, 469 .probe = sdhci_acpi_probe, 470 .remove = sdhci_acpi_remove, 471 }; 472 473 module_platform_driver(sdhci_acpi_driver); 474 475 MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver"); 476 MODULE_AUTHOR("Adrian Hunter"); 477 MODULE_LICENSE("GPL v2"); 478