1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * USB Network driver infrastructure
4 * Copyright (C) 2000-2005 by David Brownell
5 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
9 * This is a generic "USB networking" framework that works with several
10 * kinds of full and high speed networking devices: host-to-host cables,
11 * smart usb peripherals, and actual Ethernet adapters.
13 * These devices usually differ in terms of control protocols (if they
14 * even have one!) and sometimes they define new framing to wrap or batch
15 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
16 * so interface (un)binding, endpoint I/O queues, fault handling, and other
17 * issues can usefully be addressed by this framework.
20 // #define DEBUG // error path messages, extra info
21 // #define VERBOSE // more; success messages
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/ctype.h>
28 #include <linux/ethtool.h>
29 #include <linux/workqueue.h>
30 #include <linux/mii.h>
31 #include <linux/usb.h>
32 #include <linux/usb/usbnet.h>
33 #include <linux/slab.h>
34 #include <linux/kernel.h>
35 #include <linux/pm_runtime.h>
37 /*-------------------------------------------------------------------------*/
40 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
41 * Several dozen bytes of IPv4 data can fit in two such transactions.
42 * One maximum size Ethernet packet takes twenty four of them.
43 * For high speed, each frame comfortably fits almost 36 max size
44 * Ethernet packets (so queues should be bigger).
46 * The goal is to let the USB host controller be busy for 5msec or
47 * more before an irq is required, under load. Jumbograms change
50 #define MAX_QUEUE_MEMORY (60 * 1518)
51 #define RX_QLEN(dev) ((dev)->rx_qlen)
52 #define TX_QLEN(dev) ((dev)->tx_qlen)
54 // reawaken network queue this soon after stopping; else watchdog barks
55 #define TX_TIMEOUT_JIFFIES (5*HZ)
57 /* throttle rx/tx briefly after some faults, so hub_wq might disconnect()
58 * us (it polls at HZ/4 usually) before we report too many false errors.
60 #define THROTTLE_JIFFIES (HZ/8)
63 #define UNLINK_TIMEOUT_MS 3
65 /*-------------------------------------------------------------------------*/
67 // randomly generated ethernet address
68 static u8 node_id [ETH_ALEN];
70 /* use ethtool to change the level for any given device */
71 static int msg_level = -1;
72 module_param (msg_level, int, 0);
73 MODULE_PARM_DESC (msg_level, "Override default message level");
75 /*-------------------------------------------------------------------------*/
77 static const char * const usbnet_event_names[] = {
78 [EVENT_TX_HALT] = "EVENT_TX_HALT",
79 [EVENT_RX_HALT] = "EVENT_RX_HALT",
80 [EVENT_RX_MEMORY] = "EVENT_RX_MEMORY",
81 [EVENT_STS_SPLIT] = "EVENT_STS_SPLIT",
82 [EVENT_LINK_RESET] = "EVENT_LINK_RESET",
83 [EVENT_RX_PAUSED] = "EVENT_RX_PAUSED",
84 [EVENT_DEV_ASLEEP] = "EVENT_DEV_ASLEEP",
85 [EVENT_DEV_OPEN] = "EVENT_DEV_OPEN",
86 [EVENT_DEVICE_REPORT_IDLE] = "EVENT_DEVICE_REPORT_IDLE",
87 [EVENT_NO_RUNTIME_PM] = "EVENT_NO_RUNTIME_PM",
88 [EVENT_RX_KILL] = "EVENT_RX_KILL",
89 [EVENT_LINK_CHANGE] = "EVENT_LINK_CHANGE",
90 [EVENT_SET_RX_MODE] = "EVENT_SET_RX_MODE",
91 [EVENT_NO_IP_ALIGN] = "EVENT_NO_IP_ALIGN",
94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
95 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
98 struct usb_host_interface *alt = NULL;
99 struct usb_host_endpoint *in = NULL, *out = NULL;
100 struct usb_host_endpoint *status = NULL;
102 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
105 in = out = status = NULL;
106 alt = intf->altsetting + tmp;
108 /* take the first altsetting with in-bulk + out-bulk;
109 * remember any status endpoint, just in case;
110 * ignore other endpoints and altsettings.
112 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
113 struct usb_host_endpoint *e;
116 e = alt->endpoint + ep;
118 /* ignore endpoints which cannot transfer data */
119 if (!usb_endpoint_maxp(&e->desc))
122 switch (e->desc.bmAttributes) {
123 case USB_ENDPOINT_XFER_INT:
124 if (!usb_endpoint_dir_in(&e->desc))
128 case USB_ENDPOINT_XFER_BULK:
133 if (usb_endpoint_dir_in(&e->desc)) {
136 else if (intr && !status)
146 if (!alt || !in || !out)
149 if (alt->desc.bAlternateSetting != 0 ||
150 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
151 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
152 alt->desc.bAlternateSetting);
157 dev->in = usb_rcvbulkpipe (dev->udev,
158 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
159 dev->out = usb_sndbulkpipe (dev->udev,
160 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
161 dev->status = status;
164 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
166 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
169 unsigned char buf [13];
171 ret = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
173 tmp = hex2bin(dev->net->dev_addr, buf, 6);
175 dev_dbg(&dev->udev->dev,
176 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
183 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
185 static void intr_complete (struct urb *urb)
187 struct usbnet *dev = urb->context;
188 int status = urb->status;
193 dev->driver_info->status(dev, urb);
196 /* software-driven interface shutdown */
197 case -ENOENT: /* urb killed */
198 case -ESHUTDOWN: /* hardware gone */
199 netif_dbg(dev, ifdown, dev->net,
200 "intr shutdown, code %d\n", status);
203 /* NOTE: not throttling like RX/TX, since this endpoint
204 * already polls infrequently
207 netdev_dbg(dev->net, "intr status %d\n", status);
211 status = usb_submit_urb (urb, GFP_ATOMIC);
213 netif_err(dev, timer, dev->net,
214 "intr resubmit --> %d\n", status);
217 static int init_status (struct usbnet *dev, struct usb_interface *intf)
224 if (!dev->driver_info->status)
227 pipe = usb_rcvintpipe (dev->udev,
228 dev->status->desc.bEndpointAddress
229 & USB_ENDPOINT_NUMBER_MASK);
230 maxp = usb_maxpacket (dev->udev, pipe, 0);
232 /* avoid 1 msec chatter: min 8 msec poll rate */
233 period = max ((int) dev->status->desc.bInterval,
234 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
236 buf = kmalloc (maxp, GFP_KERNEL);
238 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
239 if (!dev->interrupt) {
243 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
244 buf, maxp, intr_complete, dev, period);
245 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
247 "status ep%din, %d bytes period %d\n",
248 usb_pipeendpoint(pipe), maxp, period);
254 /* Submit the interrupt URB if not previously submitted, increasing refcount */
255 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
259 WARN_ON_ONCE(dev->interrupt == NULL);
260 if (dev->interrupt) {
261 mutex_lock(&dev->interrupt_mutex);
263 if (++dev->interrupt_count == 1)
264 ret = usb_submit_urb(dev->interrupt, mem_flags);
266 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
267 dev->interrupt_count);
268 mutex_unlock(&dev->interrupt_mutex);
272 EXPORT_SYMBOL_GPL(usbnet_status_start);
274 /* For resume; submit interrupt URB if previously submitted */
275 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
279 mutex_lock(&dev->interrupt_mutex);
280 if (dev->interrupt_count) {
281 ret = usb_submit_urb(dev->interrupt, mem_flags);
282 dev_dbg(&dev->udev->dev,
283 "submitted interrupt URB for resume\n");
285 mutex_unlock(&dev->interrupt_mutex);
289 /* Kill the interrupt URB if all submitters want it killed */
290 void usbnet_status_stop(struct usbnet *dev)
292 if (dev->interrupt) {
293 mutex_lock(&dev->interrupt_mutex);
294 WARN_ON(dev->interrupt_count == 0);
296 if (dev->interrupt_count && --dev->interrupt_count == 0)
297 usb_kill_urb(dev->interrupt);
299 dev_dbg(&dev->udev->dev,
300 "decremented interrupt URB count to %d\n",
301 dev->interrupt_count);
302 mutex_unlock(&dev->interrupt_mutex);
305 EXPORT_SYMBOL_GPL(usbnet_status_stop);
307 /* For suspend; always kill interrupt URB */
308 static void __usbnet_status_stop_force(struct usbnet *dev)
310 if (dev->interrupt) {
311 mutex_lock(&dev->interrupt_mutex);
312 usb_kill_urb(dev->interrupt);
313 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
314 mutex_unlock(&dev->interrupt_mutex);
318 /* Passes this packet up the stack, updating its accounting.
319 * Some link protocols batch packets, so their rx_fixup paths
320 * can return clones as well as just modify the original skb.
322 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
324 struct pcpu_sw_netstats *stats64 = this_cpu_ptr(dev->net->tstats);
328 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
329 skb_queue_tail(&dev->rxq_pause, skb);
333 /* only update if unset to allow minidriver rx_fixup override */
334 if (skb->protocol == 0)
335 skb->protocol = eth_type_trans (skb, dev->net);
337 flags = u64_stats_update_begin_irqsave(&stats64->syncp);
338 stats64->rx_packets++;
339 stats64->rx_bytes += skb->len;
340 u64_stats_update_end_irqrestore(&stats64->syncp, flags);
342 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
343 skb->len + sizeof (struct ethhdr), skb->protocol);
344 memset (skb->cb, 0, sizeof (struct skb_data));
346 if (skb_defer_rx_timestamp(skb))
349 status = netif_rx (skb);
350 if (status != NET_RX_SUCCESS)
351 netif_dbg(dev, rx_err, dev->net,
352 "netif_rx status %d\n", status);
354 EXPORT_SYMBOL_GPL(usbnet_skb_return);
356 /* must be called if hard_mtu or rx_urb_size changed */
357 void usbnet_update_max_qlen(struct usbnet *dev)
359 enum usb_device_speed speed = dev->udev->speed;
361 if (!dev->rx_urb_size || !dev->hard_mtu)
365 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
366 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
368 case USB_SPEED_SUPER:
369 case USB_SPEED_SUPER_PLUS:
371 * Not take default 5ms qlen for super speed HC to
372 * save memory, and iperf tests show 2.5ms qlen can
375 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
376 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
380 dev->rx_qlen = dev->tx_qlen = 4;
383 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
386 /*-------------------------------------------------------------------------
388 * Network Device Driver (peer link to "Host Device", from USB host)
390 *-------------------------------------------------------------------------*/
392 int usbnet_change_mtu (struct net_device *net, int new_mtu)
394 struct usbnet *dev = netdev_priv(net);
395 int ll_mtu = new_mtu + net->hard_header_len;
396 int old_hard_mtu = dev->hard_mtu;
397 int old_rx_urb_size = dev->rx_urb_size;
399 // no second zero-length packet read wanted after mtu-sized packets
400 if ((ll_mtu % dev->maxpacket) == 0)
404 dev->hard_mtu = net->mtu + net->hard_header_len;
405 if (dev->rx_urb_size == old_hard_mtu) {
406 dev->rx_urb_size = dev->hard_mtu;
407 if (dev->rx_urb_size > old_rx_urb_size) {
408 usbnet_pause_rx(dev);
409 usbnet_unlink_rx_urbs(dev);
410 usbnet_resume_rx(dev);
414 /* max qlen depend on hard_mtu and rx_urb_size */
415 usbnet_update_max_qlen(dev);
419 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
421 /* The caller must hold list->lock */
422 static void __usbnet_queue_skb(struct sk_buff_head *list,
423 struct sk_buff *newsk, enum skb_state state)
425 struct skb_data *entry = (struct skb_data *) newsk->cb;
427 __skb_queue_tail(list, newsk);
428 entry->state = state;
431 /*-------------------------------------------------------------------------*/
433 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
434 * completion callbacks. 2.5 should have fixed those bugs...
437 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
438 struct sk_buff_head *list, enum skb_state state)
441 enum skb_state old_state;
442 struct skb_data *entry = (struct skb_data *) skb->cb;
444 spin_lock_irqsave(&list->lock, flags);
445 old_state = entry->state;
446 entry->state = state;
447 __skb_unlink(skb, list);
449 /* defer_bh() is never called with list == &dev->done.
450 * spin_lock_nested() tells lockdep that it is OK to take
451 * dev->done.lock here with list->lock held.
453 spin_lock_nested(&dev->done.lock, SINGLE_DEPTH_NESTING);
455 __skb_queue_tail(&dev->done, skb);
456 if (dev->done.qlen == 1)
457 tasklet_schedule(&dev->bh);
458 spin_unlock(&dev->done.lock);
459 spin_unlock_irqrestore(&list->lock, flags);
463 /* some work can't be done in tasklets, so we use keventd
465 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
466 * but tasklet_schedule() doesn't. hope the failure is rare.
468 void usbnet_defer_kevent (struct usbnet *dev, int work)
470 set_bit (work, &dev->flags);
471 if (!schedule_work (&dev->kevent))
472 netdev_dbg(dev->net, "kevent %s may have been dropped\n", usbnet_event_names[work]);
474 netdev_dbg(dev->net, "kevent %s scheduled\n", usbnet_event_names[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 const 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 const 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_err(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 /* These methods are written on the assumption that the device
967 int usbnet_get_link_ksettings_mii(struct net_device *net,
968 struct ethtool_link_ksettings *cmd)
970 struct usbnet *dev = netdev_priv(net);
972 if (!dev->mii.mdio_read)
975 mii_ethtool_get_link_ksettings(&dev->mii, cmd);
979 EXPORT_SYMBOL_GPL(usbnet_get_link_ksettings_mii);
981 int usbnet_get_link_ksettings_internal(struct net_device *net,
982 struct ethtool_link_ksettings *cmd)
984 struct usbnet *dev = netdev_priv(net);
986 /* the assumption that speed is equal on tx and rx
987 * is deeply engrained into the networking layer.
988 * For wireless stuff it is not true.
989 * We assume that rx_speed matters more.
991 if (dev->rx_speed != SPEED_UNSET)
992 cmd->base.speed = dev->rx_speed / 1000000;
993 else if (dev->tx_speed != SPEED_UNSET)
994 cmd->base.speed = dev->tx_speed / 1000000;
996 cmd->base.speed = SPEED_UNKNOWN;
1000 EXPORT_SYMBOL_GPL(usbnet_get_link_ksettings_internal);
1002 int usbnet_set_link_ksettings_mii(struct net_device *net,
1003 const struct ethtool_link_ksettings *cmd)
1005 struct usbnet *dev = netdev_priv(net);
1008 if (!dev->mii.mdio_write)
1011 retval = mii_ethtool_set_link_ksettings(&dev->mii, cmd);
1013 /* link speed/duplex might have changed */
1014 if (dev->driver_info->link_reset)
1015 dev->driver_info->link_reset(dev);
1017 /* hard_mtu or rx_urb_size may change in link_reset() */
1018 usbnet_update_max_qlen(dev);
1022 EXPORT_SYMBOL_GPL(usbnet_set_link_ksettings_mii);
1024 u32 usbnet_get_link (struct net_device *net)
1026 struct usbnet *dev = netdev_priv(net);
1028 /* If a check_connect is defined, return its result */
1029 if (dev->driver_info->check_connect)
1030 return dev->driver_info->check_connect (dev) == 0;
1032 /* if the device has mii operations, use those */
1033 if (dev->mii.mdio_read)
1034 return mii_link_ok(&dev->mii);
1036 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
1037 return ethtool_op_get_link(net);
1039 EXPORT_SYMBOL_GPL(usbnet_get_link);
1041 int usbnet_nway_reset(struct net_device *net)
1043 struct usbnet *dev = netdev_priv(net);
1045 if (!dev->mii.mdio_write)
1048 return mii_nway_restart(&dev->mii);
1050 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
1052 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
1054 struct usbnet *dev = netdev_priv(net);
1056 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
1057 strlcpy (info->fw_version, dev->driver_info->description,
1058 sizeof info->fw_version);
1059 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
1061 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
1063 u32 usbnet_get_msglevel (struct net_device *net)
1065 struct usbnet *dev = netdev_priv(net);
1067 return dev->msg_enable;
1069 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1071 void usbnet_set_msglevel (struct net_device *net, u32 level)
1073 struct usbnet *dev = netdev_priv(net);
1075 dev->msg_enable = level;
1077 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1079 /* drivers may override default ethtool_ops in their bind() routine */
1080 static const struct ethtool_ops usbnet_ethtool_ops = {
1081 .get_link = usbnet_get_link,
1082 .nway_reset = usbnet_nway_reset,
1083 .get_drvinfo = usbnet_get_drvinfo,
1084 .get_msglevel = usbnet_get_msglevel,
1085 .set_msglevel = usbnet_set_msglevel,
1086 .get_ts_info = ethtool_op_get_ts_info,
1087 .get_link_ksettings = usbnet_get_link_ksettings_mii,
1088 .set_link_ksettings = usbnet_set_link_ksettings_mii,
1091 /*-------------------------------------------------------------------------*/
1093 static void __handle_link_change(struct usbnet *dev)
1095 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1098 if (!netif_carrier_ok(dev->net)) {
1099 /* kill URBs for reading packets to save bus bandwidth */
1100 unlink_urbs(dev, &dev->rxq);
1103 * tx_timeout will unlink URBs for sending packets and
1104 * tx queue is stopped by netcore after link becomes off
1107 /* submitting URBs for reading packets */
1108 tasklet_schedule(&dev->bh);
1111 /* hard_mtu or rx_urb_size may change during link change */
1112 usbnet_update_max_qlen(dev);
1114 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1117 void usbnet_set_rx_mode(struct net_device *net)
1119 struct usbnet *dev = netdev_priv(net);
1121 usbnet_defer_kevent(dev, EVENT_SET_RX_MODE);
1123 EXPORT_SYMBOL_GPL(usbnet_set_rx_mode);
1125 static void __handle_set_rx_mode(struct usbnet *dev)
1127 if (dev->driver_info->set_rx_mode)
1128 (dev->driver_info->set_rx_mode)(dev);
1130 clear_bit(EVENT_SET_RX_MODE, &dev->flags);
1133 /* work that cannot be done in interrupt context uses keventd.
1135 * NOTE: with 2.5 we could do more of this using completion callbacks,
1136 * especially now that control transfers can be queued.
1139 usbnet_deferred_kevent (struct work_struct *work)
1141 struct usbnet *dev =
1142 container_of(work, struct usbnet, kevent);
1145 /* usb_clear_halt() needs a thread context */
1146 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1147 unlink_urbs (dev, &dev->txq);
1148 status = usb_autopm_get_interface(dev->intf);
1151 status = usb_clear_halt (dev->udev, dev->out);
1152 usb_autopm_put_interface(dev->intf);
1155 status != -ESHUTDOWN) {
1156 if (netif_msg_tx_err (dev))
1158 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1161 clear_bit (EVENT_TX_HALT, &dev->flags);
1162 if (status != -ESHUTDOWN)
1163 netif_wake_queue (dev->net);
1166 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1167 unlink_urbs (dev, &dev->rxq);
1168 status = usb_autopm_get_interface(dev->intf);
1171 status = usb_clear_halt (dev->udev, dev->in);
1172 usb_autopm_put_interface(dev->intf);
1175 status != -ESHUTDOWN) {
1176 if (netif_msg_rx_err (dev))
1178 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1181 clear_bit (EVENT_RX_HALT, &dev->flags);
1182 tasklet_schedule (&dev->bh);
1186 /* tasklet could resubmit itself forever if memory is tight */
1187 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1188 struct urb *urb = NULL;
1191 if (netif_running (dev->net))
1192 urb = usb_alloc_urb (0, GFP_KERNEL);
1194 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1196 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1197 status = usb_autopm_get_interface(dev->intf);
1202 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1204 usb_autopm_put_interface(dev->intf);
1207 tasklet_schedule (&dev->bh);
1211 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1212 const struct driver_info *info = dev->driver_info;
1215 clear_bit (EVENT_LINK_RESET, &dev->flags);
1216 status = usb_autopm_get_interface(dev->intf);
1219 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1220 usb_autopm_put_interface(dev->intf);
1222 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1224 dev->udev->bus->bus_name,
1228 usb_autopm_put_interface(dev->intf);
1231 /* handle link change from link resetting */
1232 __handle_link_change(dev);
1235 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1236 __handle_link_change(dev);
1238 if (test_bit (EVENT_SET_RX_MODE, &dev->flags))
1239 __handle_set_rx_mode(dev);
1243 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1246 /*-------------------------------------------------------------------------*/
1248 static void tx_complete (struct urb *urb)
1250 struct sk_buff *skb = (struct sk_buff *) urb->context;
1251 struct skb_data *entry = (struct skb_data *) skb->cb;
1252 struct usbnet *dev = entry->dev;
1254 if (urb->status == 0) {
1255 struct pcpu_sw_netstats *stats64 = this_cpu_ptr(dev->net->tstats);
1256 unsigned long flags;
1258 flags = u64_stats_update_begin_irqsave(&stats64->syncp);
1259 stats64->tx_packets += entry->packets;
1260 stats64->tx_bytes += entry->length;
1261 u64_stats_update_end_irqrestore(&stats64->syncp, flags);
1263 dev->net->stats.tx_errors++;
1265 switch (urb->status) {
1267 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1270 /* software-driven interface shutdown */
1271 case -ECONNRESET: // async unlink
1272 case -ESHUTDOWN: // hardware gone
1275 /* like rx, tx gets controller i/o faults during hub_wq
1276 * delays and so it uses the same throttling mechanism.
1281 usb_mark_last_busy(dev->udev);
1282 if (!timer_pending (&dev->delay)) {
1283 mod_timer (&dev->delay,
1284 jiffies + THROTTLE_JIFFIES);
1285 netif_dbg(dev, link, dev->net,
1286 "tx throttle %d\n", urb->status);
1288 netif_stop_queue (dev->net);
1291 netif_dbg(dev, tx_err, dev->net,
1292 "tx err %d\n", entry->urb->status);
1297 usb_autopm_put_interface_async(dev->intf);
1298 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1301 /*-------------------------------------------------------------------------*/
1303 void usbnet_tx_timeout (struct net_device *net, unsigned int txqueue)
1305 struct usbnet *dev = netdev_priv(net);
1307 unlink_urbs (dev, &dev->txq);
1308 tasklet_schedule (&dev->bh);
1309 /* this needs to be handled individually because the generic layer
1310 * doesn't know what is sufficient and could not restore private
1311 * information if a remedy of an unconditional reset were used.
1313 if (dev->driver_info->recover)
1314 (dev->driver_info->recover)(dev);
1316 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1318 /*-------------------------------------------------------------------------*/
1320 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1322 unsigned num_sgs, total_len = 0;
1325 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1329 /* reserve one for zero packet */
1330 urb->sg = kmalloc_array(num_sgs + 1, sizeof(struct scatterlist),
1335 urb->num_sgs = num_sgs;
1336 sg_init_table(urb->sg, urb->num_sgs + 1);
1338 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1339 total_len += skb_headlen(skb);
1341 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1342 skb_frag_t *f = &skb_shinfo(skb)->frags[i];
1344 total_len += skb_frag_size(f);
1345 sg_set_page(&urb->sg[i + s], skb_frag_page(f), skb_frag_size(f),
1348 urb->transfer_buffer_length = total_len;
1353 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1354 struct net_device *net)
1356 struct usbnet *dev = netdev_priv(net);
1357 unsigned int length;
1358 struct urb *urb = NULL;
1359 struct skb_data *entry;
1360 const struct driver_info *info = dev->driver_info;
1361 unsigned long flags;
1365 skb_tx_timestamp(skb);
1367 // some devices want funky USB-level framing, for
1368 // win32 driver (usually) and/or hardware quirks
1369 if (info->tx_fixup) {
1370 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1372 /* packet collected; minidriver waiting for more */
1373 if (info->flags & FLAG_MULTI_PACKET)
1375 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1380 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1381 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1385 entry = (struct skb_data *) skb->cb;
1389 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1390 skb->data, skb->len, tx_complete, skb);
1391 if (dev->can_dma_sg) {
1392 if (build_dma_sg(skb, urb) < 0)
1395 length = urb->transfer_buffer_length;
1397 /* don't assume the hardware handles USB_ZERO_PACKET
1398 * NOTE: strictly conforming cdc-ether devices should expect
1399 * the ZLP here, but ignore the one-byte packet.
1400 * NOTE2: CDC NCM specification is different from CDC ECM when
1401 * handling ZLP/short packets, so cdc_ncm driver will make short
1402 * packet itself if needed.
1404 if (length % dev->maxpacket == 0) {
1405 if (!(info->flags & FLAG_SEND_ZLP)) {
1406 if (!(info->flags & FLAG_MULTI_PACKET)) {
1408 if (skb_tailroom(skb) && !urb->num_sgs) {
1409 skb->data[skb->len] = 0;
1411 } else if (urb->num_sgs)
1412 sg_set_buf(&urb->sg[urb->num_sgs++],
1413 dev->padding_pkt, 1);
1416 urb->transfer_flags |= URB_ZERO_PACKET;
1418 urb->transfer_buffer_length = length;
1420 if (info->flags & FLAG_MULTI_PACKET) {
1421 /* Driver has set number of packets and a length delta.
1422 * Calculate the complete length and ensure that it's
1425 entry->length += length;
1426 if (WARN_ON_ONCE(entry->length <= 0))
1427 entry->length = length;
1429 usbnet_set_skb_tx_stats(skb, 1, length);
1432 spin_lock_irqsave(&dev->txq.lock, flags);
1433 retval = usb_autopm_get_interface_async(dev->intf);
1435 spin_unlock_irqrestore(&dev->txq.lock, flags);
1438 if (netif_queue_stopped(net)) {
1439 usb_autopm_put_interface_async(dev->intf);
1440 spin_unlock_irqrestore(&dev->txq.lock, flags);
1445 /* if this triggers the device is still a sleep */
1446 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1447 /* transmission will be done in resume */
1448 usb_anchor_urb(urb, &dev->deferred);
1449 /* no use to process more packets */
1450 netif_stop_queue(net);
1452 spin_unlock_irqrestore(&dev->txq.lock, flags);
1453 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1458 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1460 netif_stop_queue (net);
1461 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1462 usb_autopm_put_interface_async(dev->intf);
1465 usb_autopm_put_interface_async(dev->intf);
1466 netif_dbg(dev, tx_err, dev->net,
1467 "tx: submit urb err %d\n", retval);
1470 netif_trans_update(net);
1471 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1472 if (dev->txq.qlen >= TX_QLEN (dev))
1473 netif_stop_queue (net);
1475 spin_unlock_irqrestore (&dev->txq.lock, flags);
1478 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1480 dev->net->stats.tx_dropped++;
1483 dev_kfree_skb_any (skb);
1489 netif_dbg(dev, tx_queued, dev->net,
1490 "> tx, len %u, type 0x%x\n", length, skb->protocol);
1494 return NETDEV_TX_OK;
1496 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1498 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1504 /* don't refill the queue all at once */
1505 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1506 urb = usb_alloc_urb(0, flags);
1508 ret = rx_submit(dev, urb, flags);
1520 /*-------------------------------------------------------------------------*/
1522 // tasklet (work deferred from completions, in_irq) or timer
1524 static void usbnet_bh (struct timer_list *t)
1526 struct usbnet *dev = from_timer(dev, t, delay);
1527 struct sk_buff *skb;
1528 struct skb_data *entry;
1530 while ((skb = skb_dequeue (&dev->done))) {
1531 entry = (struct skb_data *) skb->cb;
1532 switch (entry->state) {
1534 entry->state = rx_cleanup;
1535 rx_process (dev, skb);
1538 kfree(entry->urb->sg);
1541 usb_free_urb (entry->urb);
1542 dev_kfree_skb (skb);
1545 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1549 /* restart RX again after disabling due to high error rate */
1550 clear_bit(EVENT_RX_KILL, &dev->flags);
1552 /* waiting for all pending urbs to complete?
1553 * only then can we forgo submitting anew
1555 if (waitqueue_active(&dev->wait)) {
1556 if (dev->txq.qlen + dev->rxq.qlen + dev->done.qlen == 0)
1557 wake_up_all(&dev->wait);
1559 // or are we maybe short a few urbs?
1560 } else if (netif_running (dev->net) &&
1561 netif_device_present (dev->net) &&
1562 netif_carrier_ok(dev->net) &&
1563 !timer_pending(&dev->delay) &&
1564 !test_bit(EVENT_RX_PAUSED, &dev->flags) &&
1565 !test_bit(EVENT_RX_HALT, &dev->flags)) {
1566 int temp = dev->rxq.qlen;
1568 if (temp < RX_QLEN(dev)) {
1569 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1571 if (temp != dev->rxq.qlen)
1572 netif_dbg(dev, link, dev->net,
1573 "rxqlen %d --> %d\n",
1574 temp, dev->rxq.qlen);
1575 if (dev->rxq.qlen < RX_QLEN(dev))
1576 tasklet_schedule (&dev->bh);
1578 if (dev->txq.qlen < TX_QLEN (dev))
1579 netif_wake_queue (dev->net);
1583 static void usbnet_bh_tasklet(struct tasklet_struct *t)
1585 struct usbnet *dev = from_tasklet(dev, t, bh);
1587 usbnet_bh(&dev->delay);
1591 /*-------------------------------------------------------------------------
1593 * USB Device Driver support
1595 *-------------------------------------------------------------------------*/
1597 // precondition: never called in_interrupt
1599 void usbnet_disconnect (struct usb_interface *intf)
1602 struct usb_device *xdev;
1603 struct net_device *net;
1605 dev = usb_get_intfdata(intf);
1606 usb_set_intfdata(intf, NULL);
1610 xdev = interface_to_usbdev (intf);
1612 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1613 intf->dev.driver->name,
1614 xdev->bus->bus_name, xdev->devpath,
1615 dev->driver_info->description);
1618 unregister_netdev (net);
1620 cancel_work_sync(&dev->kevent);
1622 usb_scuttle_anchored_urbs(&dev->deferred);
1624 if (dev->driver_info->unbind)
1625 dev->driver_info->unbind(dev, intf);
1627 usb_kill_urb(dev->interrupt);
1628 usb_free_urb(dev->interrupt);
1629 kfree(dev->padding_pkt);
1631 free_percpu(net->tstats);
1634 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1636 static const struct net_device_ops usbnet_netdev_ops = {
1637 .ndo_open = usbnet_open,
1638 .ndo_stop = usbnet_stop,
1639 .ndo_start_xmit = usbnet_start_xmit,
1640 .ndo_tx_timeout = usbnet_tx_timeout,
1641 .ndo_set_rx_mode = usbnet_set_rx_mode,
1642 .ndo_change_mtu = usbnet_change_mtu,
1643 .ndo_get_stats64 = dev_get_tstats64,
1644 .ndo_set_mac_address = eth_mac_addr,
1645 .ndo_validate_addr = eth_validate_addr,
1648 /*-------------------------------------------------------------------------*/
1650 // precondition: never called in_interrupt
1652 static struct device_type wlan_type = {
1656 static struct device_type wwan_type = {
1661 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1664 struct net_device *net;
1665 struct usb_host_interface *interface;
1666 const struct driver_info *info;
1667 struct usb_device *xdev;
1670 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1672 /* usbnet already took usb runtime pm, so have to enable the feature
1673 * for usb interface, otherwise usb_autopm_get_interface may return
1674 * failure if RUNTIME_PM is enabled.
1676 if (!driver->supports_autosuspend) {
1677 driver->supports_autosuspend = 1;
1678 pm_runtime_enable(&udev->dev);
1681 name = udev->dev.driver->name;
1682 info = (const struct driver_info *) prod->driver_info;
1684 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1687 xdev = interface_to_usbdev (udev);
1688 interface = udev->cur_altsetting;
1692 // set up our own records
1693 net = alloc_etherdev(sizeof(*dev));
1697 /* netdev_printk() needs this so do it as early as possible */
1698 SET_NETDEV_DEV(net, &udev->dev);
1700 dev = netdev_priv(net);
1703 dev->driver_info = info;
1704 dev->driver_name = name;
1705 dev->rx_speed = SPEED_UNSET;
1706 dev->tx_speed = SPEED_UNSET;
1708 net->tstats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
1712 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1713 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1714 init_waitqueue_head(&dev->wait);
1715 skb_queue_head_init (&dev->rxq);
1716 skb_queue_head_init (&dev->txq);
1717 skb_queue_head_init (&dev->done);
1718 skb_queue_head_init(&dev->rxq_pause);
1719 tasklet_setup(&dev->bh, usbnet_bh_tasklet);
1720 INIT_WORK (&dev->kevent, usbnet_deferred_kevent);
1721 init_usb_anchor(&dev->deferred);
1722 timer_setup(&dev->delay, usbnet_bh, 0);
1723 mutex_init (&dev->phy_mutex);
1724 mutex_init(&dev->interrupt_mutex);
1725 dev->interrupt_count = 0;
1728 strscpy(net->name, "usb%d", sizeof(net->name));
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 strscpy(net->name, "eth%d", sizeof(net->name));
1756 /* WLAN devices should always be named "wlan%d" */
1757 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1758 strscpy(net->name, "wlan%d", sizeof(net->name));
1759 /* WWAN devices should always be named "wwan%d" */
1760 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1761 strscpy(net->name, "wwan%d", sizeof(net->name));
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);
1791 if (dev->maxpacket == 0) {
1792 /* that is a broken device */
1797 /* let userspace know we have a random address */
1798 if (ether_addr_equal(net->dev_addr, node_id))
1799 net->addr_assign_type = NET_ADDR_RANDOM;
1801 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1802 SET_NETDEV_DEVTYPE(net, &wlan_type);
1803 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1804 SET_NETDEV_DEVTYPE(net, &wwan_type);
1806 /* initialize max rx_qlen and tx_qlen */
1807 usbnet_update_max_qlen(dev);
1809 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1810 !(info->flags & FLAG_MULTI_PACKET)) {
1811 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1812 if (!dev->padding_pkt) {
1818 status = register_netdev (net);
1821 netif_info(dev, probe, dev->net,
1822 "register '%s' at usb-%s-%s, %s, %pM\n",
1823 udev->dev.driver->name,
1824 xdev->bus->bus_name, xdev->devpath,
1825 dev->driver_info->description,
1828 // ok, it's ready to go.
1829 usb_set_intfdata (udev, dev);
1831 netif_device_attach (net);
1833 if (dev->driver_info->flags & FLAG_LINK_INTR)
1834 usbnet_link_change(dev, 0, 0);
1839 kfree(dev->padding_pkt);
1841 usb_free_urb(dev->interrupt);
1844 info->unbind (dev, udev);
1846 /* subdrivers must undo all they did in bind() if they
1847 * fail it, but we may fail later and a deferred kevent
1848 * may trigger an error resubmitting itself and, worse,
1849 * schedule a timer. So we kill it all just in case.
1851 cancel_work_sync(&dev->kevent);
1852 del_timer_sync(&dev->delay);
1853 free_percpu(net->tstats);
1859 EXPORT_SYMBOL_GPL(usbnet_probe);
1861 /*-------------------------------------------------------------------------*/
1864 * suspend the whole driver as soon as the first interface is suspended
1865 * resume only when the last interface is resumed
1868 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1870 struct usbnet *dev = usb_get_intfdata(intf);
1872 if (!dev->suspend_count++) {
1873 spin_lock_irq(&dev->txq.lock);
1874 /* don't autosuspend while transmitting */
1875 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1876 dev->suspend_count--;
1877 spin_unlock_irq(&dev->txq.lock);
1880 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1881 spin_unlock_irq(&dev->txq.lock);
1884 * accelerate emptying of the rx and queues, to avoid
1885 * having everything error out.
1887 netif_device_detach (dev->net);
1888 usbnet_terminate_urbs(dev);
1889 __usbnet_status_stop_force(dev);
1892 * reattach so runtime management can use and
1895 netif_device_attach (dev->net);
1899 EXPORT_SYMBOL_GPL(usbnet_suspend);
1901 int usbnet_resume (struct usb_interface *intf)
1903 struct usbnet *dev = usb_get_intfdata(intf);
1904 struct sk_buff *skb;
1908 if (!--dev->suspend_count) {
1909 /* resume interrupt URB if it was previously submitted */
1910 __usbnet_status_start_force(dev, GFP_NOIO);
1912 spin_lock_irq(&dev->txq.lock);
1913 while ((res = usb_get_from_anchor(&dev->deferred))) {
1915 skb = (struct sk_buff *)res->context;
1916 retval = usb_submit_urb(res, GFP_ATOMIC);
1918 dev_kfree_skb_any(skb);
1921 usb_autopm_put_interface_async(dev->intf);
1923 netif_trans_update(dev->net);
1924 __skb_queue_tail(&dev->txq, skb);
1929 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1930 spin_unlock_irq(&dev->txq.lock);
1932 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1933 /* handle remote wakeup ASAP
1934 * we cannot race against stop
1936 if (netif_device_present(dev->net) &&
1937 !timer_pending(&dev->delay) &&
1938 !test_bit(EVENT_RX_HALT, &dev->flags))
1939 rx_alloc_submit(dev, GFP_NOIO);
1941 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1942 netif_tx_wake_all_queues(dev->net);
1943 tasklet_schedule (&dev->bh);
1947 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1948 usb_autopm_get_interface_no_resume(intf);
1952 EXPORT_SYMBOL_GPL(usbnet_resume);
1955 * Either a subdriver implements manage_power, then it is assumed to always
1956 * be ready to be suspended or it reports the readiness to be suspended
1959 void usbnet_device_suggests_idle(struct usbnet *dev)
1961 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1962 dev->intf->needs_remote_wakeup = 1;
1963 usb_autopm_put_interface_async(dev->intf);
1966 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1969 * For devices that can do without special commands
1971 int usbnet_manage_power(struct usbnet *dev, int on)
1973 dev->intf->needs_remote_wakeup = on;
1976 EXPORT_SYMBOL(usbnet_manage_power);
1978 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1980 /* update link after link is reseted */
1981 if (link && !need_reset)
1982 netif_carrier_on(dev->net);
1984 netif_carrier_off(dev->net);
1986 if (need_reset && link)
1987 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1989 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1991 EXPORT_SYMBOL(usbnet_link_change);
1993 /*-------------------------------------------------------------------------*/
1994 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1995 u16 value, u16 index, void *data, u16 size)
2000 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
2001 " value=0x%04x index=0x%04x size=%d\n",
2002 cmd, reqtype, value, index, size);
2005 buf = kmalloc(size, GFP_NOIO);
2010 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
2011 cmd, reqtype, value, index, buf, size,
2012 USB_CTRL_GET_TIMEOUT);
2013 if (err > 0 && err <= size) {
2015 memcpy(data, buf, err);
2017 netdev_dbg(dev->net,
2018 "Huh? Data requested but thrown away.\n");
2025 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2026 u16 value, u16 index, const void *data,
2032 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2033 " value=0x%04x index=0x%04x size=%d\n",
2034 cmd, reqtype, value, index, size);
2037 buf = kmemdup(data, size, GFP_NOIO);
2048 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
2049 cmd, reqtype, value, index, buf, size,
2050 USB_CTRL_SET_TIMEOUT);
2058 * The function can't be called inside suspend/resume callback,
2059 * otherwise deadlock will be caused.
2061 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2062 u16 value, u16 index, void *data, u16 size)
2066 if (usb_autopm_get_interface(dev->intf) < 0)
2068 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2070 usb_autopm_put_interface(dev->intf);
2073 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
2076 * The function can't be called inside suspend/resume callback,
2077 * otherwise deadlock will be caused.
2079 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2080 u16 value, u16 index, const void *data, u16 size)
2084 if (usb_autopm_get_interface(dev->intf) < 0)
2086 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2088 usb_autopm_put_interface(dev->intf);
2091 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
2094 * The function can be called inside suspend/resume callback safely
2095 * and should only be called by suspend/resume callback generally.
2097 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2098 u16 value, u16 index, void *data, u16 size)
2100 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2103 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
2106 * The function can be called inside suspend/resume callback safely
2107 * and should only be called by suspend/resume callback generally.
2109 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2110 u16 value, u16 index, const void *data,
2113 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2116 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
2118 static void usbnet_async_cmd_cb(struct urb *urb)
2120 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
2121 int status = urb->status;
2124 dev_dbg(&urb->dev->dev, "%s failed with %d",
2132 * The caller must make sure that device can't be put into suspend
2133 * state until the control URB completes.
2135 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
2136 u16 value, u16 index, const void *data, u16 size)
2138 struct usb_ctrlrequest *req = NULL;
2143 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2144 " value=0x%04x index=0x%04x size=%d\n",
2145 cmd, reqtype, value, index, size);
2147 urb = usb_alloc_urb(0, GFP_ATOMIC);
2152 buf = kmemdup(data, size, GFP_ATOMIC);
2154 netdev_err(dev->net, "Error allocating buffer"
2155 " in %s!\n", __func__);
2160 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2164 req->bRequestType = reqtype;
2165 req->bRequest = cmd;
2166 req->wValue = cpu_to_le16(value);
2167 req->wIndex = cpu_to_le16(index);
2168 req->wLength = cpu_to_le16(size);
2170 usb_fill_control_urb(urb, dev->udev,
2171 usb_sndctrlpipe(dev->udev, 0),
2172 (void *)req, buf, size,
2173 usbnet_async_cmd_cb, req);
2174 urb->transfer_flags |= URB_FREE_BUFFER;
2176 err = usb_submit_urb(urb, GFP_ATOMIC);
2178 netdev_err(dev->net, "Error submitting the control"
2179 " message: status=%d\n", err);
2193 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2194 /*-------------------------------------------------------------------------*/
2196 static int __init usbnet_init(void)
2198 /* Compiler should optimize this out. */
2200 sizeof_field(struct sk_buff, cb) < sizeof(struct skb_data));
2202 eth_random_addr(node_id);
2205 module_init(usbnet_init);
2207 static void __exit usbnet_exit(void)
2210 module_exit(usbnet_exit);
2212 MODULE_AUTHOR("David Brownell");
2213 MODULE_DESCRIPTION("USB network driver framework");
2214 MODULE_LICENSE("GPL");