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
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).
35 * i2400mu_netdev_setup()
37 * i2400m_netdev_setup()
45 * i2400m_cmd_enter_powersave()
46 * i2400mu_notification_release()
49 * i2400mu_notification_setup()
51 * i2400mu_bus_dev_start() Called by i2400m_dev_start() [who is
52 * i2400mu_tx_setup() called by i2400m_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
63 * __i2400mu_send_barker()
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,
86 int i2400mu_bus_dev_start(struct i2400m *i2400m)
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);
95 goto error_usb_tx_setup;
96 result = i2400mu_rx_setup(i2400mu);
98 goto error_usb_rx_setup;
99 result = i2400mu_notification_setup(i2400mu);
101 goto error_notif_setup;
102 d_fnend(3, dev, "(i2400m %p) = %d\n", i2400m, result);
106 i2400mu_rx_release(i2400mu);
108 i2400mu_tx_release(i2400mu);
110 d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
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.
140 int __i2400mu_send_barker(struct i2400mu *i2400mu,
141 const __le32 *barker,
145 struct usb_endpoint_descriptor *epd = NULL;
146 int pipe, actual_len, ret;
147 struct device *dev = &i2400mu->usb_iface->dev;
151 ret = usb_autopm_get_interface(i2400mu->usb_iface);
153 dev_err(dev, "RESET: can't get autopm: %d\n", ret);
157 buffer = kmalloc(barker_size, GFP_KERNEL);
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,
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);
175 usb_autopm_put_interface(i2400mu->usb_iface);
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.
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
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
214 int i2400mu_bus_reset(struct i2400m *i2400m, enum i2400m_reset_type rt)
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(
236 i2400mu, i2400m_WARM_BOOT_BARKER,
237 sizeof(i2400m_WARM_BOOT_BARKER),
238 i2400mu->endpoint_cfg.bulk_out);
239 else if (rt == I2400M_RT_COLD)
240 result = __i2400mu_send_barker(
241 i2400mu, i2400m_COLD_BOOT_BARKER,
242 sizeof(i2400m_COLD_BOOT_BARKER),
243 i2400mu->endpoint_cfg.reset_cold);
244 else if (rt == I2400M_RT_BUS) {
246 result = usb_reset_device(i2400mu->usb_dev);
249 case -EINVAL: /* device is gone */
253 result = rt == I2400M_RT_WARM ? -ENODEV : 0;
254 break; /* We assume the device is disconnected */
256 dev_err(dev, "USB reset failed (%d), giving up!\n",
260 result = -EINVAL; /* shut gcc up in certain arches */
264 && result != -EINVAL /* device is gone */
265 && rt != I2400M_RT_BUS) {
266 dev_err(dev, "%s reset failed (%d); trying USB reset\n",
267 rt == I2400M_RT_WARM ? "warm" : "cold", result);
271 d_fnend(3, dev, "(i2400m %p rt %u) = %d\n", i2400m, rt, result);
277 void i2400mu_netdev_setup(struct net_device *net_dev)
279 struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
280 struct i2400mu *i2400mu = container_of(i2400m, struct i2400mu, i2400m);
281 i2400mu_init(i2400mu);
282 i2400m_netdev_setup(net_dev);
287 * Debug levels control; see debug.h
289 struct d_level D_LEVEL[] = {
290 D_SUBMODULE_DEFINE(usb),
291 D_SUBMODULE_DEFINE(fw),
292 D_SUBMODULE_DEFINE(notif),
293 D_SUBMODULE_DEFINE(rx),
294 D_SUBMODULE_DEFINE(tx),
296 size_t D_LEVEL_SIZE = ARRAY_SIZE(D_LEVEL);
299 #define __debugfs_register(prefix, name, parent) \
301 result = d_level_register_debugfs(prefix, name, parent); \
308 int i2400mu_debugfs_add(struct i2400mu *i2400mu)
311 struct device *dev = &i2400mu->usb_iface->dev;
312 struct dentry *dentry = i2400mu->i2400m.wimax_dev.debugfs_dentry;
315 dentry = debugfs_create_dir("i2400m-usb", dentry);
316 result = PTR_ERR(dentry);
317 if (IS_ERR(dentry)) {
318 if (result == -ENODEV)
319 result = 0; /* No debugfs support */
322 i2400mu->debugfs_dentry = dentry;
323 __debugfs_register("dl_", usb, dentry);
324 __debugfs_register("dl_", fw, dentry);
325 __debugfs_register("dl_", notif, dentry);
326 __debugfs_register("dl_", rx, dentry);
327 __debugfs_register("dl_", tx, dentry);
329 /* Don't touch these if you don't know what you are doing */
330 fd = debugfs_create_u8("rx_size_auto_shrink", 0600, dentry,
331 &i2400mu->rx_size_auto_shrink);
332 result = PTR_ERR(fd);
333 if (IS_ERR(fd) && result != -ENODEV) {
334 dev_err(dev, "Can't create debugfs entry "
335 "rx_size_auto_shrink: %d\n", result);
339 fd = debugfs_create_size_t("rx_size", 0600, dentry,
341 result = PTR_ERR(fd);
342 if (IS_ERR(fd) && result != -ENODEV) {
343 dev_err(dev, "Can't create debugfs entry "
344 "rx_size: %d\n", result);
351 debugfs_remove_recursive(i2400mu->debugfs_dentry);
356 static struct device_type i2400mu_type = {
361 * Probe a i2400m interface and register it
363 * @iface: USB interface to link to
364 * @id: USB class/subclass/protocol id
365 * @returns: 0 if ok, < 0 errno code on error.
367 * Alloc a net device, initialize the bus-specific details and then
368 * calls the bus-generic initialization routine. That will register
369 * the wimax and netdev devices, upload the firmware [using
370 * _bus_bm_*()], call _bus_dev_start() to finalize the setup of the
371 * communication with the device and then will start to talk to it to
372 * finnish setting it up.
375 int i2400mu_probe(struct usb_interface *iface,
376 const struct usb_device_id *id)
379 struct net_device *net_dev;
380 struct device *dev = &iface->dev;
381 struct i2400m *i2400m;
382 struct i2400mu *i2400mu;
383 struct usb_device *usb_dev = interface_to_usbdev(iface);
385 if (usb_dev->speed != USB_SPEED_HIGH)
386 dev_err(dev, "device not connected as high speed\n");
388 /* Allocate instance [calls i2400m_netdev_setup() on it]. */
390 net_dev = alloc_netdev(sizeof(*i2400mu), "wmx%d",
391 i2400mu_netdev_setup);
392 if (net_dev == NULL) {
393 dev_err(dev, "no memory for network device instance\n");
394 goto error_alloc_netdev;
396 SET_NETDEV_DEV(net_dev, dev);
397 SET_NETDEV_DEVTYPE(net_dev, &i2400mu_type);
398 i2400m = net_dev_to_i2400m(net_dev);
399 i2400mu = container_of(i2400m, struct i2400mu, i2400m);
400 i2400m->wimax_dev.net_dev = net_dev;
401 i2400mu->usb_dev = usb_get_dev(usb_dev);
402 i2400mu->usb_iface = iface;
403 usb_set_intfdata(iface, i2400mu);
405 i2400m->bus_tx_block_size = I2400MU_BLK_SIZE;
406 i2400m->bus_pl_size_max = I2400MU_PL_SIZE_MAX;
407 i2400m->bus_dev_start = i2400mu_bus_dev_start;
408 i2400m->bus_dev_stop = i2400mu_bus_dev_stop;
409 i2400m->bus_tx_kick = i2400mu_bus_tx_kick;
410 i2400m->bus_reset = i2400mu_bus_reset;
411 i2400m->bus_bm_retries = I2400M_USB_BOOT_RETRIES;
412 i2400m->bus_bm_cmd_send = i2400mu_bus_bm_cmd_send;
413 i2400m->bus_bm_wait_for_ack = i2400mu_bus_bm_wait_for_ack;
414 i2400m->bus_fw_names = i2400mu_bus_fw_names;
415 i2400m->bus_bm_mac_addr_impaired = 0;
418 i2400mu->endpoint_cfg.bulk_out = 0;
419 i2400mu->endpoint_cfg.notification = 1;
420 i2400mu->endpoint_cfg.reset_cold = 2;
421 i2400mu->endpoint_cfg.bulk_in = 3;
424 iface->needs_remote_wakeup = 1; /* autosuspend (15s delay) */
425 device_init_wakeup(dev, 1);
426 usb_dev->autosuspend_delay = 15 * HZ;
427 usb_dev->autosuspend_disabled = 0;
430 result = i2400m_bm_buf_alloc(i2400m);
432 dev_err(dev, "cannot allocate USB bootmode buffer\n");
433 goto error_bm_buf_alloc;
436 result = i2400m_setup(i2400m, I2400M_BRI_MAC_REINIT);
438 dev_err(dev, "cannot setup device: %d\n", result);
441 result = i2400mu_debugfs_add(i2400mu);
443 dev_err(dev, "Can't register i2400mu's debugfs: %d\n", result);
444 goto error_debugfs_add;
449 i2400m_release(i2400m);
451 i2400m_bm_buf_free(i2400m);
453 usb_set_intfdata(iface, NULL);
454 usb_put_dev(i2400mu->usb_dev);
455 free_netdev(net_dev);
462 * Disconect a i2400m from the system.
464 * i2400m_stop() has been called before, so al the rx and tx contexts
465 * have been taken down already. Make sure the queue is stopped,
466 * unregister netdev and i2400m, free and kill.
469 void i2400mu_disconnect(struct usb_interface *iface)
471 struct i2400mu *i2400mu = usb_get_intfdata(iface);
472 struct i2400m *i2400m = &i2400mu->i2400m;
473 struct net_device *net_dev = i2400m->wimax_dev.net_dev;
474 struct device *dev = &iface->dev;
476 d_fnstart(3, dev, "(iface %p i2400m %p)\n", iface, i2400m);
478 debugfs_remove_recursive(i2400mu->debugfs_dentry);
479 i2400m_release(i2400m);
480 usb_set_intfdata(iface, NULL);
481 usb_put_dev(i2400mu->usb_dev);
482 free_netdev(net_dev);
483 d_fnend(3, dev, "(iface %p i2400m %p) = void\n", iface, i2400m);
488 * Get the device ready for USB port or system standby and hibernation
490 * USB port and system standby are handled the same.
492 * When the system hibernates, the USB device is powered down and then
493 * up, so we don't really have to do much here, as it will be seen as
494 * a reconnect. Still for simplicity we consider this case the same as
495 * suspend, so that the device has a chance to do notify the base
496 * station (if connected).
498 * So at the end, the three cases require common handling.
500 * If at the time of this call the device's firmware is not loaded,
501 * nothing has to be done.
503 * If the firmware is loaded, we need to:
505 * - tell the device to go into host interface power save mode, wait
508 * This is quite more interesting than it is; we need to execute a
509 * command, but this time, we don't want the code in usb-{tx,rx}.c
510 * to call the usb_autopm_get/put_interface() barriers as it'd
511 * deadlock, so we need to decrement i2400mu->do_autopm, that acts
512 * as a poor man's semaphore. Ugly, but it works.
514 * As well, the device might refuse going to sleep for whichever
515 * reason. In this case we just fail. For system suspend/hibernate,
516 * we *can't* fail. We look at usb_dev->auto_pm to see if the
517 * suspend call comes from the USB stack or from the system and act
520 * - stop the notification endpoint polling
523 int i2400mu_suspend(struct usb_interface *iface, pm_message_t pm_msg)
526 struct device *dev = &iface->dev;
527 struct i2400mu *i2400mu = usb_get_intfdata(iface);
529 struct usb_device *usb_dev = i2400mu->usb_dev;
531 unsigned is_autosuspend = 0;
532 struct i2400m *i2400m = &i2400mu->i2400m;
535 if (usb_dev->auto_pm > 0)
539 d_fnstart(3, dev, "(iface %p pm_msg %u)\n", iface, pm_msg.event);
540 if (i2400m->updown == 0)
542 if (i2400m->state == I2400M_SS_DATA_PATH_CONNECTED && is_autosuspend) {
543 /* ugh -- the device is connected and this suspend
544 * request is an autosuspend one (not a system standby
547 * The only way the device can go to standby is if the
548 * link with the base station is in IDLE mode; that
549 * were the case, we'd be in status
550 * I2400M_SS_CONNECTED_IDLE. But we are not.
552 * If we *tell* him to go power save now, it'll reset
553 * as a precautionary measure, so if this is an
554 * autosuspend thing, say no and it'll come back
555 * later, when the link is IDLE
558 d_printf(1, dev, "fw up, link up, not-idle, autosuspend: "
559 "not entering powersave\n");
562 d_printf(1, dev, "fw up: entering powersave\n");
563 atomic_dec(&i2400mu->do_autopm);
564 result = i2400m_cmd_enter_powersave(i2400m);
565 atomic_inc(&i2400mu->do_autopm);
566 if (result < 0 && !is_autosuspend) {
567 /* System suspend, can't fail */
568 dev_err(dev, "failed to suspend, will reset on resume\n");
572 goto error_enter_powersave;
573 i2400mu_notification_release(i2400mu);
574 d_printf(1, dev, "powersave requested\n");
575 error_enter_powersave:
578 d_fnend(3, dev, "(iface %p pm_msg %u) = %d\n",
579 iface, pm_msg.event, result);
585 int i2400mu_resume(struct usb_interface *iface)
588 struct device *dev = &iface->dev;
589 struct i2400mu *i2400mu = usb_get_intfdata(iface);
590 struct i2400m *i2400m = &i2400mu->i2400m;
592 d_fnstart(3, dev, "(iface %p)\n", iface);
593 if (i2400m->updown == 0) {
594 d_printf(1, dev, "fw was down, no resume neeed\n");
597 d_printf(1, dev, "fw was up, resuming\n");
598 i2400mu_notification_setup(i2400mu);
599 /* USB has flow control, so we don't need to give it time to
600 * come back; otherwise, we'd use something like a get-state
603 d_fnend(3, dev, "(iface %p) = %d\n", iface, ret);
609 struct usb_device_id i2400mu_id_table[] = {
610 { USB_DEVICE(0x8086, 0x0181) },
611 { USB_DEVICE(0x8086, 0x1403) },
612 { USB_DEVICE(0x8086, 0x1405) },
613 { USB_DEVICE(0x8086, 0x0180) },
614 { USB_DEVICE(0x8086, 0x0182) },
615 { USB_DEVICE(0x8086, 0x1406) },
616 { USB_DEVICE(0x8086, 0x1403) },
619 MODULE_DEVICE_TABLE(usb, i2400mu_id_table);
623 struct usb_driver i2400mu_driver = {
624 .name = KBUILD_MODNAME,
625 .suspend = i2400mu_suspend,
626 .resume = i2400mu_resume,
627 .probe = i2400mu_probe,
628 .disconnect = i2400mu_disconnect,
629 .id_table = i2400mu_id_table,
630 .supports_autosuspend = 1,
634 int __init i2400mu_driver_init(void)
636 return usb_register(&i2400mu_driver);
638 module_init(i2400mu_driver_init);
642 void __exit i2400mu_driver_exit(void)
644 flush_scheduled_work(); /* for the stuff we schedule from sysfs.c */
645 usb_deregister(&i2400mu_driver);
647 module_exit(i2400mu_driver_exit);
649 MODULE_AUTHOR("Intel Corporation <linux-wimax@intel.com>");
650 MODULE_DESCRIPTION("Intel 2400M WiMAX networking for USB");
651 MODULE_LICENSE("GPL");
652 MODULE_FIRMWARE(I2400MU_FW_FILE_NAME_v1_4);
653 MODULE_FIRMWARE(I2400MU_FW_FILE_NAME_v1_3);