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>
47 #define DRIVER_VERSION "22-Aug-2005"
50 /*-------------------------------------------------------------------------*/
53 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
54 * Several dozen bytes of IPv4 data can fit in two such transactions.
55 * One maximum size Ethernet packet takes twenty four of them.
56 * For high speed, each frame comfortably fits almost 36 max size
57 * Ethernet packets (so queues should be bigger).
59 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
60 * let the USB host controller be busy for 5msec or more before an irq
61 * is required, under load. Jumbograms change the equation.
63 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
64 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
65 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
66 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
67 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
69 // reawaken network queue this soon after stopping; else watchdog barks
70 #define TX_TIMEOUT_JIFFIES (5*HZ)
72 // throttle rx/tx briefly after some faults, so khubd might disconnect()
73 // us (it polls at HZ/4 usually) before we report too many false errors.
74 #define THROTTLE_JIFFIES (HZ/8)
77 #define UNLINK_TIMEOUT_MS 3
79 /*-------------------------------------------------------------------------*/
81 // randomly generated ethernet address
82 static u8 node_id [ETH_ALEN];
84 static const char driver_name [] = "usbnet";
86 /* use ethtool to change the level for any given device */
87 static int msg_level = -1;
88 module_param (msg_level, int, 0);
89 MODULE_PARM_DESC (msg_level, "Override default message level");
91 /*-------------------------------------------------------------------------*/
93 /* handles CDC Ethernet and many other network "bulk data" interfaces */
94 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
97 struct usb_host_interface *alt = NULL;
98 struct usb_host_endpoint *in = NULL, *out = NULL;
99 struct usb_host_endpoint *status = NULL;
101 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
104 in = out = status = NULL;
105 alt = intf->altsetting + tmp;
107 /* take the first altsetting with in-bulk + out-bulk;
108 * remember any status endpoint, just in case;
109 * ignore other endpoints and altsetttings.
111 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
112 struct usb_host_endpoint *e;
115 e = alt->endpoint + ep;
116 switch (e->desc.bmAttributes) {
117 case USB_ENDPOINT_XFER_INT:
118 if (!usb_endpoint_dir_in(&e->desc))
122 case USB_ENDPOINT_XFER_BULK:
127 if (usb_endpoint_dir_in(&e->desc)) {
130 else if (intr && !status)
140 if (!alt || !in || !out)
143 if (alt->desc.bAlternateSetting != 0 ||
144 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
145 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
146 alt->desc.bAlternateSetting);
151 dev->in = usb_rcvbulkpipe (dev->udev,
152 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
153 dev->out = usb_sndbulkpipe (dev->udev,
154 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
155 dev->status = status;
158 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
160 static u8 nibble(unsigned char c)
162 if (likely(isdigit(c)))
165 if (likely(isxdigit(c)))
170 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
173 unsigned char buf [13];
175 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
177 dev_dbg(&dev->udev->dev,
178 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
183 for (i = tmp = 0; i < 6; i++, tmp += 2)
184 dev->net->dev_addr [i] =
185 (nibble(buf [tmp]) << 4) + nibble(buf [tmp + 1]);
188 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
190 static void intr_complete (struct urb *urb);
192 static int init_status (struct usbnet *dev, struct usb_interface *intf)
199 if (!dev->driver_info->status)
202 pipe = usb_rcvintpipe (dev->udev,
203 dev->status->desc.bEndpointAddress
204 & USB_ENDPOINT_NUMBER_MASK);
205 maxp = usb_maxpacket (dev->udev, pipe, 0);
207 /* avoid 1 msec chatter: min 8 msec poll rate */
208 period = max ((int) dev->status->desc.bInterval,
209 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
211 buf = kmalloc (maxp, GFP_KERNEL);
213 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
214 if (!dev->interrupt) {
218 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
219 buf, maxp, intr_complete, dev, period);
221 "status ep%din, %d bytes period %d\n",
222 usb_pipeendpoint(pipe), maxp, period);
228 /* Passes this packet up the stack, updating its accounting.
229 * Some link protocols batch packets, so their rx_fixup paths
230 * can return clones as well as just modify the original skb.
232 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
236 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
237 skb_queue_tail(&dev->rxq_pause, skb);
241 skb->protocol = eth_type_trans (skb, dev->net);
242 dev->net->stats.rx_packets++;
243 dev->net->stats.rx_bytes += skb->len;
245 if (netif_msg_rx_status (dev))
246 netdev_dbg(dev->net, "< rx, len %zu, type 0x%x\n",
247 skb->len + sizeof (struct ethhdr), skb->protocol);
248 memset (skb->cb, 0, sizeof (struct skb_data));
249 status = netif_rx (skb);
250 if (status != NET_RX_SUCCESS && netif_msg_rx_err (dev))
251 netdev_dbg(dev->net, "netif_rx status %d\n", status);
253 EXPORT_SYMBOL_GPL(usbnet_skb_return);
256 /*-------------------------------------------------------------------------
258 * Network Device Driver (peer link to "Host Device", from USB host)
260 *-------------------------------------------------------------------------*/
262 int usbnet_change_mtu (struct net_device *net, int new_mtu)
264 struct usbnet *dev = netdev_priv(net);
265 int ll_mtu = new_mtu + net->hard_header_len;
266 int old_hard_mtu = dev->hard_mtu;
267 int old_rx_urb_size = dev->rx_urb_size;
271 // no second zero-length packet read wanted after mtu-sized packets
272 if ((ll_mtu % dev->maxpacket) == 0)
276 dev->hard_mtu = net->mtu + net->hard_header_len;
277 if (dev->rx_urb_size == old_hard_mtu) {
278 dev->rx_urb_size = dev->hard_mtu;
279 if (dev->rx_urb_size > old_rx_urb_size)
280 usbnet_unlink_rx_urbs(dev);
285 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
287 /*-------------------------------------------------------------------------*/
289 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
290 * completion callbacks. 2.5 should have fixed those bugs...
293 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
297 spin_lock_irqsave(&list->lock, flags);
298 __skb_unlink(skb, list);
299 spin_unlock(&list->lock);
300 spin_lock(&dev->done.lock);
301 __skb_queue_tail(&dev->done, skb);
302 if (dev->done.qlen == 1)
303 tasklet_schedule(&dev->bh);
304 spin_unlock_irqrestore(&dev->done.lock, flags);
307 /* some work can't be done in tasklets, so we use keventd
309 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
310 * but tasklet_schedule() doesn't. hope the failure is rare.
312 void usbnet_defer_kevent (struct usbnet *dev, int work)
314 set_bit (work, &dev->flags);
315 if (!schedule_work (&dev->kevent))
316 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
318 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
320 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
322 /*-------------------------------------------------------------------------*/
324 static void rx_complete (struct urb *urb);
326 static void rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
329 struct skb_data *entry;
331 unsigned long lockflags;
332 size_t size = dev->rx_urb_size;
334 if ((skb = alloc_skb (size + NET_IP_ALIGN, flags)) == NULL) {
335 if (netif_msg_rx_err (dev))
336 netdev_dbg(dev->net, "no rx skb\n");
337 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
341 skb_reserve (skb, NET_IP_ALIGN);
343 entry = (struct skb_data *) skb->cb;
346 entry->state = rx_start;
349 usb_fill_bulk_urb (urb, dev->udev, dev->in,
350 skb->data, size, rx_complete, skb);
352 spin_lock_irqsave (&dev->rxq.lock, lockflags);
354 if (netif_running (dev->net) &&
355 netif_device_present (dev->net) &&
356 !test_bit (EVENT_RX_HALT, &dev->flags) &&
357 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
358 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
360 usbnet_defer_kevent (dev, EVENT_RX_HALT);
363 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
366 if (netif_msg_ifdown (dev))
367 netdev_dbg(dev->net, "device gone\n");
368 netif_device_detach (dev->net);
371 if (netif_msg_rx_err (dev))
372 netdev_dbg(dev->net, "rx submit, %d\n", retval);
373 tasklet_schedule (&dev->bh);
376 __skb_queue_tail (&dev->rxq, skb);
379 if (netif_msg_ifdown (dev))
380 netdev_dbg(dev->net, "rx: stopped\n");
383 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
385 dev_kfree_skb_any (skb);
391 /*-------------------------------------------------------------------------*/
393 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
395 if (dev->driver_info->rx_fixup &&
396 !dev->driver_info->rx_fixup (dev, skb))
398 // else network stack removes extra byte if we forced a short packet
401 usbnet_skb_return (dev, skb);
403 if (netif_msg_rx_err (dev))
404 netdev_dbg(dev->net, "drop\n");
406 dev->net->stats.rx_errors++;
407 skb_queue_tail (&dev->done, skb);
411 /*-------------------------------------------------------------------------*/
413 static void rx_complete (struct urb *urb)
415 struct sk_buff *skb = (struct sk_buff *) urb->context;
416 struct skb_data *entry = (struct skb_data *) skb->cb;
417 struct usbnet *dev = entry->dev;
418 int urb_status = urb->status;
420 skb_put (skb, urb->actual_length);
421 entry->state = rx_done;
424 switch (urb_status) {
427 if (skb->len < dev->net->hard_header_len) {
428 entry->state = rx_cleanup;
429 dev->net->stats.rx_errors++;
430 dev->net->stats.rx_length_errors++;
431 if (netif_msg_rx_err (dev))
432 netdev_dbg(dev->net, "rx length %d\n", skb->len);
436 /* stalls need manual reset. this is rare ... except that
437 * when going through USB 2.0 TTs, unplug appears this way.
438 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
439 * storm, recovering as needed.
442 dev->net->stats.rx_errors++;
443 usbnet_defer_kevent (dev, EVENT_RX_HALT);
446 /* software-driven interface shutdown */
447 case -ECONNRESET: /* async unlink */
448 case -ESHUTDOWN: /* hardware gone */
449 if (netif_msg_ifdown (dev))
450 netdev_dbg(dev->net, "rx shutdown, code %d\n", urb_status);
453 /* we get controller i/o faults during khubd disconnect() delays.
454 * throttle down resubmits, to avoid log floods; just temporarily,
455 * so we still recover when the fault isn't a khubd delay.
460 dev->net->stats.rx_errors++;
461 if (!timer_pending (&dev->delay)) {
462 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
463 if (netif_msg_link (dev))
464 netdev_dbg(dev->net, "rx throttle %d\n", urb_status);
467 entry->state = rx_cleanup;
472 /* data overrun ... flush fifo? */
474 dev->net->stats.rx_over_errors++;
478 entry->state = rx_cleanup;
479 dev->net->stats.rx_errors++;
480 if (netif_msg_rx_err (dev))
481 netdev_dbg(dev->net, "rx status %d\n", urb_status);
485 defer_bh(dev, skb, &dev->rxq);
488 if (netif_running (dev->net) &&
489 !test_bit (EVENT_RX_HALT, &dev->flags)) {
490 rx_submit (dev, urb, GFP_ATOMIC);
495 if (netif_msg_rx_err (dev))
496 netdev_dbg(dev->net, "no read resubmitted\n");
499 static void intr_complete (struct urb *urb)
501 struct usbnet *dev = urb->context;
502 int status = urb->status;
507 dev->driver_info->status(dev, urb);
510 /* software-driven interface shutdown */
511 case -ENOENT: /* urb killed */
512 case -ESHUTDOWN: /* hardware gone */
513 if (netif_msg_ifdown (dev))
514 netdev_dbg(dev->net, "intr shutdown, code %d\n", status);
517 /* NOTE: not throttling like RX/TX, since this endpoint
518 * already polls infrequently
521 netdev_dbg(dev->net, "intr status %d\n", status);
525 if (!netif_running (dev->net))
528 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
529 status = usb_submit_urb (urb, GFP_ATOMIC);
530 if (status != 0 && netif_msg_timer (dev))
531 netdev_err(dev->net, "intr resubmit --> %d\n", status);
534 /*-------------------------------------------------------------------------*/
535 void usbnet_pause_rx(struct usbnet *dev)
537 set_bit(EVENT_RX_PAUSED, &dev->flags);
539 if (netif_msg_rx_status(dev))
540 netdev_dbg(dev->net, "paused rx queue enabled\n");
542 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
544 void usbnet_resume_rx(struct usbnet *dev)
549 clear_bit(EVENT_RX_PAUSED, &dev->flags);
551 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
552 usbnet_skb_return(dev, skb);
556 tasklet_schedule(&dev->bh);
558 if (netif_msg_rx_status(dev))
559 netdev_dbg(dev->net, "paused rx queue disabled, %d skbs requeued\n",
562 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
564 void usbnet_purge_paused_rxq(struct usbnet *dev)
566 skb_queue_purge(&dev->rxq_pause);
568 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
570 /*-------------------------------------------------------------------------*/
572 // unlink pending rx/tx; completion handlers do all other cleanup
574 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
577 struct sk_buff *skb, *skbnext;
580 spin_lock_irqsave (&q->lock, flags);
581 skb_queue_walk_safe(q, skb, skbnext) {
582 struct skb_data *entry;
586 entry = (struct skb_data *) skb->cb;
589 // during some PM-driven resume scenarios,
590 // these (async) unlinks complete immediately
591 retval = usb_unlink_urb (urb);
592 if (retval != -EINPROGRESS && retval != 0)
593 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
597 spin_unlock_irqrestore (&q->lock, flags);
601 // Flush all pending rx urbs
602 // minidrivers may need to do this when the MTU changes
604 void usbnet_unlink_rx_urbs(struct usbnet *dev)
606 if (netif_running(dev->net)) {
607 (void) unlink_urbs (dev, &dev->rxq);
608 tasklet_schedule(&dev->bh);
611 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
613 /*-------------------------------------------------------------------------*/
615 // precondition: never called in_interrupt
616 static void usbnet_terminate_urbs(struct usbnet *dev)
618 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
619 DECLARE_WAITQUEUE(wait, current);
622 /* ensure there are no more active urbs */
623 add_wait_queue(&unlink_wakeup, &wait);
624 set_current_state(TASK_UNINTERRUPTIBLE);
625 dev->wait = &unlink_wakeup;
626 temp = unlink_urbs(dev, &dev->txq) +
627 unlink_urbs(dev, &dev->rxq);
629 /* maybe wait for deletions to finish. */
630 while (!skb_queue_empty(&dev->rxq)
631 && !skb_queue_empty(&dev->txq)
632 && !skb_queue_empty(&dev->done)) {
633 schedule_timeout(UNLINK_TIMEOUT_MS);
634 set_current_state(TASK_UNINTERRUPTIBLE);
635 if (netif_msg_ifdown(dev))
636 netdev_dbg(dev->net, "waited for %d urb completions\n",
639 set_current_state(TASK_RUNNING);
641 remove_wait_queue(&unlink_wakeup, &wait);
644 int usbnet_stop (struct net_device *net)
646 struct usbnet *dev = netdev_priv(net);
647 struct driver_info *info = dev->driver_info;
650 netif_stop_queue (net);
652 if (netif_msg_ifdown (dev))
653 netdev_info(dev->net, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n",
654 net->stats.rx_packets, net->stats.tx_packets,
655 net->stats.rx_errors, net->stats.tx_errors);
657 /* allow minidriver to stop correctly (wireless devices to turn off
660 retval = info->stop(dev);
661 if (retval < 0 && netif_msg_ifdown(dev))
662 netdev_info(dev->net,
663 "stop fail (%d) usbnet usb-%s-%s, %s\n",
665 dev->udev->bus->bus_name, dev->udev->devpath,
669 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
670 usbnet_terminate_urbs(dev);
672 usb_kill_urb(dev->interrupt);
674 usbnet_purge_paused_rxq(dev);
676 /* deferred work (task, timer, softirq) must also stop.
677 * can't flush_scheduled_work() until we drop rtnl (later),
678 * else workers could deadlock; so make workers a NOP.
681 del_timer_sync (&dev->delay);
682 tasklet_kill (&dev->bh);
683 if (info->manage_power)
684 info->manage_power(dev, 0);
686 usb_autopm_put_interface(dev->intf);
690 EXPORT_SYMBOL_GPL(usbnet_stop);
692 /*-------------------------------------------------------------------------*/
694 // posts reads, and enables write queuing
696 // precondition: never called in_interrupt
698 int usbnet_open (struct net_device *net)
700 struct usbnet *dev = netdev_priv(net);
702 struct driver_info *info = dev->driver_info;
704 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
705 if (netif_msg_ifup (dev))
706 netdev_info(dev->net,
707 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
709 dev->udev->bus->bus_name,
715 // put into "known safe" state
716 if (info->reset && (retval = info->reset (dev)) < 0) {
717 if (netif_msg_ifup (dev))
718 netdev_info(dev->net,
719 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
721 dev->udev->bus->bus_name,
727 // insist peer be connected
728 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
729 if (netif_msg_ifup (dev))
730 netdev_dbg(dev->net, "can't open; %d\n", retval);
734 /* start any status interrupt transfer */
735 if (dev->interrupt) {
736 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
738 if (netif_msg_ifup (dev))
739 netdev_err(dev->net, "intr submit %d\n", retval);
744 netif_start_queue (net);
745 if (netif_msg_ifup (dev)) {
748 if (dev->driver_info->flags & FLAG_FRAMING_NC)
750 else if (dev->driver_info->flags & FLAG_FRAMING_GL)
752 else if (dev->driver_info->flags & FLAG_FRAMING_Z)
754 else if (dev->driver_info->flags & FLAG_FRAMING_RN)
756 else if (dev->driver_info->flags & FLAG_FRAMING_AX)
761 netdev_info(dev->net, "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
762 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
763 dev->net->mtu, framing);
766 // delay posting reads until we're fully open
767 tasklet_schedule (&dev->bh);
768 if (info->manage_power) {
769 retval = info->manage_power(dev, 1);
772 usb_autopm_put_interface(dev->intf);
776 usb_autopm_put_interface(dev->intf);
780 EXPORT_SYMBOL_GPL(usbnet_open);
782 /*-------------------------------------------------------------------------*/
784 /* ethtool methods; minidrivers may need to add some more, but
785 * they'll probably want to use this base set.
788 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
790 struct usbnet *dev = netdev_priv(net);
792 if (!dev->mii.mdio_read)
795 return mii_ethtool_gset(&dev->mii, cmd);
797 EXPORT_SYMBOL_GPL(usbnet_get_settings);
799 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
801 struct usbnet *dev = netdev_priv(net);
804 if (!dev->mii.mdio_write)
807 retval = mii_ethtool_sset(&dev->mii, cmd);
809 /* link speed/duplex might have changed */
810 if (dev->driver_info->link_reset)
811 dev->driver_info->link_reset(dev);
816 EXPORT_SYMBOL_GPL(usbnet_set_settings);
818 u32 usbnet_get_link (struct net_device *net)
820 struct usbnet *dev = netdev_priv(net);
822 /* If a check_connect is defined, return its result */
823 if (dev->driver_info->check_connect)
824 return dev->driver_info->check_connect (dev) == 0;
826 /* if the device has mii operations, use those */
827 if (dev->mii.mdio_read)
828 return mii_link_ok(&dev->mii);
830 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
831 return ethtool_op_get_link(net);
833 EXPORT_SYMBOL_GPL(usbnet_get_link);
835 int usbnet_nway_reset(struct net_device *net)
837 struct usbnet *dev = netdev_priv(net);
839 if (!dev->mii.mdio_write)
842 return mii_nway_restart(&dev->mii);
844 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
846 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
848 struct usbnet *dev = netdev_priv(net);
850 strncpy (info->driver, dev->driver_name, sizeof info->driver);
851 strncpy (info->version, DRIVER_VERSION, sizeof info->version);
852 strncpy (info->fw_version, dev->driver_info->description,
853 sizeof info->fw_version);
854 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
856 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
858 u32 usbnet_get_msglevel (struct net_device *net)
860 struct usbnet *dev = netdev_priv(net);
862 return dev->msg_enable;
864 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
866 void usbnet_set_msglevel (struct net_device *net, u32 level)
868 struct usbnet *dev = netdev_priv(net);
870 dev->msg_enable = level;
872 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
874 /* drivers may override default ethtool_ops in their bind() routine */
875 static const struct ethtool_ops usbnet_ethtool_ops = {
876 .get_settings = usbnet_get_settings,
877 .set_settings = usbnet_set_settings,
878 .get_link = usbnet_get_link,
879 .nway_reset = usbnet_nway_reset,
880 .get_drvinfo = usbnet_get_drvinfo,
881 .get_msglevel = usbnet_get_msglevel,
882 .set_msglevel = usbnet_set_msglevel,
885 /*-------------------------------------------------------------------------*/
887 /* work that cannot be done in interrupt context uses keventd.
889 * NOTE: with 2.5 we could do more of this using completion callbacks,
890 * especially now that control transfers can be queued.
893 kevent (struct work_struct *work)
896 container_of(work, struct usbnet, kevent);
899 /* usb_clear_halt() needs a thread context */
900 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
901 unlink_urbs (dev, &dev->txq);
902 status = usb_autopm_get_interface(dev->intf);
905 status = usb_clear_halt (dev->udev, dev->out);
906 usb_autopm_put_interface(dev->intf);
909 status != -ESHUTDOWN) {
910 if (netif_msg_tx_err (dev))
912 netdev_err(dev->net, "can't clear tx halt, status %d\n",
915 clear_bit (EVENT_TX_HALT, &dev->flags);
916 if (status != -ESHUTDOWN)
917 netif_wake_queue (dev->net);
920 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
921 unlink_urbs (dev, &dev->rxq);
922 status = usb_autopm_get_interface(dev->intf);
925 status = usb_clear_halt (dev->udev, dev->in);
926 usb_autopm_put_interface(dev->intf);
929 status != -ESHUTDOWN) {
930 if (netif_msg_rx_err (dev))
932 netdev_err(dev->net, "can't clear rx halt, status %d\n",
935 clear_bit (EVENT_RX_HALT, &dev->flags);
936 tasklet_schedule (&dev->bh);
940 /* tasklet could resubmit itself forever if memory is tight */
941 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
942 struct urb *urb = NULL;
944 if (netif_running (dev->net))
945 urb = usb_alloc_urb (0, GFP_KERNEL);
947 clear_bit (EVENT_RX_MEMORY, &dev->flags);
949 clear_bit (EVENT_RX_MEMORY, &dev->flags);
950 status = usb_autopm_get_interface(dev->intf);
953 rx_submit (dev, urb, GFP_KERNEL);
954 usb_autopm_put_interface(dev->intf);
956 tasklet_schedule (&dev->bh);
960 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
961 struct driver_info *info = dev->driver_info;
964 clear_bit (EVENT_LINK_RESET, &dev->flags);
965 status = usb_autopm_get_interface(dev->intf);
968 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
969 usb_autopm_put_interface(dev->intf);
971 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
973 dev->udev->bus->bus_name,
977 usb_autopm_put_interface(dev->intf);
982 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
985 /*-------------------------------------------------------------------------*/
987 static void tx_complete (struct urb *urb)
989 struct sk_buff *skb = (struct sk_buff *) urb->context;
990 struct skb_data *entry = (struct skb_data *) skb->cb;
991 struct usbnet *dev = entry->dev;
993 if (urb->status == 0) {
994 dev->net->stats.tx_packets++;
995 dev->net->stats.tx_bytes += entry->length;
997 dev->net->stats.tx_errors++;
999 switch (urb->status) {
1001 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1004 /* software-driven interface shutdown */
1005 case -ECONNRESET: // async unlink
1006 case -ESHUTDOWN: // hardware gone
1009 // like rx, tx gets controller i/o faults during khubd delays
1010 // and so it uses the same throttling mechanism.
1014 usb_mark_last_busy(dev->udev);
1015 if (!timer_pending (&dev->delay)) {
1016 mod_timer (&dev->delay,
1017 jiffies + THROTTLE_JIFFIES);
1018 if (netif_msg_link (dev))
1019 netdev_dbg(dev->net, "tx throttle %d\n",
1022 netif_stop_queue (dev->net);
1025 if (netif_msg_tx_err (dev))
1026 netdev_dbg(dev->net, "tx err %d\n",
1027 entry->urb->status);
1032 usb_autopm_put_interface_async(dev->intf);
1034 entry->state = tx_done;
1035 defer_bh(dev, skb, &dev->txq);
1038 /*-------------------------------------------------------------------------*/
1040 void usbnet_tx_timeout (struct net_device *net)
1042 struct usbnet *dev = netdev_priv(net);
1044 unlink_urbs (dev, &dev->txq);
1045 tasklet_schedule (&dev->bh);
1047 // FIXME: device recovery -- reset?
1049 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1051 /*-------------------------------------------------------------------------*/
1053 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1054 struct net_device *net)
1056 struct usbnet *dev = netdev_priv(net);
1058 struct urb *urb = NULL;
1059 struct skb_data *entry;
1060 struct driver_info *info = dev->driver_info;
1061 unsigned long flags;
1064 // some devices want funky USB-level framing, for
1065 // win32 driver (usually) and/or hardware quirks
1066 if (info->tx_fixup) {
1067 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1069 if (netif_msg_tx_err (dev))
1070 netdev_dbg(dev->net, "can't tx_fixup skb\n");
1076 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1077 if (netif_msg_tx_err (dev))
1078 netdev_dbg(dev->net, "no urb\n");
1082 entry = (struct skb_data *) skb->cb;
1085 entry->state = tx_start;
1086 entry->length = length;
1088 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1089 skb->data, skb->len, tx_complete, skb);
1091 /* don't assume the hardware handles USB_ZERO_PACKET
1092 * NOTE: strictly conforming cdc-ether devices should expect
1093 * the ZLP here, but ignore the one-byte packet.
1095 if (!(info->flags & FLAG_SEND_ZLP) && (length % dev->maxpacket) == 0) {
1096 urb->transfer_buffer_length++;
1097 if (skb_tailroom(skb)) {
1098 skb->data[skb->len] = 0;
1103 spin_lock_irqsave(&dev->txq.lock, flags);
1104 retval = usb_autopm_get_interface_async(dev->intf);
1106 spin_unlock_irqrestore(&dev->txq.lock, flags);
1111 /* if this triggers the device is still a sleep */
1112 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1113 /* transmission will be done in resume */
1114 usb_anchor_urb(urb, &dev->deferred);
1115 /* no use to process more packets */
1116 netif_stop_queue(net);
1117 spin_unlock_irqrestore(&dev->txq.lock, flags);
1118 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1123 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1125 netif_stop_queue (net);
1126 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1127 usb_autopm_put_interface_async(dev->intf);
1130 usb_autopm_put_interface_async(dev->intf);
1131 if (netif_msg_tx_err (dev))
1132 netdev_dbg(dev->net, "tx: submit urb err %d\n", retval);
1135 net->trans_start = jiffies;
1136 __skb_queue_tail (&dev->txq, skb);
1137 if (dev->txq.qlen >= TX_QLEN (dev))
1138 netif_stop_queue (net);
1140 spin_unlock_irqrestore (&dev->txq.lock, flags);
1143 if (netif_msg_tx_err (dev))
1144 netdev_dbg(dev->net, "drop, code %d\n", retval);
1146 dev->net->stats.tx_dropped++;
1148 dev_kfree_skb_any (skb);
1150 } else if (netif_msg_tx_queued (dev)) {
1151 netdev_dbg(dev->net, "> tx, len %d, type 0x%x\n",
1152 length, skb->protocol);
1157 return NETDEV_TX_OK;
1159 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1161 /*-------------------------------------------------------------------------*/
1163 // tasklet (work deferred from completions, in_irq) or timer
1165 static void usbnet_bh (unsigned long param)
1167 struct usbnet *dev = (struct usbnet *) param;
1168 struct sk_buff *skb;
1169 struct skb_data *entry;
1171 while ((skb = skb_dequeue (&dev->done))) {
1172 entry = (struct skb_data *) skb->cb;
1173 switch (entry->state) {
1175 entry->state = rx_cleanup;
1176 rx_process (dev, skb);
1180 usb_free_urb (entry->urb);
1181 dev_kfree_skb (skb);
1184 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1188 // waiting for all pending urbs to complete?
1190 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1191 wake_up (dev->wait);
1194 // or are we maybe short a few urbs?
1195 } else if (netif_running (dev->net) &&
1196 netif_device_present (dev->net) &&
1197 !timer_pending (&dev->delay) &&
1198 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1199 int temp = dev->rxq.qlen;
1200 int qlen = RX_QLEN (dev);
1206 // don't refill the queue all at once
1207 for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1208 urb = usb_alloc_urb (0, GFP_ATOMIC);
1210 rx_submit (dev, urb, GFP_ATOMIC);
1212 if (temp != dev->rxq.qlen && netif_msg_link (dev))
1213 netdev_dbg(dev->net, "rxqlen %d --> %d\n",
1214 temp, dev->rxq.qlen);
1215 if (dev->rxq.qlen < qlen)
1216 tasklet_schedule (&dev->bh);
1218 if (dev->txq.qlen < TX_QLEN (dev))
1219 netif_wake_queue (dev->net);
1224 /*-------------------------------------------------------------------------
1226 * USB Device Driver support
1228 *-------------------------------------------------------------------------*/
1230 // precondition: never called in_interrupt
1232 void usbnet_disconnect (struct usb_interface *intf)
1235 struct usb_device *xdev;
1236 struct net_device *net;
1238 dev = usb_get_intfdata(intf);
1239 usb_set_intfdata(intf, NULL);
1243 xdev = interface_to_usbdev (intf);
1245 if (netif_msg_probe (dev))
1246 netdev_info(dev->net, "unregister '%s' usb-%s-%s, %s\n",
1247 intf->dev.driver->name,
1248 xdev->bus->bus_name, xdev->devpath,
1249 dev->driver_info->description);
1252 unregister_netdev (net);
1254 /* we don't hold rtnl here ... */
1255 flush_scheduled_work ();
1257 if (dev->driver_info->unbind)
1258 dev->driver_info->unbind (dev, intf);
1263 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1265 static const struct net_device_ops usbnet_netdev_ops = {
1266 .ndo_open = usbnet_open,
1267 .ndo_stop = usbnet_stop,
1268 .ndo_start_xmit = usbnet_start_xmit,
1269 .ndo_tx_timeout = usbnet_tx_timeout,
1270 .ndo_change_mtu = usbnet_change_mtu,
1271 .ndo_set_mac_address = eth_mac_addr,
1272 .ndo_validate_addr = eth_validate_addr,
1275 /*-------------------------------------------------------------------------*/
1277 // precondition: never called in_interrupt
1279 static struct device_type wlan_type = {
1283 static struct device_type wwan_type = {
1288 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1291 struct net_device *net;
1292 struct usb_host_interface *interface;
1293 struct driver_info *info;
1294 struct usb_device *xdev;
1298 name = udev->dev.driver->name;
1299 info = (struct driver_info *) prod->driver_info;
1301 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1304 xdev = interface_to_usbdev (udev);
1305 interface = udev->cur_altsetting;
1311 // set up our own records
1312 net = alloc_etherdev(sizeof(*dev));
1314 dbg ("can't kmalloc dev");
1318 dev = netdev_priv(net);
1321 dev->driver_info = info;
1322 dev->driver_name = name;
1323 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1324 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1325 skb_queue_head_init (&dev->rxq);
1326 skb_queue_head_init (&dev->txq);
1327 skb_queue_head_init (&dev->done);
1328 skb_queue_head_init(&dev->rxq_pause);
1329 dev->bh.func = usbnet_bh;
1330 dev->bh.data = (unsigned long) dev;
1331 INIT_WORK (&dev->kevent, kevent);
1332 init_usb_anchor(&dev->deferred);
1333 dev->delay.function = usbnet_bh;
1334 dev->delay.data = (unsigned long) dev;
1335 init_timer (&dev->delay);
1336 mutex_init (&dev->phy_mutex);
1339 strcpy (net->name, "usb%d");
1340 memcpy (net->dev_addr, node_id, sizeof node_id);
1342 /* rx and tx sides can use different message sizes;
1343 * bind() should set rx_urb_size in that case.
1345 dev->hard_mtu = net->mtu + net->hard_header_len;
1347 // dma_supported() is deeply broken on almost all architectures
1348 // possible with some EHCI controllers
1349 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1350 net->features |= NETIF_F_HIGHDMA;
1353 net->netdev_ops = &usbnet_netdev_ops;
1354 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1355 net->ethtool_ops = &usbnet_ethtool_ops;
1357 // allow device-specific bind/init procedures
1358 // NOTE net->name still not usable ...
1360 status = info->bind (dev, udev);
1364 // heuristic: "usb%d" for links we know are two-host,
1365 // else "eth%d" when there's reasonable doubt. userspace
1366 // can rename the link if it knows better.
1367 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1368 (net->dev_addr [0] & 0x02) == 0)
1369 strcpy (net->name, "eth%d");
1370 /* WLAN devices should always be named "wlan%d" */
1371 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1372 strcpy(net->name, "wlan%d");
1373 /* WWAN devices should always be named "wwan%d" */
1374 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1375 strcpy(net->name, "wwan%d");
1377 /* maybe the remote can't receive an Ethernet MTU */
1378 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1379 net->mtu = dev->hard_mtu - net->hard_header_len;
1380 } else if (!info->in || !info->out)
1381 status = usbnet_get_endpoints (dev, udev);
1383 dev->in = usb_rcvbulkpipe (xdev, info->in);
1384 dev->out = usb_sndbulkpipe (xdev, info->out);
1385 if (!(info->flags & FLAG_NO_SETINT))
1386 status = usb_set_interface (xdev,
1387 interface->desc.bInterfaceNumber,
1388 interface->desc.bAlternateSetting);
1393 if (status >= 0 && dev->status)
1394 status = init_status (dev, udev);
1398 if (!dev->rx_urb_size)
1399 dev->rx_urb_size = dev->hard_mtu;
1400 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1402 SET_NETDEV_DEV(net, &udev->dev);
1404 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1405 SET_NETDEV_DEVTYPE(net, &wlan_type);
1406 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1407 SET_NETDEV_DEVTYPE(net, &wwan_type);
1409 status = register_netdev (net);
1412 if (netif_msg_probe (dev))
1413 netdev_info(dev->net, "register '%s' at usb-%s-%s, %s, %pM\n",
1414 udev->dev.driver->name,
1415 xdev->bus->bus_name, xdev->devpath,
1416 dev->driver_info->description,
1419 // ok, it's ready to go.
1420 usb_set_intfdata (udev, dev);
1422 netif_device_attach (net);
1424 if (dev->driver_info->flags & FLAG_LINK_INTR)
1425 netif_carrier_off(net);
1431 info->unbind (dev, udev);
1438 EXPORT_SYMBOL_GPL(usbnet_probe);
1440 /*-------------------------------------------------------------------------*/
1443 * suspend the whole driver as soon as the first interface is suspended
1444 * resume only when the last interface is resumed
1447 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1449 struct usbnet *dev = usb_get_intfdata(intf);
1451 if (!dev->suspend_count++) {
1452 spin_lock_irq(&dev->txq.lock);
1453 /* don't autosuspend while transmitting */
1454 if (dev->txq.qlen && (message.event & PM_EVENT_AUTO)) {
1455 spin_unlock_irq(&dev->txq.lock);
1458 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1459 spin_unlock_irq(&dev->txq.lock);
1462 * accelerate emptying of the rx and queues, to avoid
1463 * having everything error out.
1465 netif_device_detach (dev->net);
1466 usbnet_terminate_urbs(dev);
1467 usb_kill_urb(dev->interrupt);
1470 * reattach so runtime management can use and
1473 netif_device_attach (dev->net);
1477 EXPORT_SYMBOL_GPL(usbnet_suspend);
1479 int usbnet_resume (struct usb_interface *intf)
1481 struct usbnet *dev = usb_get_intfdata(intf);
1482 struct sk_buff *skb;
1486 if (!--dev->suspend_count) {
1487 spin_lock_irq(&dev->txq.lock);
1488 while ((res = usb_get_from_anchor(&dev->deferred))) {
1490 printk(KERN_INFO"%s has delayed data\n", __func__);
1491 skb = (struct sk_buff *)res->context;
1492 retval = usb_submit_urb(res, GFP_ATOMIC);
1494 dev_kfree_skb_any(skb);
1496 usb_autopm_put_interface_async(dev->intf);
1498 dev->net->trans_start = jiffies;
1499 __skb_queue_tail(&dev->txq, skb);
1504 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1505 spin_unlock_irq(&dev->txq.lock);
1506 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1507 netif_start_queue(dev->net);
1508 tasklet_schedule (&dev->bh);
1512 EXPORT_SYMBOL_GPL(usbnet_resume);
1515 /*-------------------------------------------------------------------------*/
1517 static int __init usbnet_init(void)
1519 /* compiler should optimize this out */
1520 BUILD_BUG_ON (sizeof (((struct sk_buff *)0)->cb)
1521 < sizeof (struct skb_data));
1523 random_ether_addr(node_id);
1526 module_init(usbnet_init);
1528 static void __exit usbnet_exit(void)
1531 module_exit(usbnet_exit);
1533 MODULE_AUTHOR("David Brownell");
1534 MODULE_DESCRIPTION("USB network driver framework");
1535 MODULE_LICENSE("GPL");