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