xref: /openbmc/linux/drivers/net/wireless/ti/wlcore/sdio.c (revision c4c8f39a57bf5057fc51a848d42b7e348ecfa31d)
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 < 0) {
159 		pm_runtime_put_noidle(&card->dev);
160 		dev_err(glue->dev, "%s: failed to get_sync(%d)\n",
161 			__func__, ret);
162 		goto out;
163 	}
164 
165 	sdio_claim_host(func);
166 	sdio_enable_func(func);
167 	sdio_release_host(func);
168 
169 out:
170 	return ret;
171 }
172 
173 static int wl12xx_sdio_power_off(struct wl12xx_sdio_glue *glue)
174 {
175 	struct sdio_func *func = dev_to_sdio_func(glue->dev);
176 	struct mmc_card *card = func->card;
177 
178 	sdio_claim_host(func);
179 	sdio_disable_func(func);
180 	sdio_release_host(func);
181 
182 	/* Let runtime PM know the card is powered off */
183 	return pm_runtime_put_sync(&card->dev);
184 }
185 
186 static int wl12xx_sdio_set_power(struct device *child, bool enable)
187 {
188 	struct wl12xx_sdio_glue *glue = dev_get_drvdata(child->parent);
189 
190 	if (enable)
191 		return wl12xx_sdio_power_on(glue);
192 	else
193 		return wl12xx_sdio_power_off(glue);
194 }
195 
196 static struct wl1271_if_operations sdio_ops = {
197 	.read		= wl12xx_sdio_raw_read,
198 	.write		= wl12xx_sdio_raw_write,
199 	.power		= wl12xx_sdio_set_power,
200 	.set_block_size = wl1271_sdio_set_block_size,
201 };
202 
203 #ifdef CONFIG_OF
204 
205 static const struct wilink_family_data wl127x_data = {
206 	.name = "wl127x",
207 	.nvs_name = "ti-connectivity/wl127x-nvs.bin",
208 };
209 
210 static const struct wilink_family_data wl128x_data = {
211 	.name = "wl128x",
212 	.nvs_name = "ti-connectivity/wl128x-nvs.bin",
213 };
214 
215 static const struct wilink_family_data wl18xx_data = {
216 	.name = "wl18xx",
217 	.cfg_name = "ti-connectivity/wl18xx-conf.bin",
218 	.nvs_name = "ti-connectivity/wl1271-nvs.bin",
219 };
220 
221 static const struct of_device_id wlcore_sdio_of_match_table[] = {
222 	{ .compatible = "ti,wl1271", .data = &wl127x_data },
223 	{ .compatible = "ti,wl1273", .data = &wl127x_data },
224 	{ .compatible = "ti,wl1281", .data = &wl128x_data },
225 	{ .compatible = "ti,wl1283", .data = &wl128x_data },
226 	{ .compatible = "ti,wl1285", .data = &wl128x_data },
227 	{ .compatible = "ti,wl1801", .data = &wl18xx_data },
228 	{ .compatible = "ti,wl1805", .data = &wl18xx_data },
229 	{ .compatible = "ti,wl1807", .data = &wl18xx_data },
230 	{ .compatible = "ti,wl1831", .data = &wl18xx_data },
231 	{ .compatible = "ti,wl1835", .data = &wl18xx_data },
232 	{ .compatible = "ti,wl1837", .data = &wl18xx_data },
233 	{ }
234 };
235 
236 static int wlcore_probe_of(struct device *dev, int *irq,
237 			   struct wlcore_platdev_data *pdev_data)
238 {
239 	struct device_node *np = dev->of_node;
240 	const struct of_device_id *of_id;
241 
242 	of_id = of_match_node(wlcore_sdio_of_match_table, np);
243 	if (!of_id)
244 		return -ENODEV;
245 
246 	pdev_data->family = of_id->data;
247 
248 	*irq = irq_of_parse_and_map(np, 0);
249 	if (!*irq) {
250 		dev_err(dev, "No irq in platform data\n");
251 		return -EINVAL;
252 	}
253 
254 	/* optional clock frequency params */
255 	of_property_read_u32(np, "ref-clock-frequency",
256 			     &pdev_data->ref_clock_freq);
257 	of_property_read_u32(np, "tcxo-clock-frequency",
258 			     &pdev_data->tcxo_clock_freq);
259 
260 	return 0;
261 }
262 #else
263 static int wlcore_probe_of(struct device *dev, int *irq,
264 			   struct wlcore_platdev_data *pdev_data)
265 {
266 	return -ENODATA;
267 }
268 #endif
269 
270 static int wl1271_probe(struct sdio_func *func,
271 				  const struct sdio_device_id *id)
272 {
273 	struct wlcore_platdev_data *pdev_data;
274 	struct wl12xx_sdio_glue *glue;
275 	struct resource res[1];
276 	mmc_pm_flag_t mmcflags;
277 	int ret = -ENOMEM;
278 	int irq;
279 	const char *chip_family;
280 
281 	/* We are only able to handle the wlan function */
282 	if (func->num != 0x02)
283 		return -ENODEV;
284 
285 	pdev_data = devm_kzalloc(&func->dev, sizeof(*pdev_data), GFP_KERNEL);
286 	if (!pdev_data)
287 		return -ENOMEM;
288 
289 	pdev_data->if_ops = &sdio_ops;
290 
291 	glue = devm_kzalloc(&func->dev, sizeof(*glue), GFP_KERNEL);
292 	if (!glue)
293 		return -ENOMEM;
294 
295 	glue->dev = &func->dev;
296 
297 	/* Grab access to FN0 for ELP reg. */
298 	func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
299 
300 	/* Use block mode for transferring over one block size of data */
301 	func->card->quirks |= MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
302 
303 	ret = wlcore_probe_of(&func->dev, &irq, pdev_data);
304 	if (ret)
305 		goto out;
306 
307 	/* if sdio can keep power while host is suspended, enable wow */
308 	mmcflags = sdio_get_host_pm_caps(func);
309 	dev_dbg(glue->dev, "sdio PM caps = 0x%x\n", mmcflags);
310 
311 	if (mmcflags & MMC_PM_KEEP_POWER)
312 		pdev_data->pwr_in_suspend = true;
313 
314 	sdio_set_drvdata(func, glue);
315 
316 	/* Tell PM core that we don't need the card to be powered now */
317 	pm_runtime_put_noidle(&func->dev);
318 
319 	/*
320 	 * Due to a hardware bug, we can't differentiate wl18xx from
321 	 * wl12xx, because both report the same device ID.  The only
322 	 * way to differentiate is by checking the SDIO revision,
323 	 * which is 3.00 on the wl18xx chips.
324 	 */
325 	if (func->card->cccr.sdio_vsn == SDIO_SDIO_REV_3_00)
326 		chip_family = "wl18xx";
327 	else
328 		chip_family = "wl12xx";
329 
330 	glue->core = platform_device_alloc(chip_family, PLATFORM_DEVID_AUTO);
331 	if (!glue->core) {
332 		dev_err(glue->dev, "can't allocate platform_device");
333 		ret = -ENOMEM;
334 		goto out;
335 	}
336 
337 	glue->core->dev.parent = &func->dev;
338 
339 	memset(res, 0x00, sizeof(res));
340 
341 	res[0].start = irq;
342 	res[0].flags = IORESOURCE_IRQ |
343 		       irqd_get_trigger_type(irq_get_irq_data(irq));
344 	res[0].name = "irq";
345 
346 	ret = platform_device_add_resources(glue->core, res, ARRAY_SIZE(res));
347 	if (ret) {
348 		dev_err(glue->dev, "can't add resources\n");
349 		goto out_dev_put;
350 	}
351 
352 	ret = platform_device_add_data(glue->core, pdev_data,
353 				       sizeof(*pdev_data));
354 	if (ret) {
355 		dev_err(glue->dev, "can't add platform data\n");
356 		goto out_dev_put;
357 	}
358 
359 	ret = platform_device_add(glue->core);
360 	if (ret) {
361 		dev_err(glue->dev, "can't add platform device\n");
362 		goto out_dev_put;
363 	}
364 	return 0;
365 
366 out_dev_put:
367 	platform_device_put(glue->core);
368 
369 out:
370 	return ret;
371 }
372 
373 static void wl1271_remove(struct sdio_func *func)
374 {
375 	struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
376 
377 	/* Undo decrement done above in wl1271_probe */
378 	pm_runtime_get_noresume(&func->dev);
379 
380 	platform_device_unregister(glue->core);
381 }
382 
383 #ifdef CONFIG_PM
384 static int wl1271_suspend(struct device *dev)
385 {
386 	/* Tell MMC/SDIO core it's OK to power down the card
387 	 * (if it isn't already), but not to remove it completely */
388 	struct sdio_func *func = dev_to_sdio_func(dev);
389 	struct wl12xx_sdio_glue *glue = sdio_get_drvdata(func);
390 	struct wl1271 *wl = platform_get_drvdata(glue->core);
391 	mmc_pm_flag_t sdio_flags;
392 	int ret = 0;
393 
394 	dev_dbg(dev, "wl1271 suspend. wow_enabled: %d\n",
395 		wl->wow_enabled);
396 
397 	/* check whether sdio should keep power */
398 	if (wl->wow_enabled) {
399 		sdio_flags = sdio_get_host_pm_caps(func);
400 
401 		if (!(sdio_flags & MMC_PM_KEEP_POWER)) {
402 			dev_err(dev, "can't keep power while host "
403 				     "is suspended\n");
404 			ret = -EINVAL;
405 			goto out;
406 		}
407 
408 		/* keep power while host suspended */
409 		ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
410 		if (ret) {
411 			dev_err(dev, "error while trying to keep power\n");
412 			goto out;
413 		}
414 	}
415 out:
416 	return ret;
417 }
418 
419 static int wl1271_resume(struct device *dev)
420 {
421 	dev_dbg(dev, "wl1271 resume\n");
422 
423 	return 0;
424 }
425 
426 static const struct dev_pm_ops wl1271_sdio_pm_ops = {
427 	.suspend	= wl1271_suspend,
428 	.resume		= wl1271_resume,
429 };
430 #endif
431 
432 static struct sdio_driver wl1271_sdio_driver = {
433 	.name		= "wl1271_sdio",
434 	.id_table	= wl1271_devices,
435 	.probe		= wl1271_probe,
436 	.remove		= wl1271_remove,
437 #ifdef CONFIG_PM
438 	.drv = {
439 		.pm = &wl1271_sdio_pm_ops,
440 	},
441 #endif
442 };
443 
444 static int __init wl1271_init(void)
445 {
446 	return sdio_register_driver(&wl1271_sdio_driver);
447 }
448 
449 static void __exit wl1271_exit(void)
450 {
451 	sdio_unregister_driver(&wl1271_sdio_driver);
452 }
453 
454 module_init(wl1271_init);
455 module_exit(wl1271_exit);
456 
457 module_param(dump, bool, 0600);
458 MODULE_PARM_DESC(dump, "Enable sdio read/write dumps.");
459 
460 MODULE_LICENSE("GPL");
461 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
462 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
463