[ARM] pxa: Gumstix Verdex PCMCIA support
[linux-2.6/verdex.git] / drivers / net / wimax / i2400m / usb.c
blob7eadd11c815b39c4caeaf74a34757b57466bb44e
1 /*
2 * Intel Wireless WiMAX Connection 2400m
3 * Linux driver model glue for USB device, reset & fw upload
6 * Copyright (C) 2007-2008 Intel Corporation <linux-wimax@intel.com>
7 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
8 * Yanir Lubetkin <yanirx.lubetkin@intel.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License version
12 * 2 as published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 * 02110-1301, USA.
25 * See i2400m-usb.h for a general description of this driver.
27 * This file implements driver model glue, and hook ups for the
28 * generic driver to implement the bus-specific functions (device
29 * communication setup/tear down, firmware upload and resetting).
31 * ROADMAP
33 * i2400mu_probe()
34 * alloc_netdev()...
35 * i2400mu_netdev_setup()
36 * i2400mu_init()
37 * i2400m_netdev_setup()
38 * i2400m_setup()...
40 * i2400mu_disconnect
41 * i2400m_release()
42 * free_netdev()
44 * i2400mu_suspend()
45 * i2400m_cmd_enter_powersave()
46 * i2400mu_notification_release()
48 * i2400mu_resume()
49 * i2400mu_notification_setup()
51 * i2400mu_bus_dev_start() Called by i2400m_dev_start() [who is
52 * i2400mu_tx_setup() called by i2400m_setup()]
53 * i2400mu_rx_setup()
54 * i2400mu_notification_setup()
56 * i2400mu_bus_dev_stop() Called by i2400m_dev_stop() [who is
57 * i2400mu_notification_release() called by i2400m_release()]
58 * i2400mu_rx_release()
59 * i2400mu_tx_release()
61 * i2400mu_bus_reset() Called by i2400m->bus_reset
62 * __i2400mu_reset()
63 * __i2400mu_send_barker()
64 * usb_reset_device()
66 #include "i2400m-usb.h"
67 #include <linux/wimax/i2400m.h>
68 #include <linux/debugfs.h>
71 #define D_SUBMODULE usb
72 #include "usb-debug-levels.h"
75 /* Our firmware file name */
76 static const char *i2400mu_bus_fw_names[] = {
77 #define I2400MU_FW_FILE_NAME_v1_4 "i2400m-fw-usb-1.4.sbcf"
78 I2400MU_FW_FILE_NAME_v1_4,
79 #define I2400MU_FW_FILE_NAME_v1_3 "i2400m-fw-usb-1.3.sbcf"
80 I2400MU_FW_FILE_NAME_v1_3,
81 NULL,
85 static
86 int i2400mu_bus_dev_start(struct i2400m *i2400m)
88 int result;
89 struct i2400mu *i2400mu = container_of(i2400m, struct i2400mu, i2400m);
90 struct device *dev = &i2400mu->usb_iface->dev;
92 d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
93 result = i2400mu_tx_setup(i2400mu);
94 if (result < 0)
95 goto error_usb_tx_setup;
96 result = i2400mu_rx_setup(i2400mu);
97 if (result < 0)
98 goto error_usb_rx_setup;
99 result = i2400mu_notification_setup(i2400mu);
100 if (result < 0)
101 goto error_notif_setup;
102 d_fnend(3, dev, "(i2400m %p) = %d\n", i2400m, result);
103 return result;
105 error_notif_setup:
106 i2400mu_rx_release(i2400mu);
107 error_usb_rx_setup:
108 i2400mu_tx_release(i2400mu);
109 error_usb_tx_setup:
110 d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
111 return result;
115 static
116 void i2400mu_bus_dev_stop(struct i2400m *i2400m)
118 struct i2400mu *i2400mu = container_of(i2400m, struct i2400mu, i2400m);
119 struct device *dev = &i2400mu->usb_iface->dev;
121 d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
122 i2400mu_notification_release(i2400mu);
123 i2400mu_rx_release(i2400mu);
124 i2400mu_tx_release(i2400mu);
125 d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
130 * Sends a barker buffer to the device
132 * This helper will allocate a kmalloced buffer and use it to transmit
133 * (then free it). Reason for this is that other arches cannot use
134 * stack/vmalloc/text areas for DMA transfers.
136 * Error recovery here is simpler: anything is considered a hard error
137 * and will move the reset code to use a last-resort bus-based reset.
139 static
140 int __i2400mu_send_barker(struct i2400mu *i2400mu,
141 const __le32 *barker,
142 size_t barker_size,
143 unsigned endpoint)
145 struct usb_endpoint_descriptor *epd = NULL;
146 int pipe, actual_len, ret;
147 struct device *dev = &i2400mu->usb_iface->dev;
148 void *buffer;
149 int do_autopm = 1;
151 ret = usb_autopm_get_interface(i2400mu->usb_iface);
152 if (ret < 0) {
153 dev_err(dev, "RESET: can't get autopm: %d\n", ret);
154 do_autopm = 0;
156 ret = -ENOMEM;
157 buffer = kmalloc(barker_size, GFP_KERNEL);
158 if (buffer == NULL)
159 goto error_kzalloc;
160 epd = usb_get_epd(i2400mu->usb_iface, endpoint);
161 pipe = usb_sndbulkpipe(i2400mu->usb_dev, epd->bEndpointAddress);
162 memcpy(buffer, barker, barker_size);
163 ret = usb_bulk_msg(i2400mu->usb_dev, pipe, buffer, barker_size,
164 &actual_len, HZ);
165 if (ret < 0) {
166 if (ret != -EINVAL)
167 dev_err(dev, "E: barker error: %d\n", ret);
168 } else if (actual_len != barker_size) {
169 dev_err(dev, "E: only %d bytes transmitted\n", actual_len);
170 ret = -EIO;
172 kfree(buffer);
173 error_kzalloc:
174 if (do_autopm)
175 usb_autopm_put_interface(i2400mu->usb_iface);
176 return ret;
181 * Reset a device at different levels (warm, cold or bus)
183 * @i2400m: device descriptor
184 * @reset_type: soft, warm or bus reset (I2400M_RT_WARM/SOFT/BUS)
186 * Warm and cold resets get a USB reset if they fail.
188 * Warm reset:
190 * The device will be fully reset internally, but won't be
191 * disconnected from the USB bus (so no reenumeration will
192 * happen). Firmware upload will be neccessary.
194 * The device will send a reboot barker in the notification endpoint
195 * that will trigger the driver to reinitialize the state
196 * automatically from notif.c:i2400m_notification_grok() into
197 * i2400m_dev_bootstrap_delayed().
199 * Cold and bus (USB) reset:
201 * The device will be fully reset internally, disconnected from the
202 * USB bus an a reenumeration will happen. Firmware upload will be
203 * neccessary. Thus, we don't do any locking or struct
204 * reinitialization, as we are going to be fully disconnected and
205 * reenumerated.
207 * Note we need to return -ENODEV if a warm reset was requested and we
208 * had to resort to a bus reset. See i2400m_op_reset(), wimax_reset()
209 * and wimax_dev->op_reset.
211 * WARNING: no driver state saved/fixed
213 static
214 int i2400mu_bus_reset(struct i2400m *i2400m, enum i2400m_reset_type rt)
216 int result;
217 struct i2400mu *i2400mu =
218 container_of(i2400m, struct i2400mu, i2400m);
219 struct device *dev = i2400m_dev(i2400m);
220 static const __le32 i2400m_WARM_BOOT_BARKER[4] = {
221 cpu_to_le32(I2400M_WARM_RESET_BARKER),
222 cpu_to_le32(I2400M_WARM_RESET_BARKER),
223 cpu_to_le32(I2400M_WARM_RESET_BARKER),
224 cpu_to_le32(I2400M_WARM_RESET_BARKER),
226 static const __le32 i2400m_COLD_BOOT_BARKER[4] = {
227 cpu_to_le32(I2400M_COLD_RESET_BARKER),
228 cpu_to_le32(I2400M_COLD_RESET_BARKER),
229 cpu_to_le32(I2400M_COLD_RESET_BARKER),
230 cpu_to_le32(I2400M_COLD_RESET_BARKER),
233 d_fnstart(3, dev, "(i2400m %p rt %u)\n", i2400m, rt);
234 if (rt == I2400M_RT_WARM)
235 result = __i2400mu_send_barker(i2400mu, i2400m_WARM_BOOT_BARKER,
236 sizeof(i2400m_WARM_BOOT_BARKER),
237 I2400MU_EP_BULK_OUT);
238 else if (rt == I2400M_RT_COLD)
239 result = __i2400mu_send_barker(i2400mu, i2400m_COLD_BOOT_BARKER,
240 sizeof(i2400m_COLD_BOOT_BARKER),
241 I2400MU_EP_RESET_COLD);
242 else if (rt == I2400M_RT_BUS) {
243 do_bus_reset:
244 result = usb_reset_device(i2400mu->usb_dev);
245 switch (result) {
246 case 0:
247 case -EINVAL: /* device is gone */
248 case -ENODEV:
249 case -ENOENT:
250 case -ESHUTDOWN:
251 result = rt == I2400M_RT_WARM ? -ENODEV : 0;
252 break; /* We assume the device is disconnected */
253 default:
254 dev_err(dev, "USB reset failed (%d), giving up!\n",
255 result);
257 } else {
258 result = -EINVAL; /* shut gcc up in certain arches */
259 BUG();
261 if (result < 0
262 && result != -EINVAL /* device is gone */
263 && rt != I2400M_RT_BUS) {
264 dev_err(dev, "%s reset failed (%d); trying USB reset\n",
265 rt == I2400M_RT_WARM ? "warm" : "cold", result);
266 rt = I2400M_RT_BUS;
267 goto do_bus_reset;
269 d_fnend(3, dev, "(i2400m %p rt %u) = %d\n", i2400m, rt, result);
270 return result;
274 static
275 void i2400mu_netdev_setup(struct net_device *net_dev)
277 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
278 struct i2400mu *i2400mu = container_of(i2400m, struct i2400mu, i2400m);
279 i2400mu_init(i2400mu);
280 i2400m_netdev_setup(net_dev);
285 * Debug levels control; see debug.h
287 struct d_level D_LEVEL[] = {
288 D_SUBMODULE_DEFINE(usb),
289 D_SUBMODULE_DEFINE(fw),
290 D_SUBMODULE_DEFINE(notif),
291 D_SUBMODULE_DEFINE(rx),
292 D_SUBMODULE_DEFINE(tx),
294 size_t D_LEVEL_SIZE = ARRAY_SIZE(D_LEVEL);
297 #define __debugfs_register(prefix, name, parent) \
298 do { \
299 result = d_level_register_debugfs(prefix, name, parent); \
300 if (result < 0) \
301 goto error; \
302 } while (0)
305 static
306 int i2400mu_debugfs_add(struct i2400mu *i2400mu)
308 int result;
309 struct device *dev = &i2400mu->usb_iface->dev;
310 struct dentry *dentry = i2400mu->i2400m.wimax_dev.debugfs_dentry;
311 struct dentry *fd;
313 dentry = debugfs_create_dir("i2400m-usb", dentry);
314 result = PTR_ERR(dentry);
315 if (IS_ERR(dentry)) {
316 if (result == -ENODEV)
317 result = 0; /* No debugfs support */
318 goto error;
320 i2400mu->debugfs_dentry = dentry;
321 __debugfs_register("dl_", usb, dentry);
322 __debugfs_register("dl_", fw, dentry);
323 __debugfs_register("dl_", notif, dentry);
324 __debugfs_register("dl_", rx, dentry);
325 __debugfs_register("dl_", tx, dentry);
327 /* Don't touch these if you don't know what you are doing */
328 fd = debugfs_create_u8("rx_size_auto_shrink", 0600, dentry,
329 &i2400mu->rx_size_auto_shrink);
330 result = PTR_ERR(fd);
331 if (IS_ERR(fd) && result != -ENODEV) {
332 dev_err(dev, "Can't create debugfs entry "
333 "rx_size_auto_shrink: %d\n", result);
334 goto error;
337 fd = debugfs_create_size_t("rx_size", 0600, dentry,
338 &i2400mu->rx_size);
339 result = PTR_ERR(fd);
340 if (IS_ERR(fd) && result != -ENODEV) {
341 dev_err(dev, "Can't create debugfs entry "
342 "rx_size: %d\n", result);
343 goto error;
346 return 0;
348 error:
349 debugfs_remove_recursive(i2400mu->debugfs_dentry);
350 return result;
354 static struct device_type i2400mu_type = {
355 .name = "wimax",
359 * Probe a i2400m interface and register it
361 * @iface: USB interface to link to
362 * @id: USB class/subclass/protocol id
363 * @returns: 0 if ok, < 0 errno code on error.
365 * Alloc a net device, initialize the bus-specific details and then
366 * calls the bus-generic initialization routine. That will register
367 * the wimax and netdev devices, upload the firmware [using
368 * _bus_bm_*()], call _bus_dev_start() to finalize the setup of the
369 * communication with the device and then will start to talk to it to
370 * finnish setting it up.
372 static
373 int i2400mu_probe(struct usb_interface *iface,
374 const struct usb_device_id *id)
376 int result;
377 struct net_device *net_dev;
378 struct device *dev = &iface->dev;
379 struct i2400m *i2400m;
380 struct i2400mu *i2400mu;
381 struct usb_device *usb_dev = interface_to_usbdev(iface);
383 if (usb_dev->speed != USB_SPEED_HIGH)
384 dev_err(dev, "device not connected as high speed\n");
386 /* Allocate instance [calls i2400m_netdev_setup() on it]. */
387 result = -ENOMEM;
388 net_dev = alloc_netdev(sizeof(*i2400mu), "wmx%d",
389 i2400mu_netdev_setup);
390 if (net_dev == NULL) {
391 dev_err(dev, "no memory for network device instance\n");
392 goto error_alloc_netdev;
394 SET_NETDEV_DEV(net_dev, dev);
395 SET_NETDEV_DEVTYPE(net_dev, &i2400mu_type);
396 i2400m = net_dev_to_i2400m(net_dev);
397 i2400mu = container_of(i2400m, struct i2400mu, i2400m);
398 i2400m->wimax_dev.net_dev = net_dev;
399 i2400mu->usb_dev = usb_get_dev(usb_dev);
400 i2400mu->usb_iface = iface;
401 usb_set_intfdata(iface, i2400mu);
403 i2400m->bus_tx_block_size = I2400MU_BLK_SIZE;
404 i2400m->bus_pl_size_max = I2400MU_PL_SIZE_MAX;
405 i2400m->bus_dev_start = i2400mu_bus_dev_start;
406 i2400m->bus_dev_stop = i2400mu_bus_dev_stop;
407 i2400m->bus_tx_kick = i2400mu_bus_tx_kick;
408 i2400m->bus_reset = i2400mu_bus_reset;
409 i2400m->bus_bm_retries = I2400M_BOOT_RETRIES;
410 i2400m->bus_bm_cmd_send = i2400mu_bus_bm_cmd_send;
411 i2400m->bus_bm_wait_for_ack = i2400mu_bus_bm_wait_for_ack;
412 i2400m->bus_fw_names = i2400mu_bus_fw_names;
413 i2400m->bus_bm_mac_addr_impaired = 0;
415 #ifdef CONFIG_PM
416 iface->needs_remote_wakeup = 1; /* autosuspend (15s delay) */
417 device_init_wakeup(dev, 1);
418 usb_autopm_enable(i2400mu->usb_iface);
419 usb_dev->autosuspend_delay = 15 * HZ;
420 usb_dev->autosuspend_disabled = 0;
421 #endif
423 result = i2400m_setup(i2400m, I2400M_BRI_MAC_REINIT);
424 if (result < 0) {
425 dev_err(dev, "cannot setup device: %d\n", result);
426 goto error_setup;
428 result = i2400mu_debugfs_add(i2400mu);
429 if (result < 0) {
430 dev_err(dev, "Can't register i2400mu's debugfs: %d\n", result);
431 goto error_debugfs_add;
433 return 0;
435 error_debugfs_add:
436 i2400m_release(i2400m);
437 error_setup:
438 usb_set_intfdata(iface, NULL);
439 usb_put_dev(i2400mu->usb_dev);
440 free_netdev(net_dev);
441 error_alloc_netdev:
442 return result;
447 * Disconect a i2400m from the system.
449 * i2400m_stop() has been called before, so al the rx and tx contexts
450 * have been taken down already. Make sure the queue is stopped,
451 * unregister netdev and i2400m, free and kill.
453 static
454 void i2400mu_disconnect(struct usb_interface *iface)
456 struct i2400mu *i2400mu = usb_get_intfdata(iface);
457 struct i2400m *i2400m = &i2400mu->i2400m;
458 struct net_device *net_dev = i2400m->wimax_dev.net_dev;
459 struct device *dev = &iface->dev;
461 d_fnstart(3, dev, "(iface %p i2400m %p)\n", iface, i2400m);
463 debugfs_remove_recursive(i2400mu->debugfs_dentry);
464 i2400m_release(i2400m);
465 usb_set_intfdata(iface, NULL);
466 usb_put_dev(i2400mu->usb_dev);
467 free_netdev(net_dev);
468 d_fnend(3, dev, "(iface %p i2400m %p) = void\n", iface, i2400m);
473 * Get the device ready for USB port or system standby and hibernation
475 * USB port and system standby are handled the same.
477 * When the system hibernates, the USB device is powered down and then
478 * up, so we don't really have to do much here, as it will be seen as
479 * a reconnect. Still for simplicity we consider this case the same as
480 * suspend, so that the device has a chance to do notify the base
481 * station (if connected).
483 * So at the end, the three cases require common handling.
485 * If at the time of this call the device's firmware is not loaded,
486 * nothing has to be done.
488 * If the firmware is loaded, we need to:
490 * - tell the device to go into host interface power save mode, wait
491 * for it to ack
493 * This is quite more interesting than it is; we need to execute a
494 * command, but this time, we don't want the code in usb-{tx,rx}.c
495 * to call the usb_autopm_get/put_interface() barriers as it'd
496 * deadlock, so we need to decrement i2400mu->do_autopm, that acts
497 * as a poor man's semaphore. Ugly, but it works.
499 * As well, the device might refuse going to sleep for whichever
500 * reason. In this case we just fail. For system suspend/hibernate,
501 * we *can't* fail. We look at usb_dev->auto_pm to see if the
502 * suspend call comes from the USB stack or from the system and act
503 * in consequence.
505 * - stop the notification endpoint polling
507 static
508 int i2400mu_suspend(struct usb_interface *iface, pm_message_t pm_msg)
510 int result = 0;
511 struct device *dev = &iface->dev;
512 struct i2400mu *i2400mu = usb_get_intfdata(iface);
513 #ifdef CONFIG_PM
514 struct usb_device *usb_dev = i2400mu->usb_dev;
515 #endif
516 unsigned is_autosuspend = 0;
517 struct i2400m *i2400m = &i2400mu->i2400m;
519 #ifdef CONFIG_PM
520 if (usb_dev->auto_pm > 0)
521 is_autosuspend = 1;
522 #endif
524 d_fnstart(3, dev, "(iface %p pm_msg %u)\n", iface, pm_msg.event);
525 if (i2400m->updown == 0)
526 goto no_firmware;
527 if (i2400m->state == I2400M_SS_DATA_PATH_CONNECTED && is_autosuspend) {
528 /* ugh -- the device is connected and this suspend
529 * request is an autosuspend one (not a system standby
530 * / hibernate).
532 * The only way the device can go to standby is if the
533 * link with the base station is in IDLE mode; that
534 * were the case, we'd be in status
535 * I2400M_SS_CONNECTED_IDLE. But we are not.
537 * If we *tell* him to go power save now, it'll reset
538 * as a precautionary measure, so if this is an
539 * autosuspend thing, say no and it'll come back
540 * later, when the link is IDLE
542 result = -EBADF;
543 d_printf(1, dev, "fw up, link up, not-idle, autosuspend: "
544 "not entering powersave\n");
545 goto error_not_now;
547 d_printf(1, dev, "fw up: entering powersave\n");
548 atomic_dec(&i2400mu->do_autopm);
549 result = i2400m_cmd_enter_powersave(i2400m);
550 atomic_inc(&i2400mu->do_autopm);
551 if (result < 0 && !is_autosuspend) {
552 /* System suspend, can't fail */
553 dev_err(dev, "failed to suspend, will reset on resume\n");
554 result = 0;
556 if (result < 0)
557 goto error_enter_powersave;
558 i2400mu_notification_release(i2400mu);
559 d_printf(1, dev, "powersave requested\n");
560 error_enter_powersave:
561 error_not_now:
562 no_firmware:
563 d_fnend(3, dev, "(iface %p pm_msg %u) = %d\n",
564 iface, pm_msg.event, result);
565 return result;
569 static
570 int i2400mu_resume(struct usb_interface *iface)
572 int ret = 0;
573 struct device *dev = &iface->dev;
574 struct i2400mu *i2400mu = usb_get_intfdata(iface);
575 struct i2400m *i2400m = &i2400mu->i2400m;
577 d_fnstart(3, dev, "(iface %p)\n", iface);
578 if (i2400m->updown == 0) {
579 d_printf(1, dev, "fw was down, no resume neeed\n");
580 goto out;
582 d_printf(1, dev, "fw was up, resuming\n");
583 i2400mu_notification_setup(i2400mu);
584 /* USB has flow control, so we don't need to give it time to
585 * come back; otherwise, we'd use something like a get-state
586 * command... */
587 out:
588 d_fnend(3, dev, "(iface %p) = %d\n", iface, ret);
589 return ret;
593 static
594 struct usb_device_id i2400mu_id_table[] = {
595 { USB_DEVICE(0x8086, 0x0181) },
596 { USB_DEVICE(0x8086, 0x1403) },
597 { USB_DEVICE(0x8086, 0x1405) },
598 { USB_DEVICE(0x8086, 0x0180) },
599 { USB_DEVICE(0x8086, 0x0182) },
600 { USB_DEVICE(0x8086, 0x1406) },
601 { USB_DEVICE(0x8086, 0x1403) },
602 { },
604 MODULE_DEVICE_TABLE(usb, i2400mu_id_table);
607 static
608 struct usb_driver i2400mu_driver = {
609 .name = KBUILD_MODNAME,
610 .suspend = i2400mu_suspend,
611 .resume = i2400mu_resume,
612 .probe = i2400mu_probe,
613 .disconnect = i2400mu_disconnect,
614 .id_table = i2400mu_id_table,
615 .supports_autosuspend = 1,
618 static
619 int __init i2400mu_driver_init(void)
621 return usb_register(&i2400mu_driver);
623 module_init(i2400mu_driver_init);
626 static
627 void __exit i2400mu_driver_exit(void)
629 flush_scheduled_work(); /* for the stuff we schedule from sysfs.c */
630 usb_deregister(&i2400mu_driver);
632 module_exit(i2400mu_driver_exit);
634 MODULE_AUTHOR("Intel Corporation <linux-wimax@intel.com>");
635 MODULE_DESCRIPTION("Intel 2400M WiMAX networking for USB");
636 MODULE_LICENSE("GPL");
637 MODULE_FIRMWARE(I2400MU_FW_FILE_NAME_v1_4);
638 MODULE_FIRMWARE(I2400MU_FW_FILE_NAME_v1_3);