mmc: core: enable mmc host device to suspend/resume asynchronously
[linux-2.6-block.git] / drivers / mmc / host / sdhci-acpi.c
CommitLineData
c4e05037
AH
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>
b04fa064 38#include <linux/delay.h>
c4e05037
AH
39
40#include <linux/mmc/host.h>
41#include <linux/mmc/pm.h>
4fd4409c 42#include <linux/mmc/slot-gpio.h>
c4e05037
AH
43
44#include "sdhci.h"
45
46enum {
4fd4409c
AH
47 SDHCI_ACPI_SD_CD = BIT(0),
48 SDHCI_ACPI_RUNTIME_PM = BIT(1),
49 SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL = BIT(2),
c4e05037
AH
50};
51
52struct sdhci_acpi_chip {
53 const struct sdhci_ops *ops;
54 unsigned int quirks;
55 unsigned int quirks2;
56 unsigned long caps;
57 unsigned int caps2;
58 mmc_pm_flag_t pm_caps;
59};
60
61struct sdhci_acpi_slot {
62 const struct sdhci_acpi_chip *chip;
63 unsigned int quirks;
64 unsigned int quirks2;
65 unsigned long caps;
66 unsigned int caps2;
67 mmc_pm_flag_t pm_caps;
68 unsigned int flags;
7dafca83 69 int (*probe_slot)(struct platform_device *, const char *, const char *);
578b36b6 70 int (*remove_slot)(struct platform_device *);
c4e05037
AH
71};
72
73struct sdhci_acpi_host {
74 struct sdhci_host *host;
75 const struct sdhci_acpi_slot *slot;
76 struct platform_device *pdev;
77 bool use_runtime_pm;
4f64f843 78 bool dma_setup;
c4e05037
AH
79};
80
81static inline bool sdhci_acpi_flag(struct sdhci_acpi_host *c, unsigned int flag)
82{
83 return c->slot && (c->slot->flags & flag);
84}
85
86static int sdhci_acpi_enable_dma(struct sdhci_host *host)
87{
4f64f843
AH
88 struct sdhci_acpi_host *c = sdhci_priv(host);
89 struct device *dev = &c->pdev->dev;
90 int err = -1;
91
92 if (c->dma_setup)
93 return 0;
94
95 if (host->flags & SDHCI_USE_64_BIT_DMA) {
96 if (host->quirks2 & SDHCI_QUIRK2_BROKEN_64_BIT_DMA) {
97 host->flags &= ~SDHCI_USE_64_BIT_DMA;
98 } else {
99 err = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(64));
100 if (err)
101 dev_warn(dev, "Failed to set 64-bit DMA mask\n");
102 }
103 }
104
105 if (err)
106 err = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
107
108 c->dma_setup = !err;
109
110 return err;
c4e05037
AH
111}
112
b04fa064
AH
113static void sdhci_acpi_int_hw_reset(struct sdhci_host *host)
114{
115 u8 reg;
116
117 reg = sdhci_readb(host, SDHCI_POWER_CONTROL);
118 reg |= 0x10;
119 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
120 /* For eMMC, minimum is 1us but give it 9us for good measure */
121 udelay(9);
122 reg &= ~0x10;
123 sdhci_writeb(host, reg, SDHCI_POWER_CONTROL);
124 /* For eMMC, minimum is 200us but give it 300us for good measure */
125 usleep_range(300, 1000);
126}
127
c4e05037 128static const struct sdhci_ops sdhci_acpi_ops_dflt = {
1771059c 129 .set_clock = sdhci_set_clock,
c4e05037 130 .enable_dma = sdhci_acpi_enable_dma,
2317f56c 131 .set_bus_width = sdhci_set_bus_width,
03231f9b 132 .reset = sdhci_reset,
96d7b78c 133 .set_uhs_signaling = sdhci_set_uhs_signaling,
c4e05037
AH
134};
135
b04fa064 136static const struct sdhci_ops sdhci_acpi_ops_int = {
1771059c 137 .set_clock = sdhci_set_clock,
b04fa064 138 .enable_dma = sdhci_acpi_enable_dma,
2317f56c 139 .set_bus_width = sdhci_set_bus_width,
03231f9b 140 .reset = sdhci_reset,
96d7b78c 141 .set_uhs_signaling = sdhci_set_uhs_signaling,
b04fa064
AH
142 .hw_reset = sdhci_acpi_int_hw_reset,
143};
144
145static const struct sdhci_acpi_chip sdhci_acpi_chip_int = {
146 .ops = &sdhci_acpi_ops_int,
147};
148
6a645dd8
AH
149static int bxt_get_cd(struct mmc_host *mmc)
150{
151 int gpio_cd = mmc_gpio_get_cd(mmc);
152 struct sdhci_host *host = mmc_priv(mmc);
153 unsigned long flags;
154 int ret = 0;
155
156 if (!gpio_cd)
157 return 0;
158
159 pm_runtime_get_sync(mmc->parent);
160
161 spin_lock_irqsave(&host->lock, flags);
162
163 if (host->flags & SDHCI_DEVICE_DEAD)
164 goto out;
165
166 ret = !!(sdhci_readl(host, SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT);
167out:
168 spin_unlock_irqrestore(&host->lock, flags);
169
170 pm_runtime_mark_last_busy(mmc->parent);
171 pm_runtime_put_autosuspend(mmc->parent);
172
173 return ret;
174}
175
7dafca83
AH
176static int sdhci_acpi_emmc_probe_slot(struct platform_device *pdev,
177 const char *hid, const char *uid)
578b36b6
GY
178{
179 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
180 struct sdhci_host *host;
181
182 if (!c || !c->host)
183 return 0;
184
185 host = c->host;
186
94203042 187 /* Platform specific code during emmc probe slot goes here */
578b36b6 188
8024379e
AH
189 if (hid && uid && !strcmp(hid, "80860F14") && !strcmp(uid, "1") &&
190 sdhci_readl(host, SDHCI_CAPABILITIES) == 0x446cc8b2 &&
191 sdhci_readl(host, SDHCI_CAPABILITIES_1) == 0x00000807)
192 host->timeout_clk = 1000; /* 1000 kHz i.e. 1 MHz */
193
578b36b6
GY
194 return 0;
195}
196
7dafca83
AH
197static int sdhci_acpi_sdio_probe_slot(struct platform_device *pdev,
198 const char *hid, const char *uid)
578b36b6
GY
199{
200 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
201 struct sdhci_host *host;
202
203 if (!c || !c->host)
204 return 0;
205
206 host = c->host;
207
94203042 208 /* Platform specific code during sdio probe slot goes here */
578b36b6
GY
209
210 return 0;
211}
212
7dafca83
AH
213static int sdhci_acpi_sd_probe_slot(struct platform_device *pdev,
214 const char *hid, const char *uid)
578b36b6
GY
215{
216 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
217 struct sdhci_host *host;
218
219 if (!c || !c->host || !c->slot)
220 return 0;
221
222 host = c->host;
223
94203042 224 /* Platform specific code during sd probe slot goes here */
578b36b6 225
6a645dd8
AH
226 if (hid && !strcmp(hid, "80865ACA"))
227 host->mmc_host_ops.get_cd = bxt_get_cd;
228
578b36b6
GY
229 return 0;
230}
231
07a58883 232static const struct sdhci_acpi_slot sdhci_acpi_slot_int_emmc = {
b04fa064 233 .chip = &sdhci_acpi_chip_int,
f25c3372 234 .caps = MMC_CAP_8_BIT_DATA | MMC_CAP_NONREMOVABLE |
9d65cb88
AH
235 MMC_CAP_HW_RESET | MMC_CAP_1_8V_DDR |
236 MMC_CAP_BUS_WIDTH_TEST | MMC_CAP_WAIT_WHILE_BUSY,
07a58883
AH
237 .caps2 = MMC_CAP2_HC_ERASE_SZ,
238 .flags = SDHCI_ACPI_RUNTIME_PM,
e1f5633a 239 .quirks = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
e839b134
AH
240 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN |
241 SDHCI_QUIRK2_STOP_WITH_TC |
242 SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400,
578b36b6 243 .probe_slot = sdhci_acpi_emmc_probe_slot,
07a58883
AH
244};
245
e5571397 246static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sdio = {
e1f5633a
AH
247 .quirks = SDHCI_QUIRK_BROKEN_CARD_DETECTION |
248 SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
e5571397 249 .quirks2 = SDHCI_QUIRK2_HOST_OFF_CARD_ON,
9d65cb88
AH
250 .caps = MMC_CAP_NONREMOVABLE | MMC_CAP_POWER_OFF_CARD |
251 MMC_CAP_BUS_WIDTH_TEST | MMC_CAP_WAIT_WHILE_BUSY,
e5571397
AH
252 .flags = SDHCI_ACPI_RUNTIME_PM,
253 .pm_caps = MMC_PM_KEEP_POWER,
578b36b6 254 .probe_slot = sdhci_acpi_sdio_probe_slot,
e5571397
AH
255};
256
07a58883 257static const struct sdhci_acpi_slot sdhci_acpi_slot_int_sd = {
4fd4409c
AH
258 .flags = SDHCI_ACPI_SD_CD | SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL |
259 SDHCI_ACPI_RUNTIME_PM,
e1f5633a 260 .quirks = SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
934e31b9
AH
261 .quirks2 = SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON |
262 SDHCI_QUIRK2_STOP_WITH_TC,
9d65cb88 263 .caps = MMC_CAP_BUS_WIDTH_TEST | MMC_CAP_WAIT_WHILE_BUSY,
578b36b6 264 .probe_slot = sdhci_acpi_sd_probe_slot,
07a58883
AH
265};
266
267struct sdhci_acpi_uid_slot {
268 const char *hid;
269 const char *uid;
270 const struct sdhci_acpi_slot *slot;
271};
272
273static const struct sdhci_acpi_uid_slot sdhci_acpi_uids[] = {
e839b134
AH
274 { "80865ACA", NULL, &sdhci_acpi_slot_int_sd },
275 { "80865ACC", NULL, &sdhci_acpi_slot_int_emmc },
276 { "80865AD0", NULL, &sdhci_acpi_slot_int_sdio },
07a58883
AH
277 { "80860F14" , "1" , &sdhci_acpi_slot_int_emmc },
278 { "80860F14" , "3" , &sdhci_acpi_slot_int_sd },
aad95dc4 279 { "80860F16" , NULL, &sdhci_acpi_slot_int_sd },
07a58883 280 { "INT33BB" , "2" , &sdhci_acpi_slot_int_sdio },
7147eaf3 281 { "INT33BB" , "3" , &sdhci_acpi_slot_int_sd },
07a58883 282 { "INT33C6" , NULL, &sdhci_acpi_slot_int_sdio },
07c001c1 283 { "INT3436" , NULL, &sdhci_acpi_slot_int_sdio },
d0ed8e6b 284 { "INT344D" , NULL, &sdhci_acpi_slot_int_sdio },
0cd2f044 285 { "PNP0FFF" , "3" , &sdhci_acpi_slot_int_sd },
07a58883
AH
286 { "PNP0D40" },
287 { },
288};
289
c4e05037 290static const struct acpi_device_id sdhci_acpi_ids[] = {
e839b134
AH
291 { "80865ACA" },
292 { "80865ACC" },
293 { "80865AD0" },
07a58883 294 { "80860F14" },
aad95dc4 295 { "80860F16" },
07a58883
AH
296 { "INT33BB" },
297 { "INT33C6" },
07c001c1 298 { "INT3436" },
d0ed8e6b 299 { "INT344D" },
07a58883 300 { "PNP0D40" },
c4e05037
AH
301 { },
302};
303MODULE_DEVICE_TABLE(acpi, sdhci_acpi_ids);
304
3db35251
AH
305static const struct sdhci_acpi_slot *sdhci_acpi_get_slot(const char *hid,
306 const char *uid)
c4e05037 307{
07a58883
AH
308 const struct sdhci_acpi_uid_slot *u;
309
310 for (u = sdhci_acpi_uids; u->hid; u++) {
311 if (strcmp(u->hid, hid))
312 continue;
313 if (!u->uid)
314 return u->slot;
315 if (uid && !strcmp(u->uid, uid))
316 return u->slot;
317 }
c4e05037
AH
318 return NULL;
319}
320
4e608e4e 321static int sdhci_acpi_probe(struct platform_device *pdev)
c4e05037
AH
322{
323 struct device *dev = &pdev->dev;
324 acpi_handle handle = ACPI_HANDLE(dev);
325 struct acpi_device *device;
326 struct sdhci_acpi_host *c;
327 struct sdhci_host *host;
328 struct resource *iomem;
329 resource_size_t len;
330 const char *hid;
3db35251 331 const char *uid;
87875655 332 int err;
c4e05037
AH
333
334 if (acpi_bus_get_device(handle, &device))
335 return -ENODEV;
336
337 if (acpi_bus_get_status(device) || !device->status.present)
338 return -ENODEV;
339
340 hid = acpi_device_hid(device);
3db35251 341 uid = device->pnp.unique_id;
c4e05037
AH
342
343 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
344 if (!iomem)
345 return -ENOMEM;
346
347 len = resource_size(iomem);
348 if (len < 0x100)
349 dev_err(dev, "Invalid iomem size!\n");
350
351 if (!devm_request_mem_region(dev, iomem->start, len, dev_name(dev)))
352 return -ENOMEM;
353
354 host = sdhci_alloc_host(dev, sizeof(struct sdhci_acpi_host));
355 if (IS_ERR(host))
356 return PTR_ERR(host);
357
358 c = sdhci_priv(host);
359 c->host = host;
3db35251 360 c->slot = sdhci_acpi_get_slot(hid, uid);
c4e05037
AH
361 c->pdev = pdev;
362 c->use_runtime_pm = sdhci_acpi_flag(c, SDHCI_ACPI_RUNTIME_PM);
363
364 platform_set_drvdata(pdev, c);
365
366 host->hw_name = "ACPI";
367 host->ops = &sdhci_acpi_ops_dflt;
368 host->irq = platform_get_irq(pdev, 0);
369
370 host->ioaddr = devm_ioremap_nocache(dev, iomem->start,
371 resource_size(iomem));
372 if (host->ioaddr == NULL) {
373 err = -ENOMEM;
374 goto err_free;
375 }
376
c4e05037 377 if (c->slot) {
578b36b6 378 if (c->slot->probe_slot) {
7dafca83 379 err = c->slot->probe_slot(pdev, hid, uid);
578b36b6
GY
380 if (err)
381 goto err_free;
382 }
c4e05037
AH
383 if (c->slot->chip) {
384 host->ops = c->slot->chip->ops;
385 host->quirks |= c->slot->chip->quirks;
386 host->quirks2 |= c->slot->chip->quirks2;
387 host->mmc->caps |= c->slot->chip->caps;
388 host->mmc->caps2 |= c->slot->chip->caps2;
389 host->mmc->pm_caps |= c->slot->chip->pm_caps;
390 }
391 host->quirks |= c->slot->quirks;
392 host->quirks2 |= c->slot->quirks2;
393 host->mmc->caps |= c->slot->caps;
394 host->mmc->caps2 |= c->slot->caps2;
395 host->mmc->pm_caps |= c->slot->pm_caps;
396 }
397
0d3e3350
AH
398 host->mmc->caps2 |= MMC_CAP2_NO_PRESCAN_POWERUP;
399
a61abe6e 400 if (sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD)) {
4fd4409c
AH
401 bool v = sdhci_acpi_flag(c, SDHCI_ACPI_SD_CD_OVERRIDE_LEVEL);
402
89168b48 403 if (mmc_gpiod_request_cd(host->mmc, NULL, 0, v, 0, NULL)) {
4fd4409c 404 dev_warn(dev, "failed to setup card detect gpio\n");
a61abe6e 405 c->use_runtime_pm = false;
4fd4409c 406 }
a61abe6e
AH
407 }
408
4fd4409c
AH
409 err = sdhci_add_host(host);
410 if (err)
411 goto err_free;
412
c4e05037 413 if (c->use_runtime_pm) {
1d1ff458 414 pm_runtime_set_active(dev);
c4e05037
AH
415 pm_suspend_ignore_children(dev, 1);
416 pm_runtime_set_autosuspend_delay(dev, 50);
417 pm_runtime_use_autosuspend(dev);
418 pm_runtime_enable(dev);
419 }
420
421 return 0;
422
423err_free:
c4e05037
AH
424 sdhci_free_host(c->host);
425 return err;
426}
427
4e608e4e 428static int sdhci_acpi_remove(struct platform_device *pdev)
c4e05037
AH
429{
430 struct sdhci_acpi_host *c = platform_get_drvdata(pdev);
431 struct device *dev = &pdev->dev;
432 int dead;
433
434 if (c->use_runtime_pm) {
435 pm_runtime_get_sync(dev);
436 pm_runtime_disable(dev);
437 pm_runtime_put_noidle(dev);
438 }
439
578b36b6
GY
440 if (c->slot && c->slot->remove_slot)
441 c->slot->remove_slot(pdev);
442
c4e05037
AH
443 dead = (sdhci_readl(c->host, SDHCI_INT_STATUS) == ~0);
444 sdhci_remove_host(c->host, dead);
c4e05037
AH
445 sdhci_free_host(c->host);
446
447 return 0;
448}
449
450#ifdef CONFIG_PM_SLEEP
451
452static int sdhci_acpi_suspend(struct device *dev)
453{
454 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
455
456 return sdhci_suspend_host(c->host);
457}
458
459static int sdhci_acpi_resume(struct device *dev)
460{
461 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
462
463 return sdhci_resume_host(c->host);
464}
465
466#else
467
468#define sdhci_acpi_suspend NULL
469#define sdhci_acpi_resume NULL
470
471#endif
472
162d6f98 473#ifdef CONFIG_PM
c4e05037
AH
474
475static int sdhci_acpi_runtime_suspend(struct device *dev)
476{
477 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
478
479 return sdhci_runtime_suspend_host(c->host);
480}
481
482static int sdhci_acpi_runtime_resume(struct device *dev)
483{
484 struct sdhci_acpi_host *c = dev_get_drvdata(dev);
485
486 return sdhci_runtime_resume_host(c->host);
487}
488
c4e05037
AH
489#endif
490
491static const struct dev_pm_ops sdhci_acpi_pm_ops = {
492 .suspend = sdhci_acpi_suspend,
493 .resume = sdhci_acpi_resume,
1d75f74b 494 SET_RUNTIME_PM_OPS(sdhci_acpi_runtime_suspend,
9b449e99 495 sdhci_acpi_runtime_resume, NULL)
c4e05037
AH
496};
497
498static struct platform_driver sdhci_acpi_driver = {
499 .driver = {
500 .name = "sdhci-acpi",
c4e05037
AH
501 .acpi_match_table = sdhci_acpi_ids,
502 .pm = &sdhci_acpi_pm_ops,
503 },
504 .probe = sdhci_acpi_probe,
4e608e4e 505 .remove = sdhci_acpi_remove,
c4e05037
AH
506};
507
508module_platform_driver(sdhci_acpi_driver);
509
510MODULE_DESCRIPTION("Secure Digital Host Controller Interface ACPI driver");
511MODULE_AUTHOR("Adrian Hunter");
512MODULE_LICENSE("GPL v2");