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>
53 SDHCI_ACPI_SD_CD
= BIT(0),
54 SDHCI_ACPI_RUNTIME_PM
= BIT(1),
55 SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL
= BIT(2),
58 struct sdhci_acpi_chip
{
59 const struct sdhci_ops
*ops
;
64 mmc_pm_flag_t pm_caps
;
67 struct sdhci_acpi_slot
{
68 const struct sdhci_acpi_chip
*chip
;
73 mmc_pm_flag_t pm_caps
;
75 int (*probe_slot
)(struct platform_device
*, const char *, const char *);
76 int (*remove_slot
)(struct platform_device
*);
79 struct sdhci_acpi_host
{
80 struct sdhci_host
*host
;
81 const struct sdhci_acpi_slot
*slot
;
82 struct platform_device
*pdev
;
86 static inline bool sdhci_acpi_flag(struct sdhci_acpi_host
*c
, unsigned int flag
)
88 return c
->slot
&& (c
->slot
->flags
& flag
);
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 .set_bus_width
= sdhci_set_bus_width
,
109 .reset
= sdhci_reset
,
110 .set_uhs_signaling
= sdhci_set_uhs_signaling
,
113 static const struct sdhci_ops sdhci_acpi_ops_int
= {
114 .set_clock
= sdhci_set_clock
,
115 .set_bus_width
= sdhci_set_bus_width
,
116 .reset
= sdhci_reset
,
117 .set_uhs_signaling
= sdhci_set_uhs_signaling
,
118 .hw_reset
= sdhci_acpi_int_hw_reset
,
121 static const struct sdhci_acpi_chip sdhci_acpi_chip_int
= {
122 .ops
= &sdhci_acpi_ops_int
,
127 static bool sdhci_acpi_byt(void)
129 static const struct x86_cpu_id byt
[] = {
130 { X86_VENDOR_INTEL
, 6, INTEL_FAM6_ATOM_SILVERMONT1
},
134 return x86_match_cpu(byt
);
137 #define BYT_IOSF_SCCEP 0x63
138 #define BYT_IOSF_OCP_NETCTRL0 0x1078
139 #define BYT_IOSF_OCP_TIMEOUT_BASE GENMASK(10, 8)
141 static void sdhci_acpi_byt_setting(struct device
*dev
)
145 if (!sdhci_acpi_byt())
148 if (iosf_mbi_read(BYT_IOSF_SCCEP
, MBI_CR_READ
, BYT_IOSF_OCP_NETCTRL0
,
150 dev_err(dev
, "%s read error\n", __func__
);
154 if (!(val
& BYT_IOSF_OCP_TIMEOUT_BASE
))
157 val
&= ~BYT_IOSF_OCP_TIMEOUT_BASE
;
159 if (iosf_mbi_write(BYT_IOSF_SCCEP
, MBI_CR_WRITE
, BYT_IOSF_OCP_NETCTRL0
,
161 dev_err(dev
, "%s write error\n", __func__
);
165 dev_dbg(dev
, "%s completed\n", __func__
);
168 static bool sdhci_acpi_byt_defer(struct device
*dev
)
170 if (!sdhci_acpi_byt())
173 if (!iosf_mbi_available())
176 sdhci_acpi_byt_setting(dev
);
183 static inline void sdhci_acpi_byt_setting(struct device
*dev
)
187 static inline bool sdhci_acpi_byt_defer(struct device
*dev
)
194 static int bxt_get_cd(struct mmc_host
*mmc
)
196 int gpio_cd
= mmc_gpio_get_cd(mmc
);
197 struct sdhci_host
*host
= mmc_priv(mmc
);
204 spin_lock_irqsave(&host
->lock
, flags
);
206 if (host
->flags
& SDHCI_DEVICE_DEAD
)
209 ret
= !!(sdhci_readl(host
, SDHCI_PRESENT_STATE
) & SDHCI_CARD_PRESENT
);
211 spin_unlock_irqrestore(&host
->lock
, flags
);
216 static int sdhci_acpi_emmc_probe_slot(struct platform_device
*pdev
,
217 const char *hid
, const char *uid
)
219 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
220 struct sdhci_host
*host
;
227 /* Platform specific code during emmc probe slot goes here */
229 if (hid
&& uid
&& !strcmp(hid
, "80860F14") && !strcmp(uid
, "1") &&
230 sdhci_readl(host
, SDHCI_CAPABILITIES
) == 0x446cc8b2 &&
231 sdhci_readl(host
, SDHCI_CAPABILITIES_1
) == 0x00000807)
232 host
->timeout_clk
= 1000; /* 1000 kHz i.e. 1 MHz */
237 static int sdhci_acpi_sdio_probe_slot(struct platform_device
*pdev
,
238 const char *hid
, const char *uid
)
240 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
241 struct sdhci_host
*host
;
248 /* Platform specific code during sdio probe slot goes here */
253 static int sdhci_acpi_sd_probe_slot(struct platform_device
*pdev
,
254 const char *hid
, const char *uid
)
256 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
257 struct sdhci_host
*host
;
259 if (!c
|| !c
->host
|| !c
->slot
)
264 /* Platform specific code during sd probe slot goes here */
266 if (hid
&& !strcmp(hid
, "80865ACA")) {
267 host
->mmc_host_ops
.get_cd
= bxt_get_cd
;
268 host
->mmc
->caps
|= MMC_CAP_AGGRESSIVE_PM
;
274 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_emmc
= {
275 .chip
= &sdhci_acpi_chip_int
,
276 .caps
= MMC_CAP_8_BIT_DATA
| MMC_CAP_NONREMOVABLE
|
277 MMC_CAP_HW_RESET
| MMC_CAP_1_8V_DDR
|
278 MMC_CAP_CMD_DURING_TFR
| MMC_CAP_WAIT_WHILE_BUSY
,
279 .caps2
= MMC_CAP2_HC_ERASE_SZ
,
280 .flags
= SDHCI_ACPI_RUNTIME_PM
,
281 .quirks
= SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC
,
282 .quirks2
= SDHCI_QUIRK2_PRESET_VALUE_BROKEN
|
283 SDHCI_QUIRK2_STOP_WITH_TC
|
284 SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400
,
285 .probe_slot
= sdhci_acpi_emmc_probe_slot
,
288 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sdio
= {
289 .quirks
= SDHCI_QUIRK_BROKEN_CARD_DETECTION
|
290 SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC
,
291 .quirks2
= SDHCI_QUIRK2_HOST_OFF_CARD_ON
,
292 .caps
= MMC_CAP_NONREMOVABLE
| MMC_CAP_POWER_OFF_CARD
|
293 MMC_CAP_WAIT_WHILE_BUSY
,
294 .flags
= SDHCI_ACPI_RUNTIME_PM
,
295 .pm_caps
= MMC_PM_KEEP_POWER
,
296 .probe_slot
= sdhci_acpi_sdio_probe_slot
,
299 static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sd
= {
300 .flags
= SDHCI_ACPI_SD_CD
| SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL
|
301 SDHCI_ACPI_RUNTIME_PM
,
302 .quirks
= SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC
,
303 .quirks2
= SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON
|
304 SDHCI_QUIRK2_STOP_WITH_TC
,
305 .caps
= MMC_CAP_WAIT_WHILE_BUSY
,
306 .probe_slot
= sdhci_acpi_sd_probe_slot
,
309 static const struct sdhci_acpi_slot sdhci_acpi_slot_qcom_sd_3v
= {
310 .quirks
= SDHCI_QUIRK_BROKEN_CARD_DETECTION
,
311 .quirks2
= SDHCI_QUIRK2_NO_1_8_V
,
312 .caps
= MMC_CAP_NONREMOVABLE
,
315 static const struct sdhci_acpi_slot sdhci_acpi_slot_qcom_sd
= {
316 .quirks
= SDHCI_QUIRK_BROKEN_CARD_DETECTION
,
317 .caps
= MMC_CAP_NONREMOVABLE
,
320 struct sdhci_acpi_uid_slot
{
323 const struct sdhci_acpi_slot
*slot
;
326 static const struct sdhci_acpi_uid_slot sdhci_acpi_uids
[] = {
327 { "80865ACA", NULL
, &sdhci_acpi_slot_int_sd
},
328 { "80865ACC", NULL
, &sdhci_acpi_slot_int_emmc
},
329 { "80865AD0", NULL
, &sdhci_acpi_slot_int_sdio
},
330 { "80860F14" , "1" , &sdhci_acpi_slot_int_emmc
},
331 { "80860F14" , "2" , &sdhci_acpi_slot_int_sdio
},
332 { "80860F14" , "3" , &sdhci_acpi_slot_int_sd
},
333 { "80860F16" , NULL
, &sdhci_acpi_slot_int_sd
},
334 { "INT33BB" , "2" , &sdhci_acpi_slot_int_sdio
},
335 { "INT33BB" , "3" , &sdhci_acpi_slot_int_sd
},
336 { "INT33C6" , NULL
, &sdhci_acpi_slot_int_sdio
},
337 { "INT3436" , NULL
, &sdhci_acpi_slot_int_sdio
},
338 { "INT344D" , NULL
, &sdhci_acpi_slot_int_sdio
},
339 { "PNP0FFF" , "3" , &sdhci_acpi_slot_int_sd
},
341 { "QCOM8051", NULL
, &sdhci_acpi_slot_qcom_sd_3v
},
342 { "QCOM8052", NULL
, &sdhci_acpi_slot_qcom_sd
},
346 static const struct acpi_device_id sdhci_acpi_ids
[] = {
361 MODULE_DEVICE_TABLE(acpi
, sdhci_acpi_ids
);
363 static const struct sdhci_acpi_slot
*sdhci_acpi_get_slot(const char *hid
,
366 const struct sdhci_acpi_uid_slot
*u
;
368 for (u
= sdhci_acpi_uids
; u
->hid
; u
++) {
369 if (strcmp(u
->hid
, hid
))
373 if (uid
&& !strcmp(u
->uid
, uid
))
379 static int sdhci_acpi_probe(struct platform_device
*pdev
)
381 struct device
*dev
= &pdev
->dev
;
382 acpi_handle handle
= ACPI_HANDLE(dev
);
383 struct acpi_device
*device
, *child
;
384 struct sdhci_acpi_host
*c
;
385 struct sdhci_host
*host
;
386 struct resource
*iomem
;
392 if (acpi_bus_get_device(handle
, &device
))
395 /* Power on the SDHCI controller and its children */
396 acpi_device_fix_up_power(device
);
397 list_for_each_entry(child
, &device
->children
, node
)
398 if (child
->status
.present
&& child
->status
.enabled
)
399 acpi_device_fix_up_power(child
);
401 if (acpi_bus_get_status(device
) || !device
->status
.present
)
404 if (sdhci_acpi_byt_defer(dev
))
405 return -EPROBE_DEFER
;
407 hid
= acpi_device_hid(device
);
408 uid
= device
->pnp
.unique_id
;
410 iomem
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
414 len
= resource_size(iomem
);
416 dev_err(dev
, "Invalid iomem size!\n");
418 if (!devm_request_mem_region(dev
, iomem
->start
, len
, dev_name(dev
)))
421 host
= sdhci_alloc_host(dev
, sizeof(struct sdhci_acpi_host
));
423 return PTR_ERR(host
);
425 c
= sdhci_priv(host
);
427 c
->slot
= sdhci_acpi_get_slot(hid
, uid
);
429 c
->use_runtime_pm
= sdhci_acpi_flag(c
, SDHCI_ACPI_RUNTIME_PM
);
431 platform_set_drvdata(pdev
, c
);
433 host
->hw_name
= "ACPI";
434 host
->ops
= &sdhci_acpi_ops_dflt
;
435 host
->irq
= platform_get_irq(pdev
, 0);
437 host
->ioaddr
= devm_ioremap_nocache(dev
, iomem
->start
,
438 resource_size(iomem
));
439 if (host
->ioaddr
== NULL
) {
445 if (c
->slot
->probe_slot
) {
446 err
= c
->slot
->probe_slot(pdev
, hid
, uid
);
451 host
->ops
= c
->slot
->chip
->ops
;
452 host
->quirks
|= c
->slot
->chip
->quirks
;
453 host
->quirks2
|= c
->slot
->chip
->quirks2
;
454 host
->mmc
->caps
|= c
->slot
->chip
->caps
;
455 host
->mmc
->caps2
|= c
->slot
->chip
->caps2
;
456 host
->mmc
->pm_caps
|= c
->slot
->chip
->pm_caps
;
458 host
->quirks
|= c
->slot
->quirks
;
459 host
->quirks2
|= c
->slot
->quirks2
;
460 host
->mmc
->caps
|= c
->slot
->caps
;
461 host
->mmc
->caps2
|= c
->slot
->caps2
;
462 host
->mmc
->pm_caps
|= c
->slot
->pm_caps
;
465 host
->mmc
->caps2
|= MMC_CAP2_NO_PRESCAN_POWERUP
;
467 if (sdhci_acpi_flag(c
, SDHCI_ACPI_SD_CD
)) {
468 bool v
= sdhci_acpi_flag(c
, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL
);
470 err
= mmc_gpiod_request_cd(host
->mmc
, NULL
, 0, v
, 0, NULL
);
472 if (err
== -EPROBE_DEFER
)
474 dev_warn(dev
, "failed to setup card detect gpio\n");
475 c
->use_runtime_pm
= false;
479 err
= sdhci_add_host(host
);
483 if (c
->use_runtime_pm
) {
484 pm_runtime_set_active(dev
);
485 pm_suspend_ignore_children(dev
, 1);
486 pm_runtime_set_autosuspend_delay(dev
, 50);
487 pm_runtime_use_autosuspend(dev
);
488 pm_runtime_enable(dev
);
491 device_enable_async_suspend(dev
);
496 sdhci_free_host(c
->host
);
500 static int sdhci_acpi_remove(struct platform_device
*pdev
)
502 struct sdhci_acpi_host
*c
= platform_get_drvdata(pdev
);
503 struct device
*dev
= &pdev
->dev
;
506 if (c
->use_runtime_pm
) {
507 pm_runtime_get_sync(dev
);
508 pm_runtime_disable(dev
);
509 pm_runtime_put_noidle(dev
);
512 if (c
->slot
&& c
->slot
->remove_slot
)
513 c
->slot
->remove_slot(pdev
);
515 dead
= (sdhci_readl(c
->host
, SDHCI_INT_STATUS
) == ~0);
516 sdhci_remove_host(c
->host
, dead
);
517 sdhci_free_host(c
->host
);
522 #ifdef CONFIG_PM_SLEEP
524 static int sdhci_acpi_suspend(struct device
*dev
)
526 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
528 return sdhci_suspend_host(c
->host
);
531 static int sdhci_acpi_resume(struct device
*dev
)
533 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
535 sdhci_acpi_byt_setting(&c
->pdev
->dev
);
537 return sdhci_resume_host(c
->host
);
544 static int sdhci_acpi_runtime_suspend(struct device
*dev
)
546 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
548 return sdhci_runtime_suspend_host(c
->host
);
551 static int sdhci_acpi_runtime_resume(struct device
*dev
)
553 struct sdhci_acpi_host
*c
= dev_get_drvdata(dev
);
555 sdhci_acpi_byt_setting(&c
->pdev
->dev
);
557 return sdhci_runtime_resume_host(c
->host
);
562 static const struct dev_pm_ops sdhci_acpi_pm_ops
= {
563 SET_SYSTEM_SLEEP_PM_OPS(sdhci_acpi_suspend
, sdhci_acpi_resume
)
564 SET_RUNTIME_PM_OPS(sdhci_acpi_runtime_suspend
,
565 sdhci_acpi_runtime_resume
, NULL
)
568 static struct platform_driver sdhci_acpi_driver
= {
570 .name
= "sdhci-acpi",
571 .acpi_match_table
= sdhci_acpi_ids
,
572 .pm
= &sdhci_acpi_pm_ops
,
574 .probe
= sdhci_acpi_probe
,
575 .remove
= sdhci_acpi_remove
,
578 module_platform_driver(sdhci_acpi_driver
);
580 MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver");
581 MODULE_AUTHOR("Adrian Hunter");
582 MODULE_LICENSE("GPL v2");