1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * USB Network driver infrastructure
4 * Copyright (C) 2000-2005 by David Brownell
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 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/netdevice.h>
23 #include <linux/etherdevice.h>
24 #include <linux/ctype.h>
25 #include <linux/ethtool.h>
26 #include <linux/workqueue.h>
27 #include <linux/mii.h>
28 #include <linux/usb.h>
29 #include <linux/usb/usbnet.h>
30 #include <linux/slab.h>
31 #include <linux/kernel.h>
32 #include <linux/pm_runtime.h>
34 /*-------------------------------------------------------------------------*/
37 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
38 * Several dozen bytes of IPv4 data can fit in two such transactions.
39 * One maximum size Ethernet packet takes twenty four of them.
40 * For high speed, each frame comfortably fits almost 36 max size
41 * Ethernet packets (so queues should be bigger).
43 * The goal is to let the USB host controller be busy for 5msec or
44 * more before an irq is required, under load. Jumbograms change
47 #define MAX_QUEUE_MEMORY (60 * 1518)
48 #define RX_QLEN(dev) ((dev)->rx_qlen)
49 #define TX_QLEN(dev) ((dev)->tx_qlen)
51 // reawaken network queue this soon after stopping; else watchdog barks
52 #define TX_TIMEOUT_JIFFIES (5*HZ)
54 /* throttle rx/tx briefly after some faults, so hub_wq might disconnect()
55 * us (it polls at HZ/4 usually) before we report too many false errors.
57 #define THROTTLE_JIFFIES (HZ/8)
60 #define UNLINK_TIMEOUT_MS 3
62 /*-------------------------------------------------------------------------*/
64 /* use ethtool to change the level for any given device */
65 static int msg_level = -1;
66 module_param (msg_level, int, 0);
67 MODULE_PARM_DESC (msg_level, "Override default message level");
69 /*-------------------------------------------------------------------------*/
71 static const char * const usbnet_event_names[] = {
72 [EVENT_TX_HALT] = "EVENT_TX_HALT",
73 [EVENT_RX_HALT] = "EVENT_RX_HALT",
74 [EVENT_RX_MEMORY] = "EVENT_RX_MEMORY",
75 [EVENT_STS_SPLIT] = "EVENT_STS_SPLIT",
76 [EVENT_LINK_RESET] = "EVENT_LINK_RESET",
77 [EVENT_RX_PAUSED] = "EVENT_RX_PAUSED",
78 [EVENT_DEV_ASLEEP] = "EVENT_DEV_ASLEEP",
79 [EVENT_DEV_OPEN] = "EVENT_DEV_OPEN",
80 [EVENT_DEVICE_REPORT_IDLE] = "EVENT_DEVICE_REPORT_IDLE",
81 [EVENT_NO_RUNTIME_PM] = "EVENT_NO_RUNTIME_PM",
82 [EVENT_RX_KILL] = "EVENT_RX_KILL",
83 [EVENT_LINK_CHANGE] = "EVENT_LINK_CHANGE",
84 [EVENT_SET_RX_MODE] = "EVENT_SET_RX_MODE",
85 [EVENT_NO_IP_ALIGN] = "EVENT_NO_IP_ALIGN",
88 /* handles CDC Ethernet and many other network "bulk data" interfaces */
89 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
92 struct usb_host_interface *alt = NULL;
93 struct usb_host_endpoint *in = NULL, *out = NULL;
94 struct usb_host_endpoint *status = NULL;
96 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
99 in = out = status = NULL;
100 alt = intf->altsetting + tmp;
102 /* take the first altsetting with in-bulk + out-bulk;
103 * remember any status endpoint, just in case;
104 * ignore other endpoints and altsettings.
106 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
107 struct usb_host_endpoint *e;
110 e = alt->endpoint + ep;
112 /* ignore endpoints which cannot transfer data */
113 if (!usb_endpoint_maxp(&e->desc))
116 switch (e->desc.bmAttributes) {
117 case USB_ENDPOINT_XFER_INT:
118 if (!usb_endpoint_dir_in(&e->desc))
122 case USB_ENDPOINT_XFER_BULK:
127 if (usb_endpoint_dir_in(&e->desc)) {
130 else if (intr && !status)
140 if (!alt || !in || !out)
143 if (alt->desc.bAlternateSetting != 0 ||
144 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
145 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
146 alt->desc.bAlternateSetting);
151 dev->in = usb_rcvbulkpipe (dev->udev,
152 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
153 dev->out = usb_sndbulkpipe (dev->udev,
154 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
155 dev->status = status;
158 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
160 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
164 unsigned char buf [13];
166 ret = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
168 tmp = hex2bin(addr, buf, 6);
170 dev_dbg(&dev->udev->dev,
171 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
176 eth_hw_addr_set(dev->net, addr);
179 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
181 static void intr_complete (struct urb *urb)
183 struct usbnet *dev = urb->context;
184 int status = urb->status;
189 dev->driver_info->status(dev, urb);
192 /* software-driven interface shutdown */
193 case -ENOENT: /* urb killed */
194 case -ESHUTDOWN: /* hardware gone */
195 netif_dbg(dev, ifdown, dev->net,
196 "intr shutdown, code %d\n", status);
199 /* NOTE: not throttling like RX/TX, since this endpoint
200 * already polls infrequently
203 netdev_dbg(dev->net, "intr status %d\n", status);
207 status = usb_submit_urb (urb, GFP_ATOMIC);
209 netif_err(dev, timer, dev->net,
210 "intr resubmit --> %d\n", status);
213 static int init_status (struct usbnet *dev, struct usb_interface *intf)
220 if (!dev->driver_info->status)
223 pipe = usb_rcvintpipe (dev->udev,
224 dev->status->desc.bEndpointAddress
225 & USB_ENDPOINT_NUMBER_MASK);
226 maxp = usb_maxpacket(dev->udev, pipe);
228 /* avoid 1 msec chatter: min 8 msec poll rate */
229 period = max ((int) dev->status->desc.bInterval,
230 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
232 buf = kmalloc (maxp, GFP_KERNEL);
234 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
235 if (!dev->interrupt) {
239 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
240 buf, maxp, intr_complete, dev, period);
241 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
243 "status ep%din, %d bytes period %d\n",
244 usb_pipeendpoint(pipe), maxp, period);
250 /* Submit the interrupt URB if not previously submitted, increasing refcount */
251 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
255 WARN_ON_ONCE(dev->interrupt == NULL);
256 if (dev->interrupt) {
257 mutex_lock(&dev->interrupt_mutex);
259 if (++dev->interrupt_count == 1)
260 ret = usb_submit_urb(dev->interrupt, mem_flags);
262 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
263 dev->interrupt_count);
264 mutex_unlock(&dev->interrupt_mutex);
268 EXPORT_SYMBOL_GPL(usbnet_status_start);
270 /* For resume; submit interrupt URB if previously submitted */
271 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
275 mutex_lock(&dev->interrupt_mutex);
276 if (dev->interrupt_count) {
277 ret = usb_submit_urb(dev->interrupt, mem_flags);
278 dev_dbg(&dev->udev->dev,
279 "submitted interrupt URB for resume\n");
281 mutex_unlock(&dev->interrupt_mutex);
285 /* Kill the interrupt URB if all submitters want it killed */
286 void usbnet_status_stop(struct usbnet *dev)
288 if (dev->interrupt) {
289 mutex_lock(&dev->interrupt_mutex);
290 WARN_ON(dev->interrupt_count == 0);
292 if (dev->interrupt_count && --dev->interrupt_count == 0)
293 usb_kill_urb(dev->interrupt);
295 dev_dbg(&dev->udev->dev,
296 "decremented interrupt URB count to %d\n",
297 dev->interrupt_count);
298 mutex_unlock(&dev->interrupt_mutex);
301 EXPORT_SYMBOL_GPL(usbnet_status_stop);
303 /* For suspend; always kill interrupt URB */
304 static void __usbnet_status_stop_force(struct usbnet *dev)
306 if (dev->interrupt) {
307 mutex_lock(&dev->interrupt_mutex);
308 usb_kill_urb(dev->interrupt);
309 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
310 mutex_unlock(&dev->interrupt_mutex);
314 /* Passes this packet up the stack, updating its accounting.
315 * Some link protocols batch packets, so their rx_fixup paths
316 * can return clones as well as just modify the original skb.
318 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
320 struct pcpu_sw_netstats *stats64 = this_cpu_ptr(dev->net->tstats);
324 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
325 skb_queue_tail(&dev->rxq_pause, skb);
329 /* only update if unset to allow minidriver rx_fixup override */
330 if (skb->protocol == 0)
331 skb->protocol = eth_type_trans (skb, dev->net);
333 flags = u64_stats_update_begin_irqsave(&stats64->syncp);
334 u64_stats_inc(&stats64->rx_packets);
335 u64_stats_add(&stats64->rx_bytes, skb->len);
336 u64_stats_update_end_irqrestore(&stats64->syncp, flags);
338 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
339 skb->len + sizeof (struct ethhdr), skb->protocol);
340 memset (skb->cb, 0, sizeof (struct skb_data));
342 if (skb_defer_rx_timestamp(skb))
345 status = netif_rx (skb);
346 if (status != NET_RX_SUCCESS)
347 netif_dbg(dev, rx_err, dev->net,
348 "netif_rx status %d\n", status);
350 EXPORT_SYMBOL_GPL(usbnet_skb_return);
352 /* must be called if hard_mtu or rx_urb_size changed */
353 void usbnet_update_max_qlen(struct usbnet *dev)
355 enum usb_device_speed speed = dev->udev->speed;
357 if (!dev->rx_urb_size || !dev->hard_mtu)
361 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
362 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
364 case USB_SPEED_SUPER:
365 case USB_SPEED_SUPER_PLUS:
367 * Not take default 5ms qlen for super speed HC to
368 * save memory, and iperf tests show 2.5ms qlen can
371 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
372 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
376 dev->rx_qlen = dev->tx_qlen = 4;
379 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
382 /*-------------------------------------------------------------------------
384 * Network Device Driver (peer link to "Host Device", from USB host)
386 *-------------------------------------------------------------------------*/
388 int usbnet_change_mtu (struct net_device *net, int new_mtu)
390 struct usbnet *dev = netdev_priv(net);
391 int ll_mtu = new_mtu + net->hard_header_len;
392 int old_hard_mtu = dev->hard_mtu;
393 int old_rx_urb_size = dev->rx_urb_size;
395 // no second zero-length packet read wanted after mtu-sized packets
396 if ((ll_mtu % dev->maxpacket) == 0)
398 WRITE_ONCE(net->mtu, new_mtu);
400 dev->hard_mtu = net->mtu + net->hard_header_len;
401 if (dev->rx_urb_size == old_hard_mtu) {
402 dev->rx_urb_size = dev->hard_mtu;
403 if (dev->rx_urb_size > old_rx_urb_size) {
404 usbnet_pause_rx(dev);
405 usbnet_unlink_rx_urbs(dev);
406 usbnet_resume_rx(dev);
410 /* max qlen depend on hard_mtu and rx_urb_size */
411 usbnet_update_max_qlen(dev);
415 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
417 /* The caller must hold list->lock */
418 static void __usbnet_queue_skb(struct sk_buff_head *list,
419 struct sk_buff *newsk, enum skb_state state)
421 struct skb_data *entry = (struct skb_data *) newsk->cb;
423 __skb_queue_tail(list, newsk);
424 entry->state = state;
427 /*-------------------------------------------------------------------------*/
429 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
430 * completion callbacks. 2.5 should have fixed those bugs...
433 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
434 struct sk_buff_head *list, enum skb_state state)
437 enum skb_state old_state;
438 struct skb_data *entry = (struct skb_data *) skb->cb;
440 spin_lock_irqsave(&list->lock, flags);
441 old_state = entry->state;
442 entry->state = state;
443 __skb_unlink(skb, list);
445 /* defer_bh() is never called with list == &dev->done.
446 * spin_lock_nested() tells lockdep that it is OK to take
447 * dev->done.lock here with list->lock held.
449 spin_lock_nested(&dev->done.lock, SINGLE_DEPTH_NESTING);
451 __skb_queue_tail(&dev->done, skb);
452 if (dev->done.qlen == 1)
453 tasklet_schedule(&dev->bh);
454 spin_unlock(&dev->done.lock);
455 spin_unlock_irqrestore(&list->lock, flags);
459 /* some work can't be done in tasklets, so we use keventd
461 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
462 * but tasklet_schedule() doesn't. hope the failure is rare.
464 void usbnet_defer_kevent (struct usbnet *dev, int work)
466 set_bit (work, &dev->flags);
467 if (!usbnet_going_away(dev)) {
468 if (!schedule_work(&dev->kevent))
470 "kevent %s may have been dropped\n",
471 usbnet_event_names[work]);
474 "kevent %s scheduled\n", usbnet_event_names[work]);
477 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
479 /*-------------------------------------------------------------------------*/
481 static void rx_complete (struct urb *urb);
483 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
486 struct skb_data *entry;
488 unsigned long lockflags;
489 size_t size = dev->rx_urb_size;
491 /* prevent rx skb allocation when error ratio is high */
492 if (test_bit(EVENT_RX_KILL, &dev->flags)) {
497 if (test_bit(EVENT_NO_IP_ALIGN, &dev->flags))
498 skb = __netdev_alloc_skb(dev->net, size, flags);
500 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
502 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
503 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
508 entry = (struct skb_data *) skb->cb;
513 usb_fill_bulk_urb (urb, dev->udev, dev->in,
514 skb->data, size, rx_complete, skb);
516 spin_lock_irqsave (&dev->rxq.lock, lockflags);
518 if (netif_running (dev->net) &&
519 netif_device_present (dev->net) &&
520 test_bit(EVENT_DEV_OPEN, &dev->flags) &&
521 !test_bit (EVENT_RX_HALT, &dev->flags) &&
522 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
523 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
525 usbnet_defer_kevent (dev, EVENT_RX_HALT);
528 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
531 netif_dbg(dev, ifdown, dev->net, "device gone\n");
532 netif_device_detach (dev->net);
538 netif_dbg(dev, rx_err, dev->net,
539 "rx submit, %d\n", retval);
540 tasklet_schedule (&dev->bh);
543 if (!usbnet_going_away(dev))
544 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
547 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
550 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
552 dev_kfree_skb_any (skb);
559 /*-------------------------------------------------------------------------*/
561 static inline int rx_process(struct usbnet *dev, struct sk_buff *skb)
563 if (dev->driver_info->rx_fixup &&
564 !dev->driver_info->rx_fixup (dev, skb)) {
565 /* With RX_ASSEMBLE, rx_fixup() must update counters */
566 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
567 dev->net->stats.rx_errors++;
570 // else network stack removes extra byte if we forced a short packet
572 /* all data was already cloned from skb inside the driver */
573 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
576 if (skb->len < ETH_HLEN) {
577 dev->net->stats.rx_errors++;
578 dev->net->stats.rx_length_errors++;
579 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
583 usbnet_skb_return(dev, 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 (timer, softirq, task) must also stop */
852 del_timer_sync(&dev->delay);
853 tasklet_kill(&dev->bh);
854 cancel_work_sync(&dev->kevent);
856 /* We have cyclic dependencies. Those calls are needed
857 * to break a cycle. We cannot fall into the gaps because
860 tasklet_kill(&dev->bh);
861 del_timer_sync(&dev->delay);
862 cancel_work_sync(&dev->kevent);
865 usb_autopm_put_interface(dev->intf);
867 if (info->manage_power && mpn)
868 info->manage_power(dev, 0);
870 usb_autopm_put_interface(dev->intf);
874 EXPORT_SYMBOL_GPL(usbnet_stop);
876 /*-------------------------------------------------------------------------*/
878 // posts reads, and enables write queuing
880 // precondition: never called in_interrupt
882 int usbnet_open (struct net_device *net)
884 struct usbnet *dev = netdev_priv(net);
886 const struct driver_info *info = dev->driver_info;
888 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
889 netif_info(dev, ifup, dev->net,
890 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
892 dev->udev->bus->bus_name,
898 // put into "known safe" state
899 if (info->reset && (retval = info->reset (dev)) < 0) {
900 netif_info(dev, ifup, dev->net,
901 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
903 dev->udev->bus->bus_name,
909 /* hard_mtu or rx_urb_size may change in reset() */
910 usbnet_update_max_qlen(dev);
912 // insist peer be connected
913 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
914 netif_err(dev, ifup, dev->net, "can't open; %d\n", retval);
918 /* start any status interrupt transfer */
919 if (dev->interrupt) {
920 retval = usbnet_status_start(dev, GFP_KERNEL);
922 netif_err(dev, ifup, dev->net,
923 "intr submit %d\n", retval);
928 set_bit(EVENT_DEV_OPEN, &dev->flags);
929 netif_start_queue (net);
930 netif_info(dev, ifup, dev->net,
931 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
932 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
934 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
935 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
936 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
937 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
938 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
941 /* reset rx error state */
944 clear_bit(EVENT_RX_KILL, &dev->flags);
946 // delay posting reads until we're fully open
947 tasklet_schedule (&dev->bh);
948 if (info->manage_power) {
949 retval = info->manage_power(dev, 1);
952 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
954 usb_autopm_put_interface(dev->intf);
959 usb_autopm_put_interface(dev->intf);
963 EXPORT_SYMBOL_GPL(usbnet_open);
965 /*-------------------------------------------------------------------------*/
967 /* ethtool methods; minidrivers may need to add some more, but
968 * they'll probably want to use this base set.
971 /* These methods are written on the assumption that the device
974 int usbnet_get_link_ksettings_mii(struct net_device *net,
975 struct ethtool_link_ksettings *cmd)
977 struct usbnet *dev = netdev_priv(net);
979 if (!dev->mii.mdio_read)
982 mii_ethtool_get_link_ksettings(&dev->mii, cmd);
986 EXPORT_SYMBOL_GPL(usbnet_get_link_ksettings_mii);
988 int usbnet_get_link_ksettings_internal(struct net_device *net,
989 struct ethtool_link_ksettings *cmd)
991 struct usbnet *dev = netdev_priv(net);
993 /* the assumption that speed is equal on tx and rx
994 * is deeply engrained into the networking layer.
995 * For wireless stuff it is not true.
996 * We assume that rx_speed matters more.
998 if (dev->rx_speed != SPEED_UNSET)
999 cmd->base.speed = dev->rx_speed / 1000000;
1000 else if (dev->tx_speed != SPEED_UNSET)
1001 cmd->base.speed = dev->tx_speed / 1000000;
1003 cmd->base.speed = SPEED_UNKNOWN;
1007 EXPORT_SYMBOL_GPL(usbnet_get_link_ksettings_internal);
1009 int usbnet_set_link_ksettings_mii(struct net_device *net,
1010 const struct ethtool_link_ksettings *cmd)
1012 struct usbnet *dev = netdev_priv(net);
1015 if (!dev->mii.mdio_write)
1018 retval = mii_ethtool_set_link_ksettings(&dev->mii, cmd);
1020 /* link speed/duplex might have changed */
1021 if (dev->driver_info->link_reset)
1022 dev->driver_info->link_reset(dev);
1024 /* hard_mtu or rx_urb_size may change in link_reset() */
1025 usbnet_update_max_qlen(dev);
1029 EXPORT_SYMBOL_GPL(usbnet_set_link_ksettings_mii);
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 strscpy(info->driver, dev->driver_name, sizeof(info->driver));
1064 strscpy(info->fw_version, dev->driver_info->description,
1065 sizeof(info->fw_version));
1066 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
1068 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
1070 u32 usbnet_get_msglevel (struct net_device *net)
1072 struct usbnet *dev = netdev_priv(net);
1074 return dev->msg_enable;
1076 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1078 void usbnet_set_msglevel (struct net_device *net, u32 level)
1080 struct usbnet *dev = netdev_priv(net);
1082 dev->msg_enable = level;
1084 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1086 /* drivers may override default ethtool_ops in their bind() routine */
1087 static const struct ethtool_ops usbnet_ethtool_ops = {
1088 .get_link = usbnet_get_link,
1089 .nway_reset = usbnet_nway_reset,
1090 .get_drvinfo = usbnet_get_drvinfo,
1091 .get_msglevel = usbnet_get_msglevel,
1092 .set_msglevel = usbnet_set_msglevel,
1093 .get_ts_info = ethtool_op_get_ts_info,
1094 .get_link_ksettings = usbnet_get_link_ksettings_mii,
1095 .set_link_ksettings = usbnet_set_link_ksettings_mii,
1098 /*-------------------------------------------------------------------------*/
1100 static void __handle_link_change(struct usbnet *dev)
1102 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1105 if (!netif_carrier_ok(dev->net)) {
1106 /* kill URBs for reading packets to save bus bandwidth */
1107 unlink_urbs(dev, &dev->rxq);
1110 * tx_timeout will unlink URBs for sending packets and
1111 * tx queue is stopped by netcore after link becomes off
1114 /* submitting URBs for reading packets */
1115 tasklet_schedule(&dev->bh);
1118 /* hard_mtu or rx_urb_size may change during link change */
1119 usbnet_update_max_qlen(dev);
1121 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1124 void usbnet_set_rx_mode(struct net_device *net)
1126 struct usbnet *dev = netdev_priv(net);
1128 usbnet_defer_kevent(dev, EVENT_SET_RX_MODE);
1130 EXPORT_SYMBOL_GPL(usbnet_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 if (!usbnet_going_away(dev))
1190 tasklet_schedule(&dev->bh);
1194 /* tasklet could resubmit itself forever if memory is tight */
1195 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1196 struct urb *urb = NULL;
1199 if (netif_running (dev->net))
1200 urb = usb_alloc_urb (0, GFP_KERNEL);
1202 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1204 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1205 status = usb_autopm_get_interface(dev->intf);
1210 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1212 usb_autopm_put_interface(dev->intf);
1215 if (!usbnet_going_away(dev))
1216 tasklet_schedule(&dev->bh);
1220 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1221 const struct driver_info *info = dev->driver_info;
1224 clear_bit (EVENT_LINK_RESET, &dev->flags);
1225 status = usb_autopm_get_interface(dev->intf);
1228 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1229 usb_autopm_put_interface(dev->intf);
1231 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1233 dev->udev->bus->bus_name,
1237 usb_autopm_put_interface(dev->intf);
1240 /* handle link change from link resetting */
1241 __handle_link_change(dev);
1244 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1245 __handle_link_change(dev);
1247 if (test_bit (EVENT_SET_RX_MODE, &dev->flags))
1248 __handle_set_rx_mode(dev);
1252 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1255 /*-------------------------------------------------------------------------*/
1257 static void tx_complete (struct urb *urb)
1259 struct sk_buff *skb = (struct sk_buff *) urb->context;
1260 struct skb_data *entry = (struct skb_data *) skb->cb;
1261 struct usbnet *dev = entry->dev;
1263 if (urb->status == 0) {
1264 struct pcpu_sw_netstats *stats64 = this_cpu_ptr(dev->net->tstats);
1265 unsigned long flags;
1267 flags = u64_stats_update_begin_irqsave(&stats64->syncp);
1268 u64_stats_add(&stats64->tx_packets, entry->packets);
1269 u64_stats_add(&stats64->tx_bytes, entry->length);
1270 u64_stats_update_end_irqrestore(&stats64->syncp, flags);
1272 dev->net->stats.tx_errors++;
1274 switch (urb->status) {
1276 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1279 /* software-driven interface shutdown */
1280 case -ECONNRESET: // async unlink
1281 case -ESHUTDOWN: // hardware gone
1284 /* like rx, tx gets controller i/o faults during hub_wq
1285 * delays and so it uses the same throttling mechanism.
1290 usb_mark_last_busy(dev->udev);
1291 if (!timer_pending (&dev->delay)) {
1292 mod_timer (&dev->delay,
1293 jiffies + THROTTLE_JIFFIES);
1294 netif_dbg(dev, link, dev->net,
1295 "tx throttle %d\n", urb->status);
1297 netif_stop_queue (dev->net);
1300 netif_dbg(dev, tx_err, dev->net,
1301 "tx err %d\n", entry->urb->status);
1306 usb_autopm_put_interface_async(dev->intf);
1307 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1310 /*-------------------------------------------------------------------------*/
1312 void usbnet_tx_timeout (struct net_device *net, unsigned int txqueue)
1314 struct usbnet *dev = netdev_priv(net);
1316 unlink_urbs (dev, &dev->txq);
1317 tasklet_schedule (&dev->bh);
1318 /* this needs to be handled individually because the generic layer
1319 * doesn't know what is sufficient and could not restore private
1320 * information if a remedy of an unconditional reset were used.
1322 if (dev->driver_info->recover)
1323 (dev->driver_info->recover)(dev);
1325 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1327 /*-------------------------------------------------------------------------*/
1329 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1331 unsigned num_sgs, total_len = 0;
1334 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1338 /* reserve one for zero packet */
1339 urb->sg = kmalloc_array(num_sgs + 1, sizeof(struct scatterlist),
1344 urb->num_sgs = num_sgs;
1345 sg_init_table(urb->sg, urb->num_sgs + 1);
1347 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1348 total_len += skb_headlen(skb);
1350 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1351 skb_frag_t *f = &skb_shinfo(skb)->frags[i];
1353 total_len += skb_frag_size(f);
1354 sg_set_page(&urb->sg[i + s], skb_frag_page(f), skb_frag_size(f),
1357 urb->transfer_buffer_length = total_len;
1362 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1363 struct net_device *net)
1365 struct usbnet *dev = netdev_priv(net);
1366 unsigned int length;
1367 struct urb *urb = NULL;
1368 struct skb_data *entry;
1369 const struct driver_info *info = dev->driver_info;
1370 unsigned long flags;
1374 skb_tx_timestamp(skb);
1376 // some devices want funky USB-level framing, for
1377 // win32 driver (usually) and/or hardware quirks
1378 if (info->tx_fixup) {
1379 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1381 /* packet collected; minidriver waiting for more */
1382 if (info->flags & FLAG_MULTI_PACKET)
1384 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1389 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1390 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1394 entry = (struct skb_data *) skb->cb;
1398 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1399 skb->data, skb->len, tx_complete, skb);
1400 if (dev->can_dma_sg) {
1401 if (build_dma_sg(skb, urb) < 0)
1404 length = urb->transfer_buffer_length;
1406 /* don't assume the hardware handles USB_ZERO_PACKET
1407 * NOTE: strictly conforming cdc-ether devices should expect
1408 * the ZLP here, but ignore the one-byte packet.
1409 * NOTE2: CDC NCM specification is different from CDC ECM when
1410 * handling ZLP/short packets, so cdc_ncm driver will make short
1411 * packet itself if needed.
1413 if (length % dev->maxpacket == 0) {
1414 if (!(info->flags & FLAG_SEND_ZLP)) {
1415 if (!(info->flags & FLAG_MULTI_PACKET)) {
1417 if (skb_tailroom(skb) && !urb->num_sgs) {
1418 skb->data[skb->len] = 0;
1420 } else if (urb->num_sgs)
1421 sg_set_buf(&urb->sg[urb->num_sgs++],
1422 dev->padding_pkt, 1);
1425 urb->transfer_flags |= URB_ZERO_PACKET;
1427 urb->transfer_buffer_length = length;
1429 if (info->flags & FLAG_MULTI_PACKET) {
1430 /* Driver has set number of packets and a length delta.
1431 * Calculate the complete length and ensure that it's
1434 entry->length += length;
1435 if (WARN_ON_ONCE(entry->length <= 0))
1436 entry->length = length;
1438 usbnet_set_skb_tx_stats(skb, 1, length);
1441 spin_lock_irqsave(&dev->txq.lock, flags);
1442 retval = usb_autopm_get_interface_async(dev->intf);
1444 spin_unlock_irqrestore(&dev->txq.lock, flags);
1447 if (netif_queue_stopped(net)) {
1448 usb_autopm_put_interface_async(dev->intf);
1449 spin_unlock_irqrestore(&dev->txq.lock, flags);
1454 /* if this triggers the device is still a sleep */
1455 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1456 /* transmission will be done in resume */
1457 usb_anchor_urb(urb, &dev->deferred);
1458 /* no use to process more packets */
1459 netif_stop_queue(net);
1461 spin_unlock_irqrestore(&dev->txq.lock, flags);
1462 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1467 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1469 netif_stop_queue (net);
1470 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1471 usb_autopm_put_interface_async(dev->intf);
1474 usb_autopm_put_interface_async(dev->intf);
1475 netif_dbg(dev, tx_err, dev->net,
1476 "tx: submit urb err %d\n", retval);
1479 netif_trans_update(net);
1480 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1481 if (dev->txq.qlen >= TX_QLEN (dev))
1482 netif_stop_queue (net);
1484 spin_unlock_irqrestore (&dev->txq.lock, flags);
1487 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1489 dev->net->stats.tx_dropped++;
1492 dev_kfree_skb_any (skb);
1498 netif_dbg(dev, tx_queued, dev->net,
1499 "> tx, len %u, type 0x%x\n", length, skb->protocol);
1503 return NETDEV_TX_OK;
1505 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1507 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1513 /* don't refill the queue all at once */
1514 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1515 urb = usb_alloc_urb(0, flags);
1517 ret = rx_submit(dev, urb, flags);
1529 static inline void usb_free_skb(struct sk_buff *skb)
1531 struct skb_data *entry = (struct skb_data *)skb->cb;
1533 usb_free_urb(entry->urb);
1537 /*-------------------------------------------------------------------------*/
1539 // tasklet (work deferred from completions, in_irq) or timer
1541 static void usbnet_bh (struct timer_list *t)
1543 struct usbnet *dev = from_timer(dev, t, delay);
1544 struct sk_buff *skb;
1545 struct skb_data *entry;
1547 while ((skb = skb_dequeue (&dev->done))) {
1548 entry = (struct skb_data *) skb->cb;
1549 switch (entry->state) {
1551 if (rx_process(dev, skb))
1555 kfree(entry->urb->sg);
1561 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1565 /* restart RX again after disabling due to high error rate */
1566 clear_bit(EVENT_RX_KILL, &dev->flags);
1568 /* waiting for all pending urbs to complete?
1569 * only then can we forgo submitting anew
1571 if (waitqueue_active(&dev->wait)) {
1572 if (dev->txq.qlen + dev->rxq.qlen + dev->done.qlen == 0)
1573 wake_up_all(&dev->wait);
1575 // or are we maybe short a few urbs?
1576 } else if (netif_running (dev->net) &&
1577 netif_device_present (dev->net) &&
1578 netif_carrier_ok(dev->net) &&
1579 !usbnet_going_away(dev) &&
1580 !timer_pending(&dev->delay) &&
1581 !test_bit(EVENT_RX_PAUSED, &dev->flags) &&
1582 !test_bit(EVENT_RX_HALT, &dev->flags)) {
1583 int temp = dev->rxq.qlen;
1585 if (temp < RX_QLEN(dev)) {
1586 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1588 if (temp != dev->rxq.qlen)
1589 netif_dbg(dev, link, dev->net,
1590 "rxqlen %d --> %d\n",
1591 temp, dev->rxq.qlen);
1592 if (dev->rxq.qlen < RX_QLEN(dev))
1593 tasklet_schedule (&dev->bh);
1595 if (dev->txq.qlen < TX_QLEN (dev))
1596 netif_wake_queue (dev->net);
1600 static void usbnet_bh_tasklet(struct tasklet_struct *t)
1602 struct usbnet *dev = from_tasklet(dev, t, bh);
1604 usbnet_bh(&dev->delay);
1608 /*-------------------------------------------------------------------------
1610 * USB Device Driver support
1612 *-------------------------------------------------------------------------*/
1614 // precondition: never called in_interrupt
1616 void usbnet_disconnect (struct usb_interface *intf)
1619 struct usb_device *xdev;
1620 struct net_device *net;
1623 dev = usb_get_intfdata(intf);
1624 usb_set_intfdata(intf, NULL);
1627 usbnet_mark_going_away(dev);
1629 xdev = interface_to_usbdev (intf);
1631 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1632 intf->dev.driver->name,
1633 xdev->bus->bus_name, xdev->devpath,
1634 dev->driver_info->description);
1637 unregister_netdev (net);
1639 while ((urb = usb_get_from_anchor(&dev->deferred))) {
1640 dev_kfree_skb(urb->context);
1645 if (dev->driver_info->unbind)
1646 dev->driver_info->unbind(dev, intf);
1648 usb_kill_urb(dev->interrupt);
1649 usb_free_urb(dev->interrupt);
1650 kfree(dev->padding_pkt);
1654 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1656 static const struct net_device_ops usbnet_netdev_ops = {
1657 .ndo_open = usbnet_open,
1658 .ndo_stop = usbnet_stop,
1659 .ndo_start_xmit = usbnet_start_xmit,
1660 .ndo_tx_timeout = usbnet_tx_timeout,
1661 .ndo_set_rx_mode = usbnet_set_rx_mode,
1662 .ndo_change_mtu = usbnet_change_mtu,
1663 .ndo_set_mac_address = eth_mac_addr,
1664 .ndo_validate_addr = eth_validate_addr,
1667 /*-------------------------------------------------------------------------*/
1669 // precondition: never called in_interrupt
1671 static const struct device_type wlan_type = {
1675 static const struct device_type wwan_type = {
1680 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1683 struct net_device *net;
1684 struct usb_host_interface *interface;
1685 const struct driver_info *info;
1686 struct usb_device *xdev;
1689 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1691 /* usbnet already took usb runtime pm, so have to enable the feature
1692 * for usb interface, otherwise usb_autopm_get_interface may return
1693 * failure if RUNTIME_PM is enabled.
1695 if (!driver->supports_autosuspend) {
1696 driver->supports_autosuspend = 1;
1697 pm_runtime_enable(&udev->dev);
1700 name = udev->dev.driver->name;
1701 info = (const struct driver_info *) prod->driver_info;
1703 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1706 xdev = interface_to_usbdev (udev);
1707 interface = udev->cur_altsetting;
1711 // set up our own records
1712 net = alloc_etherdev(sizeof(*dev));
1716 /* netdev_printk() needs this so do it as early as possible */
1717 SET_NETDEV_DEV(net, &udev->dev);
1719 dev = netdev_priv(net);
1722 dev->driver_info = info;
1723 dev->driver_name = name;
1724 dev->rx_speed = SPEED_UNSET;
1725 dev->tx_speed = SPEED_UNSET;
1727 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1728 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1729 init_waitqueue_head(&dev->wait);
1730 skb_queue_head_init (&dev->rxq);
1731 skb_queue_head_init (&dev->txq);
1732 skb_queue_head_init (&dev->done);
1733 skb_queue_head_init(&dev->rxq_pause);
1734 tasklet_setup(&dev->bh, usbnet_bh_tasklet);
1735 INIT_WORK (&dev->kevent, usbnet_deferred_kevent);
1736 init_usb_anchor(&dev->deferred);
1737 timer_setup(&dev->delay, usbnet_bh, 0);
1738 mutex_init (&dev->phy_mutex);
1739 mutex_init(&dev->interrupt_mutex);
1740 dev->interrupt_count = 0;
1743 strscpy(net->name, "usb%d", sizeof(net->name));
1745 /* rx and tx sides can use different message sizes;
1746 * bind() should set rx_urb_size in that case.
1748 dev->hard_mtu = net->mtu + net->hard_header_len;
1750 net->max_mtu = ETH_MAX_MTU;
1751 net->pcpu_stat_type = NETDEV_PCPU_STAT_TSTATS;
1753 net->netdev_ops = &usbnet_netdev_ops;
1754 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1755 net->ethtool_ops = &usbnet_ethtool_ops;
1756 net->pcpu_stat_type = NETDEV_PCPU_STAT_TSTATS;
1758 // allow device-specific bind/init procedures
1759 // NOTE net->name still not usable ...
1761 status = info->bind (dev, udev);
1765 // heuristic: "usb%d" for links we know are two-host,
1766 // else "eth%d" when there's reasonable doubt. userspace
1767 // can rename the link if it knows better.
1768 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1769 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1770 (net->dev_addr [0] & 0x02) == 0))
1771 strscpy(net->name, "eth%d", sizeof(net->name));
1772 /* WLAN devices should always be named "wlan%d" */
1773 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1774 strscpy(net->name, "wlan%d", sizeof(net->name));
1775 /* WWAN devices should always be named "wwan%d" */
1776 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1777 strscpy(net->name, "wwan%d", sizeof(net->name));
1779 /* devices that cannot do ARP */
1780 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1781 net->flags |= IFF_NOARP;
1783 /* maybe the remote can't receive an Ethernet MTU */
1784 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1785 net->mtu = dev->hard_mtu - net->hard_header_len;
1786 } else if (!info->in || !info->out)
1787 status = usbnet_get_endpoints (dev, udev);
1790 info->in + USB_DIR_IN, info->out + USB_DIR_OUT, 0
1793 dev->in = usb_rcvbulkpipe (xdev, info->in);
1794 dev->out = usb_sndbulkpipe (xdev, info->out);
1795 if (!(info->flags & FLAG_NO_SETINT))
1796 status = usb_set_interface (xdev,
1797 interface->desc.bInterfaceNumber,
1798 interface->desc.bAlternateSetting);
1802 if (status == 0 && !usb_check_bulk_endpoints(udev, ep_addrs))
1805 if (status >= 0 && dev->status)
1806 status = init_status (dev, udev);
1810 if (!dev->rx_urb_size)
1811 dev->rx_urb_size = dev->hard_mtu;
1812 dev->maxpacket = usb_maxpacket(dev->udev, dev->out);
1813 if (dev->maxpacket == 0) {
1814 /* that is a broken device */
1819 /* this flags the device for user space */
1820 if (!is_valid_ether_addr(net->dev_addr))
1821 eth_hw_addr_random(net);
1823 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1824 SET_NETDEV_DEVTYPE(net, &wlan_type);
1825 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1826 SET_NETDEV_DEVTYPE(net, &wwan_type);
1828 /* initialize max rx_qlen and tx_qlen */
1829 usbnet_update_max_qlen(dev);
1831 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1832 !(info->flags & FLAG_MULTI_PACKET)) {
1833 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1834 if (!dev->padding_pkt) {
1840 status = register_netdev (net);
1843 netif_info(dev, probe, dev->net,
1844 "register '%s' at usb-%s-%s, %s, %pM\n",
1845 udev->dev.driver->name,
1846 xdev->bus->bus_name, xdev->devpath,
1847 dev->driver_info->description,
1850 // ok, it's ready to go.
1851 usb_set_intfdata (udev, dev);
1853 netif_device_attach (net);
1855 if (dev->driver_info->flags & FLAG_LINK_INTR)
1856 usbnet_link_change(dev, 0, 0);
1861 kfree(dev->padding_pkt);
1863 usb_free_urb(dev->interrupt);
1866 info->unbind (dev, udev);
1868 /* subdrivers must undo all they did in bind() if they
1869 * fail it, but we may fail later and a deferred kevent
1870 * may trigger an error resubmitting itself and, worse,
1871 * schedule a timer. So we kill it all just in case.
1873 cancel_work_sync(&dev->kevent);
1874 del_timer_sync(&dev->delay);
1879 EXPORT_SYMBOL_GPL(usbnet_probe);
1881 /*-------------------------------------------------------------------------*/
1884 * suspend the whole driver as soon as the first interface is suspended
1885 * resume only when the last interface is resumed
1888 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1890 struct usbnet *dev = usb_get_intfdata(intf);
1892 if (!dev->suspend_count++) {
1893 spin_lock_irq(&dev->txq.lock);
1894 /* don't autosuspend while transmitting */
1895 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1896 dev->suspend_count--;
1897 spin_unlock_irq(&dev->txq.lock);
1900 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1901 spin_unlock_irq(&dev->txq.lock);
1904 * accelerate emptying of the rx and queues, to avoid
1905 * having everything error out.
1907 netif_device_detach (dev->net);
1908 usbnet_terminate_urbs(dev);
1909 __usbnet_status_stop_force(dev);
1912 * reattach so runtime management can use and
1915 netif_device_attach (dev->net);
1919 EXPORT_SYMBOL_GPL(usbnet_suspend);
1921 int usbnet_resume (struct usb_interface *intf)
1923 struct usbnet *dev = usb_get_intfdata(intf);
1924 struct sk_buff *skb;
1928 if (!--dev->suspend_count) {
1929 /* resume interrupt URB if it was previously submitted */
1930 __usbnet_status_start_force(dev, GFP_NOIO);
1932 spin_lock_irq(&dev->txq.lock);
1933 while ((res = usb_get_from_anchor(&dev->deferred))) {
1935 skb = (struct sk_buff *)res->context;
1936 retval = usb_submit_urb(res, GFP_ATOMIC);
1938 dev_kfree_skb_any(skb);
1941 usb_autopm_put_interface_async(dev->intf);
1943 netif_trans_update(dev->net);
1944 __skb_queue_tail(&dev->txq, skb);
1949 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1950 spin_unlock_irq(&dev->txq.lock);
1952 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1953 /* handle remote wakeup ASAP
1954 * we cannot race against stop
1956 if (netif_device_present(dev->net) &&
1957 !timer_pending(&dev->delay) &&
1958 !test_bit(EVENT_RX_HALT, &dev->flags))
1959 rx_alloc_submit(dev, GFP_NOIO);
1961 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1962 netif_tx_wake_all_queues(dev->net);
1963 tasklet_schedule (&dev->bh);
1967 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1968 usb_autopm_get_interface_no_resume(intf);
1972 EXPORT_SYMBOL_GPL(usbnet_resume);
1975 * Either a subdriver implements manage_power, then it is assumed to always
1976 * be ready to be suspended or it reports the readiness to be suspended
1979 void usbnet_device_suggests_idle(struct usbnet *dev)
1981 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1982 dev->intf->needs_remote_wakeup = 1;
1983 usb_autopm_put_interface_async(dev->intf);
1986 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1989 * For devices that can do without special commands
1991 int usbnet_manage_power(struct usbnet *dev, int on)
1993 dev->intf->needs_remote_wakeup = on;
1996 EXPORT_SYMBOL(usbnet_manage_power);
1998 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
2000 /* update link after link is reseted */
2001 if (link && !need_reset)
2002 netif_carrier_on(dev->net);
2004 netif_carrier_off(dev->net);
2006 if (need_reset && link)
2007 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
2009 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
2011 EXPORT_SYMBOL(usbnet_link_change);
2013 /*-------------------------------------------------------------------------*/
2014 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2015 u16 value, u16 index, void *data, u16 size)
2020 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
2021 " value=0x%04x index=0x%04x size=%d\n",
2022 cmd, reqtype, value, index, size);
2025 buf = kmalloc(size, GFP_NOIO);
2030 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
2031 cmd, reqtype, value, index, buf, size,
2032 USB_CTRL_GET_TIMEOUT);
2033 if (err > 0 && err <= size) {
2035 memcpy(data, buf, err);
2037 netdev_dbg(dev->net,
2038 "Huh? Data requested but thrown away.\n");
2045 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2046 u16 value, u16 index, const void *data,
2052 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2053 " value=0x%04x index=0x%04x size=%d\n",
2054 cmd, reqtype, value, index, size);
2057 buf = kmemdup(data, size, GFP_NOIO);
2068 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
2069 cmd, reqtype, value, index, buf, size,
2070 USB_CTRL_SET_TIMEOUT);
2078 * The function can't be called inside suspend/resume callback,
2079 * otherwise deadlock will be caused.
2081 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2082 u16 value, u16 index, void *data, u16 size)
2086 if (usb_autopm_get_interface(dev->intf) < 0)
2088 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2090 usb_autopm_put_interface(dev->intf);
2093 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
2096 * The function can't be called inside suspend/resume callback,
2097 * otherwise deadlock will be caused.
2099 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2100 u16 value, u16 index, const void *data, u16 size)
2104 if (usb_autopm_get_interface(dev->intf) < 0)
2106 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2108 usb_autopm_put_interface(dev->intf);
2111 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
2114 * The function can be called inside suspend/resume callback safely
2115 * and should only be called by suspend/resume callback generally.
2117 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2118 u16 value, u16 index, void *data, u16 size)
2120 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2123 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
2126 * The function can be called inside suspend/resume callback safely
2127 * and should only be called by suspend/resume callback generally.
2129 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2130 u16 value, u16 index, const void *data,
2133 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2136 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
2138 static void usbnet_async_cmd_cb(struct urb *urb)
2140 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
2141 int status = urb->status;
2144 dev_dbg(&urb->dev->dev, "%s failed with %d",
2152 * The caller must make sure that device can't be put into suspend
2153 * state until the control URB completes.
2155 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
2156 u16 value, u16 index, const void *data, u16 size)
2158 struct usb_ctrlrequest *req;
2163 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2164 " value=0x%04x index=0x%04x size=%d\n",
2165 cmd, reqtype, value, index, size);
2167 urb = usb_alloc_urb(0, GFP_ATOMIC);
2172 buf = kmemdup(data, size, GFP_ATOMIC);
2174 netdev_err(dev->net, "Error allocating buffer"
2175 " in %s!\n", __func__);
2180 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2184 req->bRequestType = reqtype;
2185 req->bRequest = cmd;
2186 req->wValue = cpu_to_le16(value);
2187 req->wIndex = cpu_to_le16(index);
2188 req->wLength = cpu_to_le16(size);
2190 usb_fill_control_urb(urb, dev->udev,
2191 usb_sndctrlpipe(dev->udev, 0),
2192 (void *)req, buf, size,
2193 usbnet_async_cmd_cb, req);
2194 urb->transfer_flags |= URB_FREE_BUFFER;
2196 err = usb_submit_urb(urb, GFP_ATOMIC);
2198 netdev_err(dev->net, "Error submitting the control"
2199 " message: status=%d\n", err);
2209 * avoid a double free
2210 * needed because the flag can be set only
2211 * after filling the URB
2213 urb->transfer_flags = 0;
2220 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2221 /*-------------------------------------------------------------------------*/
2223 static int __init usbnet_init(void)
2225 /* Compiler should optimize this out. */
2227 sizeof_field(struct sk_buff, cb) < sizeof(struct skb_data));
2231 module_init(usbnet_init);
2233 static void __exit usbnet_exit(void)
2236 module_exit(usbnet_exit);
2238 MODULE_AUTHOR("David Brownell");
2239 MODULE_DESCRIPTION("USB network driver framework");
2240 MODULE_LICENSE("GPL");