xref: /openbmc/linux/drivers/net/wireless/ti/wlcore/sdio.c (revision 9cfc5c90)
1 /*
2  * This file is part of wl1271
3  *
4  * Copyright (C) 2009-2010 Nokia Corporation
5  *
6  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * version 2 as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA
21  *
22  */
23 
24 #include <linux/irq.h>
25 #include <linux/module.h>
26 #include <linux/vmalloc.h>
27 #include <linux/platform_device.h>
28 #include <linux/mmc/sdio.h>
29 #include <linux/mmc/sdio_func.h>
30 #include <linux/mmc/sdio_ids.h>
31 #include <linux/mmc/card.h>
32 #include <linux/mmc/host.h>
33 #include <linux/gpio.h>
34 #include <linux/pm_runtime.h>
35 #include <linux/printk.h>
36 #include <linux/of.h>
37 #include <linux/of_irq.h>
38 
39 #include "wlcore.h"
40 #include "wl12xx_80211.h"
41 #include "io.h"
42 
43 #ifndef SDIO_VENDOR_ID_TI
44 #define SDIO_VENDOR_ID_TI		0x0097
45 #endif
46 
47 #ifndef SDIO_DEVICE_ID_TI_WL1271
48 #define SDIO_DEVICE_ID_TI_WL1271	0x4076
49 #endif
50 
51 static bool dump = false;
52 
53 struct wl12xx_sdio_glue {
54 	struct device *dev;
55 	struct platform_device *core;
56 };
57 
58 static const struct sdio_device_id wl1271_devices[] = {
59 	{ SDIO_DEVICE(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271) },
60 	{}
61 };
62 MODULE_DEVICE_TABLE(sdio, wl1271_devices);
63 
64 static void wl1271_sdio_set_block_size(struct device *child,
65 				       unsigned int blksz)
66 {
67 	struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
68 	struct sdio_func *func = dev_to_sdio_func(glue->dev);
69 
70 	sdio_claim_host(func);
71 	sdio_set_block_size(func, blksz);
72 	sdio_release_host(func);
73 }
74 
75 static int __must_check wl12xx_sdio_raw_read(struct device *child, int addr,
76 					     void *buf, size_t len, bool fixed)
77 {
78 	int ret;
79 	struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
80 	struct sdio_func *func = dev_to_sdio_func(glue->dev);
81 
82 	sdio_claim_host(func);
83 
84 	if (unlikely(dump)) {
85 		printk(KERN_DEBUG "wlcore_sdio: READ from 0x%04x\n", addr);
86 		print_hex_dump(KERN_DEBUG, "wlcore_sdio: READ ",
87 				DUMP_PREFIX_OFFSET, 16, 1,
88 				buf, len, false);
89 	}
90 
91 	if (unlikely(addr == HW_ACCESS_ELP_CTRL_REG)) {
92 		((u8 *)buf)[0] = sdio_f0_readb(func, addr, &ret);
93 		dev_dbg(child->parent, "sdio read 52 addr 0x%x, byte 0x%02x\n",
94 			addr, ((u8 *)buf)[0]);
95 	} else {
96 		if (fixed)
97 			ret = sdio_readsb(func, buf, addr, len);
98 		else
99 			ret = sdio_memcpy_fromio(func, buf, addr, len);
100 
101 		dev_dbg(child->parent, "sdio read 53 addr 0x%x, %zu bytes\n",
102 			addr, len);
103 	}
104 
105 	sdio_release_host(func);
106 
107 	if (WARN_ON(ret))
108 		dev_err(child->parent, "sdio read failed (%d)\n", ret);
109 
110 	return ret;
111 }
112 
113 static int __must_check wl12xx_sdio_raw_write(struct device *child, int addr,
114 					      void *buf, size_t len, bool fixed)
115 {
116 	int ret;
117 	struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
118 	struct sdio_func *func = dev_to_sdio_func(glue->dev);
119 
120 	sdio_claim_host(func);
121 
122 	if (unlikely(dump)) {
123 		printk(KERN_DEBUG "wlcore_sdio: WRITE to 0x%04x\n", addr);
124 		print_hex_dump(KERN_DEBUG, "wlcore_sdio: WRITE ",
125 				DUMP_PREFIX_OFFSET, 16, 1,
126 				buf, len, false);
127 	}
128 
129 	if (unlikely(addr == HW_ACCESS_ELP_CTRL_REG)) {
130 		sdio_f0_writeb(func, ((u8 *)buf)[0], addr, &ret);
131 		dev_dbg(child->parent, "sdio write 52 addr 0x%x, byte 0x%02x\n",
132 			addr, ((u8 *)buf)[0]);
133 	} else {
134 		dev_dbg(child->parent, "sdio write 53 addr 0x%x, %zu bytes\n",
135 			addr, len);
136 
137 		if (fixed)
138 			ret = sdio_writesb(func, addr, buf, len);
139 		else
140 			ret = sdio_memcpy_toio(func, addr, buf, len);
141 	}
142 
143 	sdio_release_host(func);
144 
145 	if (WARN_ON(ret))
146 		dev_err(child->parent, "sdio write failed (%d)\n", ret);
147 
148 	return ret;
149 }
150 
151 static int wl12xx_sdio_power_on(struct wl12xx_sdio_glue *glue)
152 {
153 	int ret;
154 	struct sdio_func *func = dev_to_sdio_func(glue->dev);
155 	struct mmc_card *card = func->card;
156 
157 	ret = pm_runtime_get_sync(&card->dev);
158 	if (ret) {
159 		/*
160 		 * Runtime PM might be temporarily disabled, or the device
161 		 * might have a positive reference counter. Make sure it is
162 		 * really powered on.
163 		 */
164 		ret = mmc_power_restore_host(card->host);
165 		if (ret < 0) {
166 			pm_runtime_put_sync(&card->dev);
167 			goto out;
168 		}
169 	}
170 
171 	sdio_claim_host(func);
172 	sdio_enable_func(func);
173 	sdio_release_host(func);
174 
175 out:
176 	return ret;
177 }
178 
179 static int wl12xx_sdio_power_off(struct wl12xx_sdio_glue *glue)
180 {
181 	int ret;
182 	struct sdio_func *func = dev_to_sdio_func(glue->dev);
183 	struct mmc_card *card = func->card;
184 
185 	sdio_claim_host(func);
186 	sdio_disable_func(func);
187 	sdio_release_host(func);
188 
189 	/* Power off the card manually in case it wasn't powered off above */
190 	ret = mmc_power_save_host(card->host);
191 	if (ret < 0)
192 		goto out;
193 
194 	/* Let runtime PM know the card is powered off */
195 	pm_runtime_put_sync(&card->dev);
196 
197 out:
198 	return ret;
199 }
200 
201 static int wl12xx_sdio_set_power(struct device *child, bool enable)
202 {
203 	struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
204 
205 	if (enable)
206 		return wl12xx_sdio_power_on(glue);
207 	else
208 		return wl12xx_sdio_power_off(glue);
209 }
210 
211 static struct wl1271_if_operations sdio_ops = {
212 	.read		= wl12xx_sdio_raw_read,
213 	.write		= wl12xx_sdio_raw_write,
214 	.power		= wl12xx_sdio_set_power,
215 	.set_block_size = wl1271_sdio_set_block_size,
216 };
217 
218 #ifdef CONFIG_OF
219 static const struct of_device_id wlcore_sdio_of_match_table[] = {
220 	{ .compatible = "ti,wl1271" },
221 	{ .compatible = "ti,wl1273" },
222 	{ .compatible = "ti,wl1281" },
223 	{ .compatible = "ti,wl1283" },
224 	{ .compatible = "ti,wl1801" },
225 	{ .compatible = "ti,wl1805" },
226 	{ .compatible = "ti,wl1807" },
227 	{ .compatible = "ti,wl1831" },
228 	{ .compatible = "ti,wl1835" },
229 	{ .compatible = "ti,wl1837" },
230 	{ }
231 };
232 
233 static int wlcore_probe_of(struct device *dev, int *irq,
234 			   struct wlcore_platdev_data *pdev_data)
235 {
236 	struct device_node *np = dev->of_node;
237 
238 	if (!np || !of_match_node(wlcore_sdio_of_match_table, np))
239 		return -ENODATA;
240 
241 	*irq = irq_of_parse_and_map(np, 0);
242 	if (!*irq) {
243 		dev_err(dev, "No irq in platform data\n");
244 		kfree(pdev_data);
245 		return -EINVAL;
246 	}
247 
248 	/* optional clock frequency params */
249 	of_property_read_u32(np, "ref-clock-frequency",
250 			     &pdev_data->ref_clock_freq);
251 	of_property_read_u32(np, "tcxo-clock-frequency",
252 			     &pdev_data->tcxo_clock_freq);
253 
254 	return 0;
255 }
256 #else
257 static int wlcore_probe_of(struct device *dev, int *irq,
258 			   struct wlcore_platdev_data *pdev_data)
259 {
260 	return -ENODATA;
261 }
262 #endif
263 
264 static int wl1271_probe(struct sdio_func *func,
265 				  const struct sdio_device_id *id)
266 {
267 	struct wlcore_platdev_data pdev_data;
268 	struct wl12xx_sdio_glue *glue;
269 	struct resource res[1];
270 	mmc_pm_flag_t mmcflags;
271 	int ret = -ENOMEM;
272 	int irq;
273 	const char *chip_family;
274 
275 	/* We are only able to handle the wlan function */
276 	if (func->num != 0x02)
277 		return -ENODEV;
278 
279 	memset(&pdev_data, 0x00, sizeof(pdev_data));
280 	pdev_data.if_ops = &sdio_ops;
281 
282 	glue = kzalloc(sizeof(*glue), GFP_KERNEL);
283 	if (!glue) {
284 		dev_err(&func->dev, "can't allocate glue\n");
285 		goto out;
286 	}
287 
288 	glue->dev = &func->dev;
289 
290 	/* Grab access to FN0 for ELP reg. */
291 	func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
292 
293 	/* Use block mode for transferring over one block size of data */
294 	func->card->quirks |= MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
295 
296 	ret = wlcore_probe_of(&func->dev, &irq, &pdev_data);
297 	if (ret)
298 		goto out_free_glue;
299 
300 	/* if sdio can keep power while host is suspended, enable wow */
301 	mmcflags = sdio_get_host_pm_caps(func);
302 	dev_dbg(glue->dev, "sdio PM caps = 0x%x\n", mmcflags);
303 
304 	if (mmcflags & MMC_PM_KEEP_POWER)
305 		pdev_data.pwr_in_suspend = true;
306 
307 	sdio_set_drvdata(func, glue);
308 
309 	/* Tell PM core that we don't need the card to be powered now */
310 	pm_runtime_put_noidle(&func->dev);
311 
312 	/*
313 	 * Due to a hardware bug, we can't differentiate wl18xx from
314 	 * wl12xx, because both report the same device ID.  The only
315 	 * way to differentiate is by checking the SDIO revision,
316 	 * which is 3.00 on the wl18xx chips.
317 	 */
318 	if (func->card->cccr.sdio_vsn == SDIO_SDIO_REV_3_00)
319 		chip_family = "wl18xx";
320 	else
321 		chip_family = "wl12xx";
322 
323 	glue->core = platform_device_alloc(chip_family, PLATFORM_DEVID_AUTO);
324 	if (!glue->core) {
325 		dev_err(glue->dev, "can't allocate platform_device");
326 		ret = -ENOMEM;
327 		goto out_free_glue;
328 	}
329 
330 	glue->core->dev.parent = &func->dev;
331 
332 	memset(res, 0x00, sizeof(res));
333 
334 	res[0].start = irq;
335 	res[0].flags = IORESOURCE_IRQ |
336 		       irqd_get_trigger_type(irq_get_irq_data(irq));
337 	res[0].name = "irq";
338 
339 	ret = platform_device_add_resources(glue->core, res, ARRAY_SIZE(res));
340 	if (ret) {
341 		dev_err(glue->dev, "can't add resources\n");
342 		goto out_dev_put;
343 	}
344 
345 	ret = platform_device_add_data(glue->core, &pdev_data,
346 				       sizeof(pdev_data));
347 	if (ret) {
348 		dev_err(glue->dev, "can't add platform data\n");
349 		goto out_dev_put;
350 	}
351 
352 	ret = platform_device_add(glue->core);
353 	if (ret) {
354 		dev_err(glue->dev, "can't add platform device\n");
355 		goto out_dev_put;
356 	}
357 	return 0;
358 
359 out_dev_put:
360 	platform_device_put(glue->core);
361 
362 out_free_glue:
363 	kfree(glue);
364 
365 out:
366 	return ret;
367 }
368 
369 static void wl1271_remove(struct sdio_func *func)
370 {
371 	struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
372 
373 	/* Undo decrement done above in wl1271_probe */
374 	pm_runtime_get_noresume(&func->dev);
375 
376 	platform_device_unregister(glue->core);
377 	kfree(glue);
378 }
379 
380 #ifdef CONFIG_PM
381 static int wl1271_suspend(struct device *dev)
382 {
383 	/* Tell MMC/SDIO core it's OK to power down the card
384 	 * (if it isn't already), but not to remove it completely */
385 	struct sdio_func *func = dev_to_sdio_func(dev);
386 	struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
387 	struct wl1271 *wl = platform_get_drvdata(glue->core);
388 	mmc_pm_flag_t sdio_flags;
389 	int ret = 0;
390 
391 	dev_dbg(dev, "wl1271 suspend. wow_enabled: %d\n",
392 		wl->wow_enabled);
393 
394 	/* check whether sdio should keep power */
395 	if (wl->wow_enabled) {
396 		sdio_flags = sdio_get_host_pm_caps(func);
397 
398 		if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
399 			dev_err(dev, "can't keep power while host "
400 				     "is suspended\n");
401 			ret = -EINVAL;
402 			goto out;
403 		}
404 
405 		/* keep power while host suspended */
406 		ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
407 		if (ret) {
408 			dev_err(dev, "error while trying to keep power\n");
409 			goto out;
410 		}
411 	}
412 out:
413 	return ret;
414 }
415 
416 static int wl1271_resume(struct device *dev)
417 {
418 	dev_dbg(dev, "wl1271 resume\n");
419 
420 	return 0;
421 }
422 
423 static const struct dev_pm_ops wl1271_sdio_pm_ops = {
424 	.suspend	= wl1271_suspend,
425 	.resume		= wl1271_resume,
426 };
427 #endif
428 
429 static struct sdio_driver wl1271_sdio_driver = {
430 	.name		= "wl1271_sdio",
431 	.id_table	= wl1271_devices,
432 	.probe		= wl1271_probe,
433 	.remove		= wl1271_remove,
434 #ifdef CONFIG_PM
435 	.drv = {
436 		.pm = &wl1271_sdio_pm_ops,
437 	},
438 #endif
439 };
440 
441 static int __init wl1271_init(void)
442 {
443 	return sdio_register_driver(&wl1271_sdio_driver);
444 }
445 
446 static void __exit wl1271_exit(void)
447 {
448 	sdio_unregister_driver(&wl1271_sdio_driver);
449 }
450 
451 module_init(wl1271_init);
452 module_exit(wl1271_exit);
453 
454 module_param(dump, bool, S_IRUSR | S_IWUSR);
455 MODULE_PARM_DESC(dump, "Enable sdio read/write dumps.");
456 
457 MODULE_LICENSE("GPL");
458 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
459 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
460