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/sched.h>
38 #include <linux/init.h>
39 #include <linux/netdevice.h>
40 #include <linux/etherdevice.h>
41 #include <linux/ethtool.h>
42 #include <linux/workqueue.h>
43 #include <linux/mii.h>
44 #include <linux/usb.h>
48 #define DRIVER_VERSION "22-Aug-2005"
51 /*-------------------------------------------------------------------------*/
54 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
55 * Several dozen bytes of IPv4 data can fit in two such transactions.
56 * One maximum size Ethernet packet takes twenty four of them.
57 * For high speed, each frame comfortably fits almost 36 max size
58 * Ethernet packets (so queues should be bigger).
60 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
61 * let the USB host controller be busy for 5msec or more before an irq
62 * is required, under load. Jumbograms change the equation.
64 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
65 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
66 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
67 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
68 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
70 // reawaken network queue this soon after stopping; else watchdog barks
71 #define TX_TIMEOUT_JIFFIES (5*HZ)
73 // throttle rx/tx briefly after some faults, so khubd might disconnect()
74 // us (it polls at HZ/4 usually) before we report too many false errors.
75 #define THROTTLE_JIFFIES (HZ/8)
78 #define UNLINK_TIMEOUT_MS 3
80 /*-------------------------------------------------------------------------*/
82 // randomly generated ethernet address
83 static u8 node_id [ETH_ALEN];
85 static const char driver_name [] = "usbnet";
87 /* use ethtool to change the level for any given device */
88 static int msg_level = -1;
89 module_param (msg_level, int, 0);
90 MODULE_PARM_DESC (msg_level, "Override default message level");
92 /*-------------------------------------------------------------------------*/
94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
95 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
98 struct usb_host_interface *alt = NULL;
99 struct usb_host_endpoint *in = NULL, *out = NULL;
100 struct usb_host_endpoint *status = NULL;
102 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
105 in = out = status = NULL;
106 alt = intf->altsetting + tmp;
108 /* take the first altsetting with in-bulk + out-bulk;
109 * remember any status endpoint, just in case;
110 * ignore other endpoints and altsetttings.
112 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
113 struct usb_host_endpoint *e;
116 e = alt->endpoint + ep;
117 switch (e->desc.bmAttributes) {
118 case USB_ENDPOINT_XFER_INT:
119 if (!usb_endpoint_dir_in(&e->desc))
123 case USB_ENDPOINT_XFER_BULK:
128 if (usb_endpoint_dir_in(&e->desc)) {
131 else if (intr && !status)
141 if (!alt || !in || !out)
144 if (alt->desc.bAlternateSetting != 0
145 || !(dev->driver_info->flags & FLAG_NO_SETINT)) {
146 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
147 alt->desc.bAlternateSetting);
152 dev->in = usb_rcvbulkpipe (dev->udev,
153 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
154 dev->out = usb_sndbulkpipe (dev->udev,
155 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156 dev->status = status;
159 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
161 static void intr_complete (struct urb *urb);
163 static int init_status (struct usbnet *dev, struct usb_interface *intf)
170 if (!dev->driver_info->status)
173 pipe = usb_rcvintpipe (dev->udev,
174 dev->status->desc.bEndpointAddress
175 & USB_ENDPOINT_NUMBER_MASK);
176 maxp = usb_maxpacket (dev->udev, pipe, 0);
178 /* avoid 1 msec chatter: min 8 msec poll rate */
179 period = max ((int) dev->status->desc.bInterval,
180 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
182 buf = kmalloc (maxp, SLAB_KERNEL);
184 dev->interrupt = usb_alloc_urb (0, SLAB_KERNEL);
185 if (!dev->interrupt) {
189 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
190 buf, maxp, intr_complete, dev, period);
192 "status ep%din, %d bytes period %d\n",
193 usb_pipeendpoint(pipe), maxp, period);
199 /* Passes this packet up the stack, updating its accounting.
200 * Some link protocols batch packets, so their rx_fixup paths
201 * can return clones as well as just modify the original skb.
203 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
208 skb->protocol = eth_type_trans (skb, dev->net);
209 dev->stats.rx_packets++;
210 dev->stats.rx_bytes += skb->len;
212 if (netif_msg_rx_status (dev))
213 devdbg (dev, "< rx, len %zu, type 0x%x",
214 skb->len + sizeof (struct ethhdr), skb->protocol);
215 memset (skb->cb, 0, sizeof (struct skb_data));
216 status = netif_rx (skb);
217 if (status != NET_RX_SUCCESS && netif_msg_rx_err (dev))
218 devdbg (dev, "netif_rx status %d", status);
220 EXPORT_SYMBOL_GPL(usbnet_skb_return);
223 /*-------------------------------------------------------------------------
225 * Network Device Driver (peer link to "Host Device", from USB host)
227 *-------------------------------------------------------------------------*/
229 static int usbnet_change_mtu (struct net_device *net, int new_mtu)
231 struct usbnet *dev = netdev_priv(net);
232 int ll_mtu = new_mtu + net->hard_header_len;
233 int old_hard_mtu = dev->hard_mtu;
234 int old_rx_urb_size = dev->rx_urb_size;
238 // no second zero-length packet read wanted after mtu-sized packets
239 if ((ll_mtu % dev->maxpacket) == 0)
243 dev->hard_mtu = net->mtu + net->hard_header_len;
244 if (dev->rx_urb_size == old_hard_mtu) {
245 dev->rx_urb_size = dev->hard_mtu;
246 if (dev->rx_urb_size > old_rx_urb_size)
247 usbnet_unlink_rx_urbs(dev);
253 /*-------------------------------------------------------------------------*/
255 static struct net_device_stats *usbnet_get_stats (struct net_device *net)
257 struct usbnet *dev = netdev_priv(net);
261 /*-------------------------------------------------------------------------*/
263 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
264 * completion callbacks. 2.5 should have fixed those bugs...
267 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
271 spin_lock_irqsave(&list->lock, flags);
272 __skb_unlink(skb, list);
273 spin_unlock(&list->lock);
274 spin_lock(&dev->done.lock);
275 __skb_queue_tail(&dev->done, skb);
276 if (dev->done.qlen == 1)
277 tasklet_schedule(&dev->bh);
278 spin_unlock_irqrestore(&dev->done.lock, flags);
281 /* some work can't be done in tasklets, so we use keventd
283 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
284 * but tasklet_schedule() doesn't. hope the failure is rare.
286 void usbnet_defer_kevent (struct usbnet *dev, int work)
288 set_bit (work, &dev->flags);
289 if (!schedule_work (&dev->kevent))
290 deverr (dev, "kevent %d may have been dropped", work);
292 devdbg (dev, "kevent %d scheduled", work);
294 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
296 /*-------------------------------------------------------------------------*/
298 static void rx_complete (struct urb *urb);
300 static void rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
303 struct skb_data *entry;
305 unsigned long lockflags;
306 size_t size = dev->rx_urb_size;
308 if ((skb = alloc_skb (size + NET_IP_ALIGN, flags)) == NULL) {
309 if (netif_msg_rx_err (dev))
310 devdbg (dev, "no rx skb");
311 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
315 skb_reserve (skb, NET_IP_ALIGN);
317 entry = (struct skb_data *) skb->cb;
320 entry->state = rx_start;
323 usb_fill_bulk_urb (urb, dev->udev, dev->in,
324 skb->data, size, rx_complete, skb);
326 spin_lock_irqsave (&dev->rxq.lock, lockflags);
328 if (netif_running (dev->net)
329 && netif_device_present (dev->net)
330 && !test_bit (EVENT_RX_HALT, &dev->flags)) {
331 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)){
333 usbnet_defer_kevent (dev, EVENT_RX_HALT);
336 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
339 if (netif_msg_ifdown (dev))
340 devdbg (dev, "device gone");
341 netif_device_detach (dev->net);
344 if (netif_msg_rx_err (dev))
345 devdbg (dev, "rx submit, %d", retval);
346 tasklet_schedule (&dev->bh);
349 __skb_queue_tail (&dev->rxq, skb);
352 if (netif_msg_ifdown (dev))
353 devdbg (dev, "rx: stopped");
356 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
358 dev_kfree_skb_any (skb);
364 /*-------------------------------------------------------------------------*/
366 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
368 if (dev->driver_info->rx_fixup
369 && !dev->driver_info->rx_fixup (dev, skb))
371 // else network stack removes extra byte if we forced a short packet
374 usbnet_skb_return (dev, skb);
376 if (netif_msg_rx_err (dev))
377 devdbg (dev, "drop");
379 dev->stats.rx_errors++;
380 skb_queue_tail (&dev->done, skb);
384 /*-------------------------------------------------------------------------*/
386 static void rx_complete (struct urb *urb)
388 struct sk_buff *skb = (struct sk_buff *) urb->context;
389 struct skb_data *entry = (struct skb_data *) skb->cb;
390 struct usbnet *dev = entry->dev;
391 int urb_status = urb->status;
393 skb_put (skb, urb->actual_length);
394 entry->state = rx_done;
397 switch (urb_status) {
400 if (skb->len < dev->net->hard_header_len) {
401 entry->state = rx_cleanup;
402 dev->stats.rx_errors++;
403 dev->stats.rx_length_errors++;
404 if (netif_msg_rx_err (dev))
405 devdbg (dev, "rx length %d", skb->len);
409 // stalls need manual reset. this is rare ... except that
410 // when going through USB 2.0 TTs, unplug appears this way.
411 // we avoid the highspeed version of the ETIMEOUT/EILSEQ
412 // storm, recovering as needed.
414 dev->stats.rx_errors++;
415 usbnet_defer_kevent (dev, EVENT_RX_HALT);
418 // software-driven interface shutdown
419 case -ECONNRESET: // async unlink
420 case -ESHUTDOWN: // hardware gone
421 if (netif_msg_ifdown (dev))
422 devdbg (dev, "rx shutdown, code %d", urb_status);
425 // we get controller i/o faults during khubd disconnect() delays.
426 // throttle down resubmits, to avoid log floods; just temporarily,
427 // so we still recover when the fault isn't a khubd delay.
431 dev->stats.rx_errors++;
432 if (!timer_pending (&dev->delay)) {
433 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
434 if (netif_msg_link (dev))
435 devdbg (dev, "rx throttle %d", urb_status);
438 entry->state = rx_cleanup;
443 // data overrun ... flush fifo?
445 dev->stats.rx_over_errors++;
449 entry->state = rx_cleanup;
450 dev->stats.rx_errors++;
451 if (netif_msg_rx_err (dev))
452 devdbg (dev, "rx status %d", urb_status);
456 defer_bh(dev, skb, &dev->rxq);
459 if (netif_running (dev->net)
460 && !test_bit (EVENT_RX_HALT, &dev->flags)) {
461 rx_submit (dev, urb, GFP_ATOMIC);
466 if (netif_msg_rx_err (dev))
467 devdbg (dev, "no read resubmitted");
470 static void intr_complete (struct urb *urb)
472 struct usbnet *dev = urb->context;
473 int status = urb->status;
478 dev->driver_info->status(dev, urb);
481 /* software-driven interface shutdown */
482 case -ENOENT: // urb killed
483 case -ESHUTDOWN: // hardware gone
484 if (netif_msg_ifdown (dev))
485 devdbg (dev, "intr shutdown, code %d", status);
488 /* NOTE: not throttling like RX/TX, since this endpoint
489 * already polls infrequently
492 devdbg (dev, "intr status %d", status);
496 if (!netif_running (dev->net))
499 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
500 status = usb_submit_urb (urb, GFP_ATOMIC);
501 if (status != 0 && netif_msg_timer (dev))
502 deverr(dev, "intr resubmit --> %d", status);
505 /*-------------------------------------------------------------------------*/
507 // unlink pending rx/tx; completion handlers do all other cleanup
509 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
512 struct sk_buff *skb, *skbnext;
515 spin_lock_irqsave (&q->lock, flags);
516 for (skb = q->next; skb != (struct sk_buff *) q; skb = skbnext) {
517 struct skb_data *entry;
521 entry = (struct skb_data *) skb->cb;
525 // during some PM-driven resume scenarios,
526 // these (async) unlinks complete immediately
527 retval = usb_unlink_urb (urb);
528 if (retval != -EINPROGRESS && retval != 0)
529 devdbg (dev, "unlink urb err, %d", retval);
533 spin_unlock_irqrestore (&q->lock, flags);
537 // Flush all pending rx urbs
538 // minidrivers may need to do this when the MTU changes
540 void usbnet_unlink_rx_urbs(struct usbnet *dev)
542 if (netif_running(dev->net)) {
543 (void) unlink_urbs (dev, &dev->rxq);
544 tasklet_schedule(&dev->bh);
547 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
549 /*-------------------------------------------------------------------------*/
551 // precondition: never called in_interrupt
553 static int usbnet_stop (struct net_device *net)
555 struct usbnet *dev = netdev_priv(net);
557 DECLARE_WAIT_QUEUE_HEAD_ONSTACK (unlink_wakeup);
558 DECLARE_WAITQUEUE (wait, current);
560 netif_stop_queue (net);
562 if (netif_msg_ifdown (dev))
563 devinfo (dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld",
564 dev->stats.rx_packets, dev->stats.tx_packets,
565 dev->stats.rx_errors, dev->stats.tx_errors
568 // ensure there are no more active urbs
569 add_wait_queue (&unlink_wakeup, &wait);
570 dev->wait = &unlink_wakeup;
571 temp = unlink_urbs (dev, &dev->txq) + unlink_urbs (dev, &dev->rxq);
573 // maybe wait for deletions to finish.
574 while (!skb_queue_empty(&dev->rxq) &&
575 !skb_queue_empty(&dev->txq) &&
576 !skb_queue_empty(&dev->done)) {
577 msleep(UNLINK_TIMEOUT_MS);
578 if (netif_msg_ifdown (dev))
579 devdbg (dev, "waited for %d urb completions", temp);
582 remove_wait_queue (&unlink_wakeup, &wait);
584 usb_kill_urb(dev->interrupt);
586 /* deferred work (task, timer, softirq) must also stop.
587 * can't flush_scheduled_work() until we drop rtnl (later),
588 * else workers could deadlock; so make workers a NOP.
591 del_timer_sync (&dev->delay);
592 tasklet_kill (&dev->bh);
597 /*-------------------------------------------------------------------------*/
599 // posts reads, and enables write queuing
601 // precondition: never called in_interrupt
603 static int usbnet_open (struct net_device *net)
605 struct usbnet *dev = netdev_priv(net);
607 struct driver_info *info = dev->driver_info;
609 // put into "known safe" state
610 if (info->reset && (retval = info->reset (dev)) < 0) {
611 if (netif_msg_ifup (dev))
613 "open reset fail (%d) usbnet usb-%s-%s, %s",
615 dev->udev->bus->bus_name, dev->udev->devpath,
620 // insist peer be connected
621 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
622 if (netif_msg_ifup (dev))
623 devdbg (dev, "can't open; %d", retval);
627 /* start any status interrupt transfer */
628 if (dev->interrupt) {
629 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
631 if (netif_msg_ifup (dev))
632 deverr (dev, "intr submit %d", retval);
637 netif_start_queue (net);
638 if (netif_msg_ifup (dev)) {
641 if (dev->driver_info->flags & FLAG_FRAMING_NC)
643 else if (dev->driver_info->flags & FLAG_FRAMING_GL)
645 else if (dev->driver_info->flags & FLAG_FRAMING_Z)
647 else if (dev->driver_info->flags & FLAG_FRAMING_RN)
649 else if (dev->driver_info->flags & FLAG_FRAMING_AX)
654 devinfo (dev, "open: enable queueing "
655 "(rx %d, tx %d) mtu %d %s framing",
656 (int)RX_QLEN (dev), (int)TX_QLEN (dev), dev->net->mtu,
660 // delay posting reads until we're fully open
661 tasklet_schedule (&dev->bh);
666 /*-------------------------------------------------------------------------*/
668 /* ethtool methods; minidrivers may need to add some more, but
669 * they'll probably want to use this base set.
672 #if defined(CONFIG_MII) || defined(CONFIG_MII_MODULE)
675 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
677 struct usbnet *dev = netdev_priv(net);
679 if (!dev->mii.mdio_read)
682 return mii_ethtool_gset(&dev->mii, cmd);
684 EXPORT_SYMBOL_GPL(usbnet_get_settings);
686 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
688 struct usbnet *dev = netdev_priv(net);
691 if (!dev->mii.mdio_write)
694 retval = mii_ethtool_sset(&dev->mii, cmd);
696 /* link speed/duplex might have changed */
697 if (dev->driver_info->link_reset)
698 dev->driver_info->link_reset(dev);
703 EXPORT_SYMBOL_GPL(usbnet_set_settings);
705 u32 usbnet_get_link (struct net_device *net)
707 struct usbnet *dev = netdev_priv(net);
709 /* If a check_connect is defined, return its result */
710 if (dev->driver_info->check_connect)
711 return dev->driver_info->check_connect (dev) == 0;
713 /* if the device has mii operations, use those */
714 if (dev->mii.mdio_read)
715 return mii_link_ok(&dev->mii);
717 /* Otherwise, say we're up (to avoid breaking scripts) */
720 EXPORT_SYMBOL_GPL(usbnet_get_link);
722 int usbnet_nway_reset(struct net_device *net)
724 struct usbnet *dev = netdev_priv(net);
726 if (!dev->mii.mdio_write)
729 return mii_nway_restart(&dev->mii);
731 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
733 #endif /* HAVE_MII */
735 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
737 struct usbnet *dev = netdev_priv(net);
739 /* REVISIT don't always return "usbnet" */
740 strncpy (info->driver, driver_name, sizeof info->driver);
741 strncpy (info->version, DRIVER_VERSION, sizeof info->version);
742 strncpy (info->fw_version, dev->driver_info->description,
743 sizeof info->fw_version);
744 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
746 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
748 u32 usbnet_get_msglevel (struct net_device *net)
750 struct usbnet *dev = netdev_priv(net);
752 return dev->msg_enable;
754 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
756 void usbnet_set_msglevel (struct net_device *net, u32 level)
758 struct usbnet *dev = netdev_priv(net);
760 dev->msg_enable = level;
762 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
764 /* drivers may override default ethtool_ops in their bind() routine */
765 static struct ethtool_ops usbnet_ethtool_ops = {
767 .get_settings = usbnet_get_settings,
768 .set_settings = usbnet_set_settings,
769 .get_link = usbnet_get_link,
770 .nway_reset = usbnet_nway_reset,
772 .get_drvinfo = usbnet_get_drvinfo,
773 .get_msglevel = usbnet_get_msglevel,
774 .set_msglevel = usbnet_set_msglevel,
777 /*-------------------------------------------------------------------------*/
779 /* work that cannot be done in interrupt context uses keventd.
781 * NOTE: with 2.5 we could do more of this using completion callbacks,
782 * especially now that control transfers can be queued.
785 kevent (struct work_struct *work)
788 container_of(work, struct usbnet, kevent);
791 /* usb_clear_halt() needs a thread context */
792 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
793 unlink_urbs (dev, &dev->txq);
794 status = usb_clear_halt (dev->udev, dev->out);
797 && status != -ESHUTDOWN) {
798 if (netif_msg_tx_err (dev))
799 deverr (dev, "can't clear tx halt, status %d",
802 clear_bit (EVENT_TX_HALT, &dev->flags);
803 if (status != -ESHUTDOWN)
804 netif_wake_queue (dev->net);
807 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
808 unlink_urbs (dev, &dev->rxq);
809 status = usb_clear_halt (dev->udev, dev->in);
812 && status != -ESHUTDOWN) {
813 if (netif_msg_rx_err (dev))
814 deverr (dev, "can't clear rx halt, status %d",
817 clear_bit (EVENT_RX_HALT, &dev->flags);
818 tasklet_schedule (&dev->bh);
822 /* tasklet could resubmit itself forever if memory is tight */
823 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
824 struct urb *urb = NULL;
826 if (netif_running (dev->net))
827 urb = usb_alloc_urb (0, GFP_KERNEL);
829 clear_bit (EVENT_RX_MEMORY, &dev->flags);
831 clear_bit (EVENT_RX_MEMORY, &dev->flags);
832 rx_submit (dev, urb, GFP_KERNEL);
833 tasklet_schedule (&dev->bh);
837 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
838 struct driver_info *info = dev->driver_info;
841 clear_bit (EVENT_LINK_RESET, &dev->flags);
842 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
843 devinfo(dev, "link reset failed (%d) usbnet usb-%s-%s, %s",
845 dev->udev->bus->bus_name, dev->udev->devpath,
851 devdbg (dev, "kevent done, flags = 0x%lx",
855 /*-------------------------------------------------------------------------*/
857 static void tx_complete (struct urb *urb)
859 struct sk_buff *skb = (struct sk_buff *) urb->context;
860 struct skb_data *entry = (struct skb_data *) skb->cb;
861 struct usbnet *dev = entry->dev;
863 if (urb->status == 0) {
864 dev->stats.tx_packets++;
865 dev->stats.tx_bytes += entry->length;
867 dev->stats.tx_errors++;
869 switch (urb->status) {
871 usbnet_defer_kevent (dev, EVENT_TX_HALT);
874 /* software-driven interface shutdown */
875 case -ECONNRESET: // async unlink
876 case -ESHUTDOWN: // hardware gone
879 // like rx, tx gets controller i/o faults during khubd delays
880 // and so it uses the same throttling mechanism.
884 if (!timer_pending (&dev->delay)) {
885 mod_timer (&dev->delay,
886 jiffies + THROTTLE_JIFFIES);
887 if (netif_msg_link (dev))
888 devdbg (dev, "tx throttle %d",
891 netif_stop_queue (dev->net);
894 if (netif_msg_tx_err (dev))
895 devdbg (dev, "tx err %d", entry->urb->status);
901 entry->state = tx_done;
902 defer_bh(dev, skb, &dev->txq);
905 /*-------------------------------------------------------------------------*/
907 static void usbnet_tx_timeout (struct net_device *net)
909 struct usbnet *dev = netdev_priv(net);
911 unlink_urbs (dev, &dev->txq);
912 tasklet_schedule (&dev->bh);
914 // FIXME: device recovery -- reset?
917 /*-------------------------------------------------------------------------*/
919 static int usbnet_start_xmit (struct sk_buff *skb, struct net_device *net)
921 struct usbnet *dev = netdev_priv(net);
923 int retval = NET_XMIT_SUCCESS;
924 struct urb *urb = NULL;
925 struct skb_data *entry;
926 struct driver_info *info = dev->driver_info;
929 // some devices want funky USB-level framing, for
930 // win32 driver (usually) and/or hardware quirks
931 if (info->tx_fixup) {
932 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
934 if (netif_msg_tx_err (dev))
935 devdbg (dev, "can't tx_fixup skb");
941 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
942 if (netif_msg_tx_err (dev))
943 devdbg (dev, "no urb");
947 entry = (struct skb_data *) skb->cb;
950 entry->state = tx_start;
951 entry->length = length;
953 usb_fill_bulk_urb (urb, dev->udev, dev->out,
954 skb->data, skb->len, tx_complete, skb);
956 /* don't assume the hardware handles USB_ZERO_PACKET
957 * NOTE: strictly conforming cdc-ether devices should expect
958 * the ZLP here, but ignore the one-byte packet.
960 * FIXME zero that byte, if it doesn't require a new skb.
962 if ((length % dev->maxpacket) == 0)
963 urb->transfer_buffer_length++;
965 spin_lock_irqsave (&dev->txq.lock, flags);
967 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
969 netif_stop_queue (net);
970 usbnet_defer_kevent (dev, EVENT_TX_HALT);
973 if (netif_msg_tx_err (dev))
974 devdbg (dev, "tx: submit urb err %d", retval);
977 net->trans_start = jiffies;
978 __skb_queue_tail (&dev->txq, skb);
979 if (dev->txq.qlen >= TX_QLEN (dev))
980 netif_stop_queue (net);
982 spin_unlock_irqrestore (&dev->txq.lock, flags);
985 if (netif_msg_tx_err (dev))
986 devdbg (dev, "drop, code %d", retval);
988 retval = NET_XMIT_SUCCESS;
989 dev->stats.tx_dropped++;
991 dev_kfree_skb_any (skb);
993 } else if (netif_msg_tx_queued (dev)) {
994 devdbg (dev, "> tx, len %d, type 0x%x",
995 length, skb->protocol);
1001 /*-------------------------------------------------------------------------*/
1003 // tasklet (work deferred from completions, in_irq) or timer
1005 static void usbnet_bh (unsigned long param)
1007 struct usbnet *dev = (struct usbnet *) param;
1008 struct sk_buff *skb;
1009 struct skb_data *entry;
1011 while ((skb = skb_dequeue (&dev->done))) {
1012 entry = (struct skb_data *) skb->cb;
1013 switch (entry->state) {
1015 entry->state = rx_cleanup;
1016 rx_process (dev, skb);
1020 usb_free_urb (entry->urb);
1021 dev_kfree_skb (skb);
1024 devdbg (dev, "bogus skb state %d", entry->state);
1028 // waiting for all pending urbs to complete?
1030 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1031 wake_up (dev->wait);
1034 // or are we maybe short a few urbs?
1035 } else if (netif_running (dev->net)
1036 && netif_device_present (dev->net)
1037 && !timer_pending (&dev->delay)
1038 && !test_bit (EVENT_RX_HALT, &dev->flags)) {
1039 int temp = dev->rxq.qlen;
1040 int qlen = RX_QLEN (dev);
1046 // don't refill the queue all at once
1047 for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1048 urb = usb_alloc_urb (0, GFP_ATOMIC);
1050 rx_submit (dev, urb, GFP_ATOMIC);
1052 if (temp != dev->rxq.qlen && netif_msg_link (dev))
1053 devdbg (dev, "rxqlen %d --> %d",
1054 temp, dev->rxq.qlen);
1055 if (dev->rxq.qlen < qlen)
1056 tasklet_schedule (&dev->bh);
1058 if (dev->txq.qlen < TX_QLEN (dev))
1059 netif_wake_queue (dev->net);
1065 /*-------------------------------------------------------------------------
1067 * USB Device Driver support
1069 *-------------------------------------------------------------------------*/
1071 // precondition: never called in_interrupt
1073 void usbnet_disconnect (struct usb_interface *intf)
1076 struct usb_device *xdev;
1077 struct net_device *net;
1079 dev = usb_get_intfdata(intf);
1080 usb_set_intfdata(intf, NULL);
1084 xdev = interface_to_usbdev (intf);
1086 if (netif_msg_probe (dev))
1087 devinfo (dev, "unregister '%s' usb-%s-%s, %s",
1088 intf->dev.driver->name,
1089 xdev->bus->bus_name, xdev->devpath,
1090 dev->driver_info->description);
1093 unregister_netdev (net);
1095 /* we don't hold rtnl here ... */
1096 flush_scheduled_work ();
1098 if (dev->driver_info->unbind)
1099 dev->driver_info->unbind (dev, intf);
1104 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1107 /*-------------------------------------------------------------------------*/
1109 // precondition: never called in_interrupt
1112 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1115 struct net_device *net;
1116 struct usb_host_interface *interface;
1117 struct driver_info *info;
1118 struct usb_device *xdev;
1121 info = (struct driver_info *) prod->driver_info;
1123 dev_dbg (&udev->dev, "blacklisted by %s\n", driver_name);
1126 xdev = interface_to_usbdev (udev);
1127 interface = udev->cur_altsetting;
1133 // set up our own records
1134 net = alloc_etherdev(sizeof(*dev));
1136 dbg ("can't kmalloc dev");
1140 dev = netdev_priv(net);
1142 dev->driver_info = info;
1143 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1144 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1145 skb_queue_head_init (&dev->rxq);
1146 skb_queue_head_init (&dev->txq);
1147 skb_queue_head_init (&dev->done);
1148 dev->bh.func = usbnet_bh;
1149 dev->bh.data = (unsigned long) dev;
1150 INIT_WORK (&dev->kevent, kevent);
1151 dev->delay.function = usbnet_bh;
1152 dev->delay.data = (unsigned long) dev;
1153 init_timer (&dev->delay);
1154 mutex_init (&dev->phy_mutex);
1156 SET_MODULE_OWNER (net);
1158 strcpy (net->name, "usb%d");
1159 memcpy (net->dev_addr, node_id, sizeof node_id);
1161 /* rx and tx sides can use different message sizes;
1162 * bind() should set rx_urb_size in that case.
1164 dev->hard_mtu = net->mtu + net->hard_header_len;
1166 // dma_supported() is deeply broken on almost all architectures
1167 // possible with some EHCI controllers
1168 if (dma_supported (&udev->dev, DMA_64BIT_MASK))
1169 net->features |= NETIF_F_HIGHDMA;
1172 net->change_mtu = usbnet_change_mtu;
1173 net->get_stats = usbnet_get_stats;
1174 net->hard_start_xmit = usbnet_start_xmit;
1175 net->open = usbnet_open;
1176 net->stop = usbnet_stop;
1177 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1178 net->tx_timeout = usbnet_tx_timeout;
1179 net->ethtool_ops = &usbnet_ethtool_ops;
1181 // allow device-specific bind/init procedures
1182 // NOTE net->name still not usable ...
1184 status = info->bind (dev, udev);
1185 // heuristic: "usb%d" for links we know are two-host,
1186 // else "eth%d" when there's reasonable doubt. userspace
1187 // can rename the link if it knows better.
1188 if ((dev->driver_info->flags & FLAG_ETHER) != 0
1189 && (net->dev_addr [0] & 0x02) == 0)
1190 strcpy (net->name, "eth%d");
1192 /* maybe the remote can't receive an Ethernet MTU */
1193 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1194 net->mtu = dev->hard_mtu - net->hard_header_len;
1195 } else if (!info->in || !info->out)
1196 status = usbnet_get_endpoints (dev, udev);
1198 dev->in = usb_rcvbulkpipe (xdev, info->in);
1199 dev->out = usb_sndbulkpipe (xdev, info->out);
1200 if (!(info->flags & FLAG_NO_SETINT))
1201 status = usb_set_interface (xdev,
1202 interface->desc.bInterfaceNumber,
1203 interface->desc.bAlternateSetting);
1208 if (status == 0 && dev->status)
1209 status = init_status (dev, udev);
1213 if (!dev->rx_urb_size)
1214 dev->rx_urb_size = dev->hard_mtu;
1215 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1217 SET_NETDEV_DEV(net, &udev->dev);
1218 status = register_netdev (net);
1221 if (netif_msg_probe (dev))
1222 devinfo (dev, "register '%s' at usb-%s-%s, %s, "
1223 "%02x:%02x:%02x:%02x:%02x:%02x",
1224 udev->dev.driver->name,
1225 xdev->bus->bus_name, xdev->devpath,
1226 dev->driver_info->description,
1227 net->dev_addr [0], net->dev_addr [1],
1228 net->dev_addr [2], net->dev_addr [3],
1229 net->dev_addr [4], net->dev_addr [5]);
1231 // ok, it's ready to go.
1232 usb_set_intfdata (udev, dev);
1234 // start as if the link is up
1235 netif_device_attach (net);
1241 info->unbind (dev, udev);
1248 EXPORT_SYMBOL_GPL(usbnet_probe);
1250 /*-------------------------------------------------------------------------*/
1252 /* FIXME these suspend/resume methods assume non-CDC style
1253 * devices, with only one interface.
1256 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1258 struct usbnet *dev = usb_get_intfdata(intf);
1260 /* accelerate emptying of the rx and queues, to avoid
1261 * having everything error out.
1263 netif_device_detach (dev->net);
1264 (void) unlink_urbs (dev, &dev->rxq);
1265 (void) unlink_urbs (dev, &dev->txq);
1268 EXPORT_SYMBOL_GPL(usbnet_suspend);
1270 int usbnet_resume (struct usb_interface *intf)
1272 struct usbnet *dev = usb_get_intfdata(intf);
1274 netif_device_attach (dev->net);
1275 tasklet_schedule (&dev->bh);
1278 EXPORT_SYMBOL_GPL(usbnet_resume);
1281 /*-------------------------------------------------------------------------*/
1283 static int __init usbnet_init(void)
1285 /* compiler should optimize this out */
1286 BUILD_BUG_ON (sizeof (((struct sk_buff *)0)->cb)
1287 < sizeof (struct skb_data));
1289 random_ether_addr(node_id);
1292 module_init(usbnet_init);
1294 static void __exit usbnet_exit(void)
1297 module_exit(usbnet_exit);
1299 MODULE_AUTHOR("David Brownell");
1300 MODULE_DESCRIPTION("USB network driver framework");
1301 MODULE_LICENSE("GPL");