2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * This is a generic "USB networking" framework that works with several
23 * kinds of full and high speed networking devices: host-to-host cables,
24 * smart usb peripherals, and actual Ethernet adapters.
26 * These devices usually differ in terms of control protocols (if they
27 * even have one!) and sometimes they define new framing to wrap or batch
28 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
29 * so interface (un)binding, endpoint I/O queues, fault handling, and other
30 * issues can usefully be addressed by this framework.
33 // #define DEBUG // error path messages, extra info
34 // #define VERBOSE // more; success messages
36 #include <linux/module.h>
37 #include <linux/init.h>
38 #include <linux/netdevice.h>
39 #include <linux/etherdevice.h>
40 #include <linux/ctype.h>
41 #include <linux/ethtool.h>
42 #include <linux/workqueue.h>
43 #include <linux/mii.h>
44 #include <linux/usb.h>
45 #include <linux/usb/usbnet.h>
46 #include <linux/slab.h>
47 #include <linux/kernel.h>
48 #include <linux/pm_runtime.h>
50 #define DRIVER_VERSION "22-Aug-2005"
53 /*-------------------------------------------------------------------------*/
56 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
57 * Several dozen bytes of IPv4 data can fit in two such transactions.
58 * One maximum size Ethernet packet takes twenty four of them.
59 * For high speed, each frame comfortably fits almost 36 max size
60 * Ethernet packets (so queues should be bigger).
62 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
63 * let the USB host controller be busy for 5msec or more before an irq
64 * is required, under load. Jumbograms change the equation.
66 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
67 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
68 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
69 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
70 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
72 // reawaken network queue this soon after stopping; else watchdog barks
73 #define TX_TIMEOUT_JIFFIES (5*HZ)
75 // throttle rx/tx briefly after some faults, so khubd might disconnect()
76 // us (it polls at HZ/4 usually) before we report too many false errors.
77 #define THROTTLE_JIFFIES (HZ/8)
80 #define UNLINK_TIMEOUT_MS 3
82 /*-------------------------------------------------------------------------*/
84 // randomly generated ethernet address
85 static u8 node_id [ETH_ALEN];
87 static const char driver_name [] = "usbnet";
89 /* use ethtool to change the level for any given device */
90 static int msg_level = -1;
91 module_param (msg_level, int, 0);
92 MODULE_PARM_DESC (msg_level, "Override default message level");
94 /*-------------------------------------------------------------------------*/
96 /* handles CDC Ethernet and many other network "bulk data" interfaces */
97 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
100 struct usb_host_interface *alt = NULL;
101 struct usb_host_endpoint *in = NULL, *out = NULL;
102 struct usb_host_endpoint *status = NULL;
104 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
107 in = out = status = NULL;
108 alt = intf->altsetting + tmp;
110 /* take the first altsetting with in-bulk + out-bulk;
111 * remember any status endpoint, just in case;
112 * ignore other endpoints and altsettings.
114 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
115 struct usb_host_endpoint *e;
118 e = alt->endpoint + ep;
119 switch (e->desc.bmAttributes) {
120 case USB_ENDPOINT_XFER_INT:
121 if (!usb_endpoint_dir_in(&e->desc))
125 case USB_ENDPOINT_XFER_BULK:
130 if (usb_endpoint_dir_in(&e->desc)) {
133 else if (intr && !status)
143 if (!alt || !in || !out)
146 if (alt->desc.bAlternateSetting != 0 ||
147 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
148 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
149 alt->desc.bAlternateSetting);
154 dev->in = usb_rcvbulkpipe (dev->udev,
155 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156 dev->out = usb_sndbulkpipe (dev->udev,
157 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
158 dev->status = status;
161 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
163 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
166 unsigned char buf [13];
168 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
170 dev_dbg(&dev->udev->dev,
171 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
176 for (i = tmp = 0; i < 6; i++, tmp += 2)
177 dev->net->dev_addr [i] =
178 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
181 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
183 static void intr_complete (struct urb *urb);
185 static int init_status (struct usbnet *dev, struct usb_interface *intf)
192 if (!dev->driver_info->status)
195 pipe = usb_rcvintpipe (dev->udev,
196 dev->status->desc.bEndpointAddress
197 & USB_ENDPOINT_NUMBER_MASK);
198 maxp = usb_maxpacket (dev->udev, pipe, 0);
200 /* avoid 1 msec chatter: min 8 msec poll rate */
201 period = max ((int) dev->status->desc.bInterval,
202 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
204 buf = kmalloc (maxp, GFP_KERNEL);
206 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
207 if (!dev->interrupt) {
211 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
212 buf, maxp, intr_complete, dev, period);
213 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
215 "status ep%din, %d bytes period %d\n",
216 usb_pipeendpoint(pipe), maxp, period);
222 /* Passes this packet up the stack, updating its accounting.
223 * Some link protocols batch packets, so their rx_fixup paths
224 * can return clones as well as just modify the original skb.
226 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
230 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
231 skb_queue_tail(&dev->rxq_pause, skb);
235 skb->protocol = eth_type_trans (skb, dev->net);
236 dev->net->stats.rx_packets++;
237 dev->net->stats.rx_bytes += skb->len;
239 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
240 skb->len + sizeof (struct ethhdr), skb->protocol);
241 memset (skb->cb, 0, sizeof (struct skb_data));
243 if (skb_defer_rx_timestamp(skb))
246 status = netif_rx (skb);
247 if (status != NET_RX_SUCCESS)
248 netif_dbg(dev, rx_err, dev->net,
249 "netif_rx status %d\n", status);
251 EXPORT_SYMBOL_GPL(usbnet_skb_return);
254 /*-------------------------------------------------------------------------
256 * Network Device Driver (peer link to "Host Device", from USB host)
258 *-------------------------------------------------------------------------*/
260 int usbnet_change_mtu (struct net_device *net, int new_mtu)
262 struct usbnet *dev = netdev_priv(net);
263 int ll_mtu = new_mtu + net->hard_header_len;
264 int old_hard_mtu = dev->hard_mtu;
265 int old_rx_urb_size = dev->rx_urb_size;
269 // no second zero-length packet read wanted after mtu-sized packets
270 if ((ll_mtu % dev->maxpacket) == 0)
274 dev->hard_mtu = net->mtu + net->hard_header_len;
275 if (dev->rx_urb_size == old_hard_mtu) {
276 dev->rx_urb_size = dev->hard_mtu;
277 if (dev->rx_urb_size > old_rx_urb_size)
278 usbnet_unlink_rx_urbs(dev);
283 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
285 /* The caller must hold list->lock */
286 static void __usbnet_queue_skb(struct sk_buff_head *list,
287 struct sk_buff *newsk, enum skb_state state)
289 struct skb_data *entry = (struct skb_data *) newsk->cb;
291 __skb_queue_tail(list, newsk);
292 entry->state = state;
295 /*-------------------------------------------------------------------------*/
297 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
298 * completion callbacks. 2.5 should have fixed those bugs...
301 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
302 struct sk_buff_head *list, enum skb_state state)
305 enum skb_state old_state;
306 struct skb_data *entry = (struct skb_data *) skb->cb;
308 spin_lock_irqsave(&list->lock, flags);
309 old_state = entry->state;
310 entry->state = state;
311 __skb_unlink(skb, list);
312 spin_unlock(&list->lock);
313 spin_lock(&dev->done.lock);
314 __skb_queue_tail(&dev->done, skb);
315 if (dev->done.qlen == 1)
316 tasklet_schedule(&dev->bh);
317 spin_unlock_irqrestore(&dev->done.lock, flags);
321 /* some work can't be done in tasklets, so we use keventd
323 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
324 * but tasklet_schedule() doesn't. hope the failure is rare.
326 void usbnet_defer_kevent (struct usbnet *dev, int work)
328 set_bit (work, &dev->flags);
329 if (!schedule_work (&dev->kevent))
330 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
332 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
334 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
336 /*-------------------------------------------------------------------------*/
338 static void rx_complete (struct urb *urb);
340 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
343 struct skb_data *entry;
345 unsigned long lockflags;
346 size_t size = dev->rx_urb_size;
348 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
350 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
351 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
356 entry = (struct skb_data *) skb->cb;
361 usb_fill_bulk_urb (urb, dev->udev, dev->in,
362 skb->data, size, rx_complete, skb);
364 spin_lock_irqsave (&dev->rxq.lock, lockflags);
366 if (netif_running (dev->net) &&
367 netif_device_present (dev->net) &&
368 !test_bit (EVENT_RX_HALT, &dev->flags) &&
369 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
370 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
372 usbnet_defer_kevent (dev, EVENT_RX_HALT);
375 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
378 netif_dbg(dev, ifdown, dev->net, "device gone\n");
379 netif_device_detach (dev->net);
385 netif_dbg(dev, rx_err, dev->net,
386 "rx submit, %d\n", retval);
387 tasklet_schedule (&dev->bh);
390 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
393 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
396 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
398 dev_kfree_skb_any (skb);
405 /*-------------------------------------------------------------------------*/
407 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
409 if (dev->driver_info->rx_fixup &&
410 !dev->driver_info->rx_fixup (dev, skb)) {
411 /* With RX_ASSEMBLE, rx_fixup() must update counters */
412 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
413 dev->net->stats.rx_errors++;
416 // else network stack removes extra byte if we forced a short packet
419 /* all data was already cloned from skb inside the driver */
420 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
421 dev_kfree_skb_any(skb);
423 usbnet_skb_return(dev, skb);
427 netif_dbg(dev, rx_err, dev->net, "drop\n");
428 dev->net->stats.rx_errors++;
430 skb_queue_tail(&dev->done, skb);
433 /*-------------------------------------------------------------------------*/
435 static void rx_complete (struct urb *urb)
437 struct sk_buff *skb = (struct sk_buff *) urb->context;
438 struct skb_data *entry = (struct skb_data *) skb->cb;
439 struct usbnet *dev = entry->dev;
440 int urb_status = urb->status;
441 enum skb_state state;
443 skb_put (skb, urb->actual_length);
447 switch (urb_status) {
450 if (skb->len < dev->net->hard_header_len) {
452 dev->net->stats.rx_errors++;
453 dev->net->stats.rx_length_errors++;
454 netif_dbg(dev, rx_err, dev->net,
455 "rx length %d\n", skb->len);
459 /* stalls need manual reset. this is rare ... except that
460 * when going through USB 2.0 TTs, unplug appears this way.
461 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
462 * storm, recovering as needed.
465 dev->net->stats.rx_errors++;
466 usbnet_defer_kevent (dev, EVENT_RX_HALT);
469 /* software-driven interface shutdown */
470 case -ECONNRESET: /* async unlink */
471 case -ESHUTDOWN: /* hardware gone */
472 netif_dbg(dev, ifdown, dev->net,
473 "rx shutdown, code %d\n", urb_status);
476 /* we get controller i/o faults during khubd disconnect() delays.
477 * throttle down resubmits, to avoid log floods; just temporarily,
478 * so we still recover when the fault isn't a khubd delay.
483 dev->net->stats.rx_errors++;
484 if (!timer_pending (&dev->delay)) {
485 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
486 netif_dbg(dev, link, dev->net,
487 "rx throttle %d\n", urb_status);
495 /* data overrun ... flush fifo? */
497 dev->net->stats.rx_over_errors++;
502 dev->net->stats.rx_errors++;
503 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
507 state = defer_bh(dev, skb, &dev->rxq, state);
510 if (netif_running (dev->net) &&
511 !test_bit (EVENT_RX_HALT, &dev->flags) &&
512 state != unlink_start) {
513 rx_submit (dev, urb, GFP_ATOMIC);
514 usb_mark_last_busy(dev->udev);
519 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
522 static void intr_complete (struct urb *urb)
524 struct usbnet *dev = urb->context;
525 int status = urb->status;
530 dev->driver_info->status(dev, urb);
533 /* software-driven interface shutdown */
534 case -ENOENT: /* urb killed */
535 case -ESHUTDOWN: /* hardware gone */
536 netif_dbg(dev, ifdown, dev->net,
537 "intr shutdown, code %d\n", status);
540 /* NOTE: not throttling like RX/TX, since this endpoint
541 * already polls infrequently
544 netdev_dbg(dev->net, "intr status %d\n", status);
548 if (!netif_running (dev->net))
551 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
552 status = usb_submit_urb (urb, GFP_ATOMIC);
554 netif_err(dev, timer, dev->net,
555 "intr resubmit --> %d\n", status);
558 /*-------------------------------------------------------------------------*/
559 void usbnet_pause_rx(struct usbnet *dev)
561 set_bit(EVENT_RX_PAUSED, &dev->flags);
563 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
565 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
567 void usbnet_resume_rx(struct usbnet *dev)
572 clear_bit(EVENT_RX_PAUSED, &dev->flags);
574 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
575 usbnet_skb_return(dev, skb);
579 tasklet_schedule(&dev->bh);
581 netif_dbg(dev, rx_status, dev->net,
582 "paused rx queue disabled, %d skbs requeued\n", num);
584 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
586 void usbnet_purge_paused_rxq(struct usbnet *dev)
588 skb_queue_purge(&dev->rxq_pause);
590 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
592 /*-------------------------------------------------------------------------*/
594 // unlink pending rx/tx; completion handlers do all other cleanup
596 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
602 spin_lock_irqsave (&q->lock, flags);
603 while (!skb_queue_empty(q)) {
604 struct skb_data *entry;
608 skb_queue_walk(q, skb) {
609 entry = (struct skb_data *) skb->cb;
610 if (entry->state != unlink_start)
615 entry->state = unlink_start;
619 * Get reference count of the URB to avoid it to be
620 * freed during usb_unlink_urb, which may trigger
621 * use-after-free problem inside usb_unlink_urb since
622 * usb_unlink_urb is always racing with .complete
623 * handler(include defer_bh).
626 spin_unlock_irqrestore(&q->lock, flags);
627 // during some PM-driven resume scenarios,
628 // these (async) unlinks complete immediately
629 retval = usb_unlink_urb (urb);
630 if (retval != -EINPROGRESS && retval != 0)
631 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
635 spin_lock_irqsave(&q->lock, flags);
637 spin_unlock_irqrestore (&q->lock, flags);
641 // Flush all pending rx urbs
642 // minidrivers may need to do this when the MTU changes
644 void usbnet_unlink_rx_urbs(struct usbnet *dev)
646 if (netif_running(dev->net)) {
647 (void) unlink_urbs (dev, &dev->rxq);
648 tasklet_schedule(&dev->bh);
651 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
653 /*-------------------------------------------------------------------------*/
655 // precondition: never called in_interrupt
656 static void usbnet_terminate_urbs(struct usbnet *dev)
658 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
659 DECLARE_WAITQUEUE(wait, current);
662 /* ensure there are no more active urbs */
663 add_wait_queue(&unlink_wakeup, &wait);
664 set_current_state(TASK_UNINTERRUPTIBLE);
665 dev->wait = &unlink_wakeup;
666 temp = unlink_urbs(dev, &dev->txq) +
667 unlink_urbs(dev, &dev->rxq);
669 /* maybe wait for deletions to finish. */
670 while (!skb_queue_empty(&dev->rxq)
671 && !skb_queue_empty(&dev->txq)
672 && !skb_queue_empty(&dev->done)) {
673 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
674 set_current_state(TASK_UNINTERRUPTIBLE);
675 netif_dbg(dev, ifdown, dev->net,
676 "waited for %d urb completions\n", temp);
678 set_current_state(TASK_RUNNING);
680 remove_wait_queue(&unlink_wakeup, &wait);
683 int usbnet_stop (struct net_device *net)
685 struct usbnet *dev = netdev_priv(net);
686 struct driver_info *info = dev->driver_info;
689 clear_bit(EVENT_DEV_OPEN, &dev->flags);
690 netif_stop_queue (net);
692 netif_info(dev, ifdown, dev->net,
693 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
694 net->stats.rx_packets, net->stats.tx_packets,
695 net->stats.rx_errors, net->stats.tx_errors);
697 /* allow minidriver to stop correctly (wireless devices to turn off
700 retval = info->stop(dev);
702 netif_info(dev, ifdown, dev->net,
703 "stop fail (%d) usbnet usb-%s-%s, %s\n",
705 dev->udev->bus->bus_name, dev->udev->devpath,
709 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
710 usbnet_terminate_urbs(dev);
712 usb_kill_urb(dev->interrupt);
714 usbnet_purge_paused_rxq(dev);
716 /* deferred work (task, timer, softirq) must also stop.
717 * can't flush_scheduled_work() until we drop rtnl (later),
718 * else workers could deadlock; so make workers a NOP.
721 del_timer_sync (&dev->delay);
722 tasklet_kill (&dev->bh);
723 if (info->manage_power)
724 info->manage_power(dev, 0);
726 usb_autopm_put_interface(dev->intf);
730 EXPORT_SYMBOL_GPL(usbnet_stop);
732 /*-------------------------------------------------------------------------*/
734 // posts reads, and enables write queuing
736 // precondition: never called in_interrupt
738 int usbnet_open (struct net_device *net)
740 struct usbnet *dev = netdev_priv(net);
742 struct driver_info *info = dev->driver_info;
744 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
745 netif_info(dev, ifup, dev->net,
746 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
748 dev->udev->bus->bus_name,
754 // put into "known safe" state
755 if (info->reset && (retval = info->reset (dev)) < 0) {
756 netif_info(dev, ifup, dev->net,
757 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
759 dev->udev->bus->bus_name,
765 // insist peer be connected
766 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
767 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
771 /* start any status interrupt transfer */
772 if (dev->interrupt) {
773 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
775 netif_err(dev, ifup, dev->net,
776 "intr submit %d\n", retval);
781 set_bit(EVENT_DEV_OPEN, &dev->flags);
782 netif_start_queue (net);
783 netif_info(dev, ifup, dev->net,
784 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
785 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
787 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
788 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
789 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
790 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
791 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
794 // delay posting reads until we're fully open
795 tasklet_schedule (&dev->bh);
796 if (info->manage_power) {
797 retval = info->manage_power(dev, 1);
799 goto done_manage_power_error;
800 usb_autopm_put_interface(dev->intf);
804 done_manage_power_error:
805 clear_bit(EVENT_DEV_OPEN, &dev->flags);
807 usb_autopm_put_interface(dev->intf);
811 EXPORT_SYMBOL_GPL(usbnet_open);
813 /*-------------------------------------------------------------------------*/
815 /* ethtool methods; minidrivers may need to add some more, but
816 * they'll probably want to use this base set.
819 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
821 struct usbnet *dev = netdev_priv(net);
823 if (!dev->mii.mdio_read)
826 return mii_ethtool_gset(&dev->mii, cmd);
828 EXPORT_SYMBOL_GPL(usbnet_get_settings);
830 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
832 struct usbnet *dev = netdev_priv(net);
835 if (!dev->mii.mdio_write)
838 retval = mii_ethtool_sset(&dev->mii, cmd);
840 /* link speed/duplex might have changed */
841 if (dev->driver_info->link_reset)
842 dev->driver_info->link_reset(dev);
847 EXPORT_SYMBOL_GPL(usbnet_set_settings);
849 u32 usbnet_get_link (struct net_device *net)
851 struct usbnet *dev = netdev_priv(net);
853 /* If a check_connect is defined, return its result */
854 if (dev->driver_info->check_connect)
855 return dev->driver_info->check_connect (dev) == 0;
857 /* if the device has mii operations, use those */
858 if (dev->mii.mdio_read)
859 return mii_link_ok(&dev->mii);
861 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
862 return ethtool_op_get_link(net);
864 EXPORT_SYMBOL_GPL(usbnet_get_link);
866 int usbnet_nway_reset(struct net_device *net)
868 struct usbnet *dev = netdev_priv(net);
870 if (!dev->mii.mdio_write)
873 return mii_nway_restart(&dev->mii);
875 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
877 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
879 struct usbnet *dev = netdev_priv(net);
881 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
882 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
883 strlcpy (info->fw_version, dev->driver_info->description,
884 sizeof info->fw_version);
885 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
887 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
889 u32 usbnet_get_msglevel (struct net_device *net)
891 struct usbnet *dev = netdev_priv(net);
893 return dev->msg_enable;
895 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
897 void usbnet_set_msglevel (struct net_device *net, u32 level)
899 struct usbnet *dev = netdev_priv(net);
901 dev->msg_enable = level;
903 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
905 /* drivers may override default ethtool_ops in their bind() routine */
906 static const struct ethtool_ops usbnet_ethtool_ops = {
907 .get_settings = usbnet_get_settings,
908 .set_settings = usbnet_set_settings,
909 .get_link = usbnet_get_link,
910 .nway_reset = usbnet_nway_reset,
911 .get_drvinfo = usbnet_get_drvinfo,
912 .get_msglevel = usbnet_get_msglevel,
913 .set_msglevel = usbnet_set_msglevel,
914 .get_ts_info = ethtool_op_get_ts_info,
917 /*-------------------------------------------------------------------------*/
919 /* work that cannot be done in interrupt context uses keventd.
921 * NOTE: with 2.5 we could do more of this using completion callbacks,
922 * especially now that control transfers can be queued.
925 kevent (struct work_struct *work)
928 container_of(work, struct usbnet, kevent);
931 /* usb_clear_halt() needs a thread context */
932 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
933 unlink_urbs (dev, &dev->txq);
934 status = usb_autopm_get_interface(dev->intf);
937 status = usb_clear_halt (dev->udev, dev->out);
938 usb_autopm_put_interface(dev->intf);
941 status != -ESHUTDOWN) {
942 if (netif_msg_tx_err (dev))
944 netdev_err(dev->net, "can't clear tx halt, status %d\n",
947 clear_bit (EVENT_TX_HALT, &dev->flags);
948 if (status != -ESHUTDOWN)
949 netif_wake_queue (dev->net);
952 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
953 unlink_urbs (dev, &dev->rxq);
954 status = usb_autopm_get_interface(dev->intf);
957 status = usb_clear_halt (dev->udev, dev->in);
958 usb_autopm_put_interface(dev->intf);
961 status != -ESHUTDOWN) {
962 if (netif_msg_rx_err (dev))
964 netdev_err(dev->net, "can't clear rx halt, status %d\n",
967 clear_bit (EVENT_RX_HALT, &dev->flags);
968 tasklet_schedule (&dev->bh);
972 /* tasklet could resubmit itself forever if memory is tight */
973 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
974 struct urb *urb = NULL;
977 if (netif_running (dev->net))
978 urb = usb_alloc_urb (0, GFP_KERNEL);
980 clear_bit (EVENT_RX_MEMORY, &dev->flags);
982 clear_bit (EVENT_RX_MEMORY, &dev->flags);
983 status = usb_autopm_get_interface(dev->intf);
988 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
990 usb_autopm_put_interface(dev->intf);
993 tasklet_schedule (&dev->bh);
997 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
998 struct driver_info *info = dev->driver_info;
1001 clear_bit (EVENT_LINK_RESET, &dev->flags);
1002 status = usb_autopm_get_interface(dev->intf);
1005 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1006 usb_autopm_put_interface(dev->intf);
1008 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1010 dev->udev->bus->bus_name,
1014 usb_autopm_put_interface(dev->intf);
1019 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1022 /*-------------------------------------------------------------------------*/
1024 static void tx_complete (struct urb *urb)
1026 struct sk_buff *skb = (struct sk_buff *) urb->context;
1027 struct skb_data *entry = (struct skb_data *) skb->cb;
1028 struct usbnet *dev = entry->dev;
1030 if (urb->status == 0) {
1031 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1032 dev->net->stats.tx_packets++;
1033 dev->net->stats.tx_bytes += entry->length;
1035 dev->net->stats.tx_errors++;
1037 switch (urb->status) {
1039 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1042 /* software-driven interface shutdown */
1043 case -ECONNRESET: // async unlink
1044 case -ESHUTDOWN: // hardware gone
1047 // like rx, tx gets controller i/o faults during khubd delays
1048 // and so it uses the same throttling mechanism.
1052 usb_mark_last_busy(dev->udev);
1053 if (!timer_pending (&dev->delay)) {
1054 mod_timer (&dev->delay,
1055 jiffies + THROTTLE_JIFFIES);
1056 netif_dbg(dev, link, dev->net,
1057 "tx throttle %d\n", urb->status);
1059 netif_stop_queue (dev->net);
1062 netif_dbg(dev, tx_err, dev->net,
1063 "tx err %d\n", entry->urb->status);
1068 usb_autopm_put_interface_async(dev->intf);
1069 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1072 /*-------------------------------------------------------------------------*/
1074 void usbnet_tx_timeout (struct net_device *net)
1076 struct usbnet *dev = netdev_priv(net);
1078 unlink_urbs (dev, &dev->txq);
1079 tasklet_schedule (&dev->bh);
1081 // FIXME: device recovery -- reset?
1083 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1085 /*-------------------------------------------------------------------------*/
1087 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1088 struct net_device *net)
1090 struct usbnet *dev = netdev_priv(net);
1092 struct urb *urb = NULL;
1093 struct skb_data *entry;
1094 struct driver_info *info = dev->driver_info;
1095 unsigned long flags;
1099 skb_tx_timestamp(skb);
1101 // some devices want funky USB-level framing, for
1102 // win32 driver (usually) and/or hardware quirks
1103 if (info->tx_fixup) {
1104 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1106 if (netif_msg_tx_err(dev)) {
1107 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1110 /* cdc_ncm collected packet; waits for more */
1117 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1118 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1122 entry = (struct skb_data *) skb->cb;
1125 entry->length = length;
1127 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1128 skb->data, skb->len, tx_complete, skb);
1130 /* don't assume the hardware handles USB_ZERO_PACKET
1131 * NOTE: strictly conforming cdc-ether devices should expect
1132 * the ZLP here, but ignore the one-byte packet.
1133 * NOTE2: CDC NCM specification is different from CDC ECM when
1134 * handling ZLP/short packets, so cdc_ncm driver will make short
1135 * packet itself if needed.
1137 if (length % dev->maxpacket == 0) {
1138 if (!(info->flags & FLAG_SEND_ZLP)) {
1139 if (!(info->flags & FLAG_MULTI_PACKET)) {
1140 urb->transfer_buffer_length++;
1141 if (skb_tailroom(skb)) {
1142 skb->data[skb->len] = 0;
1147 urb->transfer_flags |= URB_ZERO_PACKET;
1150 spin_lock_irqsave(&dev->txq.lock, flags);
1151 retval = usb_autopm_get_interface_async(dev->intf);
1153 spin_unlock_irqrestore(&dev->txq.lock, flags);
1158 /* if this triggers the device is still a sleep */
1159 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1160 /* transmission will be done in resume */
1161 usb_anchor_urb(urb, &dev->deferred);
1162 /* no use to process more packets */
1163 netif_stop_queue(net);
1164 spin_unlock_irqrestore(&dev->txq.lock, flags);
1165 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1170 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1172 netif_stop_queue (net);
1173 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1174 usb_autopm_put_interface_async(dev->intf);
1177 usb_autopm_put_interface_async(dev->intf);
1178 netif_dbg(dev, tx_err, dev->net,
1179 "tx: submit urb err %d\n", retval);
1182 net->trans_start = jiffies;
1183 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1184 if (dev->txq.qlen >= TX_QLEN (dev))
1185 netif_stop_queue (net);
1187 spin_unlock_irqrestore (&dev->txq.lock, flags);
1190 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1192 dev->net->stats.tx_dropped++;
1195 dev_kfree_skb_any (skb);
1198 netif_dbg(dev, tx_queued, dev->net,
1199 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1203 return NETDEV_TX_OK;
1205 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1207 static void rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1212 /* don't refill the queue all at once */
1213 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1214 urb = usb_alloc_urb(0, flags);
1216 if (rx_submit(dev, urb, flags) == -ENOLINK)
1222 /*-------------------------------------------------------------------------*/
1224 // tasklet (work deferred from completions, in_irq) or timer
1226 static void usbnet_bh (unsigned long param)
1228 struct usbnet *dev = (struct usbnet *) param;
1229 struct sk_buff *skb;
1230 struct skb_data *entry;
1232 while ((skb = skb_dequeue (&dev->done))) {
1233 entry = (struct skb_data *) skb->cb;
1234 switch (entry->state) {
1236 entry->state = rx_cleanup;
1237 rx_process (dev, skb);
1241 usb_free_urb (entry->urb);
1242 dev_kfree_skb (skb);
1245 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1249 // waiting for all pending urbs to complete?
1251 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1252 wake_up (dev->wait);
1255 // or are we maybe short a few urbs?
1256 } else if (netif_running (dev->net) &&
1257 netif_device_present (dev->net) &&
1258 !timer_pending (&dev->delay) &&
1259 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1260 int temp = dev->rxq.qlen;
1262 if (temp < RX_QLEN(dev)) {
1263 rx_alloc_submit(dev, GFP_ATOMIC);
1264 if (temp != dev->rxq.qlen)
1265 netif_dbg(dev, link, dev->net,
1266 "rxqlen %d --> %d\n",
1267 temp, dev->rxq.qlen);
1268 if (dev->rxq.qlen < RX_QLEN(dev))
1269 tasklet_schedule (&dev->bh);
1271 if (dev->txq.qlen < TX_QLEN (dev))
1272 netif_wake_queue (dev->net);
1277 /*-------------------------------------------------------------------------
1279 * USB Device Driver support
1281 *-------------------------------------------------------------------------*/
1283 // precondition: never called in_interrupt
1285 void usbnet_disconnect (struct usb_interface *intf)
1288 struct usb_device *xdev;
1289 struct net_device *net;
1291 dev = usb_get_intfdata(intf);
1292 usb_set_intfdata(intf, NULL);
1296 xdev = interface_to_usbdev (intf);
1298 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1299 intf->dev.driver->name,
1300 xdev->bus->bus_name, xdev->devpath,
1301 dev->driver_info->description);
1304 unregister_netdev (net);
1306 cancel_work_sync(&dev->kevent);
1308 if (dev->driver_info->unbind)
1309 dev->driver_info->unbind (dev, intf);
1311 usb_kill_urb(dev->interrupt);
1312 usb_free_urb(dev->interrupt);
1317 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1319 static const struct net_device_ops usbnet_netdev_ops = {
1320 .ndo_open = usbnet_open,
1321 .ndo_stop = usbnet_stop,
1322 .ndo_start_xmit = usbnet_start_xmit,
1323 .ndo_tx_timeout = usbnet_tx_timeout,
1324 .ndo_change_mtu = usbnet_change_mtu,
1325 .ndo_set_mac_address = eth_mac_addr,
1326 .ndo_validate_addr = eth_validate_addr,
1329 /*-------------------------------------------------------------------------*/
1331 // precondition: never called in_interrupt
1333 static struct device_type wlan_type = {
1337 static struct device_type wwan_type = {
1342 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1345 struct net_device *net;
1346 struct usb_host_interface *interface;
1347 struct driver_info *info;
1348 struct usb_device *xdev;
1351 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1353 /* usbnet already took usb runtime pm, so have to enable the feature
1354 * for usb interface, otherwise usb_autopm_get_interface may return
1355 * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1357 if (!driver->supports_autosuspend) {
1358 driver->supports_autosuspend = 1;
1359 pm_runtime_enable(&udev->dev);
1362 name = udev->dev.driver->name;
1363 info = (struct driver_info *) prod->driver_info;
1365 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1368 xdev = interface_to_usbdev (udev);
1369 interface = udev->cur_altsetting;
1375 // set up our own records
1376 net = alloc_etherdev(sizeof(*dev));
1380 /* netdev_printk() needs this so do it as early as possible */
1381 SET_NETDEV_DEV(net, &udev->dev);
1383 dev = netdev_priv(net);
1386 dev->driver_info = info;
1387 dev->driver_name = name;
1388 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1389 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1390 skb_queue_head_init (&dev->rxq);
1391 skb_queue_head_init (&dev->txq);
1392 skb_queue_head_init (&dev->done);
1393 skb_queue_head_init(&dev->rxq_pause);
1394 dev->bh.func = usbnet_bh;
1395 dev->bh.data = (unsigned long) dev;
1396 INIT_WORK (&dev->kevent, kevent);
1397 init_usb_anchor(&dev->deferred);
1398 dev->delay.function = usbnet_bh;
1399 dev->delay.data = (unsigned long) dev;
1400 init_timer (&dev->delay);
1401 mutex_init (&dev->phy_mutex);
1404 strcpy (net->name, "usb%d");
1405 memcpy (net->dev_addr, node_id, sizeof node_id);
1407 /* rx and tx sides can use different message sizes;
1408 * bind() should set rx_urb_size in that case.
1410 dev->hard_mtu = net->mtu + net->hard_header_len;
1412 // dma_supported() is deeply broken on almost all architectures
1413 // possible with some EHCI controllers
1414 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1415 net->features |= NETIF_F_HIGHDMA;
1418 net->netdev_ops = &usbnet_netdev_ops;
1419 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1420 net->ethtool_ops = &usbnet_ethtool_ops;
1422 // allow device-specific bind/init procedures
1423 // NOTE net->name still not usable ...
1425 status = info->bind (dev, udev);
1429 // heuristic: "usb%d" for links we know are two-host,
1430 // else "eth%d" when there's reasonable doubt. userspace
1431 // can rename the link if it knows better.
1432 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1433 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1434 (net->dev_addr [0] & 0x02) == 0))
1435 strcpy (net->name, "eth%d");
1436 /* WLAN devices should always be named "wlan%d" */
1437 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1438 strcpy(net->name, "wlan%d");
1439 /* WWAN devices should always be named "wwan%d" */
1440 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1441 strcpy(net->name, "wwan%d");
1443 /* maybe the remote can't receive an Ethernet MTU */
1444 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1445 net->mtu = dev->hard_mtu - net->hard_header_len;
1446 } else if (!info->in || !info->out)
1447 status = usbnet_get_endpoints (dev, udev);
1449 dev->in = usb_rcvbulkpipe (xdev, info->in);
1450 dev->out = usb_sndbulkpipe (xdev, info->out);
1451 if (!(info->flags & FLAG_NO_SETINT))
1452 status = usb_set_interface (xdev,
1453 interface->desc.bInterfaceNumber,
1454 interface->desc.bAlternateSetting);
1459 if (status >= 0 && dev->status)
1460 status = init_status (dev, udev);
1464 if (!dev->rx_urb_size)
1465 dev->rx_urb_size = dev->hard_mtu;
1466 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1468 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1469 SET_NETDEV_DEVTYPE(net, &wlan_type);
1470 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1471 SET_NETDEV_DEVTYPE(net, &wwan_type);
1473 status = register_netdev (net);
1476 netif_info(dev, probe, dev->net,
1477 "register '%s' at usb-%s-%s, %s, %pM\n",
1478 udev->dev.driver->name,
1479 xdev->bus->bus_name, xdev->devpath,
1480 dev->driver_info->description,
1483 // ok, it's ready to go.
1484 usb_set_intfdata (udev, dev);
1486 netif_device_attach (net);
1488 if (dev->driver_info->flags & FLAG_LINK_INTR)
1489 netif_carrier_off(net);
1494 usb_free_urb(dev->interrupt);
1497 info->unbind (dev, udev);
1504 EXPORT_SYMBOL_GPL(usbnet_probe);
1506 /*-------------------------------------------------------------------------*/
1509 * suspend the whole driver as soon as the first interface is suspended
1510 * resume only when the last interface is resumed
1513 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1515 struct usbnet *dev = usb_get_intfdata(intf);
1517 if (!dev->suspend_count++) {
1518 spin_lock_irq(&dev->txq.lock);
1519 /* don't autosuspend while transmitting */
1520 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1521 dev->suspend_count--;
1522 spin_unlock_irq(&dev->txq.lock);
1525 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1526 spin_unlock_irq(&dev->txq.lock);
1529 * accelerate emptying of the rx and queues, to avoid
1530 * having everything error out.
1532 netif_device_detach (dev->net);
1533 usbnet_terminate_urbs(dev);
1534 usb_kill_urb(dev->interrupt);
1537 * reattach so runtime management can use and
1540 netif_device_attach (dev->net);
1544 EXPORT_SYMBOL_GPL(usbnet_suspend);
1546 int usbnet_resume (struct usb_interface *intf)
1548 struct usbnet *dev = usb_get_intfdata(intf);
1549 struct sk_buff *skb;
1553 if (!--dev->suspend_count) {
1554 /* resume interrupt URBs */
1555 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1556 usb_submit_urb(dev->interrupt, GFP_NOIO);
1558 spin_lock_irq(&dev->txq.lock);
1559 while ((res = usb_get_from_anchor(&dev->deferred))) {
1561 skb = (struct sk_buff *)res->context;
1562 retval = usb_submit_urb(res, GFP_ATOMIC);
1564 dev_kfree_skb_any(skb);
1566 usb_autopm_put_interface_async(dev->intf);
1568 dev->net->trans_start = jiffies;
1569 __skb_queue_tail(&dev->txq, skb);
1574 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1575 spin_unlock_irq(&dev->txq.lock);
1577 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1578 /* handle remote wakeup ASAP */
1580 netif_device_present(dev->net) &&
1581 !timer_pending(&dev->delay) &&
1582 !test_bit(EVENT_RX_HALT, &dev->flags))
1583 rx_alloc_submit(dev, GFP_KERNEL);
1585 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1586 netif_tx_wake_all_queues(dev->net);
1587 tasklet_schedule (&dev->bh);
1592 EXPORT_SYMBOL_GPL(usbnet_resume);
1595 /*-------------------------------------------------------------------------*/
1597 static int __init usbnet_init(void)
1599 /* Compiler should optimize this out. */
1601 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1603 random_ether_addr(node_id);
1606 module_init(usbnet_init);
1608 static void __exit usbnet_exit(void)
1611 module_exit(usbnet_exit);
1613 MODULE_AUTHOR("David Brownell");
1614 MODULE_DESCRIPTION("USB network driver framework");
1615 MODULE_LICENSE("GPL");