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, see <http://www.gnu.org/licenses/>.
21 * This is a generic "USB networking" framework that works with several
22 * kinds of full and high speed networking devices: host-to-host cables,
23 * smart usb peripherals, and actual Ethernet adapters.
25 * These devices usually differ in terms of control protocols (if they
26 * even have one!) and sometimes they define new framing to wrap or batch
27 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
28 * so interface (un)binding, endpoint I/O queues, fault handling, and other
29 * issues can usefully be addressed by this framework.
32 // #define DEBUG // error path messages, extra info
33 // #define VERBOSE // more; success messages
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/netdevice.h>
38 #include <linux/etherdevice.h>
39 #include <linux/ctype.h>
40 #include <linux/ethtool.h>
41 #include <linux/workqueue.h>
42 #include <linux/mii.h>
43 #include <linux/usb.h>
44 #include <linux/usb/usbnet.h>
45 #include <linux/slab.h>
46 #include <linux/kernel.h>
47 #include <linux/pm_runtime.h>
49 #define DRIVER_VERSION "22-Aug-2005"
52 /*-------------------------------------------------------------------------*/
55 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
56 * Several dozen bytes of IPv4 data can fit in two such transactions.
57 * One maximum size Ethernet packet takes twenty four of them.
58 * For high speed, each frame comfortably fits almost 36 max size
59 * Ethernet packets (so queues should be bigger).
61 * The goal is to let the USB host controller be busy for 5msec or
62 * more before an irq is required, under load. Jumbograms change
65 #define MAX_QUEUE_MEMORY (60 * 1518)
66 #define RX_QLEN(dev) ((dev)->rx_qlen)
67 #define TX_QLEN(dev) ((dev)->tx_qlen)
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 hub_wq might disconnect()
73 * 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 /* use ethtool to change the level for any given device */
86 static int msg_level = -1;
87 module_param (msg_level, int, 0);
88 MODULE_PARM_DESC (msg_level, "Override default message level");
90 /*-------------------------------------------------------------------------*/
92 /* handles CDC Ethernet and many other network "bulk data" interfaces */
93 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
96 struct usb_host_interface *alt = NULL;
97 struct usb_host_endpoint *in = NULL, *out = NULL;
98 struct usb_host_endpoint *status = NULL;
100 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
103 in = out = status = NULL;
104 alt = intf->altsetting + tmp;
106 /* take the first altsetting with in-bulk + out-bulk;
107 * remember any status endpoint, just in case;
108 * ignore other endpoints and altsettings.
110 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
111 struct usb_host_endpoint *e;
114 e = alt->endpoint + ep;
116 /* ignore endpoints which cannot transfer data */
117 if (!usb_endpoint_maxp(&e->desc))
120 switch (e->desc.bmAttributes) {
121 case USB_ENDPOINT_XFER_INT:
122 if (!usb_endpoint_dir_in(&e->desc))
126 case USB_ENDPOINT_XFER_BULK:
131 if (usb_endpoint_dir_in(&e->desc)) {
134 else if (intr && !status)
144 if (!alt || !in || !out)
147 if (alt->desc.bAlternateSetting != 0 ||
148 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
149 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
150 alt->desc.bAlternateSetting);
155 dev->in = usb_rcvbulkpipe (dev->udev,
156 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
157 dev->out = usb_sndbulkpipe (dev->udev,
158 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
159 dev->status = status;
162 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
164 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
167 unsigned char buf [13];
169 ret = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
171 tmp = hex2bin(dev->net->dev_addr, buf, 6);
173 dev_dbg(&dev->udev->dev,
174 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
181 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
183 static void intr_complete (struct urb *urb)
185 struct usbnet *dev = urb->context;
186 int status = urb->status;
191 dev->driver_info->status(dev, urb);
194 /* software-driven interface shutdown */
195 case -ENOENT: /* urb killed */
196 case -ESHUTDOWN: /* hardware gone */
197 netif_dbg(dev, ifdown, dev->net,
198 "intr shutdown, code %d\n", status);
201 /* NOTE: not throttling like RX/TX, since this endpoint
202 * already polls infrequently
205 netdev_dbg(dev->net, "intr status %d\n", status);
209 status = usb_submit_urb (urb, GFP_ATOMIC);
211 netif_err(dev, timer, dev->net,
212 "intr resubmit --> %d\n", status);
215 static int init_status (struct usbnet *dev, struct usb_interface *intf)
222 if (!dev->driver_info->status)
225 pipe = usb_rcvintpipe (dev->udev,
226 dev->status->desc.bEndpointAddress
227 & USB_ENDPOINT_NUMBER_MASK);
228 maxp = usb_maxpacket (dev->udev, pipe, 0);
230 /* avoid 1 msec chatter: min 8 msec poll rate */
231 period = max ((int) dev->status->desc.bInterval,
232 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
234 buf = kmalloc (maxp, GFP_KERNEL);
236 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
237 if (!dev->interrupt) {
241 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
242 buf, maxp, intr_complete, dev, period);
243 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
245 "status ep%din, %d bytes period %d\n",
246 usb_pipeendpoint(pipe), maxp, period);
252 /* Submit the interrupt URB if not previously submitted, increasing refcount */
253 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
257 WARN_ON_ONCE(dev->interrupt == NULL);
258 if (dev->interrupt) {
259 mutex_lock(&dev->interrupt_mutex);
261 if (++dev->interrupt_count == 1)
262 ret = usb_submit_urb(dev->interrupt, mem_flags);
264 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
265 dev->interrupt_count);
266 mutex_unlock(&dev->interrupt_mutex);
270 EXPORT_SYMBOL_GPL(usbnet_status_start);
272 /* For resume; submit interrupt URB if previously submitted */
273 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
277 mutex_lock(&dev->interrupt_mutex);
278 if (dev->interrupt_count) {
279 ret = usb_submit_urb(dev->interrupt, mem_flags);
280 dev_dbg(&dev->udev->dev,
281 "submitted interrupt URB for resume\n");
283 mutex_unlock(&dev->interrupt_mutex);
287 /* Kill the interrupt URB if all submitters want it killed */
288 void usbnet_status_stop(struct usbnet *dev)
290 if (dev->interrupt) {
291 mutex_lock(&dev->interrupt_mutex);
292 WARN_ON(dev->interrupt_count == 0);
294 if (dev->interrupt_count && --dev->interrupt_count == 0)
295 usb_kill_urb(dev->interrupt);
297 dev_dbg(&dev->udev->dev,
298 "decremented interrupt URB count to %d\n",
299 dev->interrupt_count);
300 mutex_unlock(&dev->interrupt_mutex);
303 EXPORT_SYMBOL_GPL(usbnet_status_stop);
305 /* For suspend; always kill interrupt URB */
306 static void __usbnet_status_stop_force(struct usbnet *dev)
308 if (dev->interrupt) {
309 mutex_lock(&dev->interrupt_mutex);
310 usb_kill_urb(dev->interrupt);
311 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
312 mutex_unlock(&dev->interrupt_mutex);
316 /* Passes this packet up the stack, updating its accounting.
317 * Some link protocols batch packets, so their rx_fixup paths
318 * can return clones as well as just modify the original skb.
320 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
322 struct pcpu_sw_netstats *stats64 = this_cpu_ptr(dev->stats64);
326 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
327 skb_queue_tail(&dev->rxq_pause, skb);
331 /* only update if unset to allow minidriver rx_fixup override */
332 if (skb->protocol == 0)
333 skb->protocol = eth_type_trans (skb, dev->net);
335 flags = u64_stats_update_begin_irqsave(&stats64->syncp);
336 stats64->rx_packets++;
337 stats64->rx_bytes += skb->len;
338 u64_stats_update_end_irqrestore(&stats64->syncp, flags);
340 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
341 skb->len + sizeof (struct ethhdr), skb->protocol);
342 memset (skb->cb, 0, sizeof (struct skb_data));
344 if (skb_defer_rx_timestamp(skb))
347 status = netif_rx (skb);
348 if (status != NET_RX_SUCCESS)
349 netif_dbg(dev, rx_err, dev->net,
350 "netif_rx status %d\n", status);
352 EXPORT_SYMBOL_GPL(usbnet_skb_return);
354 /* must be called if hard_mtu or rx_urb_size changed */
355 void usbnet_update_max_qlen(struct usbnet *dev)
357 enum usb_device_speed speed = dev->udev->speed;
359 if (!dev->rx_urb_size || !dev->hard_mtu)
363 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
364 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
366 case USB_SPEED_SUPER:
367 case USB_SPEED_SUPER_PLUS:
369 * Not take default 5ms qlen for super speed HC to
370 * save memory, and iperf tests show 2.5ms qlen can
373 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
374 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
378 dev->rx_qlen = dev->tx_qlen = 4;
381 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
384 /*-------------------------------------------------------------------------
386 * Network Device Driver (peer link to "Host Device", from USB host)
388 *-------------------------------------------------------------------------*/
390 int usbnet_change_mtu (struct net_device *net, int new_mtu)
392 struct usbnet *dev = netdev_priv(net);
393 int ll_mtu = new_mtu + net->hard_header_len;
394 int old_hard_mtu = dev->hard_mtu;
395 int old_rx_urb_size = dev->rx_urb_size;
397 // no second zero-length packet read wanted after mtu-sized packets
398 if ((ll_mtu % dev->maxpacket) == 0)
402 dev->hard_mtu = net->mtu + net->hard_header_len;
403 if (dev->rx_urb_size == old_hard_mtu) {
404 dev->rx_urb_size = dev->hard_mtu;
405 if (dev->rx_urb_size > old_rx_urb_size) {
406 usbnet_pause_rx(dev);
407 usbnet_unlink_rx_urbs(dev);
408 usbnet_resume_rx(dev);
412 /* max qlen depend on hard_mtu and rx_urb_size */
413 usbnet_update_max_qlen(dev);
417 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
419 /* The caller must hold list->lock */
420 static void __usbnet_queue_skb(struct sk_buff_head *list,
421 struct sk_buff *newsk, enum skb_state state)
423 struct skb_data *entry = (struct skb_data *) newsk->cb;
425 __skb_queue_tail(list, newsk);
426 entry->state = state;
429 /*-------------------------------------------------------------------------*/
431 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
432 * completion callbacks. 2.5 should have fixed those bugs...
435 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
436 struct sk_buff_head *list, enum skb_state state)
439 enum skb_state old_state;
440 struct skb_data *entry = (struct skb_data *) skb->cb;
442 spin_lock_irqsave(&list->lock, flags);
443 old_state = entry->state;
444 entry->state = state;
445 __skb_unlink(skb, list);
447 /* defer_bh() is never called with list == &dev->done.
448 * spin_lock_nested() tells lockdep that it is OK to take
449 * dev->done.lock here with list->lock held.
451 spin_lock_nested(&dev->done.lock, SINGLE_DEPTH_NESTING);
453 __skb_queue_tail(&dev->done, skb);
454 if (dev->done.qlen == 1)
455 tasklet_schedule(&dev->bh);
456 spin_unlock(&dev->done.lock);
457 spin_unlock_irqrestore(&list->lock, flags);
461 /* some work can't be done in tasklets, so we use keventd
463 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
464 * but tasklet_schedule() doesn't. hope the failure is rare.
466 void usbnet_defer_kevent (struct usbnet *dev, int work)
468 set_bit (work, &dev->flags);
469 if (!schedule_work (&dev->kevent)) {
471 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
473 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
476 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
478 /*-------------------------------------------------------------------------*/
480 static void rx_complete (struct urb *urb);
482 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
485 struct skb_data *entry;
487 unsigned long lockflags;
488 size_t size = dev->rx_urb_size;
490 /* prevent rx skb allocation when error ratio is high */
491 if (test_bit(EVENT_RX_KILL, &dev->flags)) {
496 if (test_bit(EVENT_NO_IP_ALIGN, &dev->flags))
497 skb = __netdev_alloc_skb(dev->net, size, flags);
499 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
501 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
502 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
507 entry = (struct skb_data *) skb->cb;
512 usb_fill_bulk_urb (urb, dev->udev, dev->in,
513 skb->data, size, rx_complete, skb);
515 spin_lock_irqsave (&dev->rxq.lock, lockflags);
517 if (netif_running (dev->net) &&
518 netif_device_present (dev->net) &&
519 test_bit(EVENT_DEV_OPEN, &dev->flags) &&
520 !test_bit (EVENT_RX_HALT, &dev->flags) &&
521 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
522 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
524 usbnet_defer_kevent (dev, EVENT_RX_HALT);
527 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
530 netif_dbg(dev, ifdown, dev->net, "device gone\n");
531 netif_device_detach (dev->net);
537 netif_dbg(dev, rx_err, dev->net,
538 "rx submit, %d\n", retval);
539 tasklet_schedule (&dev->bh);
542 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
545 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
548 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
550 dev_kfree_skb_any (skb);
557 /*-------------------------------------------------------------------------*/
559 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
561 if (dev->driver_info->rx_fixup &&
562 !dev->driver_info->rx_fixup (dev, skb)) {
563 /* With RX_ASSEMBLE, rx_fixup() must update counters */
564 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
565 dev->net->stats.rx_errors++;
568 // else network stack removes extra byte if we forced a short packet
570 /* all data was already cloned from skb inside the driver */
571 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
574 if (skb->len < ETH_HLEN) {
575 dev->net->stats.rx_errors++;
576 dev->net->stats.rx_length_errors++;
577 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
579 usbnet_skb_return(dev, skb);
584 skb_queue_tail(&dev->done, skb);
587 /*-------------------------------------------------------------------------*/
589 static void rx_complete (struct urb *urb)
591 struct sk_buff *skb = (struct sk_buff *) urb->context;
592 struct skb_data *entry = (struct skb_data *) skb->cb;
593 struct usbnet *dev = entry->dev;
594 int urb_status = urb->status;
595 enum skb_state state;
597 skb_put (skb, urb->actual_length);
601 switch (urb_status) {
606 /* stalls need manual reset. this is rare ... except that
607 * when going through USB 2.0 TTs, unplug appears this way.
608 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
609 * storm, recovering as needed.
612 dev->net->stats.rx_errors++;
613 usbnet_defer_kevent (dev, EVENT_RX_HALT);
616 /* software-driven interface shutdown */
617 case -ECONNRESET: /* async unlink */
618 case -ESHUTDOWN: /* hardware gone */
619 netif_dbg(dev, ifdown, dev->net,
620 "rx shutdown, code %d\n", urb_status);
623 /* we get controller i/o faults during hub_wq disconnect() delays.
624 * throttle down resubmits, to avoid log floods; just temporarily,
625 * so we still recover when the fault isn't a hub_wq delay.
630 dev->net->stats.rx_errors++;
631 if (!timer_pending (&dev->delay)) {
632 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
633 netif_dbg(dev, link, dev->net,
634 "rx throttle %d\n", urb_status);
642 /* data overrun ... flush fifo? */
644 dev->net->stats.rx_over_errors++;
649 dev->net->stats.rx_errors++;
650 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
654 /* stop rx if packet error rate is high */
655 if (++dev->pkt_cnt > 30) {
659 if (state == rx_cleanup)
661 if (dev->pkt_err > 20)
662 set_bit(EVENT_RX_KILL, &dev->flags);
665 state = defer_bh(dev, skb, &dev->rxq, state);
668 if (netif_running (dev->net) &&
669 !test_bit (EVENT_RX_HALT, &dev->flags) &&
670 state != unlink_start) {
671 rx_submit (dev, urb, GFP_ATOMIC);
672 usb_mark_last_busy(dev->udev);
677 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
680 /*-------------------------------------------------------------------------*/
681 void usbnet_pause_rx(struct usbnet *dev)
683 set_bit(EVENT_RX_PAUSED, &dev->flags);
685 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
687 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
689 void usbnet_resume_rx(struct usbnet *dev)
694 clear_bit(EVENT_RX_PAUSED, &dev->flags);
696 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
697 usbnet_skb_return(dev, skb);
701 tasklet_schedule(&dev->bh);
703 netif_dbg(dev, rx_status, dev->net,
704 "paused rx queue disabled, %d skbs requeued\n", num);
706 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
708 void usbnet_purge_paused_rxq(struct usbnet *dev)
710 skb_queue_purge(&dev->rxq_pause);
712 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
714 /*-------------------------------------------------------------------------*/
716 // unlink pending rx/tx; completion handlers do all other cleanup
718 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
724 spin_lock_irqsave (&q->lock, flags);
725 while (!skb_queue_empty(q)) {
726 struct skb_data *entry;
730 skb_queue_walk(q, skb) {
731 entry = (struct skb_data *) skb->cb;
732 if (entry->state != unlink_start)
737 entry->state = unlink_start;
741 * Get reference count of the URB to avoid it to be
742 * freed during usb_unlink_urb, which may trigger
743 * use-after-free problem inside usb_unlink_urb since
744 * usb_unlink_urb is always racing with .complete
745 * handler(include defer_bh).
748 spin_unlock_irqrestore(&q->lock, flags);
749 // during some PM-driven resume scenarios,
750 // these (async) unlinks complete immediately
751 retval = usb_unlink_urb (urb);
752 if (retval != -EINPROGRESS && retval != 0)
753 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
757 spin_lock_irqsave(&q->lock, flags);
759 spin_unlock_irqrestore (&q->lock, flags);
763 // Flush all pending rx urbs
764 // minidrivers may need to do this when the MTU changes
766 void usbnet_unlink_rx_urbs(struct usbnet *dev)
768 if (netif_running(dev->net)) {
769 (void) unlink_urbs (dev, &dev->rxq);
770 tasklet_schedule(&dev->bh);
773 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
775 /*-------------------------------------------------------------------------*/
777 static void wait_skb_queue_empty(struct sk_buff_head *q)
781 spin_lock_irqsave(&q->lock, flags);
782 while (!skb_queue_empty(q)) {
783 spin_unlock_irqrestore(&q->lock, flags);
784 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
785 set_current_state(TASK_UNINTERRUPTIBLE);
786 spin_lock_irqsave(&q->lock, flags);
788 spin_unlock_irqrestore(&q->lock, flags);
791 // precondition: never called in_interrupt
792 static void usbnet_terminate_urbs(struct usbnet *dev)
794 DECLARE_WAITQUEUE(wait, current);
797 /* ensure there are no more active urbs */
798 add_wait_queue(&dev->wait, &wait);
799 set_current_state(TASK_UNINTERRUPTIBLE);
800 temp = unlink_urbs(dev, &dev->txq) +
801 unlink_urbs(dev, &dev->rxq);
803 /* maybe wait for deletions to finish. */
804 wait_skb_queue_empty(&dev->rxq);
805 wait_skb_queue_empty(&dev->txq);
806 wait_skb_queue_empty(&dev->done);
807 netif_dbg(dev, ifdown, dev->net,
808 "waited for %d urb completions\n", temp);
809 set_current_state(TASK_RUNNING);
810 remove_wait_queue(&dev->wait, &wait);
813 int usbnet_stop (struct net_device *net)
815 struct usbnet *dev = netdev_priv(net);
816 struct driver_info *info = dev->driver_info;
819 clear_bit(EVENT_DEV_OPEN, &dev->flags);
820 netif_stop_queue (net);
822 netif_info(dev, ifdown, dev->net,
823 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
824 net->stats.rx_packets, net->stats.tx_packets,
825 net->stats.rx_errors, net->stats.tx_errors);
827 /* to not race resume */
828 pm = usb_autopm_get_interface(dev->intf);
829 /* allow minidriver to stop correctly (wireless devices to turn off
832 retval = info->stop(dev);
834 netif_info(dev, ifdown, dev->net,
835 "stop fail (%d) usbnet usb-%s-%s, %s\n",
837 dev->udev->bus->bus_name, dev->udev->devpath,
841 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
842 usbnet_terminate_urbs(dev);
844 usbnet_status_stop(dev);
846 usbnet_purge_paused_rxq(dev);
848 mpn = !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
850 /* deferred work (task, timer, softirq) must also stop.
851 * can't flush_scheduled_work() until we drop rtnl (later),
852 * else workers could deadlock; so make workers a NOP.
855 del_timer_sync (&dev->delay);
856 tasklet_kill (&dev->bh);
858 usb_autopm_put_interface(dev->intf);
860 if (info->manage_power && mpn)
861 info->manage_power(dev, 0);
863 usb_autopm_put_interface(dev->intf);
867 EXPORT_SYMBOL_GPL(usbnet_stop);
869 /*-------------------------------------------------------------------------*/
871 // posts reads, and enables write queuing
873 // precondition: never called in_interrupt
875 int usbnet_open (struct net_device *net)
877 struct usbnet *dev = netdev_priv(net);
879 struct driver_info *info = dev->driver_info;
881 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
882 netif_info(dev, ifup, dev->net,
883 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
885 dev->udev->bus->bus_name,
891 // put into "known safe" state
892 if (info->reset && (retval = info->reset (dev)) < 0) {
893 netif_info(dev, ifup, dev->net,
894 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
896 dev->udev->bus->bus_name,
902 /* hard_mtu or rx_urb_size may change in reset() */
903 usbnet_update_max_qlen(dev);
905 // insist peer be connected
906 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
907 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
911 /* start any status interrupt transfer */
912 if (dev->interrupt) {
913 retval = usbnet_status_start(dev, GFP_KERNEL);
915 netif_err(dev, ifup, dev->net,
916 "intr submit %d\n", retval);
921 set_bit(EVENT_DEV_OPEN, &dev->flags);
922 netif_start_queue (net);
923 netif_info(dev, ifup, dev->net,
924 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
925 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
927 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
928 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
929 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
930 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
931 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
934 /* reset rx error state */
937 clear_bit(EVENT_RX_KILL, &dev->flags);
939 // delay posting reads until we're fully open
940 tasklet_schedule (&dev->bh);
941 if (info->manage_power) {
942 retval = info->manage_power(dev, 1);
945 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
947 usb_autopm_put_interface(dev->intf);
952 usb_autopm_put_interface(dev->intf);
956 EXPORT_SYMBOL_GPL(usbnet_open);
958 /*-------------------------------------------------------------------------*/
960 /* ethtool methods; minidrivers may need to add some more, but
961 * they'll probably want to use this base set.
964 int usbnet_get_link_ksettings(struct net_device *net,
965 struct ethtool_link_ksettings *cmd)
967 struct usbnet *dev = netdev_priv(net);
969 if (!dev->mii.mdio_read)
972 mii_ethtool_get_link_ksettings(&dev->mii, cmd);
976 EXPORT_SYMBOL_GPL(usbnet_get_link_ksettings);
978 int usbnet_set_link_ksettings(struct net_device *net,
979 const struct ethtool_link_ksettings *cmd)
981 struct usbnet *dev = netdev_priv(net);
984 if (!dev->mii.mdio_write)
987 retval = mii_ethtool_set_link_ksettings(&dev->mii, cmd);
989 /* link speed/duplex might have changed */
990 if (dev->driver_info->link_reset)
991 dev->driver_info->link_reset(dev);
993 /* hard_mtu or rx_urb_size may change in link_reset() */
994 usbnet_update_max_qlen(dev);
998 EXPORT_SYMBOL_GPL(usbnet_set_link_ksettings);
1000 void usbnet_get_stats64(struct net_device *net, struct rtnl_link_stats64 *stats)
1002 struct usbnet *dev = netdev_priv(net);
1006 netdev_stats_to_stats64(stats, &net->stats);
1008 for_each_possible_cpu(cpu) {
1009 struct pcpu_sw_netstats *stats64;
1010 u64 rx_packets, rx_bytes;
1011 u64 tx_packets, tx_bytes;
1013 stats64 = per_cpu_ptr(dev->stats64, cpu);
1016 start = u64_stats_fetch_begin_irq(&stats64->syncp);
1017 rx_packets = stats64->rx_packets;
1018 rx_bytes = stats64->rx_bytes;
1019 tx_packets = stats64->tx_packets;
1020 tx_bytes = stats64->tx_bytes;
1021 } while (u64_stats_fetch_retry_irq(&stats64->syncp, start));
1023 stats->rx_packets += rx_packets;
1024 stats->rx_bytes += rx_bytes;
1025 stats->tx_packets += tx_packets;
1026 stats->tx_bytes += tx_bytes;
1029 EXPORT_SYMBOL_GPL(usbnet_get_stats64);
1031 u32 usbnet_get_link (struct net_device *net)
1033 struct usbnet *dev = netdev_priv(net);
1035 /* If a check_connect is defined, return its result */
1036 if (dev->driver_info->check_connect)
1037 return dev->driver_info->check_connect (dev) == 0;
1039 /* if the device has mii operations, use those */
1040 if (dev->mii.mdio_read)
1041 return mii_link_ok(&dev->mii);
1043 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
1044 return ethtool_op_get_link(net);
1046 EXPORT_SYMBOL_GPL(usbnet_get_link);
1048 int usbnet_nway_reset(struct net_device *net)
1050 struct usbnet *dev = netdev_priv(net);
1052 if (!dev->mii.mdio_write)
1055 return mii_nway_restart(&dev->mii);
1057 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
1059 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
1061 struct usbnet *dev = netdev_priv(net);
1063 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
1064 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
1065 strlcpy (info->fw_version, dev->driver_info->description,
1066 sizeof info->fw_version);
1067 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
1069 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
1071 u32 usbnet_get_msglevel (struct net_device *net)
1073 struct usbnet *dev = netdev_priv(net);
1075 return dev->msg_enable;
1077 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1079 void usbnet_set_msglevel (struct net_device *net, u32 level)
1081 struct usbnet *dev = netdev_priv(net);
1083 dev->msg_enable = level;
1085 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1087 /* drivers may override default ethtool_ops in their bind() routine */
1088 static const struct ethtool_ops usbnet_ethtool_ops = {
1089 .get_link = usbnet_get_link,
1090 .nway_reset = usbnet_nway_reset,
1091 .get_drvinfo = usbnet_get_drvinfo,
1092 .get_msglevel = usbnet_get_msglevel,
1093 .set_msglevel = usbnet_set_msglevel,
1094 .get_ts_info = ethtool_op_get_ts_info,
1095 .get_link_ksettings = usbnet_get_link_ksettings,
1096 .set_link_ksettings = usbnet_set_link_ksettings,
1099 /*-------------------------------------------------------------------------*/
1101 static void __handle_link_change(struct usbnet *dev)
1103 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1106 if (!netif_carrier_ok(dev->net)) {
1107 /* kill URBs for reading packets to save bus bandwidth */
1108 unlink_urbs(dev, &dev->rxq);
1111 * tx_timeout will unlink URBs for sending packets and
1112 * tx queue is stopped by netcore after link becomes off
1115 /* submitting URBs for reading packets */
1116 tasklet_schedule(&dev->bh);
1119 /* hard_mtu or rx_urb_size may change during link change */
1120 usbnet_update_max_qlen(dev);
1122 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1125 static void usbnet_set_rx_mode(struct net_device *net)
1127 struct usbnet *dev = netdev_priv(net);
1129 usbnet_defer_kevent(dev, EVENT_SET_RX_MODE);
1132 static void __handle_set_rx_mode(struct usbnet *dev)
1134 if (dev->driver_info->set_rx_mode)
1135 (dev->driver_info->set_rx_mode)(dev);
1137 clear_bit(EVENT_SET_RX_MODE, &dev->flags);
1140 /* work that cannot be done in interrupt context uses keventd.
1142 * NOTE: with 2.5 we could do more of this using completion callbacks,
1143 * especially now that control transfers can be queued.
1146 usbnet_deferred_kevent (struct work_struct *work)
1148 struct usbnet *dev =
1149 container_of(work, struct usbnet, kevent);
1152 /* usb_clear_halt() needs a thread context */
1153 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1154 unlink_urbs (dev, &dev->txq);
1155 status = usb_autopm_get_interface(dev->intf);
1158 status = usb_clear_halt (dev->udev, dev->out);
1159 usb_autopm_put_interface(dev->intf);
1162 status != -ESHUTDOWN) {
1163 if (netif_msg_tx_err (dev))
1165 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1168 clear_bit (EVENT_TX_HALT, &dev->flags);
1169 if (status != -ESHUTDOWN)
1170 netif_wake_queue (dev->net);
1173 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1174 unlink_urbs (dev, &dev->rxq);
1175 status = usb_autopm_get_interface(dev->intf);
1178 status = usb_clear_halt (dev->udev, dev->in);
1179 usb_autopm_put_interface(dev->intf);
1182 status != -ESHUTDOWN) {
1183 if (netif_msg_rx_err (dev))
1185 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1188 clear_bit (EVENT_RX_HALT, &dev->flags);
1189 tasklet_schedule (&dev->bh);
1193 /* tasklet could resubmit itself forever if memory is tight */
1194 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1195 struct urb *urb = NULL;
1198 if (netif_running (dev->net))
1199 urb = usb_alloc_urb (0, GFP_KERNEL);
1201 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1203 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1204 status = usb_autopm_get_interface(dev->intf);
1209 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1211 usb_autopm_put_interface(dev->intf);
1214 tasklet_schedule (&dev->bh);
1218 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1219 struct driver_info *info = dev->driver_info;
1222 clear_bit (EVENT_LINK_RESET, &dev->flags);
1223 status = usb_autopm_get_interface(dev->intf);
1226 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1227 usb_autopm_put_interface(dev->intf);
1229 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1231 dev->udev->bus->bus_name,
1235 usb_autopm_put_interface(dev->intf);
1238 /* handle link change from link resetting */
1239 __handle_link_change(dev);
1242 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1243 __handle_link_change(dev);
1245 if (test_bit (EVENT_SET_RX_MODE, &dev->flags))
1246 __handle_set_rx_mode(dev);
1250 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1253 /*-------------------------------------------------------------------------*/
1255 static void tx_complete (struct urb *urb)
1257 struct sk_buff *skb = (struct sk_buff *) urb->context;
1258 struct skb_data *entry = (struct skb_data *) skb->cb;
1259 struct usbnet *dev = entry->dev;
1261 if (urb->status == 0) {
1262 struct pcpu_sw_netstats *stats64 = this_cpu_ptr(dev->stats64);
1263 unsigned long flags;
1265 flags = u64_stats_update_begin_irqsave(&stats64->syncp);
1266 stats64->tx_packets += entry->packets;
1267 stats64->tx_bytes += entry->length;
1268 u64_stats_update_end_irqrestore(&stats64->syncp, flags);
1270 dev->net->stats.tx_errors++;
1272 switch (urb->status) {
1274 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1277 /* software-driven interface shutdown */
1278 case -ECONNRESET: // async unlink
1279 case -ESHUTDOWN: // hardware gone
1282 /* like rx, tx gets controller i/o faults during hub_wq
1283 * delays and so it uses the same throttling mechanism.
1288 usb_mark_last_busy(dev->udev);
1289 if (!timer_pending (&dev->delay)) {
1290 mod_timer (&dev->delay,
1291 jiffies + THROTTLE_JIFFIES);
1292 netif_dbg(dev, link, dev->net,
1293 "tx throttle %d\n", urb->status);
1295 netif_stop_queue (dev->net);
1298 netif_dbg(dev, tx_err, dev->net,
1299 "tx err %d\n", entry->urb->status);
1304 usb_autopm_put_interface_async(dev->intf);
1305 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1308 /*-------------------------------------------------------------------------*/
1310 void usbnet_tx_timeout (struct net_device *net)
1312 struct usbnet *dev = netdev_priv(net);
1314 unlink_urbs (dev, &dev->txq);
1315 tasklet_schedule (&dev->bh);
1316 /* this needs to be handled individually because the generic layer
1317 * doesn't know what is sufficient and could not restore private
1318 * information if a remedy of an unconditional reset were used.
1320 if (dev->driver_info->recover)
1321 (dev->driver_info->recover)(dev);
1323 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1325 /*-------------------------------------------------------------------------*/
1327 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1329 unsigned num_sgs, total_len = 0;
1332 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1336 /* reserve one for zero packet */
1337 urb->sg = kmalloc((num_sgs + 1) * sizeof(struct scatterlist),
1342 urb->num_sgs = num_sgs;
1343 sg_init_table(urb->sg, urb->num_sgs + 1);
1345 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1346 total_len += skb_headlen(skb);
1348 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1349 struct skb_frag_struct *f = &skb_shinfo(skb)->frags[i];
1351 total_len += skb_frag_size(f);
1352 sg_set_page(&urb->sg[i + s], f->page.p, f->size,
1355 urb->transfer_buffer_length = total_len;
1360 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1361 struct net_device *net)
1363 struct usbnet *dev = netdev_priv(net);
1364 unsigned int length;
1365 struct urb *urb = NULL;
1366 struct skb_data *entry;
1367 struct driver_info *info = dev->driver_info;
1368 unsigned long flags;
1372 skb_tx_timestamp(skb);
1374 // some devices want funky USB-level framing, for
1375 // win32 driver (usually) and/or hardware quirks
1376 if (info->tx_fixup) {
1377 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1379 /* packet collected; minidriver waiting for more */
1380 if (info->flags & FLAG_MULTI_PACKET)
1382 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1387 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1388 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1392 entry = (struct skb_data *) skb->cb;
1396 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1397 skb->data, skb->len, tx_complete, skb);
1398 if (dev->can_dma_sg) {
1399 if (build_dma_sg(skb, urb) < 0)
1402 length = urb->transfer_buffer_length;
1404 /* don't assume the hardware handles USB_ZERO_PACKET
1405 * NOTE: strictly conforming cdc-ether devices should expect
1406 * the ZLP here, but ignore the one-byte packet.
1407 * NOTE2: CDC NCM specification is different from CDC ECM when
1408 * handling ZLP/short packets, so cdc_ncm driver will make short
1409 * packet itself if needed.
1411 if (length % dev->maxpacket == 0) {
1412 if (!(info->flags & FLAG_SEND_ZLP)) {
1413 if (!(info->flags & FLAG_MULTI_PACKET)) {
1415 if (skb_tailroom(skb) && !urb->num_sgs) {
1416 skb->data[skb->len] = 0;
1418 } else if (urb->num_sgs)
1419 sg_set_buf(&urb->sg[urb->num_sgs++],
1420 dev->padding_pkt, 1);
1423 urb->transfer_flags |= URB_ZERO_PACKET;
1425 urb->transfer_buffer_length = length;
1427 if (info->flags & FLAG_MULTI_PACKET) {
1428 /* Driver has set number of packets and a length delta.
1429 * Calculate the complete length and ensure that it's
1432 entry->length += length;
1433 if (WARN_ON_ONCE(entry->length <= 0))
1434 entry->length = length;
1436 usbnet_set_skb_tx_stats(skb, 1, length);
1439 spin_lock_irqsave(&dev->txq.lock, flags);
1440 retval = usb_autopm_get_interface_async(dev->intf);
1442 spin_unlock_irqrestore(&dev->txq.lock, flags);
1445 if (netif_queue_stopped(net)) {
1446 usb_autopm_put_interface_async(dev->intf);
1447 spin_unlock_irqrestore(&dev->txq.lock, flags);
1452 /* if this triggers the device is still a sleep */
1453 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1454 /* transmission will be done in resume */
1455 usb_anchor_urb(urb, &dev->deferred);
1456 /* no use to process more packets */
1457 netif_stop_queue(net);
1459 spin_unlock_irqrestore(&dev->txq.lock, flags);
1460 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1465 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1467 netif_stop_queue (net);
1468 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1469 usb_autopm_put_interface_async(dev->intf);
1472 usb_autopm_put_interface_async(dev->intf);
1473 netif_dbg(dev, tx_err, dev->net,
1474 "tx: submit urb err %d\n", retval);
1477 netif_trans_update(net);
1478 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1479 if (dev->txq.qlen >= TX_QLEN (dev))
1480 netif_stop_queue (net);
1482 spin_unlock_irqrestore (&dev->txq.lock, flags);
1485 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1487 dev->net->stats.tx_dropped++;
1490 dev_kfree_skb_any (skb);
1496 netif_dbg(dev, tx_queued, dev->net,
1497 "> tx, len %u, type 0x%x\n", length, skb->protocol);
1501 return NETDEV_TX_OK;
1503 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1505 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1511 /* don't refill the queue all at once */
1512 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1513 urb = usb_alloc_urb(0, flags);
1515 ret = rx_submit(dev, urb, flags);
1527 /*-------------------------------------------------------------------------*/
1529 // tasklet (work deferred from completions, in_irq) or timer
1531 static void usbnet_bh (unsigned long param)
1533 struct usbnet *dev = (struct usbnet *) param;
1534 struct sk_buff *skb;
1535 struct skb_data *entry;
1537 while ((skb = skb_dequeue (&dev->done))) {
1538 entry = (struct skb_data *) skb->cb;
1539 switch (entry->state) {
1541 entry->state = rx_cleanup;
1542 rx_process (dev, skb);
1545 kfree(entry->urb->sg);
1547 usb_free_urb (entry->urb);
1548 dev_kfree_skb (skb);
1551 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1555 /* restart RX again after disabling due to high error rate */
1556 clear_bit(EVENT_RX_KILL, &dev->flags);
1558 /* waiting for all pending urbs to complete?
1559 * only then can we forgo submitting anew
1561 if (waitqueue_active(&dev->wait)) {
1562 if (dev->txq.qlen + dev->rxq.qlen + dev->done.qlen == 0)
1563 wake_up_all(&dev->wait);
1565 // or are we maybe short a few urbs?
1566 } else if (netif_running (dev->net) &&
1567 netif_device_present (dev->net) &&
1568 netif_carrier_ok(dev->net) &&
1569 !timer_pending(&dev->delay) &&
1570 !test_bit(EVENT_RX_PAUSED, &dev->flags) &&
1571 !test_bit(EVENT_RX_HALT, &dev->flags)) {
1572 int temp = dev->rxq.qlen;
1574 if (temp < RX_QLEN(dev)) {
1575 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1577 if (temp != dev->rxq.qlen)
1578 netif_dbg(dev, link, dev->net,
1579 "rxqlen %d --> %d\n",
1580 temp, dev->rxq.qlen);
1581 if (dev->rxq.qlen < RX_QLEN(dev))
1582 tasklet_schedule (&dev->bh);
1584 if (dev->txq.qlen < TX_QLEN (dev))
1585 netif_wake_queue (dev->net);
1590 /*-------------------------------------------------------------------------
1592 * USB Device Driver support
1594 *-------------------------------------------------------------------------*/
1596 // precondition: never called in_interrupt
1598 void usbnet_disconnect (struct usb_interface *intf)
1601 struct usb_device *xdev;
1602 struct net_device *net;
1604 dev = usb_get_intfdata(intf);
1605 usb_set_intfdata(intf, NULL);
1609 xdev = interface_to_usbdev (intf);
1611 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1612 intf->dev.driver->name,
1613 xdev->bus->bus_name, xdev->devpath,
1614 dev->driver_info->description);
1617 unregister_netdev (net);
1619 cancel_work_sync(&dev->kevent);
1621 usb_scuttle_anchored_urbs(&dev->deferred);
1623 if (dev->driver_info->unbind)
1624 dev->driver_info->unbind (dev, intf);
1626 usb_kill_urb(dev->interrupt);
1627 usb_free_urb(dev->interrupt);
1628 kfree(dev->padding_pkt);
1630 free_percpu(dev->stats64);
1633 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1635 static const struct net_device_ops usbnet_netdev_ops = {
1636 .ndo_open = usbnet_open,
1637 .ndo_stop = usbnet_stop,
1638 .ndo_start_xmit = usbnet_start_xmit,
1639 .ndo_tx_timeout = usbnet_tx_timeout,
1640 .ndo_set_rx_mode = usbnet_set_rx_mode,
1641 .ndo_change_mtu = usbnet_change_mtu,
1642 .ndo_get_stats64 = usbnet_get_stats64,
1643 .ndo_set_mac_address = eth_mac_addr,
1644 .ndo_validate_addr = eth_validate_addr,
1647 /*-------------------------------------------------------------------------*/
1649 // precondition: never called in_interrupt
1651 static struct device_type wlan_type = {
1655 static struct device_type wwan_type = {
1660 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1663 struct net_device *net;
1664 struct usb_host_interface *interface;
1665 struct driver_info *info;
1666 struct usb_device *xdev;
1669 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1671 /* usbnet already took usb runtime pm, so have to enable the feature
1672 * for usb interface, otherwise usb_autopm_get_interface may return
1673 * failure if RUNTIME_PM is enabled.
1675 if (!driver->supports_autosuspend) {
1676 driver->supports_autosuspend = 1;
1677 pm_runtime_enable(&udev->dev);
1680 name = udev->dev.driver->name;
1681 info = (struct driver_info *) prod->driver_info;
1683 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1686 xdev = interface_to_usbdev (udev);
1687 interface = udev->cur_altsetting;
1691 // set up our own records
1692 net = alloc_etherdev(sizeof(*dev));
1696 /* netdev_printk() needs this so do it as early as possible */
1697 SET_NETDEV_DEV(net, &udev->dev);
1699 dev = netdev_priv(net);
1702 dev->driver_info = info;
1703 dev->driver_name = name;
1705 dev->stats64 = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
1709 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1710 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1711 init_waitqueue_head(&dev->wait);
1712 skb_queue_head_init (&dev->rxq);
1713 skb_queue_head_init (&dev->txq);
1714 skb_queue_head_init (&dev->done);
1715 skb_queue_head_init(&dev->rxq_pause);
1716 dev->bh.func = usbnet_bh;
1717 dev->bh.data = (unsigned long) dev;
1718 INIT_WORK (&dev->kevent, usbnet_deferred_kevent);
1719 init_usb_anchor(&dev->deferred);
1720 dev->delay.function = usbnet_bh;
1721 dev->delay.data = (unsigned long) dev;
1722 init_timer (&dev->delay);
1723 mutex_init (&dev->phy_mutex);
1724 mutex_init(&dev->interrupt_mutex);
1725 dev->interrupt_count = 0;
1728 strcpy (net->name, "usb%d");
1729 memcpy (net->dev_addr, node_id, sizeof node_id);
1731 /* rx and tx sides can use different message sizes;
1732 * bind() should set rx_urb_size in that case.
1734 dev->hard_mtu = net->mtu + net->hard_header_len;
1736 net->max_mtu = ETH_MAX_MTU;
1738 net->netdev_ops = &usbnet_netdev_ops;
1739 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1740 net->ethtool_ops = &usbnet_ethtool_ops;
1742 // allow device-specific bind/init procedures
1743 // NOTE net->name still not usable ...
1745 status = info->bind (dev, udev);
1749 // heuristic: "usb%d" for links we know are two-host,
1750 // else "eth%d" when there's reasonable doubt. userspace
1751 // can rename the link if it knows better.
1752 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1753 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1754 (net->dev_addr [0] & 0x02) == 0))
1755 strcpy (net->name, "eth%d");
1756 /* WLAN devices should always be named "wlan%d" */
1757 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1758 strcpy(net->name, "wlan%d");
1759 /* WWAN devices should always be named "wwan%d" */
1760 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1761 strcpy(net->name, "wwan%d");
1763 /* devices that cannot do ARP */
1764 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1765 net->flags |= IFF_NOARP;
1767 /* maybe the remote can't receive an Ethernet MTU */
1768 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1769 net->mtu = dev->hard_mtu - net->hard_header_len;
1770 } else if (!info->in || !info->out)
1771 status = usbnet_get_endpoints (dev, udev);
1773 dev->in = usb_rcvbulkpipe (xdev, info->in);
1774 dev->out = usb_sndbulkpipe (xdev, info->out);
1775 if (!(info->flags & FLAG_NO_SETINT))
1776 status = usb_set_interface (xdev,
1777 interface->desc.bInterfaceNumber,
1778 interface->desc.bAlternateSetting);
1783 if (status >= 0 && dev->status)
1784 status = init_status (dev, udev);
1788 if (!dev->rx_urb_size)
1789 dev->rx_urb_size = dev->hard_mtu;
1790 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1792 /* let userspace know we have a random address */
1793 if (ether_addr_equal(net->dev_addr, node_id))
1794 net->addr_assign_type = NET_ADDR_RANDOM;
1796 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1797 SET_NETDEV_DEVTYPE(net, &wlan_type);
1798 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1799 SET_NETDEV_DEVTYPE(net, &wwan_type);
1801 /* initialize max rx_qlen and tx_qlen */
1802 usbnet_update_max_qlen(dev);
1804 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1805 !(info->flags & FLAG_MULTI_PACKET)) {
1806 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1807 if (!dev->padding_pkt) {
1813 status = register_netdev (net);
1816 netif_info(dev, probe, dev->net,
1817 "register '%s' at usb-%s-%s, %s, %pM\n",
1818 udev->dev.driver->name,
1819 xdev->bus->bus_name, xdev->devpath,
1820 dev->driver_info->description,
1823 // ok, it's ready to go.
1824 usb_set_intfdata (udev, dev);
1826 netif_device_attach (net);
1828 if (dev->driver_info->flags & FLAG_LINK_INTR)
1829 usbnet_link_change(dev, 0, 0);
1834 kfree(dev->padding_pkt);
1836 usb_free_urb(dev->interrupt);
1839 info->unbind (dev, udev);
1841 /* subdrivers must undo all they did in bind() if they
1842 * fail it, but we may fail later and a deferred kevent
1843 * may trigger an error resubmitting itself and, worse,
1844 * schedule a timer. So we kill it all just in case.
1846 cancel_work_sync(&dev->kevent);
1847 del_timer_sync(&dev->delay);
1848 free_percpu(dev->stats64);
1854 EXPORT_SYMBOL_GPL(usbnet_probe);
1856 /*-------------------------------------------------------------------------*/
1859 * suspend the whole driver as soon as the first interface is suspended
1860 * resume only when the last interface is resumed
1863 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1865 struct usbnet *dev = usb_get_intfdata(intf);
1867 if (!dev->suspend_count++) {
1868 spin_lock_irq(&dev->txq.lock);
1869 /* don't autosuspend while transmitting */
1870 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1871 dev->suspend_count--;
1872 spin_unlock_irq(&dev->txq.lock);
1875 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1876 spin_unlock_irq(&dev->txq.lock);
1879 * accelerate emptying of the rx and queues, to avoid
1880 * having everything error out.
1882 netif_device_detach (dev->net);
1883 usbnet_terminate_urbs(dev);
1884 __usbnet_status_stop_force(dev);
1887 * reattach so runtime management can use and
1890 netif_device_attach (dev->net);
1894 EXPORT_SYMBOL_GPL(usbnet_suspend);
1896 int usbnet_resume (struct usb_interface *intf)
1898 struct usbnet *dev = usb_get_intfdata(intf);
1899 struct sk_buff *skb;
1903 if (!--dev->suspend_count) {
1904 /* resume interrupt URB if it was previously submitted */
1905 __usbnet_status_start_force(dev, GFP_NOIO);
1907 spin_lock_irq(&dev->txq.lock);
1908 while ((res = usb_get_from_anchor(&dev->deferred))) {
1910 skb = (struct sk_buff *)res->context;
1911 retval = usb_submit_urb(res, GFP_ATOMIC);
1913 dev_kfree_skb_any(skb);
1916 usb_autopm_put_interface_async(dev->intf);
1918 netif_trans_update(dev->net);
1919 __skb_queue_tail(&dev->txq, skb);
1924 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1925 spin_unlock_irq(&dev->txq.lock);
1927 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1928 /* handle remote wakeup ASAP
1929 * we cannot race against stop
1931 if (netif_device_present(dev->net) &&
1932 !timer_pending(&dev->delay) &&
1933 !test_bit(EVENT_RX_HALT, &dev->flags))
1934 rx_alloc_submit(dev, GFP_NOIO);
1936 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1937 netif_tx_wake_all_queues(dev->net);
1938 tasklet_schedule (&dev->bh);
1942 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1943 usb_autopm_get_interface_no_resume(intf);
1947 EXPORT_SYMBOL_GPL(usbnet_resume);
1950 * Either a subdriver implements manage_power, then it is assumed to always
1951 * be ready to be suspended or it reports the readiness to be suspended
1954 void usbnet_device_suggests_idle(struct usbnet *dev)
1956 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1957 dev->intf->needs_remote_wakeup = 1;
1958 usb_autopm_put_interface_async(dev->intf);
1961 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1964 * For devices that can do without special commands
1966 int usbnet_manage_power(struct usbnet *dev, int on)
1968 dev->intf->needs_remote_wakeup = on;
1971 EXPORT_SYMBOL(usbnet_manage_power);
1973 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1975 /* update link after link is reseted */
1976 if (link && !need_reset)
1977 netif_carrier_on(dev->net);
1979 netif_carrier_off(dev->net);
1981 if (need_reset && link)
1982 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1984 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1986 EXPORT_SYMBOL(usbnet_link_change);
1988 /*-------------------------------------------------------------------------*/
1989 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1990 u16 value, u16 index, void *data, u16 size)
1995 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1996 " value=0x%04x index=0x%04x size=%d\n",
1997 cmd, reqtype, value, index, size);
2000 buf = kmalloc(size, GFP_KERNEL);
2005 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
2006 cmd, reqtype, value, index, buf, size,
2007 USB_CTRL_GET_TIMEOUT);
2008 if (err > 0 && err <= size) {
2010 memcpy(data, buf, err);
2012 netdev_dbg(dev->net,
2013 "Huh? Data requested but thrown away.\n");
2020 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2021 u16 value, u16 index, const void *data,
2027 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2028 " value=0x%04x index=0x%04x size=%d\n",
2029 cmd, reqtype, value, index, size);
2032 buf = kmemdup(data, size, GFP_KERNEL);
2043 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
2044 cmd, reqtype, value, index, buf, size,
2045 USB_CTRL_SET_TIMEOUT);
2053 * The function can't be called inside suspend/resume callback,
2054 * otherwise deadlock will be caused.
2056 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2057 u16 value, u16 index, void *data, u16 size)
2061 if (usb_autopm_get_interface(dev->intf) < 0)
2063 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2065 usb_autopm_put_interface(dev->intf);
2068 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
2071 * The function can't be called inside suspend/resume callback,
2072 * otherwise deadlock will be caused.
2074 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2075 u16 value, u16 index, const void *data, u16 size)
2079 if (usb_autopm_get_interface(dev->intf) < 0)
2081 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2083 usb_autopm_put_interface(dev->intf);
2086 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
2089 * The function can be called inside suspend/resume callback safely
2090 * and should only be called by suspend/resume callback generally.
2092 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2093 u16 value, u16 index, void *data, u16 size)
2095 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2098 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
2101 * The function can be called inside suspend/resume callback safely
2102 * and should only be called by suspend/resume callback generally.
2104 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2105 u16 value, u16 index, const void *data,
2108 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2111 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
2113 static void usbnet_async_cmd_cb(struct urb *urb)
2115 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
2116 int status = urb->status;
2119 dev_dbg(&urb->dev->dev, "%s failed with %d",
2127 * The caller must make sure that device can't be put into suspend
2128 * state until the control URB completes.
2130 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
2131 u16 value, u16 index, const void *data, u16 size)
2133 struct usb_ctrlrequest *req = NULL;
2138 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2139 " value=0x%04x index=0x%04x size=%d\n",
2140 cmd, reqtype, value, index, size);
2142 urb = usb_alloc_urb(0, GFP_ATOMIC);
2147 buf = kmemdup(data, size, GFP_ATOMIC);
2149 netdev_err(dev->net, "Error allocating buffer"
2150 " in %s!\n", __func__);
2155 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2159 req->bRequestType = reqtype;
2160 req->bRequest = cmd;
2161 req->wValue = cpu_to_le16(value);
2162 req->wIndex = cpu_to_le16(index);
2163 req->wLength = cpu_to_le16(size);
2165 usb_fill_control_urb(urb, dev->udev,
2166 usb_sndctrlpipe(dev->udev, 0),
2167 (void *)req, buf, size,
2168 usbnet_async_cmd_cb, req);
2169 urb->transfer_flags |= URB_FREE_BUFFER;
2171 err = usb_submit_urb(urb, GFP_ATOMIC);
2173 netdev_err(dev->net, "Error submitting the control"
2174 " message: status=%d\n", err);
2188 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2189 /*-------------------------------------------------------------------------*/
2191 static int __init usbnet_init(void)
2193 /* Compiler should optimize this out. */
2195 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
2197 eth_random_addr(node_id);
2200 module_init(usbnet_init);
2202 static void __exit usbnet_exit(void)
2205 module_exit(usbnet_exit);
2207 MODULE_AUTHOR("David Brownell");
2208 MODULE_DESCRIPTION("USB network driver framework");
2209 MODULE_LICENSE("GPL");