Merge tag 'docs-5.0-fixes' of git://git.lwn.net/linux
[linux-2.6-microblaze.git] / drivers / mmc / host / sdhci-pltfm.c
1 /*
2  * sdhci-pltfm.c Support for SDHCI platform devices
3  * Copyright (c) 2009 Intel Corporation
4  *
5  * Copyright (c) 2007, 2011 Freescale Semiconductor, Inc.
6  * Copyright (c) 2009 MontaVista Software, Inc.
7  *
8  * Authors: Xiaobo Xie <X.Xie@freescale.com>
9  *          Anton Vorontsov <avorontsov@ru.mvista.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  */
24
25 /* Supports:
26  * SDHCI platform devices
27  *
28  * Inspired by sdhci-pci.c, by Pierre Ossman
29  */
30
31 #include <linux/err.h>
32 #include <linux/module.h>
33 #include <linux/property.h>
34 #include <linux/of.h>
35 #ifdef CONFIG_PPC
36 #include <asm/machdep.h>
37 #endif
38 #include "sdhci-pltfm.h"
39
40 unsigned int sdhci_pltfm_clk_get_max_clock(struct sdhci_host *host)
41 {
42         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
43
44         return clk_get_rate(pltfm_host->clk);
45 }
46 EXPORT_SYMBOL_GPL(sdhci_pltfm_clk_get_max_clock);
47
48 static const struct sdhci_ops sdhci_pltfm_ops = {
49         .set_clock = sdhci_set_clock,
50         .set_bus_width = sdhci_set_bus_width,
51         .reset = sdhci_reset,
52         .set_uhs_signaling = sdhci_set_uhs_signaling,
53 };
54
55 static bool sdhci_wp_inverted(struct device *dev)
56 {
57         if (device_property_present(dev, "sdhci,wp-inverted") ||
58             device_property_present(dev, "wp-inverted"))
59                 return true;
60
61         /* Old device trees don't have the wp-inverted property. */
62 #ifdef CONFIG_PPC
63         return machine_is(mpc837x_rdb) || machine_is(mpc837x_mds);
64 #else
65         return false;
66 #endif /* CONFIG_PPC */
67 }
68
69 #ifdef CONFIG_OF
70 static void sdhci_get_compatibility(struct platform_device *pdev)
71 {
72         struct sdhci_host *host = platform_get_drvdata(pdev);
73         struct device_node *np = pdev->dev.of_node;
74
75         if (!np)
76                 return;
77
78         if (of_device_is_compatible(np, "fsl,p2020-rev1-esdhc"))
79                 host->quirks |= SDHCI_QUIRK_BROKEN_DMA;
80
81         if (of_device_is_compatible(np, "fsl,p2020-esdhc") ||
82             of_device_is_compatible(np, "fsl,p1010-esdhc") ||
83             of_device_is_compatible(np, "fsl,t4240-esdhc") ||
84             of_device_is_compatible(np, "fsl,mpc8536-esdhc"))
85                 host->quirks |= SDHCI_QUIRK_BROKEN_TIMEOUT_VAL;
86 }
87 #else
88 void sdhci_get_compatibility(struct platform_device *pdev) {}
89 #endif /* CONFIG_OF */
90
91 void sdhci_get_property(struct platform_device *pdev)
92 {
93         struct device *dev = &pdev->dev;
94         struct sdhci_host *host = platform_get_drvdata(pdev);
95         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
96         u32 bus_width;
97
98         if (device_property_present(dev, "sdhci,auto-cmd12"))
99                 host->quirks |= SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12;
100
101         if (device_property_present(dev, "sdhci,1-bit-only") ||
102             (device_property_read_u32(dev, "bus-width", &bus_width) == 0 &&
103             bus_width == 1))
104                 host->quirks |= SDHCI_QUIRK_FORCE_1_BIT_DATA;
105
106         if (sdhci_wp_inverted(dev))
107                 host->quirks |= SDHCI_QUIRK_INVERTED_WRITE_PROTECT;
108
109         if (device_property_present(dev, "broken-cd"))
110                 host->quirks |= SDHCI_QUIRK_BROKEN_CARD_DETECTION;
111
112         if (device_property_present(dev, "no-1-8-v"))
113                 host->quirks2 |= SDHCI_QUIRK2_NO_1_8_V;
114
115         sdhci_get_compatibility(pdev);
116
117         device_property_read_u32(dev, "clock-frequency", &pltfm_host->clock);
118
119         if (device_property_present(dev, "keep-power-in-suspend"))
120                 host->mmc->pm_caps |= MMC_PM_KEEP_POWER;
121
122         if (device_property_read_bool(dev, "wakeup-source") ||
123             device_property_read_bool(dev, "enable-sdio-wakeup")) /* legacy */
124                 host->mmc->pm_caps |= MMC_PM_WAKE_SDIO_IRQ;
125 }
126 EXPORT_SYMBOL_GPL(sdhci_get_property);
127
128 struct sdhci_host *sdhci_pltfm_init(struct platform_device *pdev,
129                                     const struct sdhci_pltfm_data *pdata,
130                                     size_t priv_size)
131 {
132         struct sdhci_host *host;
133         struct resource *iomem;
134         void __iomem *ioaddr;
135         int irq, ret;
136
137         iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
138         ioaddr = devm_ioremap_resource(&pdev->dev, iomem);
139         if (IS_ERR(ioaddr)) {
140                 ret = PTR_ERR(ioaddr);
141                 goto err;
142         }
143
144         irq = platform_get_irq(pdev, 0);
145         if (irq < 0) {
146                 dev_err(&pdev->dev, "failed to get IRQ number\n");
147                 ret = irq;
148                 goto err;
149         }
150
151         host = sdhci_alloc_host(&pdev->dev,
152                 sizeof(struct sdhci_pltfm_host) + priv_size);
153
154         if (IS_ERR(host)) {
155                 ret = PTR_ERR(host);
156                 goto err;
157         }
158
159         host->ioaddr = ioaddr;
160         host->irq = irq;
161         host->hw_name = dev_name(&pdev->dev);
162         if (pdata && pdata->ops)
163                 host->ops = pdata->ops;
164         else
165                 host->ops = &sdhci_pltfm_ops;
166         if (pdata) {
167                 host->quirks = pdata->quirks;
168                 host->quirks2 = pdata->quirks2;
169         }
170
171         platform_set_drvdata(pdev, host);
172
173         return host;
174 err:
175         dev_err(&pdev->dev, "%s failed %d\n", __func__, ret);
176         return ERR_PTR(ret);
177 }
178 EXPORT_SYMBOL_GPL(sdhci_pltfm_init);
179
180 void sdhci_pltfm_free(struct platform_device *pdev)
181 {
182         struct sdhci_host *host = platform_get_drvdata(pdev);
183
184         sdhci_free_host(host);
185 }
186 EXPORT_SYMBOL_GPL(sdhci_pltfm_free);
187
188 int sdhci_pltfm_register(struct platform_device *pdev,
189                         const struct sdhci_pltfm_data *pdata,
190                         size_t priv_size)
191 {
192         struct sdhci_host *host;
193         int ret = 0;
194
195         host = sdhci_pltfm_init(pdev, pdata, priv_size);
196         if (IS_ERR(host))
197                 return PTR_ERR(host);
198
199         sdhci_get_property(pdev);
200
201         ret = sdhci_add_host(host);
202         if (ret)
203                 sdhci_pltfm_free(pdev);
204
205         return ret;
206 }
207 EXPORT_SYMBOL_GPL(sdhci_pltfm_register);
208
209 int sdhci_pltfm_unregister(struct platform_device *pdev)
210 {
211         struct sdhci_host *host = platform_get_drvdata(pdev);
212         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
213         int dead = (readl(host->ioaddr + SDHCI_INT_STATUS) == 0xffffffff);
214
215         sdhci_remove_host(host, dead);
216         clk_disable_unprepare(pltfm_host->clk);
217         sdhci_pltfm_free(pdev);
218
219         return 0;
220 }
221 EXPORT_SYMBOL_GPL(sdhci_pltfm_unregister);
222
223 #ifdef CONFIG_PM_SLEEP
224 int sdhci_pltfm_suspend(struct device *dev)
225 {
226         struct sdhci_host *host = dev_get_drvdata(dev);
227         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
228         int ret;
229
230         if (host->tuning_mode != SDHCI_TUNING_MODE_3)
231                 mmc_retune_needed(host->mmc);
232
233         ret = sdhci_suspend_host(host);
234         if (ret)
235                 return ret;
236
237         clk_disable_unprepare(pltfm_host->clk);
238
239         return 0;
240 }
241 EXPORT_SYMBOL_GPL(sdhci_pltfm_suspend);
242
243 int sdhci_pltfm_resume(struct device *dev)
244 {
245         struct sdhci_host *host = dev_get_drvdata(dev);
246         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
247         int ret;
248
249         ret = clk_prepare_enable(pltfm_host->clk);
250         if (ret)
251                 return ret;
252
253         ret = sdhci_resume_host(host);
254         if (ret)
255                 clk_disable_unprepare(pltfm_host->clk);
256
257         return ret;
258 }
259 EXPORT_SYMBOL_GPL(sdhci_pltfm_resume);
260 #endif
261
262 const struct dev_pm_ops sdhci_pltfm_pmops = {
263         SET_SYSTEM_SLEEP_PM_OPS(sdhci_pltfm_suspend, sdhci_pltfm_resume)
264 };
265 EXPORT_SYMBOL_GPL(sdhci_pltfm_pmops);
266
267 static int __init sdhci_pltfm_drv_init(void)
268 {
269         pr_info("sdhci-pltfm: SDHCI platform and OF driver helper\n");
270
271         return 0;
272 }
273 module_init(sdhci_pltfm_drv_init);
274
275 static void __exit sdhci_pltfm_drv_exit(void)
276 {
277 }
278 module_exit(sdhci_pltfm_drv_exit);
279
280 MODULE_DESCRIPTION("SDHCI platform and OF driver helper");
281 MODULE_AUTHOR("Intel Corporation");
282 MODULE_LICENSE("GPL v2");