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 bool dma_setup;
84 };
85
sdhci_acpi_flag(struct sdhci_acpi_host * c,unsigned int flag)86 static inline bool sdhci_acpi_flag(struct sdhci_acpi_host *c, unsigned int flag)
87 {
88 return c->slot && (c->slot->flags & flag);
89 }
90
sdhci_acpi_enable_dma(struct sdhci_host * host)91 static int sdhci_acpi_enable_dma(struct sdhci_host *host)
92 {
93 struct sdhci_acpi_host *c = sdhci_priv(host);
94 struct device *dev = &c->pdev->dev;
95 int err = -1;
96
97 if (c->dma_setup)
98 return 0;
99
100 if (host->flags & SDHCI_USE_64_BIT_DMA) {
101 if (host->quirks2 & SDHCI_QUIRK2_BROKEN_64_BIT_DMA) {
102 host->flags &= ~SDHCI_USE_64_BIT_DMA;
103 } else {
104 err = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(64));
105 if (err)
106 dev_warn(dev, "Failed to set 64-bit DMA mask\n");
107 }
108 }
109
110 if (err)
111 err = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
112
113 c->dma_setup = !err;
114
115 return err;
116 }
117
sdhci_acpi_int_hw_reset(struct sdhci_host * host)118 static void sdhci_acpi_int_hw_reset(struct sdhci_host *host)
119 {
120 u8 reg;
121
122 reg = sdhci_readb(host, SDHCI_POWER_CONTROL);
123 reg |= 0x10;
124 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
125 /* For eMMC, minimum is 1us but give it 9us for good measure */
126 udelay(9);
127 reg &= ~0x10;
128 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
129 /* For eMMC, minimum is 200us but give it 300us for good measure */
130 usleep_range(300, 1000);
131 }
132
133 static const struct sdhci_ops sdhci_acpi_ops_dflt = {
134 .set_clock = sdhci_set_clock,
135 .enable_dma = sdhci_acpi_enable_dma,
136 .set_bus_width = sdhci_set_bus_width,
137 .reset = sdhci_reset,
138 .set_uhs_signaling = sdhci_set_uhs_signaling,
139 };
140
141 static const struct sdhci_ops sdhci_acpi_ops_int = {
142 .set_clock = sdhci_set_clock,
143 .enable_dma = sdhci_acpi_enable_dma,
144 .set_bus_width = sdhci_set_bus_width,
145 .reset = sdhci_reset,
146 .set_uhs_signaling = sdhci_set_uhs_signaling,
147 .hw_reset = sdhci_acpi_int_hw_reset,
148 };
149
150 static const struct sdhci_acpi_chip sdhci_acpi_chip_int = {
151 .ops = &sdhci_acpi_ops_int,
152 };
153
154 #ifdef CONFIG_X86
155
sdhci_acpi_byt(void)156 static bool sdhci_acpi_byt(void)
157 {
158 static const struct x86_cpu_id byt[] = {
159 { X86_VENDOR_INTEL, 6, 0x37 },
160 {}
161 };
162
163 return x86_match_cpu(byt);
164 }
165
166 #define BYT_IOSF_SCCEP 0x63
167 #define BYT_IOSF_OCP_NETCTRL0 0x1078
168 #define BYT_IOSF_OCP_TIMEOUT_BASE GENMASK(10, 8)
169
sdhci_acpi_byt_setting(struct device * dev)170 static void sdhci_acpi_byt_setting(struct device *dev)
171 {
172 u32 val = 0;
173
174 if (!sdhci_acpi_byt())
175 return;
176
177 if (iosf_mbi_read(BYT_IOSF_SCCEP, 0x06, BYT_IOSF_OCP_NETCTRL0,
178 &val)) {
179 dev_err(dev, "%s read error\n", __func__);
180 return;
181 }
182
183 if (!(val & BYT_IOSF_OCP_TIMEOUT_BASE))
184 return;
185
186 val &= ~BYT_IOSF_OCP_TIMEOUT_BASE;
187
188 if (iosf_mbi_write(BYT_IOSF_SCCEP, 0x07, BYT_IOSF_OCP_NETCTRL0,
189 val)) {
190 dev_err(dev, "%s write error\n", __func__);
191 return;
192 }
193
194 dev_dbg(dev, "%s completed\n", __func__);
195 }
196
sdhci_acpi_byt_defer(struct device * dev)197 static bool sdhci_acpi_byt_defer(struct device *dev)
198 {
199 if (!sdhci_acpi_byt())
200 return false;
201
202 if (!iosf_mbi_available())
203 return true;
204
205 sdhci_acpi_byt_setting(dev);
206
207 return false;
208 }
209
210 #else
211
sdhci_acpi_byt_setting(struct device * dev)212 static inline void sdhci_acpi_byt_setting(struct device *dev)
213 {
214 }
215
sdhci_acpi_byt_defer(struct device * dev)216 static inline bool sdhci_acpi_byt_defer(struct device *dev)
217 {
218 return false;
219 }
220
221 #endif
222
bxt_get_cd(struct mmc_host * mmc)223 static int bxt_get_cd(struct mmc_host *mmc)
224 {
225 int gpio_cd = mmc_gpio_get_cd(mmc);
226 struct sdhci_host *host = mmc_priv(mmc);
227 unsigned long flags;
228 int ret = 0;
229
230 if (!gpio_cd)
231 return 0;
232
233 pm_runtime_get_sync(mmc->parent);
234
235 spin_lock_irqsave(&host->lock, flags);
236
237 if (host->flags & SDHCI_DEVICE_DEAD)
238 goto out;
239
240 ret = !!(sdhci_readl(host, SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT);
241 out:
242 spin_unlock_irqrestore(&host->lock, flags);
243
244 pm_runtime_mark_last_busy(mmc->parent);
245 pm_runtime_put_autosuspend(mmc->parent);
246
247 return ret;
248 }
249
sdhci_acpi_emmc_probe_slot(struct platform_device * pdev,const char * hid,const char * uid)250 static int sdhci_acpi_emmc_probe_slot(struct platform_device *pdev,
251 const char *hid, const char *uid)
252 {
253 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
254 struct sdhci_host *host;
255
256 if (!c || !c->host)
257 return 0;
258
259 host = c->host;
260
261 /* Platform specific code during emmc probe slot goes here */
262
263 if (hid && uid && !strcmp(hid, "80860F14") && !strcmp(uid, "1") &&
264 sdhci_readl(host, SDHCI_CAPABILITIES) == 0x446cc8b2 &&
265 sdhci_readl(host, SDHCI_CAPABILITIES_1) == 0x00000807)
266 host->timeout_clk = 1000; /* 1000 kHz i.e. 1 MHz */
267
268 return 0;
269 }
270
sdhci_acpi_sdio_probe_slot(struct platform_device * pdev,const char * hid,const char * uid)271 static int sdhci_acpi_sdio_probe_slot(struct platform_device *pdev,
272 const char *hid, const char *uid)
273 {
274 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
275 struct sdhci_host *host;
276
277 if (!c || !c->host)
278 return 0;
279
280 host = c->host;
281
282 /* Platform specific code during sdio probe slot goes here */
283
284 return 0;
285 }
286
sdhci_acpi_sd_probe_slot(struct platform_device * pdev,const char * hid,const char * uid)287 static int sdhci_acpi_sd_probe_slot(struct platform_device *pdev,
288 const char *hid, const char *uid)
289 {
290 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
291 struct sdhci_host *host;
292
293 if (!c || !c->host || !c->slot)
294 return 0;
295
296 host = c->host;
297
298 /* Platform specific code during sd probe slot goes here */
299
300 if (hid && !strcmp(hid, "80865ACA"))
301 host->mmc_host_ops.get_cd = bxt_get_cd;
302
303 return 0;
304 }
305
306 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_emmc = {
307 .chip = &sdhci_acpi_chip_int,
308 .caps = MMC_CAP_8_BIT_DATA | MMC_CAP_NONREMOVABLE |
309 MMC_CAP_HW_RESET | MMC_CAP_1_8V_DDR |
310 MMC_CAP_WAIT_WHILE_BUSY,
311 .caps2 = MMC_CAP2_HC_ERASE_SZ,
312 .flags = SDHCI_ACPI_RUNTIME_PM,
313 .quirks = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
314 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN |
315 SDHCI_QUIRK2_STOP_WITH_TC |
316 SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400,
317 .probe_slot = sdhci_acpi_emmc_probe_slot,
318 };
319
320 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sdio = {
321 .quirks = SDHCI_QUIRK_BROKEN_CARD_DETECTION |
322 SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
323 .quirks2 = SDHCI_QUIRK2_HOST_OFF_CARD_ON,
324 .caps = MMC_CAP_NONREMOVABLE | MMC_CAP_POWER_OFF_CARD |
325 MMC_CAP_WAIT_WHILE_BUSY,
326 .flags = SDHCI_ACPI_RUNTIME_PM,
327 .pm_caps = MMC_PM_KEEP_POWER,
328 .probe_slot = sdhci_acpi_sdio_probe_slot,
329 };
330
331 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sd = {
332 .flags = SDHCI_ACPI_SD_CD | SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL |
333 SDHCI_ACPI_RUNTIME_PM,
334 .quirks = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
335 .quirks2 = SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON |
336 SDHCI_QUIRK2_STOP_WITH_TC,
337 .caps = MMC_CAP_WAIT_WHILE_BUSY,
338 .probe_slot = sdhci_acpi_sd_probe_slot,
339 };
340
341 struct sdhci_acpi_uid_slot {
342 const char *hid;
343 const char *uid;
344 const struct sdhci_acpi_slot *slot;
345 };
346
347 static const struct sdhci_acpi_uid_slot sdhci_acpi_uids[] = {
348 { "80865ACA", NULL, &sdhci_acpi_slot_int_sd },
349 { "80865ACC", NULL, &sdhci_acpi_slot_int_emmc },
350 { "80865AD0", NULL, &sdhci_acpi_slot_int_sdio },
351 { "80860F14" , "1" , &sdhci_acpi_slot_int_emmc },
352 { "80860F14" , "3" , &sdhci_acpi_slot_int_sd },
353 { "80860F16" , NULL, &sdhci_acpi_slot_int_sd },
354 { "INT33BB" , "2" , &sdhci_acpi_slot_int_sdio },
355 { "INT33BB" , "3" , &sdhci_acpi_slot_int_sd },
356 { "INT33C6" , NULL, &sdhci_acpi_slot_int_sdio },
357 { "INT3436" , NULL, &sdhci_acpi_slot_int_sdio },
358 { "INT344D" , NULL, &sdhci_acpi_slot_int_sdio },
359 { "PNP0FFF" , "3" , &sdhci_acpi_slot_int_sd },
360 { "PNP0D40" },
361 { },
362 };
363
364 static const struct acpi_device_id sdhci_acpi_ids[] = {
365 { "80865ACA" },
366 { "80865ACC" },
367 { "80865AD0" },
368 { "80860F14" },
369 { "80860F16" },
370 { "INT33BB" },
371 { "INT33C6" },
372 { "INT3436" },
373 { "INT344D" },
374 { "PNP0D40" },
375 { },
376 };
377 MODULE_DEVICE_TABLE(acpi, sdhci_acpi_ids);
378
sdhci_acpi_get_slot(const char * hid,const char * uid)379 static const struct sdhci_acpi_slot *sdhci_acpi_get_slot(const char *hid,
380 const char *uid)
381 {
382 const struct sdhci_acpi_uid_slot *u;
383
384 for (u = sdhci_acpi_uids; u->hid; u++) {
385 if (strcmp(u->hid, hid))
386 continue;
387 if (!u->uid)
388 return u->slot;
389 if (uid && !strcmp(u->uid, uid))
390 return u->slot;
391 }
392 return NULL;
393 }
394
sdhci_acpi_probe(struct platform_device * pdev)395 static int sdhci_acpi_probe(struct platform_device *pdev)
396 {
397 struct device *dev = &pdev->dev;
398 acpi_handle handle = ACPI_HANDLE(dev);
399 struct acpi_device *device;
400 struct sdhci_acpi_host *c;
401 struct sdhci_host *host;
402 struct resource *iomem;
403 resource_size_t len;
404 const char *hid;
405 const char *uid;
406 int err;
407
408 if (acpi_bus_get_device(handle, &device))
409 return -ENODEV;
410
411 if (acpi_bus_get_status(device) || !device->status.present)
412 return -ENODEV;
413
414 if (sdhci_acpi_byt_defer(dev))
415 return -EPROBE_DEFER;
416
417 hid = acpi_device_hid(device);
418 uid = device->pnp.unique_id;
419
420 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
421 if (!iomem)
422 return -ENOMEM;
423
424 len = resource_size(iomem);
425 if (len < 0x100)
426 dev_err(dev, "Invalid iomem size!\n");
427
428 if (!devm_request_mem_region(dev, iomem->start, len, dev_name(dev)))
429 return -ENOMEM;
430
431 host = sdhci_alloc_host(dev, sizeof(struct sdhci_acpi_host));
432 if (IS_ERR(host))
433 return PTR_ERR(host);
434
435 c = sdhci_priv(host);
436 c->host = host;
437 c->slot = sdhci_acpi_get_slot(hid, uid);
438 c->pdev = pdev;
439 c->use_runtime_pm = sdhci_acpi_flag(c, SDHCI_ACPI_RUNTIME_PM);
440
441 platform_set_drvdata(pdev, c);
442
443 host->hw_name = "ACPI";
444 host->ops = &sdhci_acpi_ops_dflt;
445 host->irq = platform_get_irq(pdev, 0);
446
447 host->ioaddr = devm_ioremap_nocache(dev, iomem->start,
448 resource_size(iomem));
449 if (host->ioaddr == NULL) {
450 err = -ENOMEM;
451 goto err_free;
452 }
453
454 if (c->slot) {
455 if (c->slot->probe_slot) {
456 err = c->slot->probe_slot(pdev, hid, uid);
457 if (err)
458 goto err_free;
459 }
460 if (c->slot->chip) {
461 host->ops = c->slot->chip->ops;
462 host->quirks |= c->slot->chip->quirks;
463 host->quirks2 |= c->slot->chip->quirks2;
464 host->mmc->caps |= c->slot->chip->caps;
465 host->mmc->caps2 |= c->slot->chip->caps2;
466 host->mmc->pm_caps |= c->slot->chip->pm_caps;
467 }
468 host->quirks |= c->slot->quirks;
469 host->quirks2 |= c->slot->quirks2;
470 host->mmc->caps |= c->slot->caps;
471 host->mmc->caps2 |= c->slot->caps2;
472 host->mmc->pm_caps |= c->slot->pm_caps;
473 }
474
475 host->mmc->caps2 |= MMC_CAP2_NO_PRESCAN_POWERUP;
476
477 if (sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD)) {
478 bool v = sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL);
479
480 if (mmc_gpiod_request_cd(host->mmc, NULL, 0, v, 0, NULL)) {
481 dev_warn(dev, "failed to setup card detect gpio\n");
482 c->use_runtime_pm = false;
483 }
484 }
485
486 err = sdhci_add_host(host);
487 if (err)
488 goto err_free;
489
490 if (c->use_runtime_pm) {
491 pm_runtime_set_active(dev);
492 pm_suspend_ignore_children(dev, 1);
493 pm_runtime_set_autosuspend_delay(dev, 50);
494 pm_runtime_use_autosuspend(dev);
495 pm_runtime_enable(dev);
496 }
497
498 return 0;
499
500 err_free:
501 sdhci_free_host(c->host);
502 return err;
503 }
504
sdhci_acpi_remove(struct platform_device * pdev)505 static int sdhci_acpi_remove(struct platform_device *pdev)
506 {
507 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
508 struct device *dev = &pdev->dev;
509 int dead;
510
511 if (c->use_runtime_pm) {
512 pm_runtime_get_sync(dev);
513 pm_runtime_disable(dev);
514 pm_runtime_put_noidle(dev);
515 }
516
517 if (c->slot && c->slot->remove_slot)
518 c->slot->remove_slot(pdev);
519
520 dead = (sdhci_readl(c->host, SDHCI_INT_STATUS) == ~0);
521 sdhci_remove_host(c->host, dead);
522 sdhci_free_host(c->host);
523
524 return 0;
525 }
526
527 #ifdef CONFIG_PM_SLEEP
528
sdhci_acpi_suspend(struct device * dev)529 static int sdhci_acpi_suspend(struct device *dev)
530 {
531 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
532
533 return sdhci_suspend_host(c->host);
534 }
535
sdhci_acpi_resume(struct device * dev)536 static int sdhci_acpi_resume(struct device *dev)
537 {
538 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
539
540 sdhci_acpi_byt_setting(&c->pdev->dev);
541
542 return sdhci_resume_host(c->host);
543 }
544
545 #else
546
547 #define sdhci_acpi_suspend NULL
548 #define sdhci_acpi_resume NULL
549
550 #endif
551
552 #ifdef CONFIG_PM
553
sdhci_acpi_runtime_suspend(struct device * dev)554 static int sdhci_acpi_runtime_suspend(struct device *dev)
555 {
556 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
557
558 return sdhci_runtime_suspend_host(c->host);
559 }
560
sdhci_acpi_runtime_resume(struct device * dev)561 static int sdhci_acpi_runtime_resume(struct device *dev)
562 {
563 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
564
565 sdhci_acpi_byt_setting(&c->pdev->dev);
566
567 return sdhci_runtime_resume_host(c->host);
568 }
569
570 #endif
571
572 static const struct dev_pm_ops sdhci_acpi_pm_ops = {
573 .suspend = sdhci_acpi_suspend,
574 .resume = sdhci_acpi_resume,
575 SET_RUNTIME_PM_OPS(sdhci_acpi_runtime_suspend,
576 sdhci_acpi_runtime_resume, NULL)
577 };
578
579 static struct platform_driver sdhci_acpi_driver = {
580 .driver = {
581 .name = "sdhci-acpi",
582 .acpi_match_table = sdhci_acpi_ids,
583 .pm = &sdhci_acpi_pm_ops,
584 },
585 .probe = sdhci_acpi_probe,
586 .remove = sdhci_acpi_remove,
587 };
588
589 module_platform_driver(sdhci_acpi_driver);
590
591 MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver");
592 MODULE_AUTHOR("Adrian Hunter");
593 MODULE_LICENSE("GPL v2");
594