ea7b29034aab9fd308a46129f87ca65d9596b934
[pandora-kernel.git] / drivers / net / wimax / i2400m / sdio.c
1 /*
2  * Intel Wireless WiMAX Connection 2400m
3  * Linux driver model glue for the SDIO device, reset & fw upload
4  *
5  *
6  * Copyright (C) 2007-2008 Intel Corporation <linux-wimax@intel.com>
7  * Dirk Brandewie <dirk.j.brandewie@intel.com>
8  * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
9  * Yanir Lubetkin <yanirx.lubetkin@intel.com>
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License version
13  * 2 as published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23  * 02110-1301, USA.
24  *
25  *
26  * See i2400m-sdio.h for a general description of this driver.
27  *
28  * This file implements driver model glue, and hook ups for the
29  * generic driver to implement the bus-specific functions (device
30  * communication setup/tear down, firmware upload and resetting).
31  *
32  * ROADMAP
33  *
34  * i2400m_probe()
35  *   alloc_netdev()
36  *     i2400ms_netdev_setup()
37  *       i2400ms_init()
38  *       i2400m_netdev_setup()
39  *   i2400ms_enable_function()
40  *   i2400m_setup()
41  *
42  * i2400m_remove()
43  *     i2400m_release()
44  *     free_netdev(net_dev)
45  *
46  * i2400ms_bus_reset()            Called by i2400m->bus_reset
47  *   __i2400ms_reset()
48  *     __i2400ms_send_barker()
49  *
50  * i2400ms_bus_dev_start()        Called by i2400m_dev_start() [who is
51  *   i2400ms_tx_setup()           called by i2400m_setup()]
52  *   i2400ms_rx_setup()
53  *
54  * i2400ms_bus_dev_stop()         Called by i2400m_dev_stop() [who is
55  *   i2400ms_rx_release()         is called by i2400m_release()]
56  *   i2400ms_tx_release()
57  *
58  */
59
60 #include <linux/debugfs.h>
61 #include <linux/mmc/sdio_ids.h>
62 #include <linux/mmc/sdio.h>
63 #include <linux/mmc/sdio_func.h>
64 #include "i2400m-sdio.h"
65 #include <linux/wimax/i2400m.h>
66
67 #define D_SUBMODULE main
68 #include "sdio-debug-levels.h"
69
70 /* IOE WiMAX function timeout in seconds */
71 static int ioe_timeout = 2;
72 module_param(ioe_timeout, int, 0);
73
74 /* Our firmware file name list */
75 static const char *i2400ms_bus_fw_names[] = {
76 #define I2400MS_FW_FILE_NAME "i2400m-fw-sdio-1.3.sbcf"
77         I2400MS_FW_FILE_NAME,
78         NULL
79 };
80
81
82 static const struct i2400m_poke_table i2400ms_pokes[] = {
83         I2400M_FW_POKE(0x6BE260, 0x00000088),
84         I2400M_FW_POKE(0x080550, 0x00000005),
85         I2400M_FW_POKE(0xAE0000, 0x00000000),
86         I2400M_FW_POKE(0x000000, 0x00000000), /* MUST be 0 terminated or bad
87                                                * things will happen */
88 };
89
90 /*
91  * Enable the SDIO function
92  *
93  * Tries to enable the SDIO function; might fail if it is still not
94  * ready (in some hardware, the SDIO WiMAX function is only enabled
95  * when we ask it to explicitly doing). Tries until a timeout is
96  * reached.
97  *
98  * The reverse of this is...sdio_disable_function()
99  *
100  * Returns: 0 if the SDIO function was enabled, < 0 errno code on
101  *     error (-ENODEV when it was unable to enable the function).
102  */
103 static
104 int i2400ms_enable_function(struct sdio_func *func)
105 {
106         u64 timeout;
107         int err;
108         struct device *dev = &func->dev;
109
110         d_fnstart(3, dev, "(func %p)\n", func);
111         /* Setup timeout (FIXME: This needs to read the CIS table to
112          * get a real timeout) and then wait for the device to signal
113          * it is ready */
114         timeout = get_jiffies_64() + ioe_timeout * HZ;
115         err = -ENODEV;
116         while (err != 0 && time_before64(get_jiffies_64(), timeout)) {
117                 sdio_claim_host(func);
118                 err = sdio_enable_func(func);
119                 if (0 == err) {
120                         sdio_release_host(func);
121                         d_printf(2, dev, "SDIO function enabled\n");
122                         goto function_enabled;
123                 }
124                 d_printf(2, dev, "SDIO function failed to enable: %d\n", err);
125                 sdio_disable_func(func);
126                 sdio_release_host(func);
127                 msleep(I2400MS_INIT_SLEEP_INTERVAL);
128         }
129         /* If timed out, device is not there yet -- get -ENODEV so
130          * the device driver core will retry later on. */
131         if (err == -ETIME) {
132                 dev_err(dev, "Can't enable WiMAX function; "
133                         " has the function been enabled?\n");
134                 err = -ENODEV;
135         }
136 function_enabled:
137         d_fnend(3, dev, "(func %p) = %d\n", func, err);
138         return err;
139 }
140
141
142 /*
143  * Setup driver resources needed to communicate with the device
144  *
145  * The fw needs some time to settle, and it was just uploaded,
146  * so give it a break first. I'd prefer to just wait for the device to
147  * send something, but seems the poking we do to enable SDIO stuff
148  * interferes with it, so just give it a break before starting...
149  */
150 static
151 int i2400ms_bus_dev_start(struct i2400m *i2400m)
152 {
153         int result;
154         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
155         struct sdio_func *func = i2400ms->func;
156         struct device *dev = &func->dev;
157
158         d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
159         msleep(200);
160         result = i2400ms_tx_setup(i2400ms);
161         if (result < 0)
162                 goto error_tx_setup;
163         d_fnend(3, dev, "(i2400m %p) = %d\n", i2400m, result);
164         return result;
165
166 error_tx_setup:
167         i2400ms_tx_release(i2400ms);
168         d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
169         return result;
170 }
171
172
173 static
174 void i2400ms_bus_dev_stop(struct i2400m *i2400m)
175 {
176         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
177         struct sdio_func *func = i2400ms->func;
178         struct device *dev = &func->dev;
179
180         d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
181         i2400ms_tx_release(i2400ms);
182         d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
183 }
184
185
186 /*
187  * Sends a barker buffer to the device
188  *
189  * This helper will allocate a kmalloced buffer and use it to transmit
190  * (then free it). Reason for this is that the SDIO host controller
191  * expects alignment (unknown exactly which) which the stack won't
192  * really provide and certain arches/host-controller combinations
193  * cannot use stack/vmalloc/text areas for DMA transfers.
194  */
195 static
196 int __i2400ms_send_barker(struct i2400ms *i2400ms,
197                           const __le32 *barker, size_t barker_size)
198 {
199         int  ret;
200         struct sdio_func *func = i2400ms->func;
201         struct device *dev = &func->dev;
202         void *buffer;
203
204         ret = -ENOMEM;
205         buffer = kmalloc(I2400MS_BLK_SIZE, GFP_KERNEL);
206         if (buffer == NULL)
207                 goto error_kzalloc;
208
209         memcpy(buffer, barker, barker_size);
210         sdio_claim_host(func);
211         ret = sdio_memcpy_toio(func, 0, buffer, I2400MS_BLK_SIZE);
212         sdio_release_host(func);
213
214         if (ret < 0)
215                 d_printf(0, dev, "E: barker error: %d\n", ret);
216
217         kfree(buffer);
218 error_kzalloc:
219         return ret;
220 }
221
222
223 /*
224  * Reset a device at different levels (warm, cold or bus)
225  *
226  * @i2400ms: device descriptor
227  * @reset_type: soft, warm or bus reset (I2400M_RT_WARM/SOFT/BUS)
228  *
229  * FIXME: not tested -- need to confirm expected effects
230  *
231  * Warm and cold resets get an SDIO reset if they fail (unimplemented)
232  *
233  * Warm reset:
234  *
235  * The device will be fully reset internally, but won't be
236  * disconnected from the USB bus (so no reenumeration will
237  * happen). Firmware upload will be neccessary.
238  *
239  * The device will send a reboot barker in the notification endpoint
240  * that will trigger the driver to reinitialize the state
241  * automatically from notif.c:i2400m_notification_grok() into
242  * i2400m_dev_bootstrap_delayed().
243  *
244  * Cold and bus (USB) reset:
245  *
246  * The device will be fully reset internally, disconnected from the
247  * USB bus an a reenumeration will happen. Firmware upload will be
248  * neccessary. Thus, we don't do any locking or struct
249  * reinitialization, as we are going to be fully disconnected and
250  * reenumerated.
251  *
252  * Note we need to return -ENODEV if a warm reset was requested and we
253  * had to resort to a bus reset. See i2400m_op_reset(), wimax_reset()
254  * and wimax_dev->op_reset.
255  *
256  * WARNING: no driver state saved/fixed
257  */
258 static
259 int i2400ms_bus_reset(struct i2400m *i2400m, enum i2400m_reset_type rt)
260 {
261         int result = 0;
262         struct i2400ms *i2400ms =
263                 container_of(i2400m, struct i2400ms, i2400m);
264         struct device *dev = i2400m_dev(i2400m);
265         static const __le32 i2400m_WARM_BOOT_BARKER[4] = {
266                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
267                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
268                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
269                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
270         };
271         static const __le32 i2400m_COLD_BOOT_BARKER[4] = {
272                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
273                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
274                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
275                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
276         };
277
278         if (rt == I2400M_RT_WARM)
279                 result = __i2400ms_send_barker(i2400ms, i2400m_WARM_BOOT_BARKER,
280                                                sizeof(i2400m_WARM_BOOT_BARKER));
281         else if (rt == I2400M_RT_COLD)
282                 result = __i2400ms_send_barker(i2400ms, i2400m_COLD_BOOT_BARKER,
283                                                sizeof(i2400m_COLD_BOOT_BARKER));
284         else if (rt == I2400M_RT_BUS) {
285 do_bus_reset:
286                 /* call netif_tx_disable() before sending IOE disable,
287                  * so that all the tx from network layer are stopped
288                  * while IOE is being reset. Make sure it is called
289                  * only after register_netdev() was issued.
290                  */
291                 if (i2400m->wimax_dev.net_dev->reg_state == NETREG_REGISTERED)
292                         netif_tx_disable(i2400m->wimax_dev.net_dev);
293
294                 i2400ms_rx_release(i2400ms);
295                 sdio_claim_host(i2400ms->func);
296                 sdio_disable_func(i2400ms->func);
297                 sdio_release_host(i2400ms->func);
298
299                 /* Wait for the device to settle */
300                 msleep(40);
301
302                 result = i2400ms_enable_function(i2400ms->func);
303                 if (result >= 0)
304                         i2400ms_rx_setup(i2400ms);
305         } else
306                 BUG();
307         if (result < 0 && rt != I2400M_RT_BUS) {
308                 dev_err(dev, "%s reset failed (%d); trying SDIO reset\n",
309                         rt == I2400M_RT_WARM ? "warm" : "cold", result);
310                 rt = I2400M_RT_BUS;
311                 goto do_bus_reset;
312         }
313         return result;
314 }
315
316
317 static
318 void i2400ms_netdev_setup(struct net_device *net_dev)
319 {
320         struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
321         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
322         i2400ms_init(i2400ms);
323         i2400m_netdev_setup(net_dev);
324 }
325
326
327 /*
328  * Debug levels control; see debug.h
329  */
330 struct d_level D_LEVEL[] = {
331         D_SUBMODULE_DEFINE(main),
332         D_SUBMODULE_DEFINE(tx),
333         D_SUBMODULE_DEFINE(rx),
334         D_SUBMODULE_DEFINE(fw),
335 };
336 size_t D_LEVEL_SIZE = ARRAY_SIZE(D_LEVEL);
337
338
339 #define __debugfs_register(prefix, name, parent)                        \
340 do {                                                                    \
341         result = d_level_register_debugfs(prefix, name, parent);        \
342         if (result < 0)                                                 \
343                 goto error;                                             \
344 } while (0)
345
346
347 static
348 int i2400ms_debugfs_add(struct i2400ms *i2400ms)
349 {
350         int result;
351         struct dentry *dentry = i2400ms->i2400m.wimax_dev.debugfs_dentry;
352
353         dentry = debugfs_create_dir("i2400m-usb", dentry);
354         result = PTR_ERR(dentry);
355         if (IS_ERR(dentry)) {
356                 if (result == -ENODEV)
357                         result = 0;     /* No debugfs support */
358                 goto error;
359         }
360         i2400ms->debugfs_dentry = dentry;
361         __debugfs_register("dl_", main, dentry);
362         __debugfs_register("dl_", tx, dentry);
363         __debugfs_register("dl_", rx, dentry);
364         __debugfs_register("dl_", fw, dentry);
365
366         return 0;
367
368 error:
369         debugfs_remove_recursive(i2400ms->debugfs_dentry);
370         return result;
371 }
372
373
374 /*
375  * Probe a i2400m interface and register it
376  *
377  * @func:    SDIO function
378  * @id:      SDIO device ID
379  * @returns: 0 if ok, < 0 errno code on error.
380  *
381  * Alloc a net device, initialize the bus-specific details and then
382  * calls the bus-generic initialization routine. That will register
383  * the wimax and netdev devices, upload the firmware [using
384  * _bus_bm_*()], call _bus_dev_start() to finalize the setup of the
385  * communication with the device and then will start to talk to it to
386  * finnish setting it up.
387  *
388  * Initialization is tricky; some instances of the hw are packed with
389  * others in a way that requires a third driver that enables the WiMAX
390  * function. In those cases, we can't enable the SDIO function and
391  * we'll return with -ENODEV. When the driver that enables the WiMAX
392  * function does its thing, it has to do a bus_rescan_devices() on the
393  * SDIO bus so this driver is called again to enumerate the WiMAX
394  * function.
395  */
396 static
397 int i2400ms_probe(struct sdio_func *func,
398                   const struct sdio_device_id *id)
399 {
400         int result;
401         struct net_device *net_dev;
402         struct device *dev = &func->dev;
403         struct i2400m *i2400m;
404         struct i2400ms *i2400ms;
405
406         /* Allocate instance [calls i2400m_netdev_setup() on it]. */
407         result = -ENOMEM;
408         net_dev = alloc_netdev(sizeof(*i2400ms), "wmx%d",
409                                i2400ms_netdev_setup);
410         if (net_dev == NULL) {
411                 dev_err(dev, "no memory for network device instance\n");
412                 goto error_alloc_netdev;
413         }
414         SET_NETDEV_DEV(net_dev, dev);
415         i2400m = net_dev_to_i2400m(net_dev);
416         i2400ms = container_of(i2400m, struct i2400ms, i2400m);
417         i2400m->wimax_dev.net_dev = net_dev;
418         i2400ms->func = func;
419         sdio_set_drvdata(func, i2400ms);
420
421         i2400m->bus_tx_block_size = I2400MS_BLK_SIZE;
422         i2400m->bus_pl_size_max = I2400MS_PL_SIZE_MAX;
423         i2400m->bus_dev_start = i2400ms_bus_dev_start;
424         i2400m->bus_dev_stop = i2400ms_bus_dev_stop;
425         i2400m->bus_tx_kick = i2400ms_bus_tx_kick;
426         i2400m->bus_reset = i2400ms_bus_reset;
427         /* The iwmc3200-wimax sometimes requires the driver to try
428          * hard when we paint it into a corner. */
429         i2400m->bus_bm_retries = I3200_BOOT_RETRIES;
430         i2400m->bus_bm_cmd_send = i2400ms_bus_bm_cmd_send;
431         i2400m->bus_bm_wait_for_ack = i2400ms_bus_bm_wait_for_ack;
432         i2400m->bus_fw_names = i2400ms_bus_fw_names;
433         i2400m->bus_bm_mac_addr_impaired = 1;
434         i2400m->bus_bm_pokes_table = &i2400ms_pokes[0];
435
436         sdio_claim_host(func);
437         result = sdio_set_block_size(func, I2400MS_BLK_SIZE);
438         sdio_release_host(func);
439         if (result < 0) {
440                 dev_err(dev, "Failed to set block size: %d\n", result);
441                 goto error_set_blk_size;
442         }
443
444         result = i2400ms_enable_function(i2400ms->func);
445         if (result < 0) {
446                 dev_err(dev, "Cannot enable SDIO function: %d\n", result);
447                 goto error_func_enable;
448         }
449
450         result = i2400ms_rx_setup(i2400ms);
451         if (result < 0)
452                 goto error_rx_setup;
453
454         result = i2400m_setup(i2400m, I2400M_BRI_NO_REBOOT);
455         if (result < 0) {
456                 dev_err(dev, "cannot setup device: %d\n", result);
457                 goto error_setup;
458         }
459
460         result = i2400ms_debugfs_add(i2400ms);
461         if (result < 0) {
462                 dev_err(dev, "cannot create SDIO debugfs: %d\n",
463                         result);
464                 goto error_debugfs_add;
465         }
466         return 0;
467
468 error_debugfs_add:
469         i2400m_release(i2400m);
470 error_setup:
471         i2400ms_rx_release(i2400ms);
472 error_rx_setup:
473         sdio_claim_host(func);
474         sdio_disable_func(func);
475         sdio_release_host(func);
476 error_func_enable:
477 error_set_blk_size:
478         sdio_set_drvdata(func, NULL);
479         free_netdev(net_dev);
480 error_alloc_netdev:
481         return result;
482 }
483
484
485 static
486 void i2400ms_remove(struct sdio_func *func)
487 {
488         struct device *dev = &func->dev;
489         struct i2400ms *i2400ms = sdio_get_drvdata(func);
490         struct i2400m *i2400m = &i2400ms->i2400m;
491         struct net_device *net_dev = i2400m->wimax_dev.net_dev;
492
493         d_fnstart(3, dev, "SDIO func %p\n", func);
494         debugfs_remove_recursive(i2400ms->debugfs_dentry);
495         i2400ms_rx_release(i2400ms);
496         i2400m_release(i2400m);
497         sdio_set_drvdata(func, NULL);
498         sdio_claim_host(func);
499         sdio_disable_func(func);
500         sdio_release_host(func);
501         free_netdev(net_dev);
502         d_fnend(3, dev, "SDIO func %p\n", func);
503 }
504
505 static
506 const struct sdio_device_id i2400ms_sdio_ids[] = {
507         /* Intel: i2400m WiMAX (iwmc3200) over SDIO */
508         { SDIO_DEVICE(SDIO_VENDOR_ID_INTEL,
509                       SDIO_DEVICE_ID_INTEL_IWMC3200WIMAX) },
510         { /* end: all zeroes */ },
511 };
512 MODULE_DEVICE_TABLE(sdio, i2400ms_sdio_ids);
513
514
515 static
516 struct sdio_driver i2400m_sdio_driver = {
517         .name           = KBUILD_MODNAME,
518         .probe          = i2400ms_probe,
519         .remove         = i2400ms_remove,
520         .id_table       = i2400ms_sdio_ids,
521 };
522
523
524 static
525 int __init i2400ms_driver_init(void)
526 {
527         return sdio_register_driver(&i2400m_sdio_driver);
528 }
529 module_init(i2400ms_driver_init);
530
531
532 static
533 void __exit i2400ms_driver_exit(void)
534 {
535         flush_scheduled_work(); /* for the stuff we schedule */
536         sdio_unregister_driver(&i2400m_sdio_driver);
537 }
538 module_exit(i2400ms_driver_exit);
539
540
541 MODULE_AUTHOR("Intel Corporation <linux-wimax@intel.com>");
542 MODULE_DESCRIPTION("Intel 2400M WiMAX networking for SDIO");
543 MODULE_LICENSE("GPL");
544 MODULE_FIRMWARE(I2400MS_FW_FILE_NAME);