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 altsetttings.
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);
214 "status ep%din, %d bytes period %d\n",
215 usb_pipeendpoint(pipe), maxp, period);
221 /* Passes this packet up the stack, updating its accounting.
222 * Some link protocols batch packets, so their rx_fixup paths
223 * can return clones as well as just modify the original skb.
225 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
229 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
230 skb_queue_tail(&dev->rxq_pause, skb);
234 skb->protocol = eth_type_trans (skb, dev->net);
235 dev->net->stats.rx_packets++;
236 dev->net->stats.rx_bytes += skb->len;
238 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
239 skb->len + sizeof (struct ethhdr), skb->protocol);
240 memset (skb->cb, 0, sizeof (struct skb_data));
241 status = netif_rx (skb);
242 if (status != NET_RX_SUCCESS)
243 netif_dbg(dev, rx_err, dev->net,
244 "netif_rx status %d\n", status);
246 EXPORT_SYMBOL_GPL(usbnet_skb_return);
249 /*-------------------------------------------------------------------------
251 * Network Device Driver (peer link to "Host Device", from USB host)
253 *-------------------------------------------------------------------------*/
255 int usbnet_change_mtu (struct net_device *net, int new_mtu)
257 struct usbnet *dev = netdev_priv(net);
258 int ll_mtu = new_mtu + net->hard_header_len;
259 int old_hard_mtu = dev->hard_mtu;
260 int old_rx_urb_size = dev->rx_urb_size;
264 // no second zero-length packet read wanted after mtu-sized packets
265 if ((ll_mtu % dev->maxpacket) == 0)
269 dev->hard_mtu = net->mtu + net->hard_header_len;
270 if (dev->rx_urb_size == old_hard_mtu) {
271 dev->rx_urb_size = dev->hard_mtu;
272 if (dev->rx_urb_size > old_rx_urb_size)
273 usbnet_unlink_rx_urbs(dev);
278 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
280 /*-------------------------------------------------------------------------*/
282 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
283 * completion callbacks. 2.5 should have fixed those bugs...
286 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
290 spin_lock_irqsave(&list->lock, flags);
291 __skb_unlink(skb, list);
292 spin_unlock(&list->lock);
293 spin_lock(&dev->done.lock);
294 __skb_queue_tail(&dev->done, skb);
295 if (dev->done.qlen == 1)
296 tasklet_schedule(&dev->bh);
297 spin_unlock_irqrestore(&dev->done.lock, flags);
300 /* some work can't be done in tasklets, so we use keventd
302 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
303 * but tasklet_schedule() doesn't. hope the failure is rare.
305 void usbnet_defer_kevent (struct usbnet *dev, int work)
307 set_bit (work, &dev->flags);
308 if (!schedule_work (&dev->kevent))
309 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
311 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
313 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
315 /*-------------------------------------------------------------------------*/
317 static void rx_complete (struct urb *urb);
319 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
322 struct skb_data *entry;
324 unsigned long lockflags;
325 size_t size = dev->rx_urb_size;
327 if ((skb = alloc_skb (size + NET_IP_ALIGN, flags)) == NULL) {
328 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
329 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
333 skb_reserve (skb, NET_IP_ALIGN);
335 entry = (struct skb_data *) skb->cb;
338 entry->state = rx_start;
341 usb_fill_bulk_urb (urb, dev->udev, dev->in,
342 skb->data, size, rx_complete, skb);
344 spin_lock_irqsave (&dev->rxq.lock, lockflags);
346 if (netif_running (dev->net) &&
347 netif_device_present (dev->net) &&
348 !test_bit (EVENT_RX_HALT, &dev->flags) &&
349 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
350 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
352 usbnet_defer_kevent (dev, EVENT_RX_HALT);
355 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
358 netif_dbg(dev, ifdown, dev->net, "device gone\n");
359 netif_device_detach (dev->net);
365 netif_dbg(dev, rx_err, dev->net,
366 "rx submit, %d\n", retval);
367 tasklet_schedule (&dev->bh);
370 __skb_queue_tail (&dev->rxq, skb);
373 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
376 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
378 dev_kfree_skb_any (skb);
385 /*-------------------------------------------------------------------------*/
387 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
389 if (dev->driver_info->rx_fixup &&
390 !dev->driver_info->rx_fixup (dev, skb))
392 // else network stack removes extra byte if we forced a short packet
395 usbnet_skb_return (dev, skb);
397 netif_dbg(dev, rx_err, dev->net, "drop\n");
399 dev->net->stats.rx_errors++;
400 skb_queue_tail (&dev->done, skb);
404 /*-------------------------------------------------------------------------*/
406 static void rx_complete (struct urb *urb)
408 struct sk_buff *skb = (struct sk_buff *) urb->context;
409 struct skb_data *entry = (struct skb_data *) skb->cb;
410 struct usbnet *dev = entry->dev;
411 int urb_status = urb->status;
413 skb_put (skb, urb->actual_length);
414 entry->state = rx_done;
417 switch (urb_status) {
420 if (skb->len < dev->net->hard_header_len) {
421 entry->state = rx_cleanup;
422 dev->net->stats.rx_errors++;
423 dev->net->stats.rx_length_errors++;
424 netif_dbg(dev, rx_err, dev->net,
425 "rx length %d\n", skb->len);
429 /* stalls need manual reset. this is rare ... except that
430 * when going through USB 2.0 TTs, unplug appears this way.
431 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
432 * storm, recovering as needed.
435 dev->net->stats.rx_errors++;
436 usbnet_defer_kevent (dev, EVENT_RX_HALT);
439 /* software-driven interface shutdown */
440 case -ECONNRESET: /* async unlink */
441 case -ESHUTDOWN: /* hardware gone */
442 netif_dbg(dev, ifdown, dev->net,
443 "rx shutdown, code %d\n", urb_status);
446 /* we get controller i/o faults during khubd disconnect() delays.
447 * throttle down resubmits, to avoid log floods; just temporarily,
448 * so we still recover when the fault isn't a khubd delay.
453 dev->net->stats.rx_errors++;
454 if (!timer_pending (&dev->delay)) {
455 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
456 netif_dbg(dev, link, dev->net,
457 "rx throttle %d\n", urb_status);
460 entry->state = rx_cleanup;
465 /* data overrun ... flush fifo? */
467 dev->net->stats.rx_over_errors++;
471 entry->state = rx_cleanup;
472 dev->net->stats.rx_errors++;
473 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
477 defer_bh(dev, skb, &dev->rxq);
480 if (netif_running (dev->net) &&
481 !test_bit (EVENT_RX_HALT, &dev->flags)) {
482 rx_submit (dev, urb, GFP_ATOMIC);
487 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
490 static void intr_complete (struct urb *urb)
492 struct usbnet *dev = urb->context;
493 int status = urb->status;
498 dev->driver_info->status(dev, urb);
501 /* software-driven interface shutdown */
502 case -ENOENT: /* urb killed */
503 case -ESHUTDOWN: /* hardware gone */
504 netif_dbg(dev, ifdown, dev->net,
505 "intr shutdown, code %d\n", status);
508 /* NOTE: not throttling like RX/TX, since this endpoint
509 * already polls infrequently
512 netdev_dbg(dev->net, "intr status %d\n", status);
516 if (!netif_running (dev->net))
519 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
520 status = usb_submit_urb (urb, GFP_ATOMIC);
522 netif_err(dev, timer, dev->net,
523 "intr resubmit --> %d\n", status);
526 /*-------------------------------------------------------------------------*/
527 void usbnet_pause_rx(struct usbnet *dev)
529 set_bit(EVENT_RX_PAUSED, &dev->flags);
531 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
533 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
535 void usbnet_resume_rx(struct usbnet *dev)
540 clear_bit(EVENT_RX_PAUSED, &dev->flags);
542 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
543 usbnet_skb_return(dev, skb);
547 tasklet_schedule(&dev->bh);
549 netif_dbg(dev, rx_status, dev->net,
550 "paused rx queue disabled, %d skbs requeued\n", num);
552 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
554 void usbnet_purge_paused_rxq(struct usbnet *dev)
556 skb_queue_purge(&dev->rxq_pause);
558 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
560 /*-------------------------------------------------------------------------*/
562 // unlink pending rx/tx; completion handlers do all other cleanup
564 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
567 struct sk_buff *skb, *skbnext;
570 spin_lock_irqsave (&q->lock, flags);
571 skb_queue_walk_safe(q, skb, skbnext) {
572 struct skb_data *entry;
576 entry = (struct skb_data *) skb->cb;
579 // during some PM-driven resume scenarios,
580 // these (async) unlinks complete immediately
581 retval = usb_unlink_urb (urb);
582 if (retval != -EINPROGRESS && retval != 0)
583 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
587 spin_unlock_irqrestore (&q->lock, flags);
591 // Flush all pending rx urbs
592 // minidrivers may need to do this when the MTU changes
594 void usbnet_unlink_rx_urbs(struct usbnet *dev)
596 if (netif_running(dev->net)) {
597 (void) unlink_urbs (dev, &dev->rxq);
598 tasklet_schedule(&dev->bh);
601 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
603 /*-------------------------------------------------------------------------*/
605 // precondition: never called in_interrupt
606 static void usbnet_terminate_urbs(struct usbnet *dev)
608 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
609 DECLARE_WAITQUEUE(wait, current);
612 /* ensure there are no more active urbs */
613 add_wait_queue(&unlink_wakeup, &wait);
614 set_current_state(TASK_UNINTERRUPTIBLE);
615 dev->wait = &unlink_wakeup;
616 temp = unlink_urbs(dev, &dev->txq) +
617 unlink_urbs(dev, &dev->rxq);
619 /* maybe wait for deletions to finish. */
620 while (!skb_queue_empty(&dev->rxq)
621 && !skb_queue_empty(&dev->txq)
622 && !skb_queue_empty(&dev->done)) {
623 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
624 set_current_state(TASK_UNINTERRUPTIBLE);
625 netif_dbg(dev, ifdown, dev->net,
626 "waited for %d urb completions\n", temp);
628 set_current_state(TASK_RUNNING);
630 remove_wait_queue(&unlink_wakeup, &wait);
633 int usbnet_stop (struct net_device *net)
635 struct usbnet *dev = netdev_priv(net);
636 struct driver_info *info = dev->driver_info;
639 netif_stop_queue (net);
641 netif_info(dev, ifdown, dev->net,
642 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
643 net->stats.rx_packets, net->stats.tx_packets,
644 net->stats.rx_errors, net->stats.tx_errors);
646 /* allow minidriver to stop correctly (wireless devices to turn off
649 retval = info->stop(dev);
651 netif_info(dev, ifdown, dev->net,
652 "stop fail (%d) usbnet usb-%s-%s, %s\n",
654 dev->udev->bus->bus_name, dev->udev->devpath,
658 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
659 usbnet_terminate_urbs(dev);
661 usb_kill_urb(dev->interrupt);
663 usbnet_purge_paused_rxq(dev);
665 /* deferred work (task, timer, softirq) must also stop.
666 * can't flush_scheduled_work() until we drop rtnl (later),
667 * else workers could deadlock; so make workers a NOP.
670 del_timer_sync (&dev->delay);
671 tasklet_kill (&dev->bh);
672 if (info->manage_power)
673 info->manage_power(dev, 0);
675 usb_autopm_put_interface(dev->intf);
679 EXPORT_SYMBOL_GPL(usbnet_stop);
681 /*-------------------------------------------------------------------------*/
683 // posts reads, and enables write queuing
685 // precondition: never called in_interrupt
687 int usbnet_open (struct net_device *net)
689 struct usbnet *dev = netdev_priv(net);
691 struct driver_info *info = dev->driver_info;
693 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
694 netif_info(dev, ifup, dev->net,
695 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
697 dev->udev->bus->bus_name,
703 // put into "known safe" state
704 if (info->reset && (retval = info->reset (dev)) < 0) {
705 netif_info(dev, ifup, dev->net,
706 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
708 dev->udev->bus->bus_name,
714 // insist peer be connected
715 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
716 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
720 /* start any status interrupt transfer */
721 if (dev->interrupt) {
722 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
724 netif_err(dev, ifup, dev->net,
725 "intr submit %d\n", retval);
730 netif_start_queue (net);
731 netif_info(dev, ifup, dev->net,
732 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
733 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
735 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
736 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
737 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
738 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
739 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
742 // delay posting reads until we're fully open
743 tasklet_schedule (&dev->bh);
744 if (info->manage_power) {
745 retval = info->manage_power(dev, 1);
748 usb_autopm_put_interface(dev->intf);
753 usb_autopm_put_interface(dev->intf);
757 EXPORT_SYMBOL_GPL(usbnet_open);
759 /*-------------------------------------------------------------------------*/
761 /* ethtool methods; minidrivers may need to add some more, but
762 * they'll probably want to use this base set.
765 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
767 struct usbnet *dev = netdev_priv(net);
769 if (!dev->mii.mdio_read)
772 return mii_ethtool_gset(&dev->mii, cmd);
774 EXPORT_SYMBOL_GPL(usbnet_get_settings);
776 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
778 struct usbnet *dev = netdev_priv(net);
781 if (!dev->mii.mdio_write)
784 retval = mii_ethtool_sset(&dev->mii, cmd);
786 /* link speed/duplex might have changed */
787 if (dev->driver_info->link_reset)
788 dev->driver_info->link_reset(dev);
793 EXPORT_SYMBOL_GPL(usbnet_set_settings);
795 u32 usbnet_get_link (struct net_device *net)
797 struct usbnet *dev = netdev_priv(net);
799 /* If a check_connect is defined, return its result */
800 if (dev->driver_info->check_connect)
801 return dev->driver_info->check_connect (dev) == 0;
803 /* if the device has mii operations, use those */
804 if (dev->mii.mdio_read)
805 return mii_link_ok(&dev->mii);
807 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
808 return ethtool_op_get_link(net);
810 EXPORT_SYMBOL_GPL(usbnet_get_link);
812 int usbnet_nway_reset(struct net_device *net)
814 struct usbnet *dev = netdev_priv(net);
816 if (!dev->mii.mdio_write)
819 return mii_nway_restart(&dev->mii);
821 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
823 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
825 struct usbnet *dev = netdev_priv(net);
827 strncpy (info->driver, dev->driver_name, sizeof info->driver);
828 strncpy (info->version, DRIVER_VERSION, sizeof info->version);
829 strncpy (info->fw_version, dev->driver_info->description,
830 sizeof info->fw_version);
831 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
833 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
835 u32 usbnet_get_msglevel (struct net_device *net)
837 struct usbnet *dev = netdev_priv(net);
839 return dev->msg_enable;
841 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
843 void usbnet_set_msglevel (struct net_device *net, u32 level)
845 struct usbnet *dev = netdev_priv(net);
847 dev->msg_enable = level;
849 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
851 /* drivers may override default ethtool_ops in their bind() routine */
852 static const struct ethtool_ops usbnet_ethtool_ops = {
853 .get_settings = usbnet_get_settings,
854 .set_settings = usbnet_set_settings,
855 .get_link = usbnet_get_link,
856 .nway_reset = usbnet_nway_reset,
857 .get_drvinfo = usbnet_get_drvinfo,
858 .get_msglevel = usbnet_get_msglevel,
859 .set_msglevel = usbnet_set_msglevel,
862 /*-------------------------------------------------------------------------*/
864 /* work that cannot be done in interrupt context uses keventd.
866 * NOTE: with 2.5 we could do more of this using completion callbacks,
867 * especially now that control transfers can be queued.
870 kevent (struct work_struct *work)
873 container_of(work, struct usbnet, kevent);
876 /* usb_clear_halt() needs a thread context */
877 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
878 unlink_urbs (dev, &dev->txq);
879 status = usb_autopm_get_interface(dev->intf);
882 status = usb_clear_halt (dev->udev, dev->out);
883 usb_autopm_put_interface(dev->intf);
886 status != -ESHUTDOWN) {
887 if (netif_msg_tx_err (dev))
889 netdev_err(dev->net, "can't clear tx halt, status %d\n",
892 clear_bit (EVENT_TX_HALT, &dev->flags);
893 if (status != -ESHUTDOWN)
894 netif_wake_queue (dev->net);
897 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
898 unlink_urbs (dev, &dev->rxq);
899 status = usb_autopm_get_interface(dev->intf);
902 status = usb_clear_halt (dev->udev, dev->in);
903 usb_autopm_put_interface(dev->intf);
906 status != -ESHUTDOWN) {
907 if (netif_msg_rx_err (dev))
909 netdev_err(dev->net, "can't clear rx halt, status %d\n",
912 clear_bit (EVENT_RX_HALT, &dev->flags);
913 tasklet_schedule (&dev->bh);
917 /* tasklet could resubmit itself forever if memory is tight */
918 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
919 struct urb *urb = NULL;
922 if (netif_running (dev->net))
923 urb = usb_alloc_urb (0, GFP_KERNEL);
925 clear_bit (EVENT_RX_MEMORY, &dev->flags);
927 clear_bit (EVENT_RX_MEMORY, &dev->flags);
928 status = usb_autopm_get_interface(dev->intf);
931 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
933 usb_autopm_put_interface(dev->intf);
936 tasklet_schedule (&dev->bh);
940 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
941 struct driver_info *info = dev->driver_info;
944 clear_bit (EVENT_LINK_RESET, &dev->flags);
945 status = usb_autopm_get_interface(dev->intf);
948 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
949 usb_autopm_put_interface(dev->intf);
951 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
953 dev->udev->bus->bus_name,
957 usb_autopm_put_interface(dev->intf);
962 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
965 /*-------------------------------------------------------------------------*/
967 static void tx_complete (struct urb *urb)
969 struct sk_buff *skb = (struct sk_buff *) urb->context;
970 struct skb_data *entry = (struct skb_data *) skb->cb;
971 struct usbnet *dev = entry->dev;
973 if (urb->status == 0) {
974 dev->net->stats.tx_packets++;
975 dev->net->stats.tx_bytes += entry->length;
977 dev->net->stats.tx_errors++;
979 switch (urb->status) {
981 usbnet_defer_kevent (dev, EVENT_TX_HALT);
984 /* software-driven interface shutdown */
985 case -ECONNRESET: // async unlink
986 case -ESHUTDOWN: // hardware gone
989 // like rx, tx gets controller i/o faults during khubd delays
990 // and so it uses the same throttling mechanism.
994 usb_mark_last_busy(dev->udev);
995 if (!timer_pending (&dev->delay)) {
996 mod_timer (&dev->delay,
997 jiffies + THROTTLE_JIFFIES);
998 netif_dbg(dev, link, dev->net,
999 "tx throttle %d\n", urb->status);
1001 netif_stop_queue (dev->net);
1004 netif_dbg(dev, tx_err, dev->net,
1005 "tx err %d\n", entry->urb->status);
1010 usb_autopm_put_interface_async(dev->intf);
1012 entry->state = tx_done;
1013 defer_bh(dev, skb, &dev->txq);
1016 /*-------------------------------------------------------------------------*/
1018 void usbnet_tx_timeout (struct net_device *net)
1020 struct usbnet *dev = netdev_priv(net);
1022 unlink_urbs (dev, &dev->txq);
1023 tasklet_schedule (&dev->bh);
1025 // FIXME: device recovery -- reset?
1027 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1029 /*-------------------------------------------------------------------------*/
1031 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1032 struct net_device *net)
1034 struct usbnet *dev = netdev_priv(net);
1036 struct urb *urb = NULL;
1037 struct skb_data *entry;
1038 struct driver_info *info = dev->driver_info;
1039 unsigned long flags;
1042 // some devices want funky USB-level framing, for
1043 // win32 driver (usually) and/or hardware quirks
1044 if (info->tx_fixup) {
1045 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1047 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1053 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1054 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1058 entry = (struct skb_data *) skb->cb;
1061 entry->state = tx_start;
1062 entry->length = length;
1064 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1065 skb->data, skb->len, tx_complete, skb);
1067 /* don't assume the hardware handles USB_ZERO_PACKET
1068 * NOTE: strictly conforming cdc-ether devices should expect
1069 * the ZLP here, but ignore the one-byte packet.
1071 if (length % dev->maxpacket == 0) {
1072 if (!(info->flags & FLAG_SEND_ZLP)) {
1073 urb->transfer_buffer_length++;
1074 if (skb_tailroom(skb)) {
1075 skb->data[skb->len] = 0;
1079 urb->transfer_flags |= URB_ZERO_PACKET;
1082 spin_lock_irqsave(&dev->txq.lock, flags);
1083 retval = usb_autopm_get_interface_async(dev->intf);
1085 spin_unlock_irqrestore(&dev->txq.lock, flags);
1090 /* if this triggers the device is still a sleep */
1091 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1092 /* transmission will be done in resume */
1093 usb_anchor_urb(urb, &dev->deferred);
1094 /* no use to process more packets */
1095 netif_stop_queue(net);
1096 spin_unlock_irqrestore(&dev->txq.lock, flags);
1097 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1102 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1104 netif_stop_queue (net);
1105 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1106 usb_autopm_put_interface_async(dev->intf);
1109 usb_autopm_put_interface_async(dev->intf);
1110 netif_dbg(dev, tx_err, dev->net,
1111 "tx: submit urb err %d\n", retval);
1114 net->trans_start = jiffies;
1115 __skb_queue_tail (&dev->txq, skb);
1116 if (dev->txq.qlen >= TX_QLEN (dev))
1117 netif_stop_queue (net);
1119 spin_unlock_irqrestore (&dev->txq.lock, flags);
1122 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1124 dev->net->stats.tx_dropped++;
1126 dev_kfree_skb_any (skb);
1129 netif_dbg(dev, tx_queued, dev->net,
1130 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1134 return NETDEV_TX_OK;
1136 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1138 /*-------------------------------------------------------------------------*/
1140 // tasklet (work deferred from completions, in_irq) or timer
1142 static void usbnet_bh (unsigned long param)
1144 struct usbnet *dev = (struct usbnet *) param;
1145 struct sk_buff *skb;
1146 struct skb_data *entry;
1148 while ((skb = skb_dequeue (&dev->done))) {
1149 entry = (struct skb_data *) skb->cb;
1150 switch (entry->state) {
1152 entry->state = rx_cleanup;
1153 rx_process (dev, skb);
1157 usb_free_urb (entry->urb);
1158 dev_kfree_skb (skb);
1161 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1165 // waiting for all pending urbs to complete?
1167 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1168 wake_up (dev->wait);
1171 // or are we maybe short a few urbs?
1172 } else if (netif_running (dev->net) &&
1173 netif_device_present (dev->net) &&
1174 !timer_pending (&dev->delay) &&
1175 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1176 int temp = dev->rxq.qlen;
1177 int qlen = RX_QLEN (dev);
1183 // don't refill the queue all at once
1184 for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1185 urb = usb_alloc_urb (0, GFP_ATOMIC);
1187 if (rx_submit (dev, urb, GFP_ATOMIC) ==
1192 if (temp != dev->rxq.qlen)
1193 netif_dbg(dev, link, dev->net,
1194 "rxqlen %d --> %d\n",
1195 temp, dev->rxq.qlen);
1196 if (dev->rxq.qlen < qlen)
1197 tasklet_schedule (&dev->bh);
1199 if (dev->txq.qlen < TX_QLEN (dev))
1200 netif_wake_queue (dev->net);
1205 /*-------------------------------------------------------------------------
1207 * USB Device Driver support
1209 *-------------------------------------------------------------------------*/
1211 // precondition: never called in_interrupt
1213 void usbnet_disconnect (struct usb_interface *intf)
1216 struct usb_device *xdev;
1217 struct net_device *net;
1219 dev = usb_get_intfdata(intf);
1220 usb_set_intfdata(intf, NULL);
1224 xdev = interface_to_usbdev (intf);
1226 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1227 intf->dev.driver->name,
1228 xdev->bus->bus_name, xdev->devpath,
1229 dev->driver_info->description);
1232 unregister_netdev (net);
1234 /* we don't hold rtnl here ... */
1235 flush_scheduled_work ();
1237 if (dev->driver_info->unbind)
1238 dev->driver_info->unbind (dev, intf);
1243 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1245 static const struct net_device_ops usbnet_netdev_ops = {
1246 .ndo_open = usbnet_open,
1247 .ndo_stop = usbnet_stop,
1248 .ndo_start_xmit = usbnet_start_xmit,
1249 .ndo_tx_timeout = usbnet_tx_timeout,
1250 .ndo_change_mtu = usbnet_change_mtu,
1251 .ndo_set_mac_address = eth_mac_addr,
1252 .ndo_validate_addr = eth_validate_addr,
1255 /*-------------------------------------------------------------------------*/
1257 // precondition: never called in_interrupt
1259 static struct device_type wlan_type = {
1263 static struct device_type wwan_type = {
1268 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1271 struct net_device *net;
1272 struct usb_host_interface *interface;
1273 struct driver_info *info;
1274 struct usb_device *xdev;
1277 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1279 /* usbnet already took usb runtime pm, so have to enable the feature
1280 * for usb interface, otherwise usb_autopm_get_interface may return
1281 * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1283 if (!driver->supports_autosuspend) {
1284 driver->supports_autosuspend = 1;
1285 pm_runtime_enable(&udev->dev);
1288 name = udev->dev.driver->name;
1289 info = (struct driver_info *) prod->driver_info;
1291 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1294 xdev = interface_to_usbdev (udev);
1295 interface = udev->cur_altsetting;
1301 // set up our own records
1302 net = alloc_etherdev(sizeof(*dev));
1304 dbg ("can't kmalloc dev");
1308 /* netdev_printk() needs this so do it as early as possible */
1309 SET_NETDEV_DEV(net, &udev->dev);
1311 dev = netdev_priv(net);
1314 dev->driver_info = info;
1315 dev->driver_name = name;
1316 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1317 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1318 skb_queue_head_init (&dev->rxq);
1319 skb_queue_head_init (&dev->txq);
1320 skb_queue_head_init (&dev->done);
1321 skb_queue_head_init(&dev->rxq_pause);
1322 dev->bh.func = usbnet_bh;
1323 dev->bh.data = (unsigned long) dev;
1324 INIT_WORK (&dev->kevent, kevent);
1325 init_usb_anchor(&dev->deferred);
1326 dev->delay.function = usbnet_bh;
1327 dev->delay.data = (unsigned long) dev;
1328 init_timer (&dev->delay);
1329 mutex_init (&dev->phy_mutex);
1332 strcpy (net->name, "usb%d");
1333 memcpy (net->dev_addr, node_id, sizeof node_id);
1335 /* rx and tx sides can use different message sizes;
1336 * bind() should set rx_urb_size in that case.
1338 dev->hard_mtu = net->mtu + net->hard_header_len;
1340 // dma_supported() is deeply broken on almost all architectures
1341 // possible with some EHCI controllers
1342 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1343 net->features |= NETIF_F_HIGHDMA;
1346 net->netdev_ops = &usbnet_netdev_ops;
1347 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1348 net->ethtool_ops = &usbnet_ethtool_ops;
1350 // allow device-specific bind/init procedures
1351 // NOTE net->name still not usable ...
1353 status = info->bind (dev, udev);
1357 // heuristic: "usb%d" for links we know are two-host,
1358 // else "eth%d" when there's reasonable doubt. userspace
1359 // can rename the link if it knows better.
1360 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1361 (net->dev_addr [0] & 0x02) == 0)
1362 strcpy (net->name, "eth%d");
1363 /* WLAN devices should always be named "wlan%d" */
1364 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1365 strcpy(net->name, "wlan%d");
1366 /* WWAN devices should always be named "wwan%d" */
1367 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1368 strcpy(net->name, "wwan%d");
1370 /* maybe the remote can't receive an Ethernet MTU */
1371 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1372 net->mtu = dev->hard_mtu - net->hard_header_len;
1373 } else if (!info->in || !info->out)
1374 status = usbnet_get_endpoints (dev, udev);
1376 dev->in = usb_rcvbulkpipe (xdev, info->in);
1377 dev->out = usb_sndbulkpipe (xdev, info->out);
1378 if (!(info->flags & FLAG_NO_SETINT))
1379 status = usb_set_interface (xdev,
1380 interface->desc.bInterfaceNumber,
1381 interface->desc.bAlternateSetting);
1386 if (status >= 0 && dev->status)
1387 status = init_status (dev, udev);
1391 if (!dev->rx_urb_size)
1392 dev->rx_urb_size = dev->hard_mtu;
1393 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1395 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1396 SET_NETDEV_DEVTYPE(net, &wlan_type);
1397 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1398 SET_NETDEV_DEVTYPE(net, &wwan_type);
1400 status = register_netdev (net);
1403 netif_info(dev, probe, dev->net,
1404 "register '%s' at usb-%s-%s, %s, %pM\n",
1405 udev->dev.driver->name,
1406 xdev->bus->bus_name, xdev->devpath,
1407 dev->driver_info->description,
1410 // ok, it's ready to go.
1411 usb_set_intfdata (udev, dev);
1413 netif_device_attach (net);
1415 if (dev->driver_info->flags & FLAG_LINK_INTR)
1416 netif_carrier_off(net);
1422 info->unbind (dev, udev);
1429 EXPORT_SYMBOL_GPL(usbnet_probe);
1431 /*-------------------------------------------------------------------------*/
1434 * suspend the whole driver as soon as the first interface is suspended
1435 * resume only when the last interface is resumed
1438 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1440 struct usbnet *dev = usb_get_intfdata(intf);
1442 if (!dev->suspend_count++) {
1443 spin_lock_irq(&dev->txq.lock);
1444 /* don't autosuspend while transmitting */
1445 if (dev->txq.qlen && (message.event & PM_EVENT_AUTO)) {
1446 spin_unlock_irq(&dev->txq.lock);
1449 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1450 spin_unlock_irq(&dev->txq.lock);
1453 * accelerate emptying of the rx and queues, to avoid
1454 * having everything error out.
1456 netif_device_detach (dev->net);
1457 usbnet_terminate_urbs(dev);
1458 usb_kill_urb(dev->interrupt);
1461 * reattach so runtime management can use and
1464 netif_device_attach (dev->net);
1468 EXPORT_SYMBOL_GPL(usbnet_suspend);
1470 int usbnet_resume (struct usb_interface *intf)
1472 struct usbnet *dev = usb_get_intfdata(intf);
1473 struct sk_buff *skb;
1477 if (!--dev->suspend_count) {
1478 spin_lock_irq(&dev->txq.lock);
1479 while ((res = usb_get_from_anchor(&dev->deferred))) {
1481 skb = (struct sk_buff *)res->context;
1482 retval = usb_submit_urb(res, GFP_ATOMIC);
1484 dev_kfree_skb_any(skb);
1486 usb_autopm_put_interface_async(dev->intf);
1488 dev->net->trans_start = jiffies;
1489 __skb_queue_tail(&dev->txq, skb);
1494 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1495 spin_unlock_irq(&dev->txq.lock);
1496 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1497 netif_start_queue(dev->net);
1498 tasklet_schedule (&dev->bh);
1502 EXPORT_SYMBOL_GPL(usbnet_resume);
1505 /*-------------------------------------------------------------------------*/
1507 static int __init usbnet_init(void)
1509 /* compiler should optimize this out */
1510 BUILD_BUG_ON (sizeof (((struct sk_buff *)0)->cb)
1511 < sizeof (struct skb_data));
1513 random_ether_addr(node_id);
1516 module_init(usbnet_init);
1518 static void __exit usbnet_exit(void)
1521 module_exit(usbnet_exit);
1523 MODULE_AUTHOR("David Brownell");
1524 MODULE_DESCRIPTION("USB network driver framework");
1525 MODULE_LICENSE("GPL");