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