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/ethtool.h>
41 #include <linux/workqueue.h>
42 #include <linux/mii.h>
43 #include <linux/usb.h>
44 #include <linux/usb/usbnet.h>
46 #define DRIVER_VERSION "22-Aug-2005"
49 /*-------------------------------------------------------------------------*/
52 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
53 * Several dozen bytes of IPv4 data can fit in two such transactions.
54 * One maximum size Ethernet packet takes twenty four of them.
55 * For high speed, each frame comfortably fits almost 36 max size
56 * Ethernet packets (so queues should be bigger).
58 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
59 * let the USB host controller be busy for 5msec or more before an irq
60 * is required, under load. Jumbograms change the equation.
62 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
63 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
64 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
65 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
66 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
68 // reawaken network queue this soon after stopping; else watchdog barks
69 #define TX_TIMEOUT_JIFFIES (5*HZ)
71 // throttle rx/tx briefly after some faults, so khubd might disconnect()
72 // us (it polls at HZ/4 usually) before we report too many false errors.
73 #define THROTTLE_JIFFIES (HZ/8)
76 #define UNLINK_TIMEOUT_MS 3
78 /*-------------------------------------------------------------------------*/
80 // randomly generated ethernet address
81 static u8 node_id [ETH_ALEN];
83 static const char driver_name [] = "usbnet";
85 /* use ethtool to change the level for any given device */
86 static int msg_level = -1;
87 module_param (msg_level, int, 0);
88 MODULE_PARM_DESC (msg_level, "Override default message level");
90 /*-------------------------------------------------------------------------*/
92 /* handles CDC Ethernet and many other network "bulk data" interfaces */
93 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
96 struct usb_host_interface *alt = NULL;
97 struct usb_host_endpoint *in = NULL, *out = NULL;
98 struct usb_host_endpoint *status = NULL;
100 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
103 in = out = status = NULL;
104 alt = intf->altsetting + tmp;
106 /* take the first altsetting with in-bulk + out-bulk;
107 * remember any status endpoint, just in case;
108 * ignore other endpoints and altsetttings.
110 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
111 struct usb_host_endpoint *e;
114 e = alt->endpoint + ep;
115 switch (e->desc.bmAttributes) {
116 case USB_ENDPOINT_XFER_INT:
117 if (!usb_endpoint_dir_in(&e->desc))
121 case USB_ENDPOINT_XFER_BULK:
126 if (usb_endpoint_dir_in(&e->desc)) {
129 else if (intr && !status)
139 if (!alt || !in || !out)
142 if (alt->desc.bAlternateSetting != 0
143 || !(dev->driver_info->flags & FLAG_NO_SETINT)) {
144 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
145 alt->desc.bAlternateSetting);
150 dev->in = usb_rcvbulkpipe (dev->udev,
151 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
152 dev->out = usb_sndbulkpipe (dev->udev,
153 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
154 dev->status = status;
157 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
159 static void intr_complete (struct urb *urb);
161 static int init_status (struct usbnet *dev, struct usb_interface *intf)
168 if (!dev->driver_info->status)
171 pipe = usb_rcvintpipe (dev->udev,
172 dev->status->desc.bEndpointAddress
173 & USB_ENDPOINT_NUMBER_MASK);
174 maxp = usb_maxpacket (dev->udev, pipe, 0);
176 /* avoid 1 msec chatter: min 8 msec poll rate */
177 period = max ((int) dev->status->desc.bInterval,
178 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
180 buf = kmalloc (maxp, GFP_KERNEL);
182 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
183 if (!dev->interrupt) {
187 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
188 buf, maxp, intr_complete, dev, period);
190 "status ep%din, %d bytes period %d\n",
191 usb_pipeendpoint(pipe), maxp, period);
197 /* Passes this packet up the stack, updating its accounting.
198 * Some link protocols batch packets, so their rx_fixup paths
199 * can return clones as well as just modify the original skb.
201 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
205 skb->protocol = eth_type_trans (skb, dev->net);
206 dev->stats.rx_packets++;
207 dev->stats.rx_bytes += skb->len;
209 if (netif_msg_rx_status (dev))
210 devdbg (dev, "< rx, len %zu, type 0x%x",
211 skb->len + sizeof (struct ethhdr), skb->protocol);
212 memset (skb->cb, 0, sizeof (struct skb_data));
213 status = netif_rx (skb);
214 if (status != NET_RX_SUCCESS && netif_msg_rx_err (dev))
215 devdbg (dev, "netif_rx status %d", status);
217 EXPORT_SYMBOL_GPL(usbnet_skb_return);
220 /*-------------------------------------------------------------------------
222 * Network Device Driver (peer link to "Host Device", from USB host)
224 *-------------------------------------------------------------------------*/
226 static int usbnet_change_mtu (struct net_device *net, int new_mtu)
228 struct usbnet *dev = netdev_priv(net);
229 int ll_mtu = new_mtu + net->hard_header_len;
230 int old_hard_mtu = dev->hard_mtu;
231 int old_rx_urb_size = dev->rx_urb_size;
235 // no second zero-length packet read wanted after mtu-sized packets
236 if ((ll_mtu % dev->maxpacket) == 0)
240 dev->hard_mtu = net->mtu + net->hard_header_len;
241 if (dev->rx_urb_size == old_hard_mtu) {
242 dev->rx_urb_size = dev->hard_mtu;
243 if (dev->rx_urb_size > old_rx_urb_size)
244 usbnet_unlink_rx_urbs(dev);
250 /*-------------------------------------------------------------------------*/
252 static struct net_device_stats *usbnet_get_stats (struct net_device *net)
254 struct usbnet *dev = netdev_priv(net);
258 /*-------------------------------------------------------------------------*/
260 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
261 * completion callbacks. 2.5 should have fixed those bugs...
264 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
268 spin_lock_irqsave(&list->lock, flags);
269 __skb_unlink(skb, list);
270 spin_unlock(&list->lock);
271 spin_lock(&dev->done.lock);
272 __skb_queue_tail(&dev->done, skb);
273 if (dev->done.qlen == 1)
274 tasklet_schedule(&dev->bh);
275 spin_unlock_irqrestore(&dev->done.lock, flags);
278 /* some work can't be done in tasklets, so we use keventd
280 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
281 * but tasklet_schedule() doesn't. hope the failure is rare.
283 void usbnet_defer_kevent (struct usbnet *dev, int work)
285 set_bit (work, &dev->flags);
286 if (!schedule_work (&dev->kevent))
287 deverr (dev, "kevent %d may have been dropped", work);
289 devdbg (dev, "kevent %d scheduled", work);
291 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
293 /*-------------------------------------------------------------------------*/
295 static void rx_complete (struct urb *urb);
297 static void rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
300 struct skb_data *entry;
302 unsigned long lockflags;
303 size_t size = dev->rx_urb_size;
305 if ((skb = alloc_skb (size + NET_IP_ALIGN, flags)) == NULL) {
306 if (netif_msg_rx_err (dev))
307 devdbg (dev, "no rx skb");
308 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
312 skb_reserve (skb, NET_IP_ALIGN);
314 entry = (struct skb_data *) skb->cb;
317 entry->state = rx_start;
320 usb_fill_bulk_urb (urb, dev->udev, dev->in,
321 skb->data, size, rx_complete, skb);
323 spin_lock_irqsave (&dev->rxq.lock, lockflags);
325 if (netif_running (dev->net)
326 && netif_device_present (dev->net)
327 && !test_bit (EVENT_RX_HALT, &dev->flags)) {
328 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
330 usbnet_defer_kevent (dev, EVENT_RX_HALT);
333 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
336 if (netif_msg_ifdown (dev))
337 devdbg (dev, "device gone");
338 netif_device_detach (dev->net);
341 if (netif_msg_rx_err (dev))
342 devdbg (dev, "rx submit, %d", retval);
343 tasklet_schedule (&dev->bh);
346 __skb_queue_tail (&dev->rxq, skb);
349 if (netif_msg_ifdown (dev))
350 devdbg (dev, "rx: stopped");
353 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
355 dev_kfree_skb_any (skb);
361 /*-------------------------------------------------------------------------*/
363 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
365 if (dev->driver_info->rx_fixup
366 && !dev->driver_info->rx_fixup (dev, skb))
368 // else network stack removes extra byte if we forced a short packet
371 usbnet_skb_return (dev, skb);
373 if (netif_msg_rx_err (dev))
374 devdbg (dev, "drop");
376 dev->stats.rx_errors++;
377 skb_queue_tail (&dev->done, skb);
381 /*-------------------------------------------------------------------------*/
383 static void rx_complete (struct urb *urb)
385 struct sk_buff *skb = (struct sk_buff *) urb->context;
386 struct skb_data *entry = (struct skb_data *) skb->cb;
387 struct usbnet *dev = entry->dev;
388 int urb_status = urb->status;
390 skb_put (skb, urb->actual_length);
391 entry->state = rx_done;
394 switch (urb_status) {
397 if (skb->len < dev->net->hard_header_len) {
398 entry->state = rx_cleanup;
399 dev->stats.rx_errors++;
400 dev->stats.rx_length_errors++;
401 if (netif_msg_rx_err (dev))
402 devdbg (dev, "rx length %d", skb->len);
406 /* stalls need manual reset. this is rare ... except that
407 * when going through USB 2.0 TTs, unplug appears this way.
408 * we avoid the highspeed version of the ETIMEOUT/EILSEQ
409 * storm, recovering as needed.
412 dev->stats.rx_errors++;
413 usbnet_defer_kevent (dev, EVENT_RX_HALT);
416 /* software-driven interface shutdown */
417 case -ECONNRESET: /* async unlink */
418 case -ESHUTDOWN: /* hardware gone */
419 if (netif_msg_ifdown (dev))
420 devdbg (dev, "rx shutdown, code %d", urb_status);
423 /* we get controller i/o faults during khubd disconnect() delays.
424 * throttle down resubmits, to avoid log floods; just temporarily,
425 * so we still recover when the fault isn't a khubd delay.
430 dev->stats.rx_errors++;
431 if (!timer_pending (&dev->delay)) {
432 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
433 if (netif_msg_link (dev))
434 devdbg (dev, "rx throttle %d", urb_status);
437 entry->state = rx_cleanup;
442 /* data overrun ... flush fifo? */
444 dev->stats.rx_over_errors++;
448 entry->state = rx_cleanup;
449 dev->stats.rx_errors++;
450 if (netif_msg_rx_err (dev))
451 devdbg (dev, "rx status %d", urb_status);
455 defer_bh(dev, skb, &dev->rxq);
458 if (netif_running (dev->net)
459 && !test_bit (EVENT_RX_HALT, &dev->flags)) {
460 rx_submit (dev, urb, GFP_ATOMIC);
465 if (netif_msg_rx_err (dev))
466 devdbg (dev, "no read resubmitted");
469 static void intr_complete (struct urb *urb)
471 struct usbnet *dev = urb->context;
472 int status = urb->status;
477 dev->driver_info->status(dev, urb);
480 /* software-driven interface shutdown */
481 case -ENOENT: /* urb killed */
482 case -ESHUTDOWN: /* hardware gone */
483 if (netif_msg_ifdown (dev))
484 devdbg (dev, "intr shutdown, code %d", status);
487 /* NOTE: not throttling like RX/TX, since this endpoint
488 * already polls infrequently
491 devdbg (dev, "intr status %d", status);
495 if (!netif_running (dev->net))
498 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
499 status = usb_submit_urb (urb, GFP_ATOMIC);
500 if (status != 0 && netif_msg_timer (dev))
501 deverr(dev, "intr resubmit --> %d", status);
504 /*-------------------------------------------------------------------------*/
506 // unlink pending rx/tx; completion handlers do all other cleanup
508 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
511 struct sk_buff *skb, *skbnext;
514 spin_lock_irqsave (&q->lock, flags);
515 skb_queue_walk_safe(q, skb, skbnext) {
516 struct skb_data *entry;
520 entry = (struct skb_data *) skb->cb;
523 // during some PM-driven resume scenarios,
524 // these (async) unlinks complete immediately
525 retval = usb_unlink_urb (urb);
526 if (retval != -EINPROGRESS && retval != 0)
527 devdbg (dev, "unlink urb err, %d", retval);
531 spin_unlock_irqrestore (&q->lock, flags);
535 // Flush all pending rx urbs
536 // minidrivers may need to do this when the MTU changes
538 void usbnet_unlink_rx_urbs(struct usbnet *dev)
540 if (netif_running(dev->net)) {
541 (void) unlink_urbs (dev, &dev->rxq);
542 tasklet_schedule(&dev->bh);
545 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
547 /*-------------------------------------------------------------------------*/
549 // precondition: never called in_interrupt
551 static int usbnet_stop (struct net_device *net)
553 struct usbnet *dev = netdev_priv(net);
555 DECLARE_WAIT_QUEUE_HEAD_ONSTACK (unlink_wakeup);
556 DECLARE_WAITQUEUE (wait, current);
558 netif_stop_queue (net);
560 if (netif_msg_ifdown (dev))
561 devinfo (dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld",
562 dev->stats.rx_packets, dev->stats.tx_packets,
563 dev->stats.rx_errors, dev->stats.tx_errors
566 // ensure there are no more active urbs
567 add_wait_queue (&unlink_wakeup, &wait);
568 dev->wait = &unlink_wakeup;
569 temp = unlink_urbs (dev, &dev->txq) + unlink_urbs (dev, &dev->rxq);
571 // maybe wait for deletions to finish.
572 while (!skb_queue_empty(&dev->rxq)
573 && !skb_queue_empty(&dev->txq)
574 && !skb_queue_empty(&dev->done)) {
575 msleep(UNLINK_TIMEOUT_MS);
576 if (netif_msg_ifdown (dev))
577 devdbg (dev, "waited for %d urb completions", temp);
580 remove_wait_queue (&unlink_wakeup, &wait);
582 usb_kill_urb(dev->interrupt);
584 /* deferred work (task, timer, softirq) must also stop.
585 * can't flush_scheduled_work() until we drop rtnl (later),
586 * else workers could deadlock; so make workers a NOP.
589 del_timer_sync (&dev->delay);
590 tasklet_kill (&dev->bh);
591 usb_autopm_put_interface(dev->intf);
596 /*-------------------------------------------------------------------------*/
598 // posts reads, and enables write queuing
600 // precondition: never called in_interrupt
602 static int usbnet_open (struct net_device *net)
604 struct usbnet *dev = netdev_priv(net);
606 struct driver_info *info = dev->driver_info;
608 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
609 if (netif_msg_ifup (dev))
611 "resumption fail (%d) usbnet usb-%s-%s, %s",
613 dev->udev->bus->bus_name, dev->udev->devpath,
618 // put into "known safe" state
619 if (info->reset && (retval = info->reset (dev)) < 0) {
620 if (netif_msg_ifup (dev))
622 "open reset fail (%d) usbnet usb-%s-%s, %s",
624 dev->udev->bus->bus_name, dev->udev->devpath,
629 // insist peer be connected
630 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
631 if (netif_msg_ifup (dev))
632 devdbg (dev, "can't open; %d", retval);
636 /* start any status interrupt transfer */
637 if (dev->interrupt) {
638 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
640 if (netif_msg_ifup (dev))
641 deverr (dev, "intr submit %d", retval);
646 netif_start_queue (net);
647 if (netif_msg_ifup (dev)) {
650 if (dev->driver_info->flags & FLAG_FRAMING_NC)
652 else if (dev->driver_info->flags & FLAG_FRAMING_GL)
654 else if (dev->driver_info->flags & FLAG_FRAMING_Z)
656 else if (dev->driver_info->flags & FLAG_FRAMING_RN)
658 else if (dev->driver_info->flags & FLAG_FRAMING_AX)
663 devinfo (dev, "open: enable queueing "
664 "(rx %d, tx %d) mtu %d %s framing",
665 (int)RX_QLEN (dev), (int)TX_QLEN (dev), dev->net->mtu,
669 // delay posting reads until we're fully open
670 tasklet_schedule (&dev->bh);
673 usb_autopm_put_interface(dev->intf);
678 /*-------------------------------------------------------------------------*/
680 /* ethtool methods; minidrivers may need to add some more, but
681 * they'll probably want to use this base set.
684 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
686 struct usbnet *dev = netdev_priv(net);
688 if (!dev->mii.mdio_read)
691 return mii_ethtool_gset(&dev->mii, cmd);
693 EXPORT_SYMBOL_GPL(usbnet_get_settings);
695 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
697 struct usbnet *dev = netdev_priv(net);
700 if (!dev->mii.mdio_write)
703 retval = mii_ethtool_sset(&dev->mii, cmd);
705 /* link speed/duplex might have changed */
706 if (dev->driver_info->link_reset)
707 dev->driver_info->link_reset(dev);
712 EXPORT_SYMBOL_GPL(usbnet_set_settings);
714 u32 usbnet_get_link (struct net_device *net)
716 struct usbnet *dev = netdev_priv(net);
718 /* If a check_connect is defined, return its result */
719 if (dev->driver_info->check_connect)
720 return dev->driver_info->check_connect (dev) == 0;
722 /* if the device has mii operations, use those */
723 if (dev->mii.mdio_read)
724 return mii_link_ok(&dev->mii);
726 /* Otherwise, say we're up (to avoid breaking scripts) */
729 EXPORT_SYMBOL_GPL(usbnet_get_link);
731 int usbnet_nway_reset(struct net_device *net)
733 struct usbnet *dev = netdev_priv(net);
735 if (!dev->mii.mdio_write)
738 return mii_nway_restart(&dev->mii);
740 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
742 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
744 struct usbnet *dev = netdev_priv(net);
746 strncpy (info->driver, dev->driver_name, sizeof info->driver);
747 strncpy (info->version, DRIVER_VERSION, sizeof info->version);
748 strncpy (info->fw_version, dev->driver_info->description,
749 sizeof info->fw_version);
750 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
752 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
754 u32 usbnet_get_msglevel (struct net_device *net)
756 struct usbnet *dev = netdev_priv(net);
758 return dev->msg_enable;
760 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
762 void usbnet_set_msglevel (struct net_device *net, u32 level)
764 struct usbnet *dev = netdev_priv(net);
766 dev->msg_enable = level;
768 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
770 /* drivers may override default ethtool_ops in their bind() routine */
771 static struct ethtool_ops usbnet_ethtool_ops = {
772 .get_settings = usbnet_get_settings,
773 .set_settings = usbnet_set_settings,
774 .get_link = usbnet_get_link,
775 .nway_reset = usbnet_nway_reset,
776 .get_drvinfo = usbnet_get_drvinfo,
777 .get_msglevel = usbnet_get_msglevel,
778 .set_msglevel = usbnet_set_msglevel,
781 /*-------------------------------------------------------------------------*/
783 /* work that cannot be done in interrupt context uses keventd.
785 * NOTE: with 2.5 we could do more of this using completion callbacks,
786 * especially now that control transfers can be queued.
789 kevent (struct work_struct *work)
792 container_of(work, struct usbnet, kevent);
795 /* usb_clear_halt() needs a thread context */
796 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
797 unlink_urbs (dev, &dev->txq);
798 status = usb_clear_halt (dev->udev, dev->out);
801 && status != -ESHUTDOWN) {
802 if (netif_msg_tx_err (dev))
803 deverr (dev, "can't clear tx halt, status %d",
806 clear_bit (EVENT_TX_HALT, &dev->flags);
807 if (status != -ESHUTDOWN)
808 netif_wake_queue (dev->net);
811 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
812 unlink_urbs (dev, &dev->rxq);
813 status = usb_clear_halt (dev->udev, dev->in);
816 && status != -ESHUTDOWN) {
817 if (netif_msg_rx_err (dev))
818 deverr (dev, "can't clear rx halt, status %d",
821 clear_bit (EVENT_RX_HALT, &dev->flags);
822 tasklet_schedule (&dev->bh);
826 /* tasklet could resubmit itself forever if memory is tight */
827 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
828 struct urb *urb = NULL;
830 if (netif_running (dev->net))
831 urb = usb_alloc_urb (0, GFP_KERNEL);
833 clear_bit (EVENT_RX_MEMORY, &dev->flags);
835 clear_bit (EVENT_RX_MEMORY, &dev->flags);
836 rx_submit (dev, urb, GFP_KERNEL);
837 tasklet_schedule (&dev->bh);
841 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
842 struct driver_info *info = dev->driver_info;
845 clear_bit (EVENT_LINK_RESET, &dev->flags);
846 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
847 devinfo(dev, "link reset failed (%d) usbnet usb-%s-%s, %s",
849 dev->udev->bus->bus_name, dev->udev->devpath,
855 devdbg (dev, "kevent done, flags = 0x%lx",
859 /*-------------------------------------------------------------------------*/
861 static void tx_complete (struct urb *urb)
863 struct sk_buff *skb = (struct sk_buff *) urb->context;
864 struct skb_data *entry = (struct skb_data *) skb->cb;
865 struct usbnet *dev = entry->dev;
867 if (urb->status == 0) {
868 dev->stats.tx_packets++;
869 dev->stats.tx_bytes += entry->length;
871 dev->stats.tx_errors++;
873 switch (urb->status) {
875 usbnet_defer_kevent (dev, EVENT_TX_HALT);
878 /* software-driven interface shutdown */
879 case -ECONNRESET: // async unlink
880 case -ESHUTDOWN: // hardware gone
883 // like rx, tx gets controller i/o faults during khubd delays
884 // and so it uses the same throttling mechanism.
888 if (!timer_pending (&dev->delay)) {
889 mod_timer (&dev->delay,
890 jiffies + THROTTLE_JIFFIES);
891 if (netif_msg_link (dev))
892 devdbg (dev, "tx throttle %d",
895 netif_stop_queue (dev->net);
898 if (netif_msg_tx_err (dev))
899 devdbg (dev, "tx err %d", entry->urb->status);
905 entry->state = tx_done;
906 defer_bh(dev, skb, &dev->txq);
909 /*-------------------------------------------------------------------------*/
911 static void usbnet_tx_timeout (struct net_device *net)
913 struct usbnet *dev = netdev_priv(net);
915 unlink_urbs (dev, &dev->txq);
916 tasklet_schedule (&dev->bh);
918 // FIXME: device recovery -- reset?
921 /*-------------------------------------------------------------------------*/
923 static int usbnet_start_xmit (struct sk_buff *skb, struct net_device *net)
925 struct usbnet *dev = netdev_priv(net);
927 int retval = NET_XMIT_SUCCESS;
928 struct urb *urb = NULL;
929 struct skb_data *entry;
930 struct driver_info *info = dev->driver_info;
933 // some devices want funky USB-level framing, for
934 // win32 driver (usually) and/or hardware quirks
935 if (info->tx_fixup) {
936 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
938 if (netif_msg_tx_err (dev))
939 devdbg (dev, "can't tx_fixup skb");
945 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
946 if (netif_msg_tx_err (dev))
947 devdbg (dev, "no urb");
951 entry = (struct skb_data *) skb->cb;
954 entry->state = tx_start;
955 entry->length = length;
957 usb_fill_bulk_urb (urb, dev->udev, dev->out,
958 skb->data, skb->len, tx_complete, skb);
960 /* don't assume the hardware handles USB_ZERO_PACKET
961 * NOTE: strictly conforming cdc-ether devices should expect
962 * the ZLP here, but ignore the one-byte packet.
964 if ((length % dev->maxpacket) == 0) {
965 urb->transfer_buffer_length++;
966 if (skb_tailroom(skb)) {
967 skb->data[skb->len] = 0;
972 spin_lock_irqsave (&dev->txq.lock, flags);
974 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
976 netif_stop_queue (net);
977 usbnet_defer_kevent (dev, EVENT_TX_HALT);
980 if (netif_msg_tx_err (dev))
981 devdbg (dev, "tx: submit urb err %d", retval);
984 net->trans_start = jiffies;
985 __skb_queue_tail (&dev->txq, skb);
986 if (dev->txq.qlen >= TX_QLEN (dev))
987 netif_stop_queue (net);
989 spin_unlock_irqrestore (&dev->txq.lock, flags);
992 if (netif_msg_tx_err (dev))
993 devdbg (dev, "drop, code %d", retval);
995 retval = NET_XMIT_SUCCESS;
996 dev->stats.tx_dropped++;
998 dev_kfree_skb_any (skb);
1000 } else if (netif_msg_tx_queued (dev)) {
1001 devdbg (dev, "> tx, len %d, type 0x%x",
1002 length, skb->protocol);
1008 /*-------------------------------------------------------------------------*/
1010 // tasklet (work deferred from completions, in_irq) or timer
1012 static void usbnet_bh (unsigned long param)
1014 struct usbnet *dev = (struct usbnet *) param;
1015 struct sk_buff *skb;
1016 struct skb_data *entry;
1018 while ((skb = skb_dequeue (&dev->done))) {
1019 entry = (struct skb_data *) skb->cb;
1020 switch (entry->state) {
1022 entry->state = rx_cleanup;
1023 rx_process (dev, skb);
1027 usb_free_urb (entry->urb);
1028 dev_kfree_skb (skb);
1031 devdbg (dev, "bogus skb state %d", entry->state);
1035 // waiting for all pending urbs to complete?
1037 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1038 wake_up (dev->wait);
1041 // or are we maybe short a few urbs?
1042 } else if (netif_running (dev->net)
1043 && netif_device_present (dev->net)
1044 && !timer_pending (&dev->delay)
1045 && !test_bit (EVENT_RX_HALT, &dev->flags)) {
1046 int temp = dev->rxq.qlen;
1047 int qlen = RX_QLEN (dev);
1053 // don't refill the queue all at once
1054 for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1055 urb = usb_alloc_urb (0, GFP_ATOMIC);
1057 rx_submit (dev, urb, GFP_ATOMIC);
1059 if (temp != dev->rxq.qlen && netif_msg_link (dev))
1060 devdbg (dev, "rxqlen %d --> %d",
1061 temp, dev->rxq.qlen);
1062 if (dev->rxq.qlen < qlen)
1063 tasklet_schedule (&dev->bh);
1065 if (dev->txq.qlen < TX_QLEN (dev))
1066 netif_wake_queue (dev->net);
1072 /*-------------------------------------------------------------------------
1074 * USB Device Driver support
1076 *-------------------------------------------------------------------------*/
1078 // precondition: never called in_interrupt
1080 void usbnet_disconnect (struct usb_interface *intf)
1083 struct usb_device *xdev;
1084 struct net_device *net;
1086 dev = usb_get_intfdata(intf);
1087 usb_set_intfdata(intf, NULL);
1091 xdev = interface_to_usbdev (intf);
1093 if (netif_msg_probe (dev))
1094 devinfo (dev, "unregister '%s' usb-%s-%s, %s",
1095 intf->dev.driver->name,
1096 xdev->bus->bus_name, xdev->devpath,
1097 dev->driver_info->description);
1100 unregister_netdev (net);
1102 /* we don't hold rtnl here ... */
1103 flush_scheduled_work ();
1105 if (dev->driver_info->unbind)
1106 dev->driver_info->unbind (dev, intf);
1111 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1114 /*-------------------------------------------------------------------------*/
1116 // precondition: never called in_interrupt
1119 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1122 struct net_device *net;
1123 struct usb_host_interface *interface;
1124 struct driver_info *info;
1125 struct usb_device *xdev;
1128 DECLARE_MAC_BUF(mac);
1130 name = udev->dev.driver->name;
1131 info = (struct driver_info *) prod->driver_info;
1133 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1136 xdev = interface_to_usbdev (udev);
1137 interface = udev->cur_altsetting;
1143 // set up our own records
1144 net = alloc_etherdev(sizeof(*dev));
1146 dbg ("can't kmalloc dev");
1150 dev = netdev_priv(net);
1153 dev->driver_info = info;
1154 dev->driver_name = name;
1155 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1156 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1157 skb_queue_head_init (&dev->rxq);
1158 skb_queue_head_init (&dev->txq);
1159 skb_queue_head_init (&dev->done);
1160 dev->bh.func = usbnet_bh;
1161 dev->bh.data = (unsigned long) dev;
1162 INIT_WORK (&dev->kevent, kevent);
1163 dev->delay.function = usbnet_bh;
1164 dev->delay.data = (unsigned long) dev;
1165 init_timer (&dev->delay);
1166 mutex_init (&dev->phy_mutex);
1169 strcpy (net->name, "usb%d");
1170 memcpy (net->dev_addr, node_id, sizeof node_id);
1172 /* rx and tx sides can use different message sizes;
1173 * bind() should set rx_urb_size in that case.
1175 dev->hard_mtu = net->mtu + net->hard_header_len;
1177 // dma_supported() is deeply broken on almost all architectures
1178 // possible with some EHCI controllers
1179 if (dma_supported (&udev->dev, DMA_64BIT_MASK))
1180 net->features |= NETIF_F_HIGHDMA;
1183 net->change_mtu = usbnet_change_mtu;
1184 net->get_stats = usbnet_get_stats;
1185 net->hard_start_xmit = usbnet_start_xmit;
1186 net->open = usbnet_open;
1187 net->stop = usbnet_stop;
1188 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1189 net->tx_timeout = usbnet_tx_timeout;
1190 net->ethtool_ops = &usbnet_ethtool_ops;
1192 // allow device-specific bind/init procedures
1193 // NOTE net->name still not usable ...
1195 status = info->bind (dev, udev);
1199 // heuristic: "usb%d" for links we know are two-host,
1200 // else "eth%d" when there's reasonable doubt. userspace
1201 // can rename the link if it knows better.
1202 if ((dev->driver_info->flags & FLAG_ETHER) != 0
1203 && (net->dev_addr [0] & 0x02) == 0)
1204 strcpy (net->name, "eth%d");
1205 /* WLAN devices should always be named "wlan%d" */
1206 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1207 strcpy(net->name, "wlan%d");
1209 /* maybe the remote can't receive an Ethernet MTU */
1210 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1211 net->mtu = dev->hard_mtu - net->hard_header_len;
1212 } else if (!info->in || !info->out)
1213 status = usbnet_get_endpoints (dev, udev);
1215 dev->in = usb_rcvbulkpipe (xdev, info->in);
1216 dev->out = usb_sndbulkpipe (xdev, info->out);
1217 if (!(info->flags & FLAG_NO_SETINT))
1218 status = usb_set_interface (xdev,
1219 interface->desc.bInterfaceNumber,
1220 interface->desc.bAlternateSetting);
1225 if (status >= 0 && dev->status)
1226 status = init_status (dev, udev);
1230 if (!dev->rx_urb_size)
1231 dev->rx_urb_size = dev->hard_mtu;
1232 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1234 SET_NETDEV_DEV(net, &udev->dev);
1235 status = register_netdev (net);
1238 if (netif_msg_probe (dev))
1239 devinfo (dev, "register '%s' at usb-%s-%s, %s, %s",
1240 udev->dev.driver->name,
1241 xdev->bus->bus_name, xdev->devpath,
1242 dev->driver_info->description,
1243 print_mac(mac, net->dev_addr));
1245 // ok, it's ready to go.
1246 usb_set_intfdata (udev, dev);
1248 // start as if the link is up
1249 netif_device_attach (net);
1255 info->unbind (dev, udev);
1262 EXPORT_SYMBOL_GPL(usbnet_probe);
1264 /*-------------------------------------------------------------------------*/
1267 * suspend the whole driver as soon as the first interface is suspended
1268 * resume only when the last interface is resumed
1271 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1273 struct usbnet *dev = usb_get_intfdata(intf);
1275 if (!dev->suspend_count++) {
1277 * accelerate emptying of the rx and queues, to avoid
1278 * having everything error out.
1280 netif_device_detach (dev->net);
1281 (void) unlink_urbs (dev, &dev->rxq);
1282 (void) unlink_urbs (dev, &dev->txq);
1284 * reattach so runtime management can use and
1287 netif_device_attach (dev->net);
1291 EXPORT_SYMBOL_GPL(usbnet_suspend);
1293 int usbnet_resume (struct usb_interface *intf)
1295 struct usbnet *dev = usb_get_intfdata(intf);
1297 if (!--dev->suspend_count)
1298 tasklet_schedule (&dev->bh);
1302 EXPORT_SYMBOL_GPL(usbnet_resume);
1305 /*-------------------------------------------------------------------------*/
1307 static int __init usbnet_init(void)
1309 /* compiler should optimize this out */
1310 BUILD_BUG_ON (sizeof (((struct sk_buff *)0)->cb)
1311 < sizeof (struct skb_data));
1313 random_ether_addr(node_id);
1316 module_init(usbnet_init);
1318 static void __exit usbnet_exit(void)
1321 module_exit(usbnet_exit);
1323 MODULE_AUTHOR("David Brownell");
1324 MODULE_DESCRIPTION("USB network driver framework");
1325 MODULE_LICENSE("GPL");