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/intel-family.h>
47#include <asm/iosf_mbi.h>
48#endif
49
50#include "sdhci.h"
51
52enum {
53 SDHCI_ACPI_SD_CD = BIT(0),
54 SDHCI_ACPI_RUNTIME_PM = BIT(1),
55 SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL = BIT(2),
56};
57
58struct sdhci_acpi_chip {
59 const struct sdhci_ops *ops;
60 unsigned int quirks;
61 unsigned int quirks2;
62 unsigned long caps;
63 unsigned int caps2;
64 mmc_pm_flag_t pm_caps;
65};
66
67struct sdhci_acpi_slot {
68 const struct sdhci_acpi_chip *chip;
69 unsigned int quirks;
70 unsigned int quirks2;
71 unsigned long caps;
72 unsigned int caps2;
73 mmc_pm_flag_t pm_caps;
74 unsigned int flags;
75 int (*probe_slot)(struct platform_device *, const char *, const char *);
76 int (*remove_slot)(struct platform_device *);
77};
78
79struct sdhci_acpi_host {
80 struct sdhci_host *host;
81 const struct sdhci_acpi_slot *slot;
82 struct platform_device *pdev;
83 bool use_runtime_pm;
84};
85
86static inline bool sdhci_acpi_flag(struct sdhci_acpi_host *c, unsigned int flag)
87{
88 return c->slot && (c->slot->flags & flag);
89}
90
91static void sdhci_acpi_int_hw_reset(struct sdhci_host *host)
92{
93 u8 reg;
94
95 reg = sdhci_readb(host, SDHCI_POWER_CONTROL);
96 reg |= 0x10;
97 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
98 /* For eMMC, minimum is 1us but give it 9us for good measure */
99 udelay(9);
100 reg &= ~0x10;
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);
104}
105
106static 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,
111};
112
113static 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,
119};
120
121static const struct sdhci_acpi_chip sdhci_acpi_chip_int = {
122 .ops = &sdhci_acpi_ops_int,
123};
124
125#ifdef CONFIG_X86
126
127static bool sdhci_acpi_byt(void)
128{
129 static const struct x86_cpu_id byt[] = {
130 { X86_VENDOR_INTEL, 6, INTEL_FAM6_ATOM_SILVERMONT1 },
131 {}
132 };
133
134 return x86_match_cpu(byt);
135}
136
137#define BYT_IOSF_SCCEP 0x63
138#define BYT_IOSF_OCP_NETCTRL0 0x1078
139#define BYT_IOSF_OCP_TIMEOUT_BASE GENMASK(10, 8)
140
141static void sdhci_acpi_byt_setting(struct device *dev)
142{
143 u32 val = 0;
144
145 if (!sdhci_acpi_byt())
146 return;
147
148 if (iosf_mbi_read(BYT_IOSF_SCCEP, MBI_CR_READ, BYT_IOSF_OCP_NETCTRL0,
149 &val)) {
150 dev_err(dev, "%s read error\n", __func__);
151 return;
152 }
153
154 if (!(val & BYT_IOSF_OCP_TIMEOUT_BASE))
155 return;
156
157 val &= ~BYT_IOSF_OCP_TIMEOUT_BASE;
158
159 if (iosf_mbi_write(BYT_IOSF_SCCEP, MBI_CR_WRITE, BYT_IOSF_OCP_NETCTRL0,
160 val)) {
161 dev_err(dev, "%s write error\n", __func__);
162 return;
163 }
164
165 dev_dbg(dev, "%s completed\n", __func__);
166}
167
168static bool sdhci_acpi_byt_defer(struct device *dev)
169{
170 if (!sdhci_acpi_byt())
171 return false;
172
173 if (!iosf_mbi_available())
174 return true;
175
176 sdhci_acpi_byt_setting(dev);
177
178 return false;
179}
180
181#else
182
183static inline void sdhci_acpi_byt_setting(struct device *dev)
184{
185}
186
187static inline bool sdhci_acpi_byt_defer(struct device *dev)
188{
189 return false;
190}
191
192#endif
193
194static int bxt_get_cd(struct mmc_host *mmc)
195{
196 int gpio_cd = mmc_gpio_get_cd(mmc);
197 struct sdhci_host *host = mmc_priv(mmc);
198 unsigned long flags;
199 int ret = 0;
200
201 if (!gpio_cd)
202 return 0;
203
204 spin_lock_irqsave(&host->lock, flags);
205
206 if (host->flags & SDHCI_DEVICE_DEAD)
207 goto out;
208
209 ret = !!(sdhci_readl(host, SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT);
210out:
211 spin_unlock_irqrestore(&host->lock, flags);
212
213 return ret;
214}
215
216static int sdhci_acpi_emmc_probe_slot(struct platform_device *pdev,
217 const char *hid, const char *uid)
218{
219 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
220 struct sdhci_host *host;
221
222 if (!c || !c->host)
223 return 0;
224
225 host = c->host;
226
227 /* Platform specific code during emmc probe slot goes here */
228
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 */
233
234 return 0;
235}
236
237static int sdhci_acpi_sdio_probe_slot(struct platform_device *pdev,
238 const char *hid, const char *uid)
239{
240 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
241 struct sdhci_host *host;
242
243 if (!c || !c->host)
244 return 0;
245
246 host = c->host;
247
248 /* Platform specific code during sdio probe slot goes here */
249
250 return 0;
251}
252
253static int sdhci_acpi_sd_probe_slot(struct platform_device *pdev,
254 const char *hid, const char *uid)
255{
256 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
257 struct sdhci_host *host;
258
259 if (!c || !c->host || !c->slot)
260 return 0;
261
262 host = c->host;
263
264 /* Platform specific code during sd probe slot goes here */
265
266 if (hid && !strcmp(hid, "80865ACA")) {
267 host->mmc_host_ops.get_cd = bxt_get_cd;
268 host->mmc->caps |= MMC_CAP_AGGRESSIVE_PM;
269 }
270
271 return 0;
272}
273
274static 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,
286};
287
288static 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,
297};
298
299static 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,
307};
308
309static 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,
313};
314
315static const struct sdhci_acpi_slot sdhci_acpi_slot_qcom_sd = {
316 .quirks = SDHCI_QUIRK_BROKEN_CARD_DETECTION,
317 .caps = MMC_CAP_NONREMOVABLE,
318};
319
320struct sdhci_acpi_uid_slot {
321 const char *hid;
322 const char *uid;
323 const struct sdhci_acpi_slot *slot;
324};
325
326static 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 },
340 { "PNP0D40" },
341 { "QCOM8051", NULL, &sdhci_acpi_slot_qcom_sd_3v },
342 { "QCOM8052", NULL, &sdhci_acpi_slot_qcom_sd },
343 { },
344};
345
346static const struct acpi_device_id sdhci_acpi_ids[] = {
347 { "80865ACA" },
348 { "80865ACC" },
349 { "80865AD0" },
350 { "80860F14" },
351 { "80860F16" },
352 { "INT33BB" },
353 { "INT33C6" },
354 { "INT3436" },
355 { "INT344D" },
356 { "PNP0D40" },
357 { "QCOM8051" },
358 { "QCOM8052" },
359 { },
360};
361MODULE_DEVICE_TABLE(acpi, sdhci_acpi_ids);
362
363static const struct sdhci_acpi_slot *sdhci_acpi_get_slot(const char *hid,
364 const char *uid)
365{
366 const struct sdhci_acpi_uid_slot *u;
367
368 for (u = sdhci_acpi_uids; u->hid; u++) {
369 if (strcmp(u->hid, hid))
370 continue;
371 if (!u->uid)
372 return u->slot;
373 if (uid && !strcmp(u->uid, uid))
374 return u->slot;
375 }
376 return NULL;
377}
378
379static int sdhci_acpi_probe(struct platform_device *pdev)
380{
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;
387 resource_size_t len;
388 const char *hid;
389 const char *uid;
390 int err;
391
392 if (acpi_bus_get_device(handle, &device))
393 return -ENODEV;
394
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);
400
401 if (acpi_bus_get_status(device) || !device->status.present)
402 return -ENODEV;
403
404 if (sdhci_acpi_byt_defer(dev))
405 return -EPROBE_DEFER;
406
407 hid = acpi_device_hid(device);
408 uid = device->pnp.unique_id;
409
410 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
411 if (!iomem)
412 return -ENOMEM;
413
414 len = resource_size(iomem);
415 if (len < 0x100)
416 dev_err(dev, "Invalid iomem size!\n");
417
418 if (!devm_request_mem_region(dev, iomem->start, len, dev_name(dev)))
419 return -ENOMEM;
420
421 host = sdhci_alloc_host(dev, sizeof(struct sdhci_acpi_host));
422 if (IS_ERR(host))
423 return PTR_ERR(host);
424
425 c = sdhci_priv(host);
426 c->host = host;
427 c->slot = sdhci_acpi_get_slot(hid, uid);
428 c->pdev = pdev;
429 c->use_runtime_pm = sdhci_acpi_flag(c, SDHCI_ACPI_RUNTIME_PM);
430
431 platform_set_drvdata(pdev, c);
432
433 host->hw_name = "ACPI";
434 host->ops = &sdhci_acpi_ops_dflt;
435 host->irq = platform_get_irq(pdev, 0);
436
437 host->ioaddr = devm_ioremap_nocache(dev, iomem->start,
438 resource_size(iomem));
439 if (host->ioaddr == NULL) {
440 err = -ENOMEM;
441 goto err_free;
442 }
443
444 if (c->slot) {
445 if (c->slot->probe_slot) {
446 err = c->slot->probe_slot(pdev, hid, uid);
447 if (err)
448 goto err_free;
449 }
450 if (c->slot->chip) {
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;
457 }
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;
463 }
464
465 host->mmc->caps2 |= MMC_CAP2_NO_PRESCAN_POWERUP;
466
467 if (sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD)) {
468 bool v = sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL);
469
470 err = mmc_gpiod_request_cd(host->mmc, NULL, 0, v, 0, NULL);
471 if (err) {
472 if (err == -EPROBE_DEFER)
473 goto err_free;
474 dev_warn(dev, "failed to setup card detect gpio\n");
475 c->use_runtime_pm = false;
476 }
477 }
478
479 err = sdhci_add_host(host);
480 if (err)
481 goto err_free;
482
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);
489 }
490
491 device_enable_async_suspend(dev);
492
493 return 0;
494
495err_free:
496 sdhci_free_host(c->host);
497 return err;
498}
499
500static int sdhci_acpi_remove(struct platform_device *pdev)
501{
502 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
503 struct device *dev = &pdev->dev;
504 int dead;
505
506 if (c->use_runtime_pm) {
507 pm_runtime_get_sync(dev);
508 pm_runtime_disable(dev);
509 pm_runtime_put_noidle(dev);
510 }
511
512 if (c->slot && c->slot->remove_slot)
513 c->slot->remove_slot(pdev);
514
515 dead = (sdhci_readl(c->host, SDHCI_INT_STATUS) == ~0);
516 sdhci_remove_host(c->host, dead);
517 sdhci_free_host(c->host);
518
519 return 0;
520}
521
522#ifdef CONFIG_PM_SLEEP
523
524static int sdhci_acpi_suspend(struct device *dev)
525{
526 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
527
528 return sdhci_suspend_host(c->host);
529}
530
531static int sdhci_acpi_resume(struct device *dev)
532{
533 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
534
535 sdhci_acpi_byt_setting(&c->pdev->dev);
536
537 return sdhci_resume_host(c->host);
538}
539
540#endif
541
542#ifdef CONFIG_PM
543
544static int sdhci_acpi_runtime_suspend(struct device *dev)
545{
546 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
547
548 return sdhci_runtime_suspend_host(c->host);
549}
550
551static int sdhci_acpi_runtime_resume(struct device *dev)
552{
553 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
554
555 sdhci_acpi_byt_setting(&c->pdev->dev);
556
557 return sdhci_runtime_resume_host(c->host);
558}
559
560#endif
561
562static 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)
566};
567
568static struct platform_driver sdhci_acpi_driver = {
569 .driver = {
570 .name = "sdhci-acpi",
571 .acpi_match_table = sdhci_acpi_ids,
572 .pm = &sdhci_acpi_pm_ops,
573 },
574 .probe = sdhci_acpi_probe,
575 .remove = sdhci_acpi_remove,
576};
577
578module_platform_driver(sdhci_acpi_driver);
579
580MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver");
581MODULE_AUTHOR("Adrian Hunter");
582MODULE_LICENSE("GPL v2");