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>
45 #include <asm/cpu_device_id.h>
46 #include <asm/intel-family.h>
47 #include <asm/iosf_mbi.h>
48 #include <linux/pci.h>
54 SDHCI_ACPI_SD_CD
= BIT(0),
55 SDHCI_ACPI_RUNTIME_PM
= BIT(1),
56 SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL
= BIT(2),
59 struct sdhci_acpi_chip
{
60 const struct sdhci_ops
*ops
;
65 mmc_pm_flag_t pm_caps
;
68 struct sdhci_acpi_slot
{
69 const struct sdhci_acpi_chip
*chip
;
74 mmc_pm_flag_t pm_caps
;
76 int (*probe_slot
)(struct platform_device
*, const char *, const char *);
77 int (*remove_slot
)(struct platform_device
*);
80 struct sdhci_acpi_host
{
81 struct sdhci_host
*host
;
82 const struct sdhci_acpi_slot
*slot
;
83 struct platform_device
*pdev
;
87 static inline bool sdhci_acpi_flag(struct sdhci_acpi_host
*c
, unsigned int flag
)
89 return c
->slot
&& (c
->slot
->flags
& flag
);
92 static void sdhci_acpi_int_hw_reset(struct sdhci_host
*host
)
96 reg
= sdhci_readb(host
, SDHCI_POWER_CONTROL
);
98 sdhci_writeb(host
, reg
, SDHCI_POWER_CONTROL
);
99 /* For eMMC, minimum is 1us but give it 9us for good measure */
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);
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
,
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
,
122 static const struct sdhci_acpi_chip sdhci_acpi_chip_int
= {
123 .ops
= &sdhci_acpi_ops_int
,
128 static bool sdhci_acpi_byt(void)
130 static const struct x86_cpu_id byt
[] = {
131 { X86_VENDOR_INTEL
, 6, INTEL_FAM6_ATOM_SILVERMONT1
},
135 return x86_match_cpu(byt
);
138 static bool sdhci_acpi_cht(void)
140 static const struct x86_cpu_id cht
[] = {
141 { X86_VENDOR_INTEL
, 6, INTEL_FAM6_ATOM_AIRMONT
},
145 return x86_match_cpu(cht
);
148 #define BYT_IOSF_SCCEP 0x63
149 #define BYT_IOSF_OCP_NETCTRL0 0x1078
150 #define BYT_IOSF_OCP_TIMEOUT_BASE GENMASK(10, 8)
152 static void sdhci_acpi_byt_setting(struct device
*dev
)
156 if (!sdhci_acpi_byt())
159 if (iosf_mbi_read(BYT_IOSF_SCCEP
, MBI_CR_READ
, BYT_IOSF_OCP_NETCTRL0
,
161 dev_err(dev
, "%s read error\n", __func__
);
165 if (!(val
& BYT_IOSF_OCP_TIMEOUT_BASE
))
168 val
&= ~BYT_IOSF_OCP_TIMEOUT_BASE
;
170 if (iosf_mbi_write(BYT_IOSF_SCCEP
, MBI_CR_WRITE
, BYT_IOSF_OCP_NETCTRL0
,
172 dev_err(dev
, "%s write error\n", __func__
);
176 dev_dbg(dev
, "%s completed\n", __func__
);
179 static bool sdhci_acpi_byt_defer(struct device
*dev
)
181 if (!sdhci_acpi_byt())
184 if (!iosf_mbi_available())
187 sdhci_acpi_byt_setting(dev
);
192 static bool sdhci_acpi_cht_pci_wifi(unsigned int vendor
, unsigned int device
,
193 unsigned int slot
, unsigned int parent_slot
)
195 struct pci_dev
*dev
, *parent
, *from
= NULL
;
198 dev
= pci_get_device(vendor
, device
, from
);
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
)) {
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.
222 static inline bool sdhci_acpi_no_fixup_child_power(const char *hid
,
225 return sdhci_acpi_cht() &&
226 !strcmp(hid
, "80860F14") &&
228 sdhci_acpi_cht_pci_wifi(0x14e4, 0x43ec, 0, 28);
233 static inline void sdhci_acpi_byt_setting(struct device
*dev
)
237 static inline bool sdhci_acpi_byt_defer(struct device
*dev
)
242 static inline bool sdhci_acpi_no_fixup_child_power(const char *hid
,
250 static int bxt_get_cd(struct mmc_host
*mmc
)
252 int gpio_cd
= mmc_gpio_get_cd(mmc
);
253 struct sdhci_host
*host
= mmc_priv(mmc
);
260 spin_lock_irqsave(&host
->lock
, flags
);
262 if (host
->flags
& SDHCI_DEVICE_DEAD
)
265 ret
= !!(sdhci_readl(host
, SDHCI_PRESENT_STATE
) & SDHCI_CARD_PRESENT
);
267 spin_unlock_irqrestore(&host
->lock
, flags
);
272 static int sdhci_acpi_emmc_probe_slot(struct platform_device
*pdev
,
273 const char *hid
, const char *uid
)
275 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
276 struct sdhci_host
*host
;
283 /* Platform specific code during emmc probe slot goes here */
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 */
293 static int sdhci_acpi_sdio_probe_slot(struct platform_device
*pdev
,
294 const char *hid
, const char *uid
)
296 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
301 /* Platform specific code during sdio probe slot goes here */
306 static int sdhci_acpi_sd_probe_slot(struct platform_device
*pdev
,
307 const char *hid
, const char *uid
)
309 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
310 struct sdhci_host
*host
;
312 if (!c
|| !c
->host
|| !c
->slot
)
317 /* Platform specific code during sd probe slot goes here */
319 if (hid
&& !strcmp(hid
, "80865ACA"))
320 host
->mmc_host_ops
.get_cd
= bxt_get_cd
;
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
,
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
,
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
,
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
,
365 static const struct sdhci_acpi_slot sdhci_acpi_slot_qcom_sd
= {
366 .quirks
= SDHCI_QUIRK_BROKEN_CARD_DETECTION
,
367 .caps
= MMC_CAP_NONREMOVABLE
,
370 struct sdhci_acpi_uid_slot
{
373 const struct sdhci_acpi_slot
*slot
;
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
},
391 { "QCOM8051", NULL
, &sdhci_acpi_slot_qcom_sd_3v
},
392 { "QCOM8052", NULL
, &sdhci_acpi_slot_qcom_sd
},
396 static const struct acpi_device_id sdhci_acpi_ids
[] = {
411 MODULE_DEVICE_TABLE(acpi
, sdhci_acpi_ids
);
413 static const struct sdhci_acpi_slot
*sdhci_acpi_get_slot(const char *hid
,
416 const struct sdhci_acpi_uid_slot
*u
;
418 for (u
= sdhci_acpi_uids
; u
->hid
; u
++) {
419 if (strcmp(u
->hid
, hid
))
423 if (uid
&& !strcmp(u
->uid
, uid
))
429 static int sdhci_acpi_probe(struct platform_device
*pdev
)
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
;
441 device
= ACPI_COMPANION(dev
);
445 hid
= acpi_device_hid(device
);
446 uid
= device
->pnp
.unique_id
;
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
);
456 if (sdhci_acpi_byt_defer(dev
))
457 return -EPROBE_DEFER
;
459 iomem
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
463 len
= resource_size(iomem
);
465 dev_err(dev
, "Invalid iomem size!\n");
467 if (!devm_request_mem_region(dev
, iomem
->start
, len
, dev_name(dev
)))
470 host
= sdhci_alloc_host(dev
, sizeof(struct sdhci_acpi_host
));
472 return PTR_ERR(host
);
474 c
= sdhci_priv(host
);
476 c
->slot
= sdhci_acpi_get_slot(hid
, uid
);
478 c
->use_runtime_pm
= sdhci_acpi_flag(c
, SDHCI_ACPI_RUNTIME_PM
);
480 platform_set_drvdata(pdev
, c
);
482 host
->hw_name
= "ACPI";
483 host
->ops
= &sdhci_acpi_ops_dflt
;
484 host
->irq
= platform_get_irq(pdev
, 0);
486 host
->ioaddr
= devm_ioremap_nocache(dev
, iomem
->start
,
487 resource_size(iomem
));
488 if (host
->ioaddr
== NULL
) {
494 if (c
->slot
->probe_slot
) {
495 err
= c
->slot
->probe_slot(pdev
, hid
, uid
);
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
;
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
;
514 host
->mmc
->caps2
|= MMC_CAP2_NO_PRESCAN_POWERUP
;
516 if (sdhci_acpi_flag(c
, SDHCI_ACPI_SD_CD
)) {
517 bool v
= sdhci_acpi_flag(c
, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL
);
519 err
= mmc_gpiod_request_cd(host
->mmc
, NULL
, 0, v
, 0, NULL
);
521 if (err
== -EPROBE_DEFER
)
523 dev_warn(dev
, "failed to setup card detect gpio\n");
524 c
->use_runtime_pm
= false;
528 err
= sdhci_add_host(host
);
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
);
540 device_enable_async_suspend(dev
);
545 sdhci_free_host(c
->host
);
549 static int sdhci_acpi_remove(struct platform_device
*pdev
)
551 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
552 struct device
*dev
= &pdev
->dev
;
555 if (c
->use_runtime_pm
) {
556 pm_runtime_get_sync(dev
);
557 pm_runtime_disable(dev
);
558 pm_runtime_put_noidle(dev
);
561 if (c
->slot
&& c
->slot
->remove_slot
)
562 c
->slot
->remove_slot(pdev
);
564 dead
= (sdhci_readl(c
->host
, SDHCI_INT_STATUS
) == ~0);
565 sdhci_remove_host(c
->host
, dead
);
566 sdhci_free_host(c
->host
);
571 #ifdef CONFIG_PM_SLEEP
573 static int sdhci_acpi_suspend(struct device
*dev
)
575 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
576 struct sdhci_host
*host
= c
->host
;
578 if (host
->tuning_mode
!= SDHCI_TUNING_MODE_3
)
579 mmc_retune_needed(host
->mmc
);
581 return sdhci_suspend_host(host
);
584 static int sdhci_acpi_resume(struct device
*dev
)
586 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
588 sdhci_acpi_byt_setting(&c
->pdev
->dev
);
590 return sdhci_resume_host(c
->host
);
597 static int sdhci_acpi_runtime_suspend(struct device
*dev
)
599 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
600 struct sdhci_host
*host
= c
->host
;
602 if (host
->tuning_mode
!= SDHCI_TUNING_MODE_3
)
603 mmc_retune_needed(host
->mmc
);
605 return sdhci_runtime_suspend_host(host
);
608 static int sdhci_acpi_runtime_resume(struct device
*dev
)
610 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
612 sdhci_acpi_byt_setting(&c
->pdev
->dev
);
614 return sdhci_runtime_resume_host(c
->host
);
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
)
625 static struct platform_driver sdhci_acpi_driver
= {
627 .name
= "sdhci-acpi",
628 .acpi_match_table
= sdhci_acpi_ids
,
629 .pm
= &sdhci_acpi_pm_ops
,
631 .probe
= sdhci_acpi_probe
,
632 .remove
= sdhci_acpi_remove
,
635 module_platform_driver(sdhci_acpi_driver
);
637 MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver");
638 MODULE_AUTHOR("Adrian Hunter");
639 MODULE_LICENSE("GPL v2");