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