xref: /openbmc/linux/drivers/net/wireless/ti/wlcore/sdio.c (revision 020c5260)
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(addr == HW_ACCESS_ELP_CTRL_REG)) {
85 		((u8 *)buf)[0] = sdio_f0_readb(func, addr, &ret);
86 		dev_dbg(child->parent, "sdio read 52 addr 0x%x, byte 0x%02x\n",
87 			addr, ((u8 *)buf)[0]);
88 	} else {
89 		if (fixed)
90 			ret = sdio_readsb(func, buf, addr, len);
91 		else
92 			ret = sdio_memcpy_fromio(func, buf, addr, len);
93 
94 		dev_dbg(child->parent, "sdio read 53 addr 0x%x, %zu bytes\n",
95 			addr, len);
96 	}
97 
98 	sdio_release_host(func);
99 
100 	if (WARN_ON(ret))
101 		dev_err(child->parent, "sdio read failed (%d)\n", ret);
102 
103 	if (unlikely(dump)) {
104 		printk(KERN_DEBUG "wlcore_sdio: READ from 0x%04x\n", addr);
105 		print_hex_dump(KERN_DEBUG, "wlcore_sdio: READ ",
106 			       DUMP_PREFIX_OFFSET, 16, 1,
107 			       buf, len, false);
108 	}
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 
220 static const struct wilink_family_data wl127x_data = {
221 	.name = "wl127x",
222 	.nvs_name = "ti-connectivity/wl127x-nvs.bin",
223 };
224 
225 static const struct wilink_family_data wl128x_data = {
226 	.name = "wl128x",
227 	.nvs_name = "ti-connectivity/wl128x-nvs.bin",
228 };
229 
230 static const struct wilink_family_data wl18xx_data = {
231 	.name = "wl18xx",
232 	.cfg_name = "ti-connectivity/wl18xx-conf.bin",
233 };
234 
235 static const struct of_device_id wlcore_sdio_of_match_table[] = {
236 	{ .compatible = "ti,wl1271", .data = &wl127x_data },
237 	{ .compatible = "ti,wl1273", .data = &wl127x_data },
238 	{ .compatible = "ti,wl1281", .data = &wl128x_data },
239 	{ .compatible = "ti,wl1283", .data = &wl128x_data },
240 	{ .compatible = "ti,wl1801", .data = &wl18xx_data },
241 	{ .compatible = "ti,wl1805", .data = &wl18xx_data },
242 	{ .compatible = "ti,wl1807", .data = &wl18xx_data },
243 	{ .compatible = "ti,wl1831", .data = &wl18xx_data },
244 	{ .compatible = "ti,wl1835", .data = &wl18xx_data },
245 	{ .compatible = "ti,wl1837", .data = &wl18xx_data },
246 	{ }
247 };
248 
249 static int wlcore_probe_of(struct device *dev, int *irq,
250 			   struct wlcore_platdev_data *pdev_data)
251 {
252 	struct device_node *np = dev->of_node;
253 	const struct of_device_id *of_id;
254 
255 	of_id = of_match_node(wlcore_sdio_of_match_table, np);
256 	if (!of_id)
257 		return -ENODEV;
258 
259 	pdev_data->family = of_id->data;
260 
261 	*irq = irq_of_parse_and_map(np, 0);
262 	if (!*irq) {
263 		dev_err(dev, "No irq in platform data\n");
264 		return -EINVAL;
265 	}
266 
267 	/* optional clock frequency params */
268 	of_property_read_u32(np, "ref-clock-frequency",
269 			     &pdev_data->ref_clock_freq);
270 	of_property_read_u32(np, "tcxo-clock-frequency",
271 			     &pdev_data->tcxo_clock_freq);
272 
273 	return 0;
274 }
275 #else
276 static int wlcore_probe_of(struct device *dev, int *irq,
277 			   struct wlcore_platdev_data *pdev_data)
278 {
279 	return -ENODATA;
280 }
281 #endif
282 
283 static int wl1271_probe(struct sdio_func *func,
284 				  const struct sdio_device_id *id)
285 {
286 	struct wlcore_platdev_data *pdev_data;
287 	struct wl12xx_sdio_glue *glue;
288 	struct resource res[1];
289 	mmc_pm_flag_t mmcflags;
290 	int ret = -ENOMEM;
291 	int irq;
292 	const char *chip_family;
293 
294 	/* We are only able to handle the wlan function */
295 	if (func->num != 0x02)
296 		return -ENODEV;
297 
298 	pdev_data = devm_kzalloc(&func->dev, sizeof(*pdev_data), GFP_KERNEL);
299 	if (!pdev_data)
300 		return -ENOMEM;
301 
302 	pdev_data->if_ops = &sdio_ops;
303 
304 	glue = devm_kzalloc(&func->dev, sizeof(*glue), GFP_KERNEL);
305 	if (!glue)
306 		return -ENOMEM;
307 
308 	glue->dev = &func->dev;
309 
310 	/* Grab access to FN0 for ELP reg. */
311 	func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
312 
313 	/* Use block mode for transferring over one block size of data */
314 	func->card->quirks |= MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
315 
316 	ret = wlcore_probe_of(&func->dev, &irq, pdev_data);
317 	if (ret)
318 		goto out;
319 
320 	/* if sdio can keep power while host is suspended, enable wow */
321 	mmcflags = sdio_get_host_pm_caps(func);
322 	dev_dbg(glue->dev, "sdio PM caps = 0x%x\n", mmcflags);
323 
324 	if (mmcflags & MMC_PM_KEEP_POWER)
325 		pdev_data->pwr_in_suspend = true;
326 
327 	sdio_set_drvdata(func, glue);
328 
329 	/* Tell PM core that we don't need the card to be powered now */
330 	pm_runtime_put_noidle(&func->dev);
331 
332 	/*
333 	 * Due to a hardware bug, we can't differentiate wl18xx from
334 	 * wl12xx, because both report the same device ID.  The only
335 	 * way to differentiate is by checking the SDIO revision,
336 	 * which is 3.00 on the wl18xx chips.
337 	 */
338 	if (func->card->cccr.sdio_vsn == SDIO_SDIO_REV_3_00)
339 		chip_family = "wl18xx";
340 	else
341 		chip_family = "wl12xx";
342 
343 	glue->core = platform_device_alloc(chip_family, PLATFORM_DEVID_AUTO);
344 	if (!glue->core) {
345 		dev_err(glue->dev, "can't allocate platform_device");
346 		ret = -ENOMEM;
347 		goto out;
348 	}
349 
350 	glue->core->dev.parent = &func->dev;
351 
352 	memset(res, 0x00, sizeof(res));
353 
354 	res[0].start = irq;
355 	res[0].flags = IORESOURCE_IRQ |
356 		       irqd_get_trigger_type(irq_get_irq_data(irq));
357 	res[0].name = "irq";
358 
359 	ret = platform_device_add_resources(glue->core, res, ARRAY_SIZE(res));
360 	if (ret) {
361 		dev_err(glue->dev, "can't add resources\n");
362 		goto out_dev_put;
363 	}
364 
365 	ret = platform_device_add_data(glue->core, pdev_data,
366 				       sizeof(*pdev_data));
367 	if (ret) {
368 		dev_err(glue->dev, "can't add platform data\n");
369 		goto out_dev_put;
370 	}
371 
372 	ret = platform_device_add(glue->core);
373 	if (ret) {
374 		dev_err(glue->dev, "can't add platform device\n");
375 		goto out_dev_put;
376 	}
377 	return 0;
378 
379 out_dev_put:
380 	platform_device_put(glue->core);
381 
382 out:
383 	return ret;
384 }
385 
386 static void wl1271_remove(struct sdio_func *func)
387 {
388 	struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
389 
390 	/* Undo decrement done above in wl1271_probe */
391 	pm_runtime_get_noresume(&func->dev);
392 
393 	platform_device_unregister(glue->core);
394 }
395 
396 #ifdef CONFIG_PM
397 static int wl1271_suspend(struct device *dev)
398 {
399 	/* Tell MMC/SDIO core it's OK to power down the card
400 	 * (if it isn't already), but not to remove it completely */
401 	struct sdio_func *func = dev_to_sdio_func(dev);
402 	struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
403 	struct wl1271 *wl = platform_get_drvdata(glue->core);
404 	mmc_pm_flag_t sdio_flags;
405 	int ret = 0;
406 
407 	dev_dbg(dev, "wl1271 suspend. wow_enabled: %d\n",
408 		wl->wow_enabled);
409 
410 	/* check whether sdio should keep power */
411 	if (wl->wow_enabled) {
412 		sdio_flags = sdio_get_host_pm_caps(func);
413 
414 		if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
415 			dev_err(dev, "can't keep power while host "
416 				     "is suspended\n");
417 			ret = -EINVAL;
418 			goto out;
419 		}
420 
421 		/* keep power while host suspended */
422 		ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
423 		if (ret) {
424 			dev_err(dev, "error while trying to keep power\n");
425 			goto out;
426 		}
427 	}
428 out:
429 	return ret;
430 }
431 
432 static int wl1271_resume(struct device *dev)
433 {
434 	dev_dbg(dev, "wl1271 resume\n");
435 
436 	return 0;
437 }
438 
439 static const struct dev_pm_ops wl1271_sdio_pm_ops = {
440 	.suspend	= wl1271_suspend,
441 	.resume		= wl1271_resume,
442 };
443 #endif
444 
445 static struct sdio_driver wl1271_sdio_driver = {
446 	.name		= "wl1271_sdio",
447 	.id_table	= wl1271_devices,
448 	.probe		= wl1271_probe,
449 	.remove		= wl1271_remove,
450 #ifdef CONFIG_PM
451 	.drv = {
452 		.pm = &wl1271_sdio_pm_ops,
453 	},
454 #endif
455 };
456 
457 static int __init wl1271_init(void)
458 {
459 	return sdio_register_driver(&wl1271_sdio_driver);
460 }
461 
462 static void __exit wl1271_exit(void)
463 {
464 	sdio_unregister_driver(&wl1271_sdio_driver);
465 }
466 
467 module_init(wl1271_init);
468 module_exit(wl1271_exit);
469 
470 module_param(dump, bool, S_IRUSR | S_IWUSR);
471 MODULE_PARM_DESC(dump, "Enable sdio read/write dumps.");
472 
473 MODULE_LICENSE("GPL");
474 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
475 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
476