xref: /openbmc/linux/drivers/mmc/host/sdhci-tegra.c (revision 03231f9b)
1 /*
2  * Copyright (C) 2010 Google, Inc.
3  *
4  * This software is licensed under the terms of the GNU General Public
5  * License version 2, as published by the Free Software Foundation, and
6  * may be copied, distributed, and modified under those terms.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  */
14 
15 #include <linux/err.h>
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/platform_device.h>
19 #include <linux/clk.h>
20 #include <linux/io.h>
21 #include <linux/of.h>
22 #include <linux/of_device.h>
23 #include <linux/of_gpio.h>
24 #include <linux/gpio.h>
25 #include <linux/mmc/card.h>
26 #include <linux/mmc/host.h>
27 #include <linux/mmc/slot-gpio.h>
28 
29 #include <asm/gpio.h>
30 
31 #include "sdhci-pltfm.h"
32 
33 /* Tegra SDHOST controller vendor register definitions */
34 #define SDHCI_TEGRA_VENDOR_MISC_CTRL		0x120
35 #define SDHCI_MISC_CTRL_ENABLE_SDHCI_SPEC_300	0x20
36 
37 #define NVQUIRK_FORCE_SDHCI_SPEC_200	BIT(0)
38 #define NVQUIRK_ENABLE_BLOCK_GAP_DET	BIT(1)
39 #define NVQUIRK_ENABLE_SDHCI_SPEC_300	BIT(2)
40 
41 struct sdhci_tegra_soc_data {
42 	const struct sdhci_pltfm_data *pdata;
43 	u32 nvquirks;
44 };
45 
46 struct sdhci_tegra {
47 	const struct sdhci_tegra_soc_data *soc_data;
48 	int power_gpio;
49 };
50 
51 static u32 tegra_sdhci_readl(struct sdhci_host *host, int reg)
52 {
53 	u32 val;
54 
55 	if (unlikely(reg == SDHCI_PRESENT_STATE)) {
56 		/* Use wp_gpio here instead? */
57 		val = readl(host->ioaddr + reg);
58 		return val | SDHCI_WRITE_PROTECT;
59 	}
60 
61 	return readl(host->ioaddr + reg);
62 }
63 
64 static u16 tegra_sdhci_readw(struct sdhci_host *host, int reg)
65 {
66 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
67 	struct sdhci_tegra *tegra_host = pltfm_host->priv;
68 	const struct sdhci_tegra_soc_data *soc_data = tegra_host->soc_data;
69 
70 	if (unlikely((soc_data->nvquirks & NVQUIRK_FORCE_SDHCI_SPEC_200) &&
71 			(reg == SDHCI_HOST_VERSION))) {
72 		/* Erratum: Version register is invalid in HW. */
73 		return SDHCI_SPEC_200;
74 	}
75 
76 	return readw(host->ioaddr + reg);
77 }
78 
79 static void tegra_sdhci_writel(struct sdhci_host *host, u32 val, int reg)
80 {
81 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
82 	struct sdhci_tegra *tegra_host = pltfm_host->priv;
83 	const struct sdhci_tegra_soc_data *soc_data = tegra_host->soc_data;
84 
85 	/* Seems like we're getting spurious timeout and crc errors, so
86 	 * disable signalling of them. In case of real errors software
87 	 * timers should take care of eventually detecting them.
88 	 */
89 	if (unlikely(reg == SDHCI_SIGNAL_ENABLE))
90 		val &= ~(SDHCI_INT_TIMEOUT|SDHCI_INT_CRC);
91 
92 	writel(val, host->ioaddr + reg);
93 
94 	if (unlikely((soc_data->nvquirks & NVQUIRK_ENABLE_BLOCK_GAP_DET) &&
95 			(reg == SDHCI_INT_ENABLE))) {
96 		/* Erratum: Must enable block gap interrupt detection */
97 		u8 gap_ctrl = readb(host->ioaddr + SDHCI_BLOCK_GAP_CONTROL);
98 		if (val & SDHCI_INT_CARD_INT)
99 			gap_ctrl |= 0x8;
100 		else
101 			gap_ctrl &= ~0x8;
102 		writeb(gap_ctrl, host->ioaddr + SDHCI_BLOCK_GAP_CONTROL);
103 	}
104 }
105 
106 static unsigned int tegra_sdhci_get_ro(struct sdhci_host *host)
107 {
108 	return mmc_gpio_get_ro(host->mmc);
109 }
110 
111 static void tegra_sdhci_reset(struct sdhci_host *host, u8 mask)
112 {
113 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
114 	struct sdhci_tegra *tegra_host = pltfm_host->priv;
115 	const struct sdhci_tegra_soc_data *soc_data = tegra_host->soc_data;
116 
117 	sdhci_reset(host, mask);
118 
119 	if (!(mask & SDHCI_RESET_ALL))
120 		return;
121 
122 	/* Erratum: Enable SDHCI spec v3.00 support */
123 	if (soc_data->nvquirks & NVQUIRK_ENABLE_SDHCI_SPEC_300) {
124 		u32 misc_ctrl;
125 
126 		misc_ctrl = sdhci_readb(host, SDHCI_TEGRA_VENDOR_MISC_CTRL);
127 		misc_ctrl |= SDHCI_MISC_CTRL_ENABLE_SDHCI_SPEC_300;
128 		sdhci_writeb(host, misc_ctrl, SDHCI_TEGRA_VENDOR_MISC_CTRL);
129 	}
130 }
131 
132 static void tegra_sdhci_set_bus_width(struct sdhci_host *host, int bus_width)
133 {
134 	u32 ctrl;
135 
136 	ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL);
137 	if ((host->mmc->caps & MMC_CAP_8_BIT_DATA) &&
138 	    (bus_width == MMC_BUS_WIDTH_8)) {
139 		ctrl &= ~SDHCI_CTRL_4BITBUS;
140 		ctrl |= SDHCI_CTRL_8BITBUS;
141 	} else {
142 		ctrl &= ~SDHCI_CTRL_8BITBUS;
143 		if (bus_width == MMC_BUS_WIDTH_4)
144 			ctrl |= SDHCI_CTRL_4BITBUS;
145 		else
146 			ctrl &= ~SDHCI_CTRL_4BITBUS;
147 	}
148 	sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL);
149 }
150 
151 static const struct sdhci_ops tegra_sdhci_ops = {
152 	.get_ro     = tegra_sdhci_get_ro,
153 	.read_l     = tegra_sdhci_readl,
154 	.read_w     = tegra_sdhci_readw,
155 	.write_l    = tegra_sdhci_writel,
156 	.set_bus_width = tegra_sdhci_set_bus_width,
157 	.reset      = tegra_sdhci_reset,
158 };
159 
160 static const struct sdhci_pltfm_data sdhci_tegra20_pdata = {
161 	.quirks = SDHCI_QUIRK_BROKEN_TIMEOUT_VAL |
162 		  SDHCI_QUIRK_SINGLE_POWER_WRITE |
163 		  SDHCI_QUIRK_NO_HISPD_BIT |
164 		  SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC,
165 	.ops  = &tegra_sdhci_ops,
166 };
167 
168 static struct sdhci_tegra_soc_data soc_data_tegra20 = {
169 	.pdata = &sdhci_tegra20_pdata,
170 	.nvquirks = NVQUIRK_FORCE_SDHCI_SPEC_200 |
171 		    NVQUIRK_ENABLE_BLOCK_GAP_DET,
172 };
173 
174 static const struct sdhci_pltfm_data sdhci_tegra30_pdata = {
175 	.quirks = SDHCI_QUIRK_BROKEN_TIMEOUT_VAL |
176 		  SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK |
177 		  SDHCI_QUIRK_SINGLE_POWER_WRITE |
178 		  SDHCI_QUIRK_NO_HISPD_BIT |
179 		  SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC,
180 	.ops  = &tegra_sdhci_ops,
181 };
182 
183 static struct sdhci_tegra_soc_data soc_data_tegra30 = {
184 	.pdata = &sdhci_tegra30_pdata,
185 	.nvquirks = NVQUIRK_ENABLE_SDHCI_SPEC_300,
186 };
187 
188 static const struct sdhci_pltfm_data sdhci_tegra114_pdata = {
189 	.quirks = SDHCI_QUIRK_BROKEN_TIMEOUT_VAL |
190 		  SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK |
191 		  SDHCI_QUIRK_SINGLE_POWER_WRITE |
192 		  SDHCI_QUIRK_NO_HISPD_BIT |
193 		  SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC,
194 	.ops  = &tegra_sdhci_ops,
195 };
196 
197 static struct sdhci_tegra_soc_data soc_data_tegra114 = {
198 	.pdata = &sdhci_tegra114_pdata,
199 };
200 
201 static const struct of_device_id sdhci_tegra_dt_match[] = {
202 	{ .compatible = "nvidia,tegra124-sdhci", .data = &soc_data_tegra114 },
203 	{ .compatible = "nvidia,tegra114-sdhci", .data = &soc_data_tegra114 },
204 	{ .compatible = "nvidia,tegra30-sdhci", .data = &soc_data_tegra30 },
205 	{ .compatible = "nvidia,tegra20-sdhci", .data = &soc_data_tegra20 },
206 	{}
207 };
208 MODULE_DEVICE_TABLE(of, sdhci_tegra_dt_match);
209 
210 static int sdhci_tegra_parse_dt(struct device *dev)
211 {
212 	struct device_node *np = dev->of_node;
213 	struct sdhci_host *host = dev_get_drvdata(dev);
214 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
215 	struct sdhci_tegra *tegra_host = pltfm_host->priv;
216 
217 	tegra_host->power_gpio = of_get_named_gpio(np, "power-gpios", 0);
218 	return mmc_of_parse(host->mmc);
219 }
220 
221 static int sdhci_tegra_probe(struct platform_device *pdev)
222 {
223 	const struct of_device_id *match;
224 	const struct sdhci_tegra_soc_data *soc_data;
225 	struct sdhci_host *host;
226 	struct sdhci_pltfm_host *pltfm_host;
227 	struct sdhci_tegra *tegra_host;
228 	struct clk *clk;
229 	int rc;
230 
231 	match = of_match_device(sdhci_tegra_dt_match, &pdev->dev);
232 	if (!match)
233 		return -EINVAL;
234 	soc_data = match->data;
235 
236 	host = sdhci_pltfm_init(pdev, soc_data->pdata, 0);
237 	if (IS_ERR(host))
238 		return PTR_ERR(host);
239 	pltfm_host = sdhci_priv(host);
240 
241 	tegra_host = devm_kzalloc(&pdev->dev, sizeof(*tegra_host), GFP_KERNEL);
242 	if (!tegra_host) {
243 		dev_err(mmc_dev(host->mmc), "failed to allocate tegra_host\n");
244 		rc = -ENOMEM;
245 		goto err_alloc_tegra_host;
246 	}
247 	tegra_host->soc_data = soc_data;
248 	pltfm_host->priv = tegra_host;
249 
250 	rc = sdhci_tegra_parse_dt(&pdev->dev);
251 	if (rc)
252 		goto err_parse_dt;
253 
254 	if (gpio_is_valid(tegra_host->power_gpio)) {
255 		rc = gpio_request(tegra_host->power_gpio, "sdhci_power");
256 		if (rc) {
257 			dev_err(mmc_dev(host->mmc),
258 				"failed to allocate power gpio\n");
259 			goto err_power_req;
260 		}
261 		gpio_direction_output(tegra_host->power_gpio, 1);
262 	}
263 
264 	clk = clk_get(mmc_dev(host->mmc), NULL);
265 	if (IS_ERR(clk)) {
266 		dev_err(mmc_dev(host->mmc), "clk err\n");
267 		rc = PTR_ERR(clk);
268 		goto err_clk_get;
269 	}
270 	clk_prepare_enable(clk);
271 	pltfm_host->clk = clk;
272 
273 	rc = sdhci_add_host(host);
274 	if (rc)
275 		goto err_add_host;
276 
277 	return 0;
278 
279 err_add_host:
280 	clk_disable_unprepare(pltfm_host->clk);
281 	clk_put(pltfm_host->clk);
282 err_clk_get:
283 	if (gpio_is_valid(tegra_host->power_gpio))
284 		gpio_free(tegra_host->power_gpio);
285 err_power_req:
286 err_parse_dt:
287 err_alloc_tegra_host:
288 	sdhci_pltfm_free(pdev);
289 	return rc;
290 }
291 
292 static int sdhci_tegra_remove(struct platform_device *pdev)
293 {
294 	struct sdhci_host *host = platform_get_drvdata(pdev);
295 	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
296 	struct sdhci_tegra *tegra_host = pltfm_host->priv;
297 	int dead = (readl(host->ioaddr + SDHCI_INT_STATUS) == 0xffffffff);
298 
299 	sdhci_remove_host(host, dead);
300 
301 	if (gpio_is_valid(tegra_host->power_gpio))
302 		gpio_free(tegra_host->power_gpio);
303 
304 	clk_disable_unprepare(pltfm_host->clk);
305 	clk_put(pltfm_host->clk);
306 
307 	sdhci_pltfm_free(pdev);
308 
309 	return 0;
310 }
311 
312 static struct platform_driver sdhci_tegra_driver = {
313 	.driver		= {
314 		.name	= "sdhci-tegra",
315 		.owner	= THIS_MODULE,
316 		.of_match_table = sdhci_tegra_dt_match,
317 		.pm	= SDHCI_PLTFM_PMOPS,
318 	},
319 	.probe		= sdhci_tegra_probe,
320 	.remove		= sdhci_tegra_remove,
321 };
322 
323 module_platform_driver(sdhci_tegra_driver);
324 
325 MODULE_DESCRIPTION("SDHCI driver for Tegra");
326 MODULE_AUTHOR("Google, Inc.");
327 MODULE_LICENSE("GPL v2");
328