xref: /openbmc/linux/drivers/mmc/host/sdhci-pltfm.c (revision e15a5365)
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 	void __iomem *ioaddr;
122 	int irq, ret;
123 
124 	ioaddr = devm_platform_ioremap_resource(pdev, 0);
125 	if (IS_ERR(ioaddr)) {
126 		ret = PTR_ERR(ioaddr);
127 		goto err;
128 	}
129 
130 	irq = platform_get_irq(pdev, 0);
131 	if (irq < 0) {
132 		ret = irq;
133 		goto err;
134 	}
135 
136 	host = sdhci_alloc_host(&pdev->dev,
137 		sizeof(struct sdhci_pltfm_host) + priv_size);
138 
139 	if (IS_ERR(host)) {
140 		ret = PTR_ERR(host);
141 		goto err;
142 	}
143 
144 	host->ioaddr = ioaddr;
145 	host->irq = irq;
146 	host->hw_name = dev_name(&pdev->dev);
147 	if (pdata && pdata->ops)
148 		host->ops = pdata->ops;
149 	else
150 		host->ops = &sdhci_pltfm_ops;
151 	if (pdata) {
152 		host->quirks = pdata->quirks;
153 		host->quirks2 = pdata->quirks2;
154 	}
155 
156 	platform_set_drvdata(pdev, host);
157 
158 	return host;
159 err:
160 	dev_err(&pdev->dev, "%s failed %d\n", __func__, ret);
161 	return ERR_PTR(ret);
162 }
163 EXPORT_SYMBOL_GPL(sdhci_pltfm_init);
164 
165 void sdhci_pltfm_free(struct platform_device *pdev)
166 {
167 	struct sdhci_host *host = platform_get_drvdata(pdev);
168 
169 	sdhci_free_host(host);
170 }
171 EXPORT_SYMBOL_GPL(sdhci_pltfm_free);
172 
173 int sdhci_pltfm_register(struct platform_device *pdev,
174 			const struct sdhci_pltfm_data *pdata,
175 			size_t priv_size)
176 {
177 	struct sdhci_host *host;
178 	int ret = 0;
179 
180 	host = sdhci_pltfm_init(pdev, pdata, priv_size);
181 	if (IS_ERR(host))
182 		return PTR_ERR(host);
183 
184 	sdhci_get_property(pdev);
185 
186 	ret = sdhci_add_host(host);
187 	if (ret)
188 		sdhci_pltfm_free(pdev);
189 
190 	return ret;
191 }
192 EXPORT_SYMBOL_GPL(sdhci_pltfm_register);
193 
194 int sdhci_pltfm_unregister(struct platform_device *pdev)
195 {
196 	struct sdhci_host *host = platform_get_drvdata(pdev);
197 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
198 	int dead = (readl(host->ioaddr + SDHCI_INT_STATUS) == 0xffffffff);
199 
200 	sdhci_remove_host(host, dead);
201 	clk_disable_unprepare(pltfm_host->clk);
202 	sdhci_pltfm_free(pdev);
203 
204 	return 0;
205 }
206 EXPORT_SYMBOL_GPL(sdhci_pltfm_unregister);
207 
208 #ifdef CONFIG_PM_SLEEP
209 int sdhci_pltfm_suspend(struct device *dev)
210 {
211 	struct sdhci_host *host = dev_get_drvdata(dev);
212 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
213 	int ret;
214 
215 	if (host->tuning_mode != SDHCI_TUNING_MODE_3)
216 		mmc_retune_needed(host->mmc);
217 
218 	ret = sdhci_suspend_host(host);
219 	if (ret)
220 		return ret;
221 
222 	clk_disable_unprepare(pltfm_host->clk);
223 
224 	return 0;
225 }
226 EXPORT_SYMBOL_GPL(sdhci_pltfm_suspend);
227 
228 int sdhci_pltfm_resume(struct device *dev)
229 {
230 	struct sdhci_host *host = dev_get_drvdata(dev);
231 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
232 	int ret;
233 
234 	ret = clk_prepare_enable(pltfm_host->clk);
235 	if (ret)
236 		return ret;
237 
238 	ret = sdhci_resume_host(host);
239 	if (ret)
240 		clk_disable_unprepare(pltfm_host->clk);
241 
242 	return ret;
243 }
244 EXPORT_SYMBOL_GPL(sdhci_pltfm_resume);
245 #endif
246 
247 const struct dev_pm_ops sdhci_pltfm_pmops = {
248 	SET_SYSTEM_SLEEP_PM_OPS(sdhci_pltfm_suspend, sdhci_pltfm_resume)
249 };
250 EXPORT_SYMBOL_GPL(sdhci_pltfm_pmops);
251 
252 static int __init sdhci_pltfm_drv_init(void)
253 {
254 	pr_info("sdhci-pltfm: SDHCI platform and OF driver helper\n");
255 
256 	return 0;
257 }
258 module_init(sdhci_pltfm_drv_init);
259 
260 static void __exit sdhci_pltfm_drv_exit(void)
261 {
262 }
263 module_exit(sdhci_pltfm_drv_exit);
264 
265 MODULE_DESCRIPTION("SDHCI platform and OF driver helper");
266 MODULE_AUTHOR("Intel Corporation");
267 MODULE_LICENSE("GPL v2");
268