2 * Secure Digital Host Controller Interface ACPI driver.
4 * Copyright (c) 2012, Intel Corporation.
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.
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
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.
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>
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>
37 #include <linux/pm_runtime.h>
38 #include <linux/delay.h>
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>
48 SDHCI_ACPI_SD_CD = BIT(0),
49 SDHCI_ACPI_RUNTIME_PM = BIT(1),
50 SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL = BIT(2),
53 struct sdhci_acpi_chip {
54 const struct sdhci_ops *ops;
59 mmc_pm_flag_t pm_caps;
62 struct sdhci_acpi_slot {
63 const struct sdhci_acpi_chip *chip;
68 mmc_pm_flag_t pm_caps;
70 int (*probe_slot)(struct platform_device *, const char *, const char *);
71 int (*remove_slot)(struct platform_device *);
74 struct sdhci_acpi_host {
75 struct sdhci_host *host;
76 const struct sdhci_acpi_slot *slot;
77 struct platform_device *pdev;
81 static inline bool sdhci_acpi_flag(struct sdhci_acpi_host *c, unsigned int flag)
83 return c->slot && (c->slot->flags & flag);
86 static int sdhci_acpi_enable_dma(struct sdhci_host *host)
91 static void sdhci_acpi_int_hw_reset(struct sdhci_host *host)
95 reg = sdhci_readb(host, SDHCI_POWER_CONTROL);
97 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
98 /* For eMMC, minimum is 1us but give it 9us for good measure */
101 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
102 /* For eMMC, minimum is 200us but give it 300us for good measure */
103 usleep_range(300, 1000);
106 static const struct sdhci_ops sdhci_acpi_ops_dflt = {
107 .set_clock = sdhci_set_clock,
108 .enable_dma = sdhci_acpi_enable_dma,
109 .set_bus_width = sdhci_set_bus_width,
110 .reset = sdhci_reset,
111 .set_uhs_signaling = sdhci_set_uhs_signaling,
114 static const struct sdhci_ops sdhci_acpi_ops_int = {
115 .set_clock = sdhci_set_clock,
116 .enable_dma = sdhci_acpi_enable_dma,
117 .set_bus_width = sdhci_set_bus_width,
118 .reset = sdhci_reset,
119 .set_uhs_signaling = sdhci_set_uhs_signaling,
120 .hw_reset = sdhci_acpi_int_hw_reset,
123 static const struct sdhci_acpi_chip sdhci_acpi_chip_int = {
124 .ops = &sdhci_acpi_ops_int,
127 static int sdhci_acpi_emmc_probe_slot(struct platform_device *pdev,
128 const char *hid, const char *uid)
130 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
131 struct sdhci_host *host;
138 /* Platform specific code during emmc proble slot goes here */
140 if (hid && uid && !strcmp(hid, "80860F14") && !strcmp(uid, "1") &&
141 sdhci_readl(host, SDHCI_CAPABILITIES) == 0x446cc8b2 &&
142 sdhci_readl(host, SDHCI_CAPABILITIES_1) == 0x00000807)
143 host->timeout_clk = 1000; /* 1000 kHz i.e. 1 MHz */
148 static int sdhci_acpi_sdio_probe_slot(struct platform_device *pdev,
149 const char *hid, const char *uid)
151 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
152 struct sdhci_host *host;
159 /* Platform specific code during emmc proble slot goes here */
164 static int sdhci_acpi_sd_probe_slot(struct platform_device *pdev,
165 const char *hid, const char *uid)
167 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
168 struct sdhci_host *host;
170 if (!c || !c->host || !c->slot)
175 /* Platform specific code during emmc proble slot goes here */
180 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_emmc = {
181 .chip = &sdhci_acpi_chip_int,
182 .caps = MMC_CAP_8_BIT_DATA | MMC_CAP_NONREMOVABLE |
183 MMC_CAP_HW_RESET | MMC_CAP_1_8V_DDR,
184 .caps2 = MMC_CAP2_HC_ERASE_SZ,
185 .flags = SDHCI_ACPI_RUNTIME_PM,
186 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN | SDHCI_QUIRK2_STOP_WITH_TC,
187 .probe_slot = sdhci_acpi_emmc_probe_slot,
190 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sdio = {
191 .quirks = SDHCI_QUIRK_BROKEN_CARD_DETECTION,
192 .quirks2 = SDHCI_QUIRK2_HOST_OFF_CARD_ON,
193 .caps = MMC_CAP_NONREMOVABLE | MMC_CAP_POWER_OFF_CARD,
194 .flags = SDHCI_ACPI_RUNTIME_PM,
195 .pm_caps = MMC_PM_KEEP_POWER,
196 .probe_slot = sdhci_acpi_sdio_probe_slot,
199 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sd = {
200 .flags = SDHCI_ACPI_SD_CD | SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL |
201 SDHCI_ACPI_RUNTIME_PM,
202 .quirks2 = SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON |
203 SDHCI_QUIRK2_STOP_WITH_TC,
204 .probe_slot = sdhci_acpi_sd_probe_slot,
207 struct sdhci_acpi_uid_slot {
210 const struct sdhci_acpi_slot *slot;
213 static const struct sdhci_acpi_uid_slot sdhci_acpi_uids[] = {
214 { "80860F14" , "1" , &sdhci_acpi_slot_int_emmc },
215 { "80860F14" , "3" , &sdhci_acpi_slot_int_sd },
216 { "80860F16" , NULL, &sdhci_acpi_slot_int_sd },
217 { "INT33BB" , "2" , &sdhci_acpi_slot_int_sdio },
218 { "INT33BB" , "3" , &sdhci_acpi_slot_int_sd },
219 { "INT33C6" , NULL, &sdhci_acpi_slot_int_sdio },
220 { "INT3436" , NULL, &sdhci_acpi_slot_int_sdio },
225 static const struct acpi_device_id sdhci_acpi_ids[] = {
234 MODULE_DEVICE_TABLE(acpi, sdhci_acpi_ids);
236 static const struct sdhci_acpi_slot *sdhci_acpi_get_slot(const char *hid,
239 const struct sdhci_acpi_uid_slot *u;
241 for (u = sdhci_acpi_uids; u->hid; u++) {
242 if (strcmp(u->hid, hid))
246 if (uid && !strcmp(u->uid, uid))
252 static int sdhci_acpi_probe(struct platform_device *pdev)
254 struct device *dev = &pdev->dev;
255 acpi_handle handle = ACPI_HANDLE(dev);
256 struct acpi_device *device;
257 struct sdhci_acpi_host *c;
258 struct sdhci_host *host;
259 struct resource *iomem;
265 if (acpi_bus_get_device(handle, &device))
268 if (acpi_bus_get_status(device) || !device->status.present)
271 hid = acpi_device_hid(device);
272 uid = device->pnp.unique_id;
274 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
278 len = resource_size(iomem);
280 dev_err(dev, "Invalid iomem size!\n");
282 if (!devm_request_mem_region(dev, iomem->start, len, dev_name(dev)))
285 host = sdhci_alloc_host(dev, sizeof(struct sdhci_acpi_host));
287 return PTR_ERR(host);
289 c = sdhci_priv(host);
291 c->slot = sdhci_acpi_get_slot(hid, uid);
293 c->use_runtime_pm = sdhci_acpi_flag(c, SDHCI_ACPI_RUNTIME_PM);
295 platform_set_drvdata(pdev, c);
297 host->hw_name = "ACPI";
298 host->ops = &sdhci_acpi_ops_dflt;
299 host->irq = platform_get_irq(pdev, 0);
301 host->ioaddr = devm_ioremap_nocache(dev, iomem->start,
302 resource_size(iomem));
303 if (host->ioaddr == NULL) {
308 if (!dev->dma_mask) {
311 if (sdhci_readl(host, SDHCI_CAPABILITIES) & SDHCI_CAN_64BIT) {
312 /* 64-bit DMA is not supported at present */
313 dma_mask = DMA_BIT_MASK(32);
315 dma_mask = DMA_BIT_MASK(32);
318 err = dma_coerce_mask_and_coherent(dev, dma_mask);
324 if (c->slot->probe_slot) {
325 err = c->slot->probe_slot(pdev, hid, uid);
330 host->ops = c->slot->chip->ops;
331 host->quirks |= c->slot->chip->quirks;
332 host->quirks2 |= c->slot->chip->quirks2;
333 host->mmc->caps |= c->slot->chip->caps;
334 host->mmc->caps2 |= c->slot->chip->caps2;
335 host->mmc->pm_caps |= c->slot->chip->pm_caps;
337 host->quirks |= c->slot->quirks;
338 host->quirks2 |= c->slot->quirks2;
339 host->mmc->caps |= c->slot->caps;
340 host->mmc->caps2 |= c->slot->caps2;
341 host->mmc->pm_caps |= c->slot->pm_caps;
344 host->mmc->caps2 |= MMC_CAP2_NO_PRESCAN_POWERUP;
346 if (sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD)) {
347 bool v = sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL);
349 if (mmc_gpiod_request_cd(host->mmc, NULL, 0, v, 0, NULL)) {
350 dev_warn(dev, "failed to setup card detect gpio\n");
351 c->use_runtime_pm = false;
355 err = sdhci_add_host(host);
359 if (c->use_runtime_pm) {
360 pm_runtime_set_active(dev);
361 pm_suspend_ignore_children(dev, 1);
362 pm_runtime_set_autosuspend_delay(dev, 50);
363 pm_runtime_use_autosuspend(dev);
364 pm_runtime_enable(dev);
370 sdhci_free_host(c->host);
374 static int sdhci_acpi_remove(struct platform_device *pdev)
376 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
377 struct device *dev = &pdev->dev;
380 if (c->use_runtime_pm) {
381 pm_runtime_get_sync(dev);
382 pm_runtime_disable(dev);
383 pm_runtime_put_noidle(dev);
386 if (c->slot && c->slot->remove_slot)
387 c->slot->remove_slot(pdev);
389 dead = (sdhci_readl(c->host, SDHCI_INT_STATUS) == ~0);
390 sdhci_remove_host(c->host, dead);
391 sdhci_free_host(c->host);
396 #ifdef CONFIG_PM_SLEEP
398 static int sdhci_acpi_suspend(struct device *dev)
400 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
402 return sdhci_suspend_host(c->host);
405 static int sdhci_acpi_resume(struct device *dev)
407 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
409 return sdhci_resume_host(c->host);
414 #define sdhci_acpi_suspend NULL
415 #define sdhci_acpi_resume NULL
419 #ifdef CONFIG_PM_RUNTIME
421 static int sdhci_acpi_runtime_suspend(struct device *dev)
423 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
425 return sdhci_runtime_suspend_host(c->host);
428 static int sdhci_acpi_runtime_resume(struct device *dev)
430 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
432 return sdhci_runtime_resume_host(c->host);
435 static int sdhci_acpi_runtime_idle(struct device *dev)
442 static const struct dev_pm_ops sdhci_acpi_pm_ops = {
443 .suspend = sdhci_acpi_suspend,
444 .resume = sdhci_acpi_resume,
445 SET_RUNTIME_PM_OPS(sdhci_acpi_runtime_suspend,
446 sdhci_acpi_runtime_resume, sdhci_acpi_runtime_idle)
449 static struct platform_driver sdhci_acpi_driver = {
451 .name = "sdhci-acpi",
452 .owner = THIS_MODULE,
453 .acpi_match_table = sdhci_acpi_ids,
454 .pm = &sdhci_acpi_pm_ops,
456 .probe = sdhci_acpi_probe,
457 .remove = sdhci_acpi_remove,
460 module_platform_driver(sdhci_acpi_driver);
462 MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver");
463 MODULE_AUTHOR("Adrian Hunter");
464 MODULE_LICENSE("GPL v2");