Merge branch 'reiserfs-updates' from Jeff Mahoney
[linux-2.6] / 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.h>
62 #include <linux/mmc/sdio_func.h>
63 #include "i2400m-sdio.h"
64 #include <linux/wimax/i2400m.h>
65
66 #define D_SUBMODULE main
67 #include "sdio-debug-levels.h"
68
69 /* IOE WiMAX function timeout in seconds */
70 static int ioe_timeout = 2;
71 module_param(ioe_timeout, int, 0);
72
73 /* Our firmware file name list */
74 static const char *i2400ms_bus_fw_names[] = {
75 #define I2400MS_FW_FILE_NAME "i2400m-fw-sdio-1.3.sbcf"
76         I2400MS_FW_FILE_NAME,
77         NULL
78 };
79
80
81 /*
82  * Enable the SDIO function
83  *
84  * Tries to enable the SDIO function; might fail if it is still not
85  * ready (in some hardware, the SDIO WiMAX function is only enabled
86  * when we ask it to explicitly doing). Tries until a timeout is
87  * reached.
88  *
89  * The reverse of this is...sdio_disable_function()
90  *
91  * Returns: 0 if the SDIO function was enabled, < 0 errno code on
92  *     error (-ENODEV when it was unable to enable the function).
93  */
94 static
95 int i2400ms_enable_function(struct sdio_func *func)
96 {
97         u64 timeout;
98         int err;
99         struct device *dev = &func->dev;
100
101         d_fnstart(3, dev, "(func %p)\n", func);
102         /* Setup timeout (FIXME: This needs to read the CIS table to
103          * get a real timeout) and then wait for the device to signal
104          * it is ready */
105         timeout = get_jiffies_64() + ioe_timeout * HZ;
106         err = -ENODEV;
107         while (err != 0 && time_before64(get_jiffies_64(), timeout)) {
108                 sdio_claim_host(func);
109                 err = sdio_enable_func(func);
110                 if (0 == err) {
111                         sdio_release_host(func);
112                         d_printf(2, dev, "SDIO function enabled\n");
113                         goto function_enabled;
114                 }
115                 d_printf(2, dev, "SDIO function failed to enable: %d\n", err);
116                 sdio_disable_func(func);
117                 sdio_release_host(func);
118                 msleep(I2400MS_INIT_SLEEP_INTERVAL);
119         }
120         /* If timed out, device is not there yet -- get -ENODEV so
121          * the device driver core will retry later on. */
122         if (err == -ETIME) {
123                 dev_err(dev, "Can't enable WiMAX function; "
124                         " has the function been enabled?\n");
125                 err = -ENODEV;
126         }
127 function_enabled:
128         d_fnend(3, dev, "(func %p) = %d\n", func, err);
129         return err;
130 }
131
132
133 /*
134  * Setup driver resources needed to communicate with the device
135  *
136  * The fw needs some time to settle, and it was just uploaded,
137  * so give it a break first. I'd prefer to just wait for the device to
138  * send something, but seems the poking we do to enable SDIO stuff
139  * interferes with it, so just give it a break before starting...
140  */
141 static
142 int i2400ms_bus_dev_start(struct i2400m *i2400m)
143 {
144         int result;
145         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
146         struct sdio_func *func = i2400ms->func;
147         struct device *dev = &func->dev;
148
149         d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
150         msleep(200);
151         result = i2400ms_rx_setup(i2400ms);
152         if (result < 0)
153                 goto error_rx_setup;
154         result = i2400ms_tx_setup(i2400ms);
155         if (result < 0)
156                 goto error_tx_setup;
157         d_fnend(3, dev, "(i2400m %p) = %d\n", i2400m, result);
158         return result;
159
160         i2400ms_tx_release(i2400ms);
161 error_tx_setup:
162         i2400ms_rx_release(i2400ms);
163 error_rx_setup:
164         d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
165         return result;
166 }
167
168
169 static
170 void i2400ms_bus_dev_stop(struct i2400m *i2400m)
171 {
172         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
173         struct sdio_func *func = i2400ms->func;
174         struct device *dev = &func->dev;
175
176         d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
177         i2400ms_rx_release(i2400ms);
178         i2400ms_tx_release(i2400ms);
179         d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
180 }
181
182
183 /*
184  * Sends a barker buffer to the device
185  *
186  * This helper will allocate a kmalloced buffer and use it to transmit
187  * (then free it). Reason for this is that the SDIO host controller
188  * expects alignment (unknown exactly which) which the stack won't
189  * really provide and certain arches/host-controller combinations
190  * cannot use stack/vmalloc/text areas for DMA transfers.
191  */
192 static
193 int __i2400ms_send_barker(struct i2400ms *i2400ms,
194                           const __le32 *barker, size_t barker_size)
195 {
196         int  ret;
197         struct sdio_func *func = i2400ms->func;
198         struct device *dev = &func->dev;
199         void *buffer;
200
201         ret = -ENOMEM;
202         buffer = kmalloc(I2400MS_BLK_SIZE, GFP_KERNEL);
203         if (buffer == NULL)
204                 goto error_kzalloc;
205
206         memcpy(buffer, barker, barker_size);
207         sdio_claim_host(func);
208         ret = sdio_memcpy_toio(func, 0, buffer, I2400MS_BLK_SIZE);
209         sdio_release_host(func);
210
211         if (ret < 0)
212                 d_printf(0, dev, "E: barker error: %d\n", ret);
213
214         kfree(buffer);
215 error_kzalloc:
216         return ret;
217 }
218
219
220 /*
221  * Reset a device at different levels (warm, cold or bus)
222  *
223  * @i2400ms: device descriptor
224  * @reset_type: soft, warm or bus reset (I2400M_RT_WARM/SOFT/BUS)
225  *
226  * FIXME: not tested -- need to confirm expected effects
227  *
228  * Warm and cold resets get an SDIO reset if they fail (unimplemented)
229  *
230  * Warm reset:
231  *
232  * The device will be fully reset internally, but won't be
233  * disconnected from the USB bus (so no reenumeration will
234  * happen). Firmware upload will be neccessary.
235  *
236  * The device will send a reboot barker in the notification endpoint
237  * that will trigger the driver to reinitialize the state
238  * automatically from notif.c:i2400m_notification_grok() into
239  * i2400m_dev_bootstrap_delayed().
240  *
241  * Cold and bus (USB) reset:
242  *
243  * The device will be fully reset internally, disconnected from the
244  * USB bus an a reenumeration will happen. Firmware upload will be
245  * neccessary. Thus, we don't do any locking or struct
246  * reinitialization, as we are going to be fully disconnected and
247  * reenumerated.
248  *
249  * Note we need to return -ENODEV if a warm reset was requested and we
250  * had to resort to a bus reset. See i2400m_op_reset(), wimax_reset()
251  * and wimax_dev->op_reset.
252  *
253  * WARNING: no driver state saved/fixed
254  */
255 static
256 int i2400ms_bus_reset(struct i2400m *i2400m, enum i2400m_reset_type rt)
257 {
258         int result;
259         struct i2400ms *i2400ms =
260                 container_of(i2400m, struct i2400ms, i2400m);
261         struct device *dev = i2400m_dev(i2400m);
262         static const __le32 i2400m_WARM_BOOT_BARKER[4] = {
263                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
264                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
265                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
266                 cpu_to_le32(I2400M_WARM_RESET_BARKER),
267         };
268         static const __le32 i2400m_COLD_BOOT_BARKER[4] = {
269                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
270                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
271                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
272                 cpu_to_le32(I2400M_COLD_RESET_BARKER),
273         };
274
275         if (rt == I2400M_RT_WARM)
276                 result = __i2400ms_send_barker(i2400ms, i2400m_WARM_BOOT_BARKER,
277                                                sizeof(i2400m_WARM_BOOT_BARKER));
278         else if (rt == I2400M_RT_COLD)
279                 result = __i2400ms_send_barker(i2400ms, i2400m_COLD_BOOT_BARKER,
280                                                sizeof(i2400m_COLD_BOOT_BARKER));
281         else if (rt == I2400M_RT_BUS) {
282 do_bus_reset:
283                 dev_err(dev, "FIXME: SDIO bus reset not implemented\n");
284                 result = rt == I2400M_RT_WARM ? -ENODEV : -ENOSYS;
285         } else
286                 BUG();
287         if (result < 0 && rt != I2400M_RT_BUS) {
288                 dev_err(dev, "%s reset failed (%d); trying SDIO reset\n",
289                         rt == I2400M_RT_WARM ? "warm" : "cold", result);
290                 rt = I2400M_RT_BUS;
291                 goto do_bus_reset;
292         }
293         return result;
294 }
295
296
297 static
298 void i2400ms_netdev_setup(struct net_device *net_dev)
299 {
300         struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
301         struct i2400ms *i2400ms = container_of(i2400m, struct i2400ms, i2400m);
302         i2400ms_init(i2400ms);
303         i2400m_netdev_setup(net_dev);
304 }
305
306
307 /*
308  * Debug levels control; see debug.h
309  */
310 struct d_level D_LEVEL[] = {
311         D_SUBMODULE_DEFINE(main),
312         D_SUBMODULE_DEFINE(tx),
313         D_SUBMODULE_DEFINE(rx),
314         D_SUBMODULE_DEFINE(fw),
315 };
316 size_t D_LEVEL_SIZE = ARRAY_SIZE(D_LEVEL);
317
318
319 #define __debugfs_register(prefix, name, parent)                        \
320 do {                                                                    \
321         result = d_level_register_debugfs(prefix, name, parent);        \
322         if (result < 0)                                                 \
323                 goto error;                                             \
324 } while (0)
325
326
327 static
328 int i2400ms_debugfs_add(struct i2400ms *i2400ms)
329 {
330         int result;
331         struct dentry *dentry = i2400ms->i2400m.wimax_dev.debugfs_dentry;
332
333         dentry = debugfs_create_dir("i2400m-usb", dentry);
334         result = PTR_ERR(dentry);
335         if (IS_ERR(dentry)) {
336                 if (result == -ENODEV)
337                         result = 0;     /* No debugfs support */
338                 goto error;
339         }
340         i2400ms->debugfs_dentry = dentry;
341         __debugfs_register("dl_", main, dentry);
342         __debugfs_register("dl_", tx, dentry);
343         __debugfs_register("dl_", rx, dentry);
344         __debugfs_register("dl_", fw, dentry);
345
346         return 0;
347
348 error:
349         debugfs_remove_recursive(i2400ms->debugfs_dentry);
350         return result;
351 }
352
353
354 /*
355  * Probe a i2400m interface and register it
356  *
357  * @func:    SDIO function
358  * @id:      SDIO device ID
359  * @returns: 0 if ok, < 0 errno code on error.
360  *
361  * Alloc a net device, initialize the bus-specific details and then
362  * calls the bus-generic initialization routine. That will register
363  * the wimax and netdev devices, upload the firmware [using
364  * _bus_bm_*()], call _bus_dev_start() to finalize the setup of the
365  * communication with the device and then will start to talk to it to
366  * finnish setting it up.
367  *
368  * Initialization is tricky; some instances of the hw are packed with
369  * others in a way that requires a third driver that enables the WiMAX
370  * function. In those cases, we can't enable the SDIO function and
371  * we'll return with -ENODEV. When the driver that enables the WiMAX
372  * function does its thing, it has to do a bus_rescan_devices() on the
373  * SDIO bus so this driver is called again to enumerate the WiMAX
374  * function.
375  */
376 static
377 int i2400ms_probe(struct sdio_func *func,
378                   const struct sdio_device_id *id)
379 {
380         int result;
381         struct net_device *net_dev;
382         struct device *dev = &func->dev;
383         struct i2400m *i2400m;
384         struct i2400ms *i2400ms;
385
386         /* Allocate instance [calls i2400m_netdev_setup() on it]. */
387         result = -ENOMEM;
388         net_dev = alloc_netdev(sizeof(*i2400ms), "wmx%d",
389                                i2400ms_netdev_setup);
390         if (net_dev == NULL) {
391                 dev_err(dev, "no memory for network device instance\n");
392                 goto error_alloc_netdev;
393         }
394         SET_NETDEV_DEV(net_dev, dev);
395         i2400m = net_dev_to_i2400m(net_dev);
396         i2400ms = container_of(i2400m, struct i2400ms, i2400m);
397         i2400m->wimax_dev.net_dev = net_dev;
398         i2400ms->func = func;
399         sdio_set_drvdata(func, i2400ms);
400
401         i2400m->bus_tx_block_size = I2400MS_BLK_SIZE;
402         i2400m->bus_pl_size_max = I2400MS_PL_SIZE_MAX;
403         i2400m->bus_dev_start = i2400ms_bus_dev_start;
404         i2400m->bus_dev_stop = i2400ms_bus_dev_stop;
405         i2400m->bus_tx_kick = i2400ms_bus_tx_kick;
406         i2400m->bus_reset = i2400ms_bus_reset;
407         i2400m->bus_bm_cmd_send = i2400ms_bus_bm_cmd_send;
408         i2400m->bus_bm_wait_for_ack = i2400ms_bus_bm_wait_for_ack;
409         i2400m->bus_fw_names = i2400ms_bus_fw_names;
410         i2400m->bus_bm_mac_addr_impaired = 1;
411
412         result = i2400ms_enable_function(i2400ms->func);
413         if (result < 0) {
414                 dev_err(dev, "Cannot enable SDIO function: %d\n", result);
415                 goto error_func_enable;
416         }
417
418         sdio_claim_host(func);
419         result = sdio_set_block_size(func, I2400MS_BLK_SIZE);
420         if (result < 0) {
421                 dev_err(dev, "Failed to set block size: %d\n", result);
422                 goto error_set_blk_size;
423         }
424         sdio_release_host(func);
425
426         result = i2400m_setup(i2400m, I2400M_BRI_NO_REBOOT);
427         if (result < 0) {
428                 dev_err(dev, "cannot setup device: %d\n", result);
429                 goto error_setup;
430         }
431
432         result = i2400ms_debugfs_add(i2400ms);
433         if (result < 0) {
434                 dev_err(dev, "cannot create SDIO debugfs: %d\n",
435                         result);
436                 goto error_debugfs_add;
437         }
438         return 0;
439
440 error_debugfs_add:
441         i2400m_release(i2400m);
442 error_setup:
443         sdio_set_drvdata(func, NULL);
444         sdio_claim_host(func);
445 error_set_blk_size:
446         sdio_disable_func(func);
447         sdio_release_host(func);
448 error_func_enable:
449         free_netdev(net_dev);
450 error_alloc_netdev:
451         return result;
452 }
453
454
455 static
456 void i2400ms_remove(struct sdio_func *func)
457 {
458         struct device *dev = &func->dev;
459         struct i2400ms *i2400ms = sdio_get_drvdata(func);
460         struct i2400m *i2400m = &i2400ms->i2400m;
461         struct net_device *net_dev = i2400m->wimax_dev.net_dev;
462
463         d_fnstart(3, dev, "SDIO func %p\n", func);
464         debugfs_remove_recursive(i2400ms->debugfs_dentry);
465         i2400m_release(i2400m);
466         sdio_set_drvdata(func, NULL);
467         sdio_claim_host(func);
468         sdio_disable_func(func);
469         sdio_release_host(func);
470         free_netdev(net_dev);
471         d_fnend(3, dev, "SDIO func %p\n", func);
472 }
473
474 enum {
475         I2400MS_INTEL_VID = 0x89,
476 };
477
478 static
479 const struct sdio_device_id i2400ms_sdio_ids[] = {
480         /* Intel: i2400m WiMAX over SDIO */
481         { SDIO_DEVICE(I2400MS_INTEL_VID, 0x1402) },
482         { },                    /* end: all zeroes */
483 };
484 MODULE_DEVICE_TABLE(sdio, i2400ms_sdio_ids);
485
486
487 static
488 struct sdio_driver i2400m_sdio_driver = {
489         .name           = KBUILD_MODNAME,
490         .probe          = i2400ms_probe,
491         .remove         = i2400ms_remove,
492         .id_table       = i2400ms_sdio_ids,
493 };
494
495
496 static
497 int __init i2400ms_driver_init(void)
498 {
499         return sdio_register_driver(&i2400m_sdio_driver);
500 }
501 module_init(i2400ms_driver_init);
502
503
504 static
505 void __exit i2400ms_driver_exit(void)
506 {
507         flush_scheduled_work(); /* for the stuff we schedule */
508         sdio_unregister_driver(&i2400m_sdio_driver);
509 }
510 module_exit(i2400ms_driver_exit);
511
512
513 MODULE_AUTHOR("Intel Corporation <linux-wimax@intel.com>");
514 MODULE_DESCRIPTION("Intel 2400M WiMAX networking for SDIO");
515 MODULE_LICENSE("GPL");
516 MODULE_FIRMWARE(I2400MS_FW_FILE_NAME);