xref: /openbmc/linux/drivers/mmc/host/sdhci-pltfm.c (revision 31b90347)
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/of.h>
34 #ifdef CONFIG_PPC
35 #include <asm/machdep.h>
36 #endif
37 #include "sdhci-pltfm.h"
38 
39 unsigned int sdhci_pltfm_clk_get_max_clock(struct sdhci_host *host)
40 {
41 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
42 
43 	return clk_get_rate(pltfm_host->clk);
44 }
45 EXPORT_SYMBOL_GPL(sdhci_pltfm_clk_get_max_clock);
46 
47 static const struct sdhci_ops sdhci_pltfm_ops = {
48 };
49 
50 #ifdef CONFIG_OF
51 static bool sdhci_of_wp_inverted(struct device_node *np)
52 {
53 	if (of_get_property(np, "sdhci,wp-inverted", NULL) ||
54 	    of_get_property(np, "wp-inverted", NULL))
55 		return true;
56 
57 	/* Old device trees don't have the wp-inverted property. */
58 #ifdef CONFIG_PPC
59 	return machine_is(mpc837x_rdb) || machine_is(mpc837x_mds);
60 #else
61 	return false;
62 #endif /* CONFIG_PPC */
63 }
64 
65 void sdhci_get_of_property(struct platform_device *pdev)
66 {
67 	struct device_node *np = pdev->dev.of_node;
68 	struct sdhci_host *host = platform_get_drvdata(pdev);
69 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
70 	const __be32 *clk;
71 	u32 bus_width;
72 	int size;
73 
74 	if (of_device_is_available(np)) {
75 		if (of_get_property(np, "sdhci,auto-cmd12", NULL))
76 			host->quirks |= SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12;
77 
78 		if (of_get_property(np, "sdhci,1-bit-only", NULL) ||
79 		    (of_property_read_u32(np, "bus-width", &bus_width) == 0 &&
80 		    bus_width == 1))
81 			host->quirks |= SDHCI_QUIRK_FORCE_1_BIT_DATA;
82 
83 		if (sdhci_of_wp_inverted(np))
84 			host->quirks |= SDHCI_QUIRK_INVERTED_WRITE_PROTECT;
85 
86 		if (of_get_property(np, "broken-cd", NULL))
87 			host->quirks |= SDHCI_QUIRK_BROKEN_CARD_DETECTION;
88 
89 		if (of_get_property(np, "no-1-8-v", NULL))
90 			host->quirks2 |= SDHCI_QUIRK2_NO_1_8_V;
91 
92 		if (of_device_is_compatible(np, "fsl,p2020-rev1-esdhc"))
93 			host->quirks |= SDHCI_QUIRK_BROKEN_DMA;
94 
95 		if (of_device_is_compatible(np, "fsl,p2020-esdhc") ||
96 		    of_device_is_compatible(np, "fsl,p1010-esdhc") ||
97 		    of_device_is_compatible(np, "fsl,t4240-esdhc") ||
98 		    of_device_is_compatible(np, "fsl,mpc8536-esdhc"))
99 			host->quirks |= SDHCI_QUIRK_BROKEN_TIMEOUT_VAL;
100 
101 		clk = of_get_property(np, "clock-frequency", &size);
102 		if (clk && size == sizeof(*clk) && *clk)
103 			pltfm_host->clock = be32_to_cpup(clk);
104 
105 		if (of_find_property(np, "keep-power-in-suspend", NULL))
106 			host->mmc->pm_caps |= MMC_PM_KEEP_POWER;
107 
108 		if (of_find_property(np, "enable-sdio-wakeup", NULL))
109 			host->mmc->pm_caps |= MMC_PM_WAKE_SDIO_IRQ;
110 	}
111 }
112 #else
113 void sdhci_get_of_property(struct platform_device *pdev) {}
114 #endif /* CONFIG_OF */
115 EXPORT_SYMBOL_GPL(sdhci_get_of_property);
116 
117 struct sdhci_host *sdhci_pltfm_init(struct platform_device *pdev,
118 				    const struct sdhci_pltfm_data *pdata,
119 				    size_t priv_size)
120 {
121 	struct sdhci_host *host;
122 	struct device_node *np = pdev->dev.of_node;
123 	struct resource *iomem;
124 	int ret;
125 
126 	iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
127 	if (!iomem) {
128 		ret = -ENOMEM;
129 		goto err;
130 	}
131 
132 	if (resource_size(iomem) < 0x100)
133 		dev_err(&pdev->dev, "Invalid iomem size!\n");
134 
135 	/* Some PCI-based MFD need the parent here */
136 	if (pdev->dev.parent != &platform_bus && !np)
137 		host = sdhci_alloc_host(pdev->dev.parent,
138 			sizeof(struct sdhci_pltfm_host) + priv_size);
139 	else
140 		host = sdhci_alloc_host(&pdev->dev,
141 			sizeof(struct sdhci_pltfm_host) + priv_size);
142 
143 	if (IS_ERR(host)) {
144 		ret = PTR_ERR(host);
145 		goto err;
146 	}
147 
148 	host->hw_name = dev_name(&pdev->dev);
149 	if (pdata && pdata->ops)
150 		host->ops = pdata->ops;
151 	else
152 		host->ops = &sdhci_pltfm_ops;
153 	if (pdata) {
154 		host->quirks = pdata->quirks;
155 		host->quirks2 = pdata->quirks2;
156 	}
157 
158 	host->irq = platform_get_irq(pdev, 0);
159 
160 	if (!request_mem_region(iomem->start, resource_size(iomem),
161 		mmc_hostname(host->mmc))) {
162 		dev_err(&pdev->dev, "cannot request region\n");
163 		ret = -EBUSY;
164 		goto err_request;
165 	}
166 
167 	host->ioaddr = ioremap(iomem->start, resource_size(iomem));
168 	if (!host->ioaddr) {
169 		dev_err(&pdev->dev, "failed to remap registers\n");
170 		ret = -ENOMEM;
171 		goto err_remap;
172 	}
173 
174 	/*
175 	 * Some platforms need to probe the controller to be able to
176 	 * determine which caps should be used.
177 	 */
178 	if (host->ops && host->ops->platform_init)
179 		host->ops->platform_init(host);
180 
181 	platform_set_drvdata(pdev, host);
182 
183 	return host;
184 
185 err_remap:
186 	release_mem_region(iomem->start, resource_size(iomem));
187 err_request:
188 	sdhci_free_host(host);
189 err:
190 	dev_err(&pdev->dev, "%s failed %d\n", __func__, ret);
191 	return ERR_PTR(ret);
192 }
193 EXPORT_SYMBOL_GPL(sdhci_pltfm_init);
194 
195 void sdhci_pltfm_free(struct platform_device *pdev)
196 {
197 	struct sdhci_host *host = platform_get_drvdata(pdev);
198 	struct resource *iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
199 
200 	iounmap(host->ioaddr);
201 	release_mem_region(iomem->start, resource_size(iomem));
202 	sdhci_free_host(host);
203 }
204 EXPORT_SYMBOL_GPL(sdhci_pltfm_free);
205 
206 int sdhci_pltfm_register(struct platform_device *pdev,
207 			const struct sdhci_pltfm_data *pdata,
208 			size_t priv_size)
209 {
210 	struct sdhci_host *host;
211 	int ret = 0;
212 
213 	host = sdhci_pltfm_init(pdev, pdata, priv_size);
214 	if (IS_ERR(host))
215 		return PTR_ERR(host);
216 
217 	sdhci_get_of_property(pdev);
218 
219 	ret = sdhci_add_host(host);
220 	if (ret)
221 		sdhci_pltfm_free(pdev);
222 
223 	return ret;
224 }
225 EXPORT_SYMBOL_GPL(sdhci_pltfm_register);
226 
227 int sdhci_pltfm_unregister(struct platform_device *pdev)
228 {
229 	struct sdhci_host *host = platform_get_drvdata(pdev);
230 	int dead = (readl(host->ioaddr + SDHCI_INT_STATUS) == 0xffffffff);
231 
232 	sdhci_remove_host(host, dead);
233 	sdhci_pltfm_free(pdev);
234 
235 	return 0;
236 }
237 EXPORT_SYMBOL_GPL(sdhci_pltfm_unregister);
238 
239 #ifdef CONFIG_PM
240 static int sdhci_pltfm_suspend(struct device *dev)
241 {
242 	struct sdhci_host *host = dev_get_drvdata(dev);
243 
244 	return sdhci_suspend_host(host);
245 }
246 
247 static int sdhci_pltfm_resume(struct device *dev)
248 {
249 	struct sdhci_host *host = dev_get_drvdata(dev);
250 
251 	return sdhci_resume_host(host);
252 }
253 
254 const struct dev_pm_ops sdhci_pltfm_pmops = {
255 	.suspend	= sdhci_pltfm_suspend,
256 	.resume		= sdhci_pltfm_resume,
257 };
258 EXPORT_SYMBOL_GPL(sdhci_pltfm_pmops);
259 #endif	/* CONFIG_PM */
260 
261 static int __init sdhci_pltfm_drv_init(void)
262 {
263 	pr_info("sdhci-pltfm: SDHCI platform and OF driver helper\n");
264 
265 	return 0;
266 }
267 module_init(sdhci_pltfm_drv_init);
268 
269 static void __exit sdhci_pltfm_drv_exit(void)
270 {
271 }
272 module_exit(sdhci_pltfm_drv_exit);
273 
274 MODULE_DESCRIPTION("SDHCI platform and OF driver helper");
275 MODULE_AUTHOR("Intel Corporation");
276 MODULE_LICENSE("GPL v2");
277