2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * This is a generic "USB networking" framework that works with several
23 * kinds of full and high speed networking devices: host-to-host cables,
24 * smart usb peripherals, and actual Ethernet adapters.
26 * These devices usually differ in terms of control protocols (if they
27 * even have one!) and sometimes they define new framing to wrap or batch
28 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
29 * so interface (un)binding, endpoint I/O queues, fault handling, and other
30 * issues can usefully be addressed by this framework.
33 // #define DEBUG // error path messages, extra info
34 // #define VERBOSE // more; success messages
36 #include <linux/module.h>
37 #include <linux/init.h>
38 #include <linux/netdevice.h>
39 #include <linux/etherdevice.h>
40 #include <linux/ctype.h>
41 #include <linux/ethtool.h>
42 #include <linux/workqueue.h>
43 #include <linux/mii.h>
44 #include <linux/usb.h>
45 #include <linux/usb/usbnet.h>
46 #include <linux/slab.h>
47 #include <linux/kernel.h>
48 #include <linux/pm_runtime.h>
50 #define DRIVER_VERSION "22-Aug-2005"
53 /*-------------------------------------------------------------------------*/
56 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
57 * Several dozen bytes of IPv4 data can fit in two such transactions.
58 * One maximum size Ethernet packet takes twenty four of them.
59 * For high speed, each frame comfortably fits almost 36 max size
60 * Ethernet packets (so queues should be bigger).
62 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
63 * let the USB host controller be busy for 5msec or more before an irq
64 * is required, under load. Jumbograms change the equation.
66 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
67 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
68 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
69 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
70 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
72 // reawaken network queue this soon after stopping; else watchdog barks
73 #define TX_TIMEOUT_JIFFIES (5*HZ)
75 // throttle rx/tx briefly after some faults, so khubd might disconnect()
76 // us (it polls at HZ/4 usually) before we report too many false errors.
77 #define THROTTLE_JIFFIES (HZ/8)
80 #define UNLINK_TIMEOUT_MS 3
82 /*-------------------------------------------------------------------------*/
84 // randomly generated ethernet address
85 static u8 node_id [ETH_ALEN];
87 static const char driver_name [] = "usbnet";
89 /* use ethtool to change the level for any given device */
90 static int msg_level = -1;
91 module_param (msg_level, int, 0);
92 MODULE_PARM_DESC (msg_level, "Override default message level");
94 /*-------------------------------------------------------------------------*/
96 /* handles CDC Ethernet and many other network "bulk data" interfaces */
97 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
100 struct usb_host_interface *alt = NULL;
101 struct usb_host_endpoint *in = NULL, *out = NULL;
102 struct usb_host_endpoint *status = NULL;
104 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
107 in = out = status = NULL;
108 alt = intf->altsetting + tmp;
110 /* take the first altsetting with in-bulk + out-bulk;
111 * remember any status endpoint, just in case;
112 * ignore other endpoints and altsettings.
114 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
115 struct usb_host_endpoint *e;
118 e = alt->endpoint + ep;
119 switch (e->desc.bmAttributes) {
120 case USB_ENDPOINT_XFER_INT:
121 if (!usb_endpoint_dir_in(&e->desc))
125 case USB_ENDPOINT_XFER_BULK:
130 if (usb_endpoint_dir_in(&e->desc)) {
133 else if (intr && !status)
143 if (!alt || !in || !out)
146 if (alt->desc.bAlternateSetting != 0 ||
147 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
148 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
149 alt->desc.bAlternateSetting);
154 dev->in = usb_rcvbulkpipe (dev->udev,
155 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156 dev->out = usb_sndbulkpipe (dev->udev,
157 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
158 dev->status = status;
161 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
163 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
166 unsigned char buf [13];
168 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
170 dev_dbg(&dev->udev->dev,
171 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
176 for (i = tmp = 0; i < 6; i++, tmp += 2)
177 dev->net->dev_addr [i] =
178 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
181 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
183 static void intr_complete (struct urb *urb);
185 static int init_status (struct usbnet *dev, struct usb_interface *intf)
192 if (!dev->driver_info->status)
195 pipe = usb_rcvintpipe (dev->udev,
196 dev->status->desc.bEndpointAddress
197 & USB_ENDPOINT_NUMBER_MASK);
198 maxp = usb_maxpacket (dev->udev, pipe, 0);
200 /* avoid 1 msec chatter: min 8 msec poll rate */
201 period = max ((int) dev->status->desc.bInterval,
202 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
204 buf = kmalloc (maxp, GFP_KERNEL);
206 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
207 if (!dev->interrupt) {
211 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
212 buf, maxp, intr_complete, dev, period);
213 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
215 "status ep%din, %d bytes period %d\n",
216 usb_pipeendpoint(pipe), maxp, period);
222 /* Passes this packet up the stack, updating its accounting.
223 * Some link protocols batch packets, so their rx_fixup paths
224 * can return clones as well as just modify the original skb.
226 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
230 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
231 skb_queue_tail(&dev->rxq_pause, skb);
235 skb->protocol = eth_type_trans (skb, dev->net);
236 dev->net->stats.rx_packets++;
237 dev->net->stats.rx_bytes += skb->len;
239 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
240 skb->len + sizeof (struct ethhdr), skb->protocol);
241 memset (skb->cb, 0, sizeof (struct skb_data));
243 if (skb_defer_rx_timestamp(skb))
246 status = netif_rx (skb);
247 if (status != NET_RX_SUCCESS)
248 netif_dbg(dev, rx_err, dev->net,
249 "netif_rx status %d\n", status);
251 EXPORT_SYMBOL_GPL(usbnet_skb_return);
254 /*-------------------------------------------------------------------------
256 * Network Device Driver (peer link to "Host Device", from USB host)
258 *-------------------------------------------------------------------------*/
260 int usbnet_change_mtu (struct net_device *net, int new_mtu)
262 struct usbnet *dev = netdev_priv(net);
263 int ll_mtu = new_mtu + net->hard_header_len;
264 int old_hard_mtu = dev->hard_mtu;
265 int old_rx_urb_size = dev->rx_urb_size;
269 // no second zero-length packet read wanted after mtu-sized packets
270 if ((ll_mtu % dev->maxpacket) == 0)
274 dev->hard_mtu = net->mtu + net->hard_header_len;
275 if (dev->rx_urb_size == old_hard_mtu) {
276 dev->rx_urb_size = dev->hard_mtu;
277 if (dev->rx_urb_size > old_rx_urb_size)
278 usbnet_unlink_rx_urbs(dev);
283 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
285 /*-------------------------------------------------------------------------*/
287 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
288 * completion callbacks. 2.5 should have fixed those bugs...
291 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
295 spin_lock_irqsave(&list->lock, flags);
296 __skb_unlink(skb, list);
297 spin_unlock(&list->lock);
298 spin_lock(&dev->done.lock);
299 __skb_queue_tail(&dev->done, skb);
300 if (dev->done.qlen == 1)
301 tasklet_schedule(&dev->bh);
302 spin_unlock_irqrestore(&dev->done.lock, flags);
305 /* some work can't be done in tasklets, so we use keventd
307 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
308 * but tasklet_schedule() doesn't. hope the failure is rare.
310 void usbnet_defer_kevent (struct usbnet *dev, int work)
312 set_bit (work, &dev->flags);
313 if (!schedule_work (&dev->kevent))
314 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
316 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
318 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
320 /*-------------------------------------------------------------------------*/
322 static void rx_complete (struct urb *urb);
324 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
327 struct skb_data *entry;
329 unsigned long lockflags;
330 size_t size = dev->rx_urb_size;
332 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
334 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
335 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
340 entry = (struct skb_data *) skb->cb;
343 entry->state = rx_start;
346 usb_fill_bulk_urb (urb, dev->udev, dev->in,
347 skb->data, size, rx_complete, skb);
349 spin_lock_irqsave (&dev->rxq.lock, lockflags);
351 if (netif_running (dev->net) &&
352 netif_device_present (dev->net) &&
353 !test_bit (EVENT_RX_HALT, &dev->flags) &&
354 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
355 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
357 usbnet_defer_kevent (dev, EVENT_RX_HALT);
360 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
363 netif_dbg(dev, ifdown, dev->net, "device gone\n");
364 netif_device_detach (dev->net);
370 netif_dbg(dev, rx_err, dev->net,
371 "rx submit, %d\n", retval);
372 tasklet_schedule (&dev->bh);
375 __skb_queue_tail (&dev->rxq, skb);
378 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
381 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
383 dev_kfree_skb_any (skb);
390 /*-------------------------------------------------------------------------*/
392 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
394 if (dev->driver_info->rx_fixup &&
395 !dev->driver_info->rx_fixup (dev, skb)) {
396 /* With RX_ASSEMBLE, rx_fixup() must update counters */
397 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
398 dev->net->stats.rx_errors++;
401 // else network stack removes extra byte if we forced a short packet
404 /* all data was already cloned from skb inside the driver */
405 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
406 dev_kfree_skb_any(skb);
408 usbnet_skb_return(dev, skb);
412 netif_dbg(dev, rx_err, dev->net, "drop\n");
413 dev->net->stats.rx_errors++;
415 skb_queue_tail(&dev->done, skb);
418 /*-------------------------------------------------------------------------*/
420 static void rx_complete (struct urb *urb)
422 struct sk_buff *skb = (struct sk_buff *) urb->context;
423 struct skb_data *entry = (struct skb_data *) skb->cb;
424 struct usbnet *dev = entry->dev;
425 int urb_status = urb->status;
427 skb_put (skb, urb->actual_length);
428 entry->state = rx_done;
431 switch (urb_status) {
434 if (skb->len < dev->net->hard_header_len) {
435 entry->state = rx_cleanup;
436 dev->net->stats.rx_errors++;
437 dev->net->stats.rx_length_errors++;
438 netif_dbg(dev, rx_err, dev->net,
439 "rx length %d\n", skb->len);
443 /* stalls need manual reset. this is rare ... except that
444 * when going through USB 2.0 TTs, unplug appears this way.
445 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
446 * storm, recovering as needed.
449 dev->net->stats.rx_errors++;
450 usbnet_defer_kevent (dev, EVENT_RX_HALT);
453 /* software-driven interface shutdown */
454 case -ECONNRESET: /* async unlink */
455 case -ESHUTDOWN: /* hardware gone */
456 netif_dbg(dev, ifdown, dev->net,
457 "rx shutdown, code %d\n", urb_status);
460 /* we get controller i/o faults during khubd disconnect() delays.
461 * throttle down resubmits, to avoid log floods; just temporarily,
462 * so we still recover when the fault isn't a khubd delay.
467 dev->net->stats.rx_errors++;
468 if (!timer_pending (&dev->delay)) {
469 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
470 netif_dbg(dev, link, dev->net,
471 "rx throttle %d\n", urb_status);
474 entry->state = rx_cleanup;
479 /* data overrun ... flush fifo? */
481 dev->net->stats.rx_over_errors++;
485 entry->state = rx_cleanup;
486 dev->net->stats.rx_errors++;
487 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
491 defer_bh(dev, skb, &dev->rxq);
494 if (netif_running (dev->net) &&
495 !test_bit (EVENT_RX_HALT, &dev->flags)) {
496 rx_submit (dev, urb, GFP_ATOMIC);
497 usb_mark_last_busy(dev->udev);
502 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
505 static void intr_complete (struct urb *urb)
507 struct usbnet *dev = urb->context;
508 int status = urb->status;
513 dev->driver_info->status(dev, urb);
516 /* software-driven interface shutdown */
517 case -ENOENT: /* urb killed */
518 case -ESHUTDOWN: /* hardware gone */
519 netif_dbg(dev, ifdown, dev->net,
520 "intr shutdown, code %d\n", status);
523 /* NOTE: not throttling like RX/TX, since this endpoint
524 * already polls infrequently
527 netdev_dbg(dev->net, "intr status %d\n", status);
531 if (!netif_running (dev->net))
534 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
535 status = usb_submit_urb (urb, GFP_ATOMIC);
537 netif_err(dev, timer, dev->net,
538 "intr resubmit --> %d\n", status);
541 /*-------------------------------------------------------------------------*/
542 void usbnet_pause_rx(struct usbnet *dev)
544 set_bit(EVENT_RX_PAUSED, &dev->flags);
546 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
548 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
550 void usbnet_resume_rx(struct usbnet *dev)
555 clear_bit(EVENT_RX_PAUSED, &dev->flags);
557 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
558 usbnet_skb_return(dev, skb);
562 tasklet_schedule(&dev->bh);
564 netif_dbg(dev, rx_status, dev->net,
565 "paused rx queue disabled, %d skbs requeued\n", num);
567 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
569 void usbnet_purge_paused_rxq(struct usbnet *dev)
571 skb_queue_purge(&dev->rxq_pause);
573 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
575 /*-------------------------------------------------------------------------*/
577 // unlink pending rx/tx; completion handlers do all other cleanup
579 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
582 struct sk_buff *skb, *skbnext;
585 spin_lock_irqsave (&q->lock, flags);
586 skb_queue_walk_safe(q, skb, skbnext) {
587 struct skb_data *entry;
591 entry = (struct skb_data *) skb->cb;
595 * Get reference count of the URB to avoid it to be
596 * freed during usb_unlink_urb, which may trigger
597 * use-after-free problem inside usb_unlink_urb since
598 * usb_unlink_urb is always racing with .complete
599 * handler(include defer_bh).
602 spin_unlock_irqrestore(&q->lock, flags);
603 // during some PM-driven resume scenarios,
604 // these (async) unlinks complete immediately
605 retval = usb_unlink_urb (urb);
606 if (retval != -EINPROGRESS && retval != 0)
607 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
611 spin_lock_irqsave(&q->lock, flags);
613 spin_unlock_irqrestore (&q->lock, flags);
617 // Flush all pending rx urbs
618 // minidrivers may need to do this when the MTU changes
620 void usbnet_unlink_rx_urbs(struct usbnet *dev)
622 if (netif_running(dev->net)) {
623 (void) unlink_urbs (dev, &dev->rxq);
624 tasklet_schedule(&dev->bh);
627 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
629 /*-------------------------------------------------------------------------*/
631 // precondition: never called in_interrupt
632 static void usbnet_terminate_urbs(struct usbnet *dev)
634 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
635 DECLARE_WAITQUEUE(wait, current);
638 /* ensure there are no more active urbs */
639 add_wait_queue(&unlink_wakeup, &wait);
640 set_current_state(TASK_UNINTERRUPTIBLE);
641 dev->wait = &unlink_wakeup;
642 temp = unlink_urbs(dev, &dev->txq) +
643 unlink_urbs(dev, &dev->rxq);
645 /* maybe wait for deletions to finish. */
646 while (!skb_queue_empty(&dev->rxq)
647 && !skb_queue_empty(&dev->txq)
648 && !skb_queue_empty(&dev->done)) {
649 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
650 set_current_state(TASK_UNINTERRUPTIBLE);
651 netif_dbg(dev, ifdown, dev->net,
652 "waited for %d urb completions\n", temp);
654 set_current_state(TASK_RUNNING);
656 remove_wait_queue(&unlink_wakeup, &wait);
659 int usbnet_stop (struct net_device *net)
661 struct usbnet *dev = netdev_priv(net);
662 struct driver_info *info = dev->driver_info;
665 clear_bit(EVENT_DEV_OPEN, &dev->flags);
666 netif_stop_queue (net);
668 netif_info(dev, ifdown, dev->net,
669 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
670 net->stats.rx_packets, net->stats.tx_packets,
671 net->stats.rx_errors, net->stats.tx_errors);
673 /* allow minidriver to stop correctly (wireless devices to turn off
676 retval = info->stop(dev);
678 netif_info(dev, ifdown, dev->net,
679 "stop fail (%d) usbnet usb-%s-%s, %s\n",
681 dev->udev->bus->bus_name, dev->udev->devpath,
685 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
686 usbnet_terminate_urbs(dev);
688 usb_kill_urb(dev->interrupt);
690 usbnet_purge_paused_rxq(dev);
692 /* deferred work (task, timer, softirq) must also stop.
693 * can't flush_scheduled_work() until we drop rtnl (later),
694 * else workers could deadlock; so make workers a NOP.
697 del_timer_sync (&dev->delay);
698 tasklet_kill (&dev->bh);
699 if (info->manage_power)
700 info->manage_power(dev, 0);
702 usb_autopm_put_interface(dev->intf);
706 EXPORT_SYMBOL_GPL(usbnet_stop);
708 /*-------------------------------------------------------------------------*/
710 // posts reads, and enables write queuing
712 // precondition: never called in_interrupt
714 int usbnet_open (struct net_device *net)
716 struct usbnet *dev = netdev_priv(net);
718 struct driver_info *info = dev->driver_info;
720 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
721 netif_info(dev, ifup, dev->net,
722 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
724 dev->udev->bus->bus_name,
730 // put into "known safe" state
731 if (info->reset && (retval = info->reset (dev)) < 0) {
732 netif_info(dev, ifup, dev->net,
733 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
735 dev->udev->bus->bus_name,
741 // insist peer be connected
742 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
743 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
747 /* start any status interrupt transfer */
748 if (dev->interrupt) {
749 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
751 netif_err(dev, ifup, dev->net,
752 "intr submit %d\n", retval);
757 set_bit(EVENT_DEV_OPEN, &dev->flags);
758 netif_start_queue (net);
759 netif_info(dev, ifup, dev->net,
760 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
761 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
763 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
764 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
765 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
766 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
767 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
770 // delay posting reads until we're fully open
771 tasklet_schedule (&dev->bh);
772 if (info->manage_power) {
773 retval = info->manage_power(dev, 1);
776 usb_autopm_put_interface(dev->intf);
781 usb_autopm_put_interface(dev->intf);
785 EXPORT_SYMBOL_GPL(usbnet_open);
787 /*-------------------------------------------------------------------------*/
789 /* ethtool methods; minidrivers may need to add some more, but
790 * they'll probably want to use this base set.
793 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
795 struct usbnet *dev = netdev_priv(net);
797 if (!dev->mii.mdio_read)
800 return mii_ethtool_gset(&dev->mii, cmd);
802 EXPORT_SYMBOL_GPL(usbnet_get_settings);
804 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
806 struct usbnet *dev = netdev_priv(net);
809 if (!dev->mii.mdio_write)
812 retval = mii_ethtool_sset(&dev->mii, cmd);
814 /* link speed/duplex might have changed */
815 if (dev->driver_info->link_reset)
816 dev->driver_info->link_reset(dev);
821 EXPORT_SYMBOL_GPL(usbnet_set_settings);
823 u32 usbnet_get_link (struct net_device *net)
825 struct usbnet *dev = netdev_priv(net);
827 /* If a check_connect is defined, return its result */
828 if (dev->driver_info->check_connect)
829 return dev->driver_info->check_connect (dev) == 0;
831 /* if the device has mii operations, use those */
832 if (dev->mii.mdio_read)
833 return mii_link_ok(&dev->mii);
835 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
836 return ethtool_op_get_link(net);
838 EXPORT_SYMBOL_GPL(usbnet_get_link);
840 int usbnet_nway_reset(struct net_device *net)
842 struct usbnet *dev = netdev_priv(net);
844 if (!dev->mii.mdio_write)
847 return mii_nway_restart(&dev->mii);
849 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
851 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
853 struct usbnet *dev = netdev_priv(net);
855 strncpy (info->driver, dev->driver_name, sizeof info->driver);
856 strncpy (info->version, DRIVER_VERSION, sizeof info->version);
857 strncpy (info->fw_version, dev->driver_info->description,
858 sizeof info->fw_version);
859 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
861 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
863 u32 usbnet_get_msglevel (struct net_device *net)
865 struct usbnet *dev = netdev_priv(net);
867 return dev->msg_enable;
869 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
871 void usbnet_set_msglevel (struct net_device *net, u32 level)
873 struct usbnet *dev = netdev_priv(net);
875 dev->msg_enable = level;
877 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
879 /* drivers may override default ethtool_ops in their bind() routine */
880 static const struct ethtool_ops usbnet_ethtool_ops = {
881 .get_settings = usbnet_get_settings,
882 .set_settings = usbnet_set_settings,
883 .get_link = usbnet_get_link,
884 .nway_reset = usbnet_nway_reset,
885 .get_drvinfo = usbnet_get_drvinfo,
886 .get_msglevel = usbnet_get_msglevel,
887 .set_msglevel = usbnet_set_msglevel,
890 /*-------------------------------------------------------------------------*/
892 /* work that cannot be done in interrupt context uses keventd.
894 * NOTE: with 2.5 we could do more of this using completion callbacks,
895 * especially now that control transfers can be queued.
898 kevent (struct work_struct *work)
901 container_of(work, struct usbnet, kevent);
904 /* usb_clear_halt() needs a thread context */
905 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
906 unlink_urbs (dev, &dev->txq);
907 status = usb_autopm_get_interface(dev->intf);
910 status = usb_clear_halt (dev->udev, dev->out);
911 usb_autopm_put_interface(dev->intf);
914 status != -ESHUTDOWN) {
915 if (netif_msg_tx_err (dev))
917 netdev_err(dev->net, "can't clear tx halt, status %d\n",
920 clear_bit (EVENT_TX_HALT, &dev->flags);
921 if (status != -ESHUTDOWN)
922 netif_wake_queue (dev->net);
925 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
926 unlink_urbs (dev, &dev->rxq);
927 status = usb_autopm_get_interface(dev->intf);
930 status = usb_clear_halt (dev->udev, dev->in);
931 usb_autopm_put_interface(dev->intf);
934 status != -ESHUTDOWN) {
935 if (netif_msg_rx_err (dev))
937 netdev_err(dev->net, "can't clear rx halt, status %d\n",
940 clear_bit (EVENT_RX_HALT, &dev->flags);
941 tasklet_schedule (&dev->bh);
945 /* tasklet could resubmit itself forever if memory is tight */
946 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
947 struct urb *urb = NULL;
950 if (netif_running (dev->net))
951 urb = usb_alloc_urb (0, GFP_KERNEL);
953 clear_bit (EVENT_RX_MEMORY, &dev->flags);
955 clear_bit (EVENT_RX_MEMORY, &dev->flags);
956 status = usb_autopm_get_interface(dev->intf);
961 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
963 usb_autopm_put_interface(dev->intf);
966 tasklet_schedule (&dev->bh);
970 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
971 struct driver_info *info = dev->driver_info;
974 clear_bit (EVENT_LINK_RESET, &dev->flags);
975 status = usb_autopm_get_interface(dev->intf);
978 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
979 usb_autopm_put_interface(dev->intf);
981 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
983 dev->udev->bus->bus_name,
987 usb_autopm_put_interface(dev->intf);
992 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
995 /*-------------------------------------------------------------------------*/
997 static void tx_complete (struct urb *urb)
999 struct sk_buff *skb = (struct sk_buff *) urb->context;
1000 struct skb_data *entry = (struct skb_data *) skb->cb;
1001 struct usbnet *dev = entry->dev;
1003 if (urb->status == 0) {
1004 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1005 dev->net->stats.tx_packets++;
1006 dev->net->stats.tx_bytes += entry->length;
1008 dev->net->stats.tx_errors++;
1010 switch (urb->status) {
1012 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1015 /* software-driven interface shutdown */
1016 case -ECONNRESET: // async unlink
1017 case -ESHUTDOWN: // hardware gone
1020 // like rx, tx gets controller i/o faults during khubd delays
1021 // and so it uses the same throttling mechanism.
1025 usb_mark_last_busy(dev->udev);
1026 if (!timer_pending (&dev->delay)) {
1027 mod_timer (&dev->delay,
1028 jiffies + THROTTLE_JIFFIES);
1029 netif_dbg(dev, link, dev->net,
1030 "tx throttle %d\n", urb->status);
1032 netif_stop_queue (dev->net);
1035 netif_dbg(dev, tx_err, dev->net,
1036 "tx err %d\n", entry->urb->status);
1041 usb_autopm_put_interface_async(dev->intf);
1042 entry->state = tx_done;
1043 defer_bh(dev, skb, &dev->txq);
1046 /*-------------------------------------------------------------------------*/
1048 void usbnet_tx_timeout (struct net_device *net)
1050 struct usbnet *dev = netdev_priv(net);
1052 unlink_urbs (dev, &dev->txq);
1053 tasklet_schedule (&dev->bh);
1055 // FIXME: device recovery -- reset?
1057 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1059 /*-------------------------------------------------------------------------*/
1061 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1062 struct net_device *net)
1064 struct usbnet *dev = netdev_priv(net);
1066 struct urb *urb = NULL;
1067 struct skb_data *entry;
1068 struct driver_info *info = dev->driver_info;
1069 unsigned long flags;
1073 skb_tx_timestamp(skb);
1075 // some devices want funky USB-level framing, for
1076 // win32 driver (usually) and/or hardware quirks
1077 if (info->tx_fixup) {
1078 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1080 if (netif_msg_tx_err(dev)) {
1081 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1084 /* cdc_ncm collected packet; waits for more */
1091 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1092 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1096 entry = (struct skb_data *) skb->cb;
1099 entry->state = tx_start;
1100 entry->length = length;
1102 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1103 skb->data, skb->len, tx_complete, skb);
1105 /* don't assume the hardware handles USB_ZERO_PACKET
1106 * NOTE: strictly conforming cdc-ether devices should expect
1107 * the ZLP here, but ignore the one-byte packet.
1108 * NOTE2: CDC NCM specification is different from CDC ECM when
1109 * handling ZLP/short packets, so cdc_ncm driver will make short
1110 * packet itself if needed.
1112 if (length % dev->maxpacket == 0) {
1113 if (!(info->flags & FLAG_SEND_ZLP)) {
1114 if (!(info->flags & FLAG_MULTI_PACKET)) {
1115 urb->transfer_buffer_length++;
1116 if (skb_tailroom(skb)) {
1117 skb->data[skb->len] = 0;
1122 urb->transfer_flags |= URB_ZERO_PACKET;
1125 spin_lock_irqsave(&dev->txq.lock, flags);
1126 retval = usb_autopm_get_interface_async(dev->intf);
1128 spin_unlock_irqrestore(&dev->txq.lock, flags);
1133 /* if this triggers the device is still a sleep */
1134 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1135 /* transmission will be done in resume */
1136 usb_anchor_urb(urb, &dev->deferred);
1137 /* no use to process more packets */
1138 netif_stop_queue(net);
1139 spin_unlock_irqrestore(&dev->txq.lock, flags);
1140 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1145 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1147 netif_stop_queue (net);
1148 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1149 usb_autopm_put_interface_async(dev->intf);
1152 usb_autopm_put_interface_async(dev->intf);
1153 netif_dbg(dev, tx_err, dev->net,
1154 "tx: submit urb err %d\n", retval);
1157 net->trans_start = jiffies;
1158 __skb_queue_tail (&dev->txq, skb);
1159 if (dev->txq.qlen >= TX_QLEN (dev))
1160 netif_stop_queue (net);
1162 spin_unlock_irqrestore (&dev->txq.lock, flags);
1165 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1167 dev->net->stats.tx_dropped++;
1170 dev_kfree_skb_any (skb);
1173 netif_dbg(dev, tx_queued, dev->net,
1174 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1178 return NETDEV_TX_OK;
1180 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1182 /*-------------------------------------------------------------------------*/
1184 // tasklet (work deferred from completions, in_irq) or timer
1186 static void usbnet_bh (unsigned long param)
1188 struct usbnet *dev = (struct usbnet *) param;
1189 struct sk_buff *skb;
1190 struct skb_data *entry;
1192 while ((skb = skb_dequeue (&dev->done))) {
1193 entry = (struct skb_data *) skb->cb;
1194 switch (entry->state) {
1196 entry->state = rx_cleanup;
1197 rx_process (dev, skb);
1201 usb_free_urb (entry->urb);
1202 dev_kfree_skb (skb);
1205 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1209 // waiting for all pending urbs to complete?
1211 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1212 wake_up (dev->wait);
1215 // or are we maybe short a few urbs?
1216 } else if (netif_running (dev->net) &&
1217 netif_device_present (dev->net) &&
1218 !timer_pending (&dev->delay) &&
1219 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1220 int temp = dev->rxq.qlen;
1221 int qlen = RX_QLEN (dev);
1227 // don't refill the queue all at once
1228 for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1229 urb = usb_alloc_urb (0, GFP_ATOMIC);
1231 if (rx_submit (dev, urb, GFP_ATOMIC) ==
1236 if (temp != dev->rxq.qlen)
1237 netif_dbg(dev, link, dev->net,
1238 "rxqlen %d --> %d\n",
1239 temp, dev->rxq.qlen);
1240 if (dev->rxq.qlen < qlen)
1241 tasklet_schedule (&dev->bh);
1243 if (dev->txq.qlen < TX_QLEN (dev))
1244 netif_wake_queue (dev->net);
1249 /*-------------------------------------------------------------------------
1251 * USB Device Driver support
1253 *-------------------------------------------------------------------------*/
1255 // precondition: never called in_interrupt
1257 void usbnet_disconnect (struct usb_interface *intf)
1260 struct usb_device *xdev;
1261 struct net_device *net;
1263 dev = usb_get_intfdata(intf);
1264 usb_set_intfdata(intf, NULL);
1268 xdev = interface_to_usbdev (intf);
1270 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1271 intf->dev.driver->name,
1272 xdev->bus->bus_name, xdev->devpath,
1273 dev->driver_info->description);
1276 unregister_netdev (net);
1278 cancel_work_sync(&dev->kevent);
1280 if (dev->driver_info->unbind)
1281 dev->driver_info->unbind (dev, intf);
1283 usb_kill_urb(dev->interrupt);
1284 usb_free_urb(dev->interrupt);
1289 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1291 static const struct net_device_ops usbnet_netdev_ops = {
1292 .ndo_open = usbnet_open,
1293 .ndo_stop = usbnet_stop,
1294 .ndo_start_xmit = usbnet_start_xmit,
1295 .ndo_tx_timeout = usbnet_tx_timeout,
1296 .ndo_change_mtu = usbnet_change_mtu,
1297 .ndo_set_mac_address = eth_mac_addr,
1298 .ndo_validate_addr = eth_validate_addr,
1301 /*-------------------------------------------------------------------------*/
1303 // precondition: never called in_interrupt
1305 static struct device_type wlan_type = {
1309 static struct device_type wwan_type = {
1314 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1317 struct net_device *net;
1318 struct usb_host_interface *interface;
1319 struct driver_info *info;
1320 struct usb_device *xdev;
1323 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1325 /* usbnet already took usb runtime pm, so have to enable the feature
1326 * for usb interface, otherwise usb_autopm_get_interface may return
1327 * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1329 if (!driver->supports_autosuspend) {
1330 driver->supports_autosuspend = 1;
1331 pm_runtime_enable(&udev->dev);
1334 name = udev->dev.driver->name;
1335 info = (struct driver_info *) prod->driver_info;
1337 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1340 xdev = interface_to_usbdev (udev);
1341 interface = udev->cur_altsetting;
1347 // set up our own records
1348 net = alloc_etherdev(sizeof(*dev));
1352 /* netdev_printk() needs this so do it as early as possible */
1353 SET_NETDEV_DEV(net, &udev->dev);
1355 dev = netdev_priv(net);
1358 dev->driver_info = info;
1359 dev->driver_name = name;
1360 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1361 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1362 skb_queue_head_init (&dev->rxq);
1363 skb_queue_head_init (&dev->txq);
1364 skb_queue_head_init (&dev->done);
1365 skb_queue_head_init(&dev->rxq_pause);
1366 dev->bh.func = usbnet_bh;
1367 dev->bh.data = (unsigned long) dev;
1368 INIT_WORK (&dev->kevent, kevent);
1369 init_usb_anchor(&dev->deferred);
1370 dev->delay.function = usbnet_bh;
1371 dev->delay.data = (unsigned long) dev;
1372 init_timer (&dev->delay);
1373 mutex_init (&dev->phy_mutex);
1376 strcpy (net->name, "usb%d");
1377 memcpy (net->dev_addr, node_id, sizeof node_id);
1379 /* rx and tx sides can use different message sizes;
1380 * bind() should set rx_urb_size in that case.
1382 dev->hard_mtu = net->mtu + net->hard_header_len;
1384 // dma_supported() is deeply broken on almost all architectures
1385 // possible with some EHCI controllers
1386 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1387 net->features |= NETIF_F_HIGHDMA;
1390 net->netdev_ops = &usbnet_netdev_ops;
1391 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1392 net->ethtool_ops = &usbnet_ethtool_ops;
1394 // allow device-specific bind/init procedures
1395 // NOTE net->name still not usable ...
1397 status = info->bind (dev, udev);
1401 // heuristic: "usb%d" for links we know are two-host,
1402 // else "eth%d" when there's reasonable doubt. userspace
1403 // can rename the link if it knows better.
1404 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1405 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1406 (net->dev_addr [0] & 0x02) == 0))
1407 strcpy (net->name, "eth%d");
1408 /* WLAN devices should always be named "wlan%d" */
1409 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1410 strcpy(net->name, "wlan%d");
1411 /* WWAN devices should always be named "wwan%d" */
1412 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1413 strcpy(net->name, "wwan%d");
1415 /* maybe the remote can't receive an Ethernet MTU */
1416 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1417 net->mtu = dev->hard_mtu - net->hard_header_len;
1418 } else if (!info->in || !info->out)
1419 status = usbnet_get_endpoints (dev, udev);
1421 dev->in = usb_rcvbulkpipe (xdev, info->in);
1422 dev->out = usb_sndbulkpipe (xdev, info->out);
1423 if (!(info->flags & FLAG_NO_SETINT))
1424 status = usb_set_interface (xdev,
1425 interface->desc.bInterfaceNumber,
1426 interface->desc.bAlternateSetting);
1431 if (status >= 0 && dev->status)
1432 status = init_status (dev, udev);
1436 if (!dev->rx_urb_size)
1437 dev->rx_urb_size = dev->hard_mtu;
1438 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1440 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1441 SET_NETDEV_DEVTYPE(net, &wlan_type);
1442 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1443 SET_NETDEV_DEVTYPE(net, &wwan_type);
1445 status = register_netdev (net);
1448 netif_info(dev, probe, dev->net,
1449 "register '%s' at usb-%s-%s, %s, %pM\n",
1450 udev->dev.driver->name,
1451 xdev->bus->bus_name, xdev->devpath,
1452 dev->driver_info->description,
1455 // ok, it's ready to go.
1456 usb_set_intfdata (udev, dev);
1458 netif_device_attach (net);
1460 if (dev->driver_info->flags & FLAG_LINK_INTR)
1461 netif_carrier_off(net);
1466 usb_free_urb(dev->interrupt);
1469 info->unbind (dev, udev);
1476 EXPORT_SYMBOL_GPL(usbnet_probe);
1478 /*-------------------------------------------------------------------------*/
1481 * suspend the whole driver as soon as the first interface is suspended
1482 * resume only when the last interface is resumed
1485 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1487 struct usbnet *dev = usb_get_intfdata(intf);
1489 if (!dev->suspend_count++) {
1490 spin_lock_irq(&dev->txq.lock);
1491 /* don't autosuspend while transmitting */
1492 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1493 spin_unlock_irq(&dev->txq.lock);
1496 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1497 spin_unlock_irq(&dev->txq.lock);
1500 * accelerate emptying of the rx and queues, to avoid
1501 * having everything error out.
1503 netif_device_detach (dev->net);
1504 usbnet_terminate_urbs(dev);
1505 usb_kill_urb(dev->interrupt);
1508 * reattach so runtime management can use and
1511 netif_device_attach (dev->net);
1515 EXPORT_SYMBOL_GPL(usbnet_suspend);
1517 int usbnet_resume (struct usb_interface *intf)
1519 struct usbnet *dev = usb_get_intfdata(intf);
1520 struct sk_buff *skb;
1524 if (!--dev->suspend_count) {
1525 /* resume interrupt URBs */
1526 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1527 usb_submit_urb(dev->interrupt, GFP_NOIO);
1529 spin_lock_irq(&dev->txq.lock);
1530 while ((res = usb_get_from_anchor(&dev->deferred))) {
1532 skb = (struct sk_buff *)res->context;
1533 retval = usb_submit_urb(res, GFP_ATOMIC);
1535 dev_kfree_skb_any(skb);
1537 usb_autopm_put_interface_async(dev->intf);
1539 dev->net->trans_start = jiffies;
1540 __skb_queue_tail(&dev->txq, skb);
1545 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1546 spin_unlock_irq(&dev->txq.lock);
1548 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1549 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1550 netif_tx_wake_all_queues(dev->net);
1551 tasklet_schedule (&dev->bh);
1556 EXPORT_SYMBOL_GPL(usbnet_resume);
1559 /*-------------------------------------------------------------------------*/
1561 static int __init usbnet_init(void)
1563 /* Compiler should optimize this out. */
1565 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1567 random_ether_addr(node_id);
1570 module_init(usbnet_init);
1572 static void __exit usbnet_exit(void)
1575 module_exit(usbnet_exit);
1577 MODULE_AUTHOR("David Brownell");
1578 MODULE_DESCRIPTION("USB network driver framework");
1579 MODULE_LICENSE("GPL");