2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 * This is a generic "USB networking" framework that works with several
22 * kinds of full and high speed networking devices: host-to-host cables,
23 * smart usb peripherals, and actual Ethernet adapters.
25 * These devices usually differ in terms of control protocols (if they
26 * even have one!) and sometimes they define new framing to wrap or batch
27 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
28 * so interface (un)binding, endpoint I/O queues, fault handling, and other
29 * issues can usefully be addressed by this framework.
32 // #define DEBUG // error path messages, extra info
33 // #define VERBOSE // more; success messages
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/netdevice.h>
38 #include <linux/etherdevice.h>
39 #include <linux/ctype.h>
40 #include <linux/ethtool.h>
41 #include <linux/workqueue.h>
42 #include <linux/mii.h>
43 #include <linux/usb.h>
44 #include <linux/usb/usbnet.h>
45 #include <linux/usb/cdc.h>
46 #include <linux/slab.h>
47 #include <linux/kernel.h>
48 #include <linux/pm_runtime.h>
50 #define DRIVER_VERSION "22-Aug-2005"
53 /*-------------------------------------------------------------------------*/
56 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
57 * Several dozen bytes of IPv4 data can fit in two such transactions.
58 * One maximum size Ethernet packet takes twenty four of them.
59 * For high speed, each frame comfortably fits almost 36 max size
60 * Ethernet packets (so queues should be bigger).
62 * The goal is to let the USB host controller be busy for 5msec or
63 * more before an irq is required, under load. Jumbograms change
66 #define MAX_QUEUE_MEMORY (60 * 1518)
67 #define RX_QLEN(dev) ((dev)->rx_qlen)
68 #define TX_QLEN(dev) ((dev)->tx_qlen)
70 // reawaken network queue this soon after stopping; else watchdog barks
71 #define TX_TIMEOUT_JIFFIES (5*HZ)
73 /* throttle rx/tx briefly after some faults, so hub_wq might disconnect()
74 * us (it polls at HZ/4 usually) before we report too many false errors.
76 #define THROTTLE_JIFFIES (HZ/8)
79 #define UNLINK_TIMEOUT_MS 3
81 /*-------------------------------------------------------------------------*/
83 // randomly generated ethernet address
84 static u8 node_id [ETH_ALEN];
86 static const char driver_name [] = "usbnet";
88 /* use ethtool to change the level for any given device */
89 static int msg_level = -1;
90 module_param (msg_level, int, 0);
91 MODULE_PARM_DESC (msg_level, "Override default message level");
93 /*-------------------------------------------------------------------------*/
95 /* handles CDC Ethernet and many other network "bulk data" interfaces */
96 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
99 struct usb_host_interface *alt = NULL;
100 struct usb_host_endpoint *in = NULL, *out = NULL;
101 struct usb_host_endpoint *status = NULL;
103 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
106 in = out = status = NULL;
107 alt = intf->altsetting + tmp;
109 /* take the first altsetting with in-bulk + out-bulk;
110 * remember any status endpoint, just in case;
111 * ignore other endpoints and altsettings.
113 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
114 struct usb_host_endpoint *e;
117 e = alt->endpoint + ep;
119 /* ignore endpoints which cannot transfer data */
120 if (!usb_endpoint_maxp(&e->desc))
123 switch (e->desc.bmAttributes) {
124 case USB_ENDPOINT_XFER_INT:
125 if (!usb_endpoint_dir_in(&e->desc))
129 case USB_ENDPOINT_XFER_BULK:
134 if (usb_endpoint_dir_in(&e->desc)) {
137 else if (intr && !status)
147 if (!alt || !in || !out)
150 if (alt->desc.bAlternateSetting != 0 ||
151 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
152 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
153 alt->desc.bAlternateSetting);
158 dev->in = usb_rcvbulkpipe (dev->udev,
159 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
160 dev->out = usb_sndbulkpipe (dev->udev,
161 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
162 dev->status = status;
165 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
167 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
170 unsigned char buf [13];
172 ret = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
174 tmp = hex2bin(dev->net->dev_addr, buf, 6);
176 dev_dbg(&dev->udev->dev,
177 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
184 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
186 static void intr_complete (struct urb *urb)
188 struct usbnet *dev = urb->context;
189 int status = urb->status;
194 dev->driver_info->status(dev, urb);
197 /* software-driven interface shutdown */
198 case -ENOENT: /* urb killed */
199 case -ESHUTDOWN: /* hardware gone */
200 netif_dbg(dev, ifdown, dev->net,
201 "intr shutdown, code %d\n", status);
204 /* NOTE: not throttling like RX/TX, since this endpoint
205 * already polls infrequently
208 netdev_dbg(dev->net, "intr status %d\n", status);
212 status = usb_submit_urb (urb, GFP_ATOMIC);
214 netif_err(dev, timer, dev->net,
215 "intr resubmit --> %d\n", status);
218 static int init_status (struct usbnet *dev, struct usb_interface *intf)
225 if (!dev->driver_info->status)
228 pipe = usb_rcvintpipe (dev->udev,
229 dev->status->desc.bEndpointAddress
230 & USB_ENDPOINT_NUMBER_MASK);
231 maxp = usb_maxpacket (dev->udev, pipe, 0);
233 /* avoid 1 msec chatter: min 8 msec poll rate */
234 period = max ((int) dev->status->desc.bInterval,
235 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
237 buf = kmalloc (maxp, GFP_KERNEL);
239 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
240 if (!dev->interrupt) {
244 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
245 buf, maxp, intr_complete, dev, period);
246 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
248 "status ep%din, %d bytes period %d\n",
249 usb_pipeendpoint(pipe), maxp, period);
255 /* Submit the interrupt URB if not previously submitted, increasing refcount */
256 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
260 WARN_ON_ONCE(dev->interrupt == NULL);
261 if (dev->interrupt) {
262 mutex_lock(&dev->interrupt_mutex);
264 if (++dev->interrupt_count == 1)
265 ret = usb_submit_urb(dev->interrupt, mem_flags);
267 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
268 dev->interrupt_count);
269 mutex_unlock(&dev->interrupt_mutex);
273 EXPORT_SYMBOL_GPL(usbnet_status_start);
275 /* For resume; submit interrupt URB if previously submitted */
276 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
280 mutex_lock(&dev->interrupt_mutex);
281 if (dev->interrupt_count) {
282 ret = usb_submit_urb(dev->interrupt, mem_flags);
283 dev_dbg(&dev->udev->dev,
284 "submitted interrupt URB for resume\n");
286 mutex_unlock(&dev->interrupt_mutex);
290 /* Kill the interrupt URB if all submitters want it killed */
291 void usbnet_status_stop(struct usbnet *dev)
293 if (dev->interrupt) {
294 mutex_lock(&dev->interrupt_mutex);
295 WARN_ON(dev->interrupt_count == 0);
297 if (dev->interrupt_count && --dev->interrupt_count == 0)
298 usb_kill_urb(dev->interrupt);
300 dev_dbg(&dev->udev->dev,
301 "decremented interrupt URB count to %d\n",
302 dev->interrupt_count);
303 mutex_unlock(&dev->interrupt_mutex);
306 EXPORT_SYMBOL_GPL(usbnet_status_stop);
308 /* For suspend; always kill interrupt URB */
309 static void __usbnet_status_stop_force(struct usbnet *dev)
311 if (dev->interrupt) {
312 mutex_lock(&dev->interrupt_mutex);
313 usb_kill_urb(dev->interrupt);
314 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
315 mutex_unlock(&dev->interrupt_mutex);
319 /* Passes this packet up the stack, updating its accounting.
320 * Some link protocols batch packets, so their rx_fixup paths
321 * can return clones as well as just modify the original skb.
323 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
327 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
328 skb_queue_tail(&dev->rxq_pause, skb);
332 skb->protocol = eth_type_trans (skb, dev->net);
333 dev->net->stats.rx_packets++;
334 dev->net->stats.rx_bytes += skb->len;
336 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
337 skb->len + sizeof (struct ethhdr), skb->protocol);
338 memset (skb->cb, 0, sizeof (struct skb_data));
340 if (skb_defer_rx_timestamp(skb))
343 status = netif_rx (skb);
344 if (status != NET_RX_SUCCESS)
345 netif_dbg(dev, rx_err, dev->net,
346 "netif_rx status %d\n", status);
348 EXPORT_SYMBOL_GPL(usbnet_skb_return);
350 /* must be called if hard_mtu or rx_urb_size changed */
351 void usbnet_update_max_qlen(struct usbnet *dev)
353 enum usb_device_speed speed = dev->udev->speed;
355 if (!dev->rx_urb_size || !dev->hard_mtu)
359 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
360 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
362 case USB_SPEED_SUPER:
364 * Not take default 5ms qlen for super speed HC to
365 * save memory, and iperf tests show 2.5ms qlen can
368 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
369 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
373 dev->rx_qlen = dev->tx_qlen = 4;
376 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
379 /*-------------------------------------------------------------------------
381 * Network Device Driver (peer link to "Host Device", from USB host)
383 *-------------------------------------------------------------------------*/
385 int usbnet_change_mtu (struct net_device *net, int new_mtu)
387 struct usbnet *dev = netdev_priv(net);
388 int ll_mtu = new_mtu + net->hard_header_len;
389 int old_hard_mtu = dev->hard_mtu;
390 int old_rx_urb_size = dev->rx_urb_size;
394 // no second zero-length packet read wanted after mtu-sized packets
395 if ((ll_mtu % dev->maxpacket) == 0)
399 dev->hard_mtu = net->mtu + net->hard_header_len;
400 if (dev->rx_urb_size == old_hard_mtu) {
401 dev->rx_urb_size = dev->hard_mtu;
402 if (dev->rx_urb_size > old_rx_urb_size)
403 usbnet_unlink_rx_urbs(dev);
406 /* max qlen depend on hard_mtu and rx_urb_size */
407 usbnet_update_max_qlen(dev);
411 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
413 /* The caller must hold list->lock */
414 static void __usbnet_queue_skb(struct sk_buff_head *list,
415 struct sk_buff *newsk, enum skb_state state)
417 struct skb_data *entry = (struct skb_data *) newsk->cb;
419 __skb_queue_tail(list, newsk);
420 entry->state = state;
423 /*-------------------------------------------------------------------------*/
425 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
426 * completion callbacks. 2.5 should have fixed those bugs...
429 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
430 struct sk_buff_head *list, enum skb_state state)
433 enum skb_state old_state;
434 struct skb_data *entry = (struct skb_data *) skb->cb;
436 spin_lock_irqsave(&list->lock, flags);
437 old_state = entry->state;
438 entry->state = state;
439 __skb_unlink(skb, list);
441 /* defer_bh() is never called with list == &dev->done.
442 * spin_lock_nested() tells lockdep that it is OK to take
443 * dev->done.lock here with list->lock held.
445 spin_lock_nested(&dev->done.lock, SINGLE_DEPTH_NESTING);
447 __skb_queue_tail(&dev->done, skb);
448 if (dev->done.qlen == 1)
449 tasklet_schedule(&dev->bh);
450 spin_unlock(&dev->done.lock);
451 spin_unlock_irqrestore(&list->lock, flags);
455 /* some work can't be done in tasklets, so we use keventd
457 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
458 * but tasklet_schedule() doesn't. hope the failure is rare.
460 void usbnet_defer_kevent (struct usbnet *dev, int work)
462 set_bit (work, &dev->flags);
463 if (!schedule_work (&dev->kevent)) {
465 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
467 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
470 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
472 /*-------------------------------------------------------------------------*/
474 static void rx_complete (struct urb *urb);
476 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
479 struct skb_data *entry;
481 unsigned long lockflags;
482 size_t size = dev->rx_urb_size;
484 /* prevent rx skb allocation when error ratio is high */
485 if (test_bit(EVENT_RX_KILL, &dev->flags)) {
490 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
492 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
493 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
498 entry = (struct skb_data *) skb->cb;
503 usb_fill_bulk_urb (urb, dev->udev, dev->in,
504 skb->data, size, rx_complete, skb);
506 spin_lock_irqsave (&dev->rxq.lock, lockflags);
508 if (netif_running (dev->net) &&
509 netif_device_present (dev->net) &&
510 test_bit(EVENT_DEV_OPEN, &dev->flags) &&
511 !test_bit (EVENT_RX_HALT, &dev->flags) &&
512 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
513 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
515 usbnet_defer_kevent (dev, EVENT_RX_HALT);
518 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
521 netif_dbg(dev, ifdown, dev->net, "device gone\n");
522 netif_device_detach (dev->net);
528 netif_dbg(dev, rx_err, dev->net,
529 "rx submit, %d\n", retval);
530 tasklet_schedule (&dev->bh);
533 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
536 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
539 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
541 dev_kfree_skb_any (skb);
548 /*-------------------------------------------------------------------------*/
550 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
552 if (dev->driver_info->rx_fixup &&
553 !dev->driver_info->rx_fixup (dev, skb)) {
554 /* With RX_ASSEMBLE, rx_fixup() must update counters */
555 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
556 dev->net->stats.rx_errors++;
559 // else network stack removes extra byte if we forced a short packet
561 /* all data was already cloned from skb inside the driver */
562 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
565 if (skb->len < ETH_HLEN) {
566 dev->net->stats.rx_errors++;
567 dev->net->stats.rx_length_errors++;
568 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
570 usbnet_skb_return(dev, skb);
575 skb_queue_tail(&dev->done, skb);
578 /*-------------------------------------------------------------------------*/
580 static void rx_complete (struct urb *urb)
582 struct sk_buff *skb = (struct sk_buff *) urb->context;
583 struct skb_data *entry = (struct skb_data *) skb->cb;
584 struct usbnet *dev = entry->dev;
585 int urb_status = urb->status;
586 enum skb_state state;
588 skb_put (skb, urb->actual_length);
592 switch (urb_status) {
597 /* stalls need manual reset. this is rare ... except that
598 * when going through USB 2.0 TTs, unplug appears this way.
599 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
600 * storm, recovering as needed.
603 dev->net->stats.rx_errors++;
604 usbnet_defer_kevent (dev, EVENT_RX_HALT);
607 /* software-driven interface shutdown */
608 case -ECONNRESET: /* async unlink */
609 case -ESHUTDOWN: /* hardware gone */
610 netif_dbg(dev, ifdown, dev->net,
611 "rx shutdown, code %d\n", urb_status);
614 /* we get controller i/o faults during hub_wq disconnect() delays.
615 * throttle down resubmits, to avoid log floods; just temporarily,
616 * so we still recover when the fault isn't a hub_wq delay.
621 dev->net->stats.rx_errors++;
622 if (!timer_pending (&dev->delay)) {
623 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
624 netif_dbg(dev, link, dev->net,
625 "rx throttle %d\n", urb_status);
633 /* data overrun ... flush fifo? */
635 dev->net->stats.rx_over_errors++;
640 dev->net->stats.rx_errors++;
641 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
645 /* stop rx if packet error rate is high */
646 if (++dev->pkt_cnt > 30) {
650 if (state == rx_cleanup)
652 if (dev->pkt_err > 20)
653 set_bit(EVENT_RX_KILL, &dev->flags);
656 state = defer_bh(dev, skb, &dev->rxq, state);
659 if (netif_running (dev->net) &&
660 !test_bit (EVENT_RX_HALT, &dev->flags) &&
661 state != unlink_start) {
662 rx_submit (dev, urb, GFP_ATOMIC);
663 usb_mark_last_busy(dev->udev);
668 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
671 /*-------------------------------------------------------------------------*/
672 void usbnet_pause_rx(struct usbnet *dev)
674 set_bit(EVENT_RX_PAUSED, &dev->flags);
676 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
678 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
680 void usbnet_resume_rx(struct usbnet *dev)
685 clear_bit(EVENT_RX_PAUSED, &dev->flags);
687 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
688 usbnet_skb_return(dev, skb);
692 tasklet_schedule(&dev->bh);
694 netif_dbg(dev, rx_status, dev->net,
695 "paused rx queue disabled, %d skbs requeued\n", num);
697 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
699 void usbnet_purge_paused_rxq(struct usbnet *dev)
701 skb_queue_purge(&dev->rxq_pause);
703 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
705 /*-------------------------------------------------------------------------*/
707 // unlink pending rx/tx; completion handlers do all other cleanup
709 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
715 spin_lock_irqsave (&q->lock, flags);
716 while (!skb_queue_empty(q)) {
717 struct skb_data *entry;
721 skb_queue_walk(q, skb) {
722 entry = (struct skb_data *) skb->cb;
723 if (entry->state != unlink_start)
728 entry->state = unlink_start;
732 * Get reference count of the URB to avoid it to be
733 * freed during usb_unlink_urb, which may trigger
734 * use-after-free problem inside usb_unlink_urb since
735 * usb_unlink_urb is always racing with .complete
736 * handler(include defer_bh).
739 spin_unlock_irqrestore(&q->lock, flags);
740 // during some PM-driven resume scenarios,
741 // these (async) unlinks complete immediately
742 retval = usb_unlink_urb (urb);
743 if (retval != -EINPROGRESS && retval != 0)
744 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
748 spin_lock_irqsave(&q->lock, flags);
750 spin_unlock_irqrestore (&q->lock, flags);
754 // Flush all pending rx urbs
755 // minidrivers may need to do this when the MTU changes
757 void usbnet_unlink_rx_urbs(struct usbnet *dev)
759 if (netif_running(dev->net)) {
760 (void) unlink_urbs (dev, &dev->rxq);
761 tasklet_schedule(&dev->bh);
764 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
766 /*-------------------------------------------------------------------------*/
768 static void wait_skb_queue_empty(struct sk_buff_head *q)
772 spin_lock_irqsave(&q->lock, flags);
773 while (!skb_queue_empty(q)) {
774 spin_unlock_irqrestore(&q->lock, flags);
775 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
776 set_current_state(TASK_UNINTERRUPTIBLE);
777 spin_lock_irqsave(&q->lock, flags);
779 spin_unlock_irqrestore(&q->lock, flags);
782 // precondition: never called in_interrupt
783 static void usbnet_terminate_urbs(struct usbnet *dev)
785 DECLARE_WAITQUEUE(wait, current);
788 /* ensure there are no more active urbs */
789 add_wait_queue(&dev->wait, &wait);
790 set_current_state(TASK_UNINTERRUPTIBLE);
791 temp = unlink_urbs(dev, &dev->txq) +
792 unlink_urbs(dev, &dev->rxq);
794 /* maybe wait for deletions to finish. */
795 wait_skb_queue_empty(&dev->rxq);
796 wait_skb_queue_empty(&dev->txq);
797 wait_skb_queue_empty(&dev->done);
798 netif_dbg(dev, ifdown, dev->net,
799 "waited for %d urb completions\n", temp);
800 set_current_state(TASK_RUNNING);
801 remove_wait_queue(&dev->wait, &wait);
804 int usbnet_stop (struct net_device *net)
806 struct usbnet *dev = netdev_priv(net);
807 struct driver_info *info = dev->driver_info;
810 clear_bit(EVENT_DEV_OPEN, &dev->flags);
811 netif_stop_queue (net);
813 netif_info(dev, ifdown, dev->net,
814 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
815 net->stats.rx_packets, net->stats.tx_packets,
816 net->stats.rx_errors, net->stats.tx_errors);
818 /* to not race resume */
819 pm = usb_autopm_get_interface(dev->intf);
820 /* allow minidriver to stop correctly (wireless devices to turn off
823 retval = info->stop(dev);
825 netif_info(dev, ifdown, dev->net,
826 "stop fail (%d) usbnet usb-%s-%s, %s\n",
828 dev->udev->bus->bus_name, dev->udev->devpath,
832 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
833 usbnet_terminate_urbs(dev);
835 usbnet_status_stop(dev);
837 usbnet_purge_paused_rxq(dev);
839 mpn = !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
841 /* deferred work (task, timer, softirq) must also stop.
842 * can't flush_scheduled_work() until we drop rtnl (later),
843 * else workers could deadlock; so make workers a NOP.
846 del_timer_sync (&dev->delay);
847 tasklet_kill (&dev->bh);
849 usb_autopm_put_interface(dev->intf);
851 if (info->manage_power && mpn)
852 info->manage_power(dev, 0);
854 usb_autopm_put_interface(dev->intf);
858 EXPORT_SYMBOL_GPL(usbnet_stop);
860 /*-------------------------------------------------------------------------*/
862 // posts reads, and enables write queuing
864 // precondition: never called in_interrupt
866 int usbnet_open (struct net_device *net)
868 struct usbnet *dev = netdev_priv(net);
870 struct driver_info *info = dev->driver_info;
872 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
873 netif_info(dev, ifup, dev->net,
874 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
876 dev->udev->bus->bus_name,
882 // put into "known safe" state
883 if (info->reset && (retval = info->reset (dev)) < 0) {
884 netif_info(dev, ifup, dev->net,
885 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
887 dev->udev->bus->bus_name,
893 /* hard_mtu or rx_urb_size may change in reset() */
894 usbnet_update_max_qlen(dev);
896 // insist peer be connected
897 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
898 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
902 /* start any status interrupt transfer */
903 if (dev->interrupt) {
904 retval = usbnet_status_start(dev, GFP_KERNEL);
906 netif_err(dev, ifup, dev->net,
907 "intr submit %d\n", retval);
912 set_bit(EVENT_DEV_OPEN, &dev->flags);
913 netif_start_queue (net);
914 netif_info(dev, ifup, dev->net,
915 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
916 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
918 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
919 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
920 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
921 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
922 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
925 /* reset rx error state */
928 clear_bit(EVENT_RX_KILL, &dev->flags);
930 // delay posting reads until we're fully open
931 tasklet_schedule (&dev->bh);
932 if (info->manage_power) {
933 retval = info->manage_power(dev, 1);
936 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
938 usb_autopm_put_interface(dev->intf);
943 usb_autopm_put_interface(dev->intf);
947 EXPORT_SYMBOL_GPL(usbnet_open);
949 /*-------------------------------------------------------------------------*/
951 /* ethtool methods; minidrivers may need to add some more, but
952 * they'll probably want to use this base set.
955 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
957 struct usbnet *dev = netdev_priv(net);
959 if (!dev->mii.mdio_read)
962 return mii_ethtool_gset(&dev->mii, cmd);
964 EXPORT_SYMBOL_GPL(usbnet_get_settings);
966 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
968 struct usbnet *dev = netdev_priv(net);
971 if (!dev->mii.mdio_write)
974 retval = mii_ethtool_sset(&dev->mii, cmd);
976 /* link speed/duplex might have changed */
977 if (dev->driver_info->link_reset)
978 dev->driver_info->link_reset(dev);
980 /* hard_mtu or rx_urb_size may change in link_reset() */
981 usbnet_update_max_qlen(dev);
986 EXPORT_SYMBOL_GPL(usbnet_set_settings);
988 u32 usbnet_get_link (struct net_device *net)
990 struct usbnet *dev = netdev_priv(net);
992 /* If a check_connect is defined, return its result */
993 if (dev->driver_info->check_connect)
994 return dev->driver_info->check_connect (dev) == 0;
996 /* if the device has mii operations, use those */
997 if (dev->mii.mdio_read)
998 return mii_link_ok(&dev->mii);
1000 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
1001 return ethtool_op_get_link(net);
1003 EXPORT_SYMBOL_GPL(usbnet_get_link);
1005 int usbnet_nway_reset(struct net_device *net)
1007 struct usbnet *dev = netdev_priv(net);
1009 if (!dev->mii.mdio_write)
1012 return mii_nway_restart(&dev->mii);
1014 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
1016 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
1018 struct usbnet *dev = netdev_priv(net);
1020 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
1021 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
1022 strlcpy (info->fw_version, dev->driver_info->description,
1023 sizeof info->fw_version);
1024 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
1026 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
1028 u32 usbnet_get_msglevel (struct net_device *net)
1030 struct usbnet *dev = netdev_priv(net);
1032 return dev->msg_enable;
1034 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1036 void usbnet_set_msglevel (struct net_device *net, u32 level)
1038 struct usbnet *dev = netdev_priv(net);
1040 dev->msg_enable = level;
1042 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1044 /* drivers may override default ethtool_ops in their bind() routine */
1045 static const struct ethtool_ops usbnet_ethtool_ops = {
1046 .get_settings = usbnet_get_settings,
1047 .set_settings = usbnet_set_settings,
1048 .get_link = usbnet_get_link,
1049 .nway_reset = usbnet_nway_reset,
1050 .get_drvinfo = usbnet_get_drvinfo,
1051 .get_msglevel = usbnet_get_msglevel,
1052 .set_msglevel = usbnet_set_msglevel,
1053 .get_ts_info = ethtool_op_get_ts_info,
1056 /*-------------------------------------------------------------------------*/
1058 static void __handle_link_change(struct usbnet *dev)
1060 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1063 if (!netif_carrier_ok(dev->net)) {
1064 /* kill URBs for reading packets to save bus bandwidth */
1065 unlink_urbs(dev, &dev->rxq);
1068 * tx_timeout will unlink URBs for sending packets and
1069 * tx queue is stopped by netcore after link becomes off
1072 /* submitting URBs for reading packets */
1073 tasklet_schedule(&dev->bh);
1076 /* hard_mtu or rx_urb_size may change during link change */
1077 usbnet_update_max_qlen(dev);
1079 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1082 static void usbnet_set_rx_mode(struct net_device *net)
1084 struct usbnet *dev = netdev_priv(net);
1086 usbnet_defer_kevent(dev, EVENT_SET_RX_MODE);
1089 static void __handle_set_rx_mode(struct usbnet *dev)
1091 if (dev->driver_info->set_rx_mode)
1092 (dev->driver_info->set_rx_mode)(dev);
1094 clear_bit(EVENT_SET_RX_MODE, &dev->flags);
1097 /* work that cannot be done in interrupt context uses keventd.
1099 * NOTE: with 2.5 we could do more of this using completion callbacks,
1100 * especially now that control transfers can be queued.
1103 usbnet_deferred_kevent (struct work_struct *work)
1105 struct usbnet *dev =
1106 container_of(work, struct usbnet, kevent);
1109 /* usb_clear_halt() needs a thread context */
1110 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1111 unlink_urbs (dev, &dev->txq);
1112 status = usb_autopm_get_interface(dev->intf);
1115 status = usb_clear_halt (dev->udev, dev->out);
1116 usb_autopm_put_interface(dev->intf);
1119 status != -ESHUTDOWN) {
1120 if (netif_msg_tx_err (dev))
1122 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1125 clear_bit (EVENT_TX_HALT, &dev->flags);
1126 if (status != -ESHUTDOWN)
1127 netif_wake_queue (dev->net);
1130 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1131 unlink_urbs (dev, &dev->rxq);
1132 status = usb_autopm_get_interface(dev->intf);
1135 status = usb_clear_halt (dev->udev, dev->in);
1136 usb_autopm_put_interface(dev->intf);
1139 status != -ESHUTDOWN) {
1140 if (netif_msg_rx_err (dev))
1142 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1145 clear_bit (EVENT_RX_HALT, &dev->flags);
1146 tasklet_schedule (&dev->bh);
1150 /* tasklet could resubmit itself forever if memory is tight */
1151 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1152 struct urb *urb = NULL;
1155 if (netif_running (dev->net))
1156 urb = usb_alloc_urb (0, GFP_KERNEL);
1158 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1160 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1161 status = usb_autopm_get_interface(dev->intf);
1166 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1168 usb_autopm_put_interface(dev->intf);
1171 tasklet_schedule (&dev->bh);
1175 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1176 struct driver_info *info = dev->driver_info;
1179 clear_bit (EVENT_LINK_RESET, &dev->flags);
1180 status = usb_autopm_get_interface(dev->intf);
1183 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1184 usb_autopm_put_interface(dev->intf);
1186 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1188 dev->udev->bus->bus_name,
1192 usb_autopm_put_interface(dev->intf);
1195 /* handle link change from link resetting */
1196 __handle_link_change(dev);
1199 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1200 __handle_link_change(dev);
1202 if (test_bit (EVENT_SET_RX_MODE, &dev->flags))
1203 __handle_set_rx_mode(dev);
1207 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1210 /*-------------------------------------------------------------------------*/
1212 static void tx_complete (struct urb *urb)
1214 struct sk_buff *skb = (struct sk_buff *) urb->context;
1215 struct skb_data *entry = (struct skb_data *) skb->cb;
1216 struct usbnet *dev = entry->dev;
1218 if (urb->status == 0) {
1219 dev->net->stats.tx_packets += entry->packets;
1220 dev->net->stats.tx_bytes += entry->length;
1222 dev->net->stats.tx_errors++;
1224 switch (urb->status) {
1226 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1229 /* software-driven interface shutdown */
1230 case -ECONNRESET: // async unlink
1231 case -ESHUTDOWN: // hardware gone
1234 /* like rx, tx gets controller i/o faults during hub_wq
1235 * delays and so it uses the same throttling mechanism.
1240 usb_mark_last_busy(dev->udev);
1241 if (!timer_pending (&dev->delay)) {
1242 mod_timer (&dev->delay,
1243 jiffies + THROTTLE_JIFFIES);
1244 netif_dbg(dev, link, dev->net,
1245 "tx throttle %d\n", urb->status);
1247 netif_stop_queue (dev->net);
1250 netif_dbg(dev, tx_err, dev->net,
1251 "tx err %d\n", entry->urb->status);
1256 usb_autopm_put_interface_async(dev->intf);
1257 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1260 /*-------------------------------------------------------------------------*/
1262 void usbnet_tx_timeout (struct net_device *net)
1264 struct usbnet *dev = netdev_priv(net);
1266 unlink_urbs (dev, &dev->txq);
1267 tasklet_schedule (&dev->bh);
1268 /* this needs to be handled individually because the generic layer
1269 * doesn't know what is sufficient and could not restore private
1270 * information if a remedy of an unconditional reset were used.
1272 if (dev->driver_info->recover)
1273 (dev->driver_info->recover)(dev);
1275 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1277 /*-------------------------------------------------------------------------*/
1279 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1281 unsigned num_sgs, total_len = 0;
1284 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1288 /* reserve one for zero packet */
1289 urb->sg = kmalloc((num_sgs + 1) * sizeof(struct scatterlist),
1294 urb->num_sgs = num_sgs;
1295 sg_init_table(urb->sg, urb->num_sgs + 1);
1297 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1298 total_len += skb_headlen(skb);
1300 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1301 struct skb_frag_struct *f = &skb_shinfo(skb)->frags[i];
1303 total_len += skb_frag_size(f);
1304 sg_set_page(&urb->sg[i + s], f->page.p, f->size,
1307 urb->transfer_buffer_length = total_len;
1312 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1313 struct net_device *net)
1315 struct usbnet *dev = netdev_priv(net);
1316 unsigned int length;
1317 struct urb *urb = NULL;
1318 struct skb_data *entry;
1319 struct driver_info *info = dev->driver_info;
1320 unsigned long flags;
1324 skb_tx_timestamp(skb);
1326 // some devices want funky USB-level framing, for
1327 // win32 driver (usually) and/or hardware quirks
1328 if (info->tx_fixup) {
1329 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1331 /* packet collected; minidriver waiting for more */
1332 if (info->flags & FLAG_MULTI_PACKET)
1334 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1339 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1340 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1344 entry = (struct skb_data *) skb->cb;
1348 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1349 skb->data, skb->len, tx_complete, skb);
1350 if (dev->can_dma_sg) {
1351 if (build_dma_sg(skb, urb) < 0)
1354 length = urb->transfer_buffer_length;
1356 /* don't assume the hardware handles USB_ZERO_PACKET
1357 * NOTE: strictly conforming cdc-ether devices should expect
1358 * the ZLP here, but ignore the one-byte packet.
1359 * NOTE2: CDC NCM specification is different from CDC ECM when
1360 * handling ZLP/short packets, so cdc_ncm driver will make short
1361 * packet itself if needed.
1363 if (length % dev->maxpacket == 0) {
1364 if (!(info->flags & FLAG_SEND_ZLP)) {
1365 if (!(info->flags & FLAG_MULTI_PACKET)) {
1367 if (skb_tailroom(skb) && !urb->num_sgs) {
1368 skb->data[skb->len] = 0;
1370 } else if (urb->num_sgs)
1371 sg_set_buf(&urb->sg[urb->num_sgs++],
1372 dev->padding_pkt, 1);
1375 urb->transfer_flags |= URB_ZERO_PACKET;
1377 urb->transfer_buffer_length = length;
1379 if (info->flags & FLAG_MULTI_PACKET) {
1380 /* Driver has set number of packets and a length delta.
1381 * Calculate the complete length and ensure that it's
1384 entry->length += length;
1385 if (WARN_ON_ONCE(entry->length <= 0))
1386 entry->length = length;
1388 usbnet_set_skb_tx_stats(skb, 1, length);
1391 spin_lock_irqsave(&dev->txq.lock, flags);
1392 retval = usb_autopm_get_interface_async(dev->intf);
1394 spin_unlock_irqrestore(&dev->txq.lock, flags);
1397 if (netif_queue_stopped(net)) {
1398 usb_autopm_put_interface_async(dev->intf);
1399 spin_unlock_irqrestore(&dev->txq.lock, flags);
1404 /* if this triggers the device is still a sleep */
1405 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1406 /* transmission will be done in resume */
1407 usb_anchor_urb(urb, &dev->deferred);
1408 /* no use to process more packets */
1409 netif_stop_queue(net);
1411 spin_unlock_irqrestore(&dev->txq.lock, flags);
1412 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1417 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1419 netif_stop_queue (net);
1420 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1421 usb_autopm_put_interface_async(dev->intf);
1424 usb_autopm_put_interface_async(dev->intf);
1425 netif_dbg(dev, tx_err, dev->net,
1426 "tx: submit urb err %d\n", retval);
1429 net->trans_start = jiffies;
1430 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1431 if (dev->txq.qlen >= TX_QLEN (dev))
1432 netif_stop_queue (net);
1434 spin_unlock_irqrestore (&dev->txq.lock, flags);
1437 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1439 dev->net->stats.tx_dropped++;
1442 dev_kfree_skb_any (skb);
1448 netif_dbg(dev, tx_queued, dev->net,
1449 "> tx, len %u, type 0x%x\n", length, skb->protocol);
1453 return NETDEV_TX_OK;
1455 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1457 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1463 /* don't refill the queue all at once */
1464 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1465 urb = usb_alloc_urb(0, flags);
1467 ret = rx_submit(dev, urb, flags);
1479 /*-------------------------------------------------------------------------*/
1481 // tasklet (work deferred from completions, in_irq) or timer
1483 static void usbnet_bh (unsigned long param)
1485 struct usbnet *dev = (struct usbnet *) param;
1486 struct sk_buff *skb;
1487 struct skb_data *entry;
1489 while ((skb = skb_dequeue (&dev->done))) {
1490 entry = (struct skb_data *) skb->cb;
1491 switch (entry->state) {
1493 entry->state = rx_cleanup;
1494 rx_process (dev, skb);
1497 kfree(entry->urb->sg);
1499 usb_free_urb (entry->urb);
1500 dev_kfree_skb (skb);
1503 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1507 /* restart RX again after disabling due to high error rate */
1508 clear_bit(EVENT_RX_KILL, &dev->flags);
1510 /* waiting for all pending urbs to complete?
1511 * only then can we forgo submitting anew
1513 if (waitqueue_active(&dev->wait)) {
1514 if (dev->txq.qlen + dev->rxq.qlen + dev->done.qlen == 0)
1515 wake_up_all(&dev->wait);
1517 // or are we maybe short a few urbs?
1518 } else if (netif_running (dev->net) &&
1519 netif_device_present (dev->net) &&
1520 netif_carrier_ok(dev->net) &&
1521 !timer_pending (&dev->delay) &&
1522 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1523 int temp = dev->rxq.qlen;
1525 if (temp < RX_QLEN(dev)) {
1526 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1528 if (temp != dev->rxq.qlen)
1529 netif_dbg(dev, link, dev->net,
1530 "rxqlen %d --> %d\n",
1531 temp, dev->rxq.qlen);
1532 if (dev->rxq.qlen < RX_QLEN(dev))
1533 tasklet_schedule (&dev->bh);
1535 if (dev->txq.qlen < TX_QLEN (dev))
1536 netif_wake_queue (dev->net);
1541 /*-------------------------------------------------------------------------
1543 * USB Device Driver support
1545 *-------------------------------------------------------------------------*/
1547 // precondition: never called in_interrupt
1549 void usbnet_disconnect (struct usb_interface *intf)
1552 struct usb_device *xdev;
1553 struct net_device *net;
1555 dev = usb_get_intfdata(intf);
1556 usb_set_intfdata(intf, NULL);
1560 xdev = interface_to_usbdev (intf);
1562 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1563 intf->dev.driver->name,
1564 xdev->bus->bus_name, xdev->devpath,
1565 dev->driver_info->description);
1568 unregister_netdev (net);
1570 cancel_work_sync(&dev->kevent);
1572 usb_scuttle_anchored_urbs(&dev->deferred);
1574 if (dev->driver_info->unbind)
1575 dev->driver_info->unbind (dev, intf);
1577 usb_kill_urb(dev->interrupt);
1578 usb_free_urb(dev->interrupt);
1579 kfree(dev->padding_pkt);
1583 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1585 static const struct net_device_ops usbnet_netdev_ops = {
1586 .ndo_open = usbnet_open,
1587 .ndo_stop = usbnet_stop,
1588 .ndo_start_xmit = usbnet_start_xmit,
1589 .ndo_tx_timeout = usbnet_tx_timeout,
1590 .ndo_set_rx_mode = usbnet_set_rx_mode,
1591 .ndo_change_mtu = usbnet_change_mtu,
1592 .ndo_set_mac_address = eth_mac_addr,
1593 .ndo_validate_addr = eth_validate_addr,
1596 /*-------------------------------------------------------------------------*/
1598 // precondition: never called in_interrupt
1600 static struct device_type wlan_type = {
1604 static struct device_type wwan_type = {
1609 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1612 struct net_device *net;
1613 struct usb_host_interface *interface;
1614 struct driver_info *info;
1615 struct usb_device *xdev;
1618 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1620 /* usbnet already took usb runtime pm, so have to enable the feature
1621 * for usb interface, otherwise usb_autopm_get_interface may return
1622 * failure if RUNTIME_PM is enabled.
1624 if (!driver->supports_autosuspend) {
1625 driver->supports_autosuspend = 1;
1626 pm_runtime_enable(&udev->dev);
1629 name = udev->dev.driver->name;
1630 info = (struct driver_info *) prod->driver_info;
1632 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1635 xdev = interface_to_usbdev (udev);
1636 interface = udev->cur_altsetting;
1640 // set up our own records
1641 net = alloc_etherdev(sizeof(*dev));
1645 /* netdev_printk() needs this so do it as early as possible */
1646 SET_NETDEV_DEV(net, &udev->dev);
1648 dev = netdev_priv(net);
1651 dev->driver_info = info;
1652 dev->driver_name = name;
1653 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1654 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1655 init_waitqueue_head(&dev->wait);
1656 skb_queue_head_init (&dev->rxq);
1657 skb_queue_head_init (&dev->txq);
1658 skb_queue_head_init (&dev->done);
1659 skb_queue_head_init(&dev->rxq_pause);
1660 dev->bh.func = usbnet_bh;
1661 dev->bh.data = (unsigned long) dev;
1662 INIT_WORK (&dev->kevent, usbnet_deferred_kevent);
1663 init_usb_anchor(&dev->deferred);
1664 dev->delay.function = usbnet_bh;
1665 dev->delay.data = (unsigned long) dev;
1666 init_timer (&dev->delay);
1667 mutex_init (&dev->phy_mutex);
1668 mutex_init(&dev->interrupt_mutex);
1669 dev->interrupt_count = 0;
1672 strcpy (net->name, "usb%d");
1673 memcpy (net->dev_addr, node_id, sizeof node_id);
1675 /* rx and tx sides can use different message sizes;
1676 * bind() should set rx_urb_size in that case.
1678 dev->hard_mtu = net->mtu + net->hard_header_len;
1680 net->netdev_ops = &usbnet_netdev_ops;
1681 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1682 net->ethtool_ops = &usbnet_ethtool_ops;
1684 // allow device-specific bind/init procedures
1685 // NOTE net->name still not usable ...
1687 status = info->bind (dev, udev);
1691 // heuristic: "usb%d" for links we know are two-host,
1692 // else "eth%d" when there's reasonable doubt. userspace
1693 // can rename the link if it knows better.
1694 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1695 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1696 (net->dev_addr [0] & 0x02) == 0))
1697 strcpy (net->name, "eth%d");
1698 /* WLAN devices should always be named "wlan%d" */
1699 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1700 strcpy(net->name, "wlan%d");
1701 /* WWAN devices should always be named "wwan%d" */
1702 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1703 strcpy(net->name, "wwan%d");
1705 /* devices that cannot do ARP */
1706 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1707 net->flags |= IFF_NOARP;
1709 /* maybe the remote can't receive an Ethernet MTU */
1710 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1711 net->mtu = dev->hard_mtu - net->hard_header_len;
1712 } else if (!info->in || !info->out)
1713 status = usbnet_get_endpoints (dev, udev);
1715 dev->in = usb_rcvbulkpipe (xdev, info->in);
1716 dev->out = usb_sndbulkpipe (xdev, info->out);
1717 if (!(info->flags & FLAG_NO_SETINT))
1718 status = usb_set_interface (xdev,
1719 interface->desc.bInterfaceNumber,
1720 interface->desc.bAlternateSetting);
1725 if (status >= 0 && dev->status)
1726 status = init_status (dev, udev);
1730 if (!dev->rx_urb_size)
1731 dev->rx_urb_size = dev->hard_mtu;
1732 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1734 /* let userspace know we have a random address */
1735 if (ether_addr_equal(net->dev_addr, node_id))
1736 net->addr_assign_type = NET_ADDR_RANDOM;
1738 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1739 SET_NETDEV_DEVTYPE(net, &wlan_type);
1740 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1741 SET_NETDEV_DEVTYPE(net, &wwan_type);
1743 /* initialize max rx_qlen and tx_qlen */
1744 usbnet_update_max_qlen(dev);
1746 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1747 !(info->flags & FLAG_MULTI_PACKET)) {
1748 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1749 if (!dev->padding_pkt) {
1755 status = register_netdev (net);
1758 netif_info(dev, probe, dev->net,
1759 "register '%s' at usb-%s-%s, %s, %pM\n",
1760 udev->dev.driver->name,
1761 xdev->bus->bus_name, xdev->devpath,
1762 dev->driver_info->description,
1765 // ok, it's ready to go.
1766 usb_set_intfdata (udev, dev);
1768 netif_device_attach (net);
1770 if (dev->driver_info->flags & FLAG_LINK_INTR)
1771 usbnet_link_change(dev, 0, 0);
1776 kfree(dev->padding_pkt);
1778 usb_free_urb(dev->interrupt);
1781 info->unbind (dev, udev);
1783 /* subdrivers must undo all they did in bind() if they
1784 * fail it, but we may fail later and a deferred kevent
1785 * may trigger an error resubmitting itself and, worse,
1786 * schedule a timer. So we kill it all just in case.
1788 cancel_work_sync(&dev->kevent);
1789 del_timer_sync(&dev->delay);
1794 EXPORT_SYMBOL_GPL(usbnet_probe);
1796 /*-------------------------------------------------------------------------*/
1799 * suspend the whole driver as soon as the first interface is suspended
1800 * resume only when the last interface is resumed
1803 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1805 struct usbnet *dev = usb_get_intfdata(intf);
1807 if (!dev->suspend_count++) {
1808 spin_lock_irq(&dev->txq.lock);
1809 /* don't autosuspend while transmitting */
1810 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1811 dev->suspend_count--;
1812 spin_unlock_irq(&dev->txq.lock);
1815 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1816 spin_unlock_irq(&dev->txq.lock);
1819 * accelerate emptying of the rx and queues, to avoid
1820 * having everything error out.
1822 netif_device_detach (dev->net);
1823 usbnet_terminate_urbs(dev);
1824 __usbnet_status_stop_force(dev);
1827 * reattach so runtime management can use and
1830 netif_device_attach (dev->net);
1834 EXPORT_SYMBOL_GPL(usbnet_suspend);
1836 int usbnet_resume (struct usb_interface *intf)
1838 struct usbnet *dev = usb_get_intfdata(intf);
1839 struct sk_buff *skb;
1843 if (!--dev->suspend_count) {
1844 /* resume interrupt URB if it was previously submitted */
1845 __usbnet_status_start_force(dev, GFP_NOIO);
1847 spin_lock_irq(&dev->txq.lock);
1848 while ((res = usb_get_from_anchor(&dev->deferred))) {
1850 skb = (struct sk_buff *)res->context;
1851 retval = usb_submit_urb(res, GFP_ATOMIC);
1853 dev_kfree_skb_any(skb);
1856 usb_autopm_put_interface_async(dev->intf);
1858 dev->net->trans_start = jiffies;
1859 __skb_queue_tail(&dev->txq, skb);
1864 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1865 spin_unlock_irq(&dev->txq.lock);
1867 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1868 /* handle remote wakeup ASAP
1869 * we cannot race against stop
1871 if (netif_device_present(dev->net) &&
1872 !timer_pending(&dev->delay) &&
1873 !test_bit(EVENT_RX_HALT, &dev->flags))
1874 rx_alloc_submit(dev, GFP_NOIO);
1876 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1877 netif_tx_wake_all_queues(dev->net);
1878 tasklet_schedule (&dev->bh);
1882 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1883 usb_autopm_get_interface_no_resume(intf);
1887 EXPORT_SYMBOL_GPL(usbnet_resume);
1890 * Either a subdriver implements manage_power, then it is assumed to always
1891 * be ready to be suspended or it reports the readiness to be suspended
1894 void usbnet_device_suggests_idle(struct usbnet *dev)
1896 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1897 dev->intf->needs_remote_wakeup = 1;
1898 usb_autopm_put_interface_async(dev->intf);
1901 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1904 * For devices that can do without special commands
1906 int usbnet_manage_power(struct usbnet *dev, int on)
1908 dev->intf->needs_remote_wakeup = on;
1911 EXPORT_SYMBOL(usbnet_manage_power);
1913 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1915 /* update link after link is reseted */
1916 if (link && !need_reset)
1917 netif_carrier_on(dev->net);
1919 netif_carrier_off(dev->net);
1921 if (need_reset && link)
1922 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1924 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1926 EXPORT_SYMBOL(usbnet_link_change);
1928 /*-------------------------------------------------------------------------*/
1929 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1930 u16 value, u16 index, void *data, u16 size)
1935 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1936 " value=0x%04x index=0x%04x size=%d\n",
1937 cmd, reqtype, value, index, size);
1940 buf = kmalloc(size, GFP_KERNEL);
1945 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1946 cmd, reqtype, value, index, buf, size,
1947 USB_CTRL_GET_TIMEOUT);
1948 if (err > 0 && err <= size)
1949 memcpy(data, buf, err);
1955 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1956 u16 value, u16 index, const void *data,
1962 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1963 " value=0x%04x index=0x%04x size=%d\n",
1964 cmd, reqtype, value, index, size);
1967 buf = kmemdup(data, size, GFP_KERNEL);
1972 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1973 cmd, reqtype, value, index, buf, size,
1974 USB_CTRL_SET_TIMEOUT);
1981 int cdc_parse_cdc_header(struct usb_cdc_parsed_header *hdr,
1982 struct usb_interface *intf,
1986 /* duplicates are ignored */
1987 struct usb_cdc_union_desc *union_header = NULL;
1989 /* duplicates are not tolerated */
1990 struct usb_cdc_header_desc *header = NULL;
1991 struct usb_cdc_ether_desc *ether = NULL;
1992 struct usb_cdc_mdlm_detail_desc *detail = NULL;
1993 struct usb_cdc_mdlm_desc *desc = NULL;
1995 unsigned int elength;
1998 memset(hdr, 0x00, sizeof(struct usb_cdc_parsed_header));
1999 hdr->phonet_magic_present = false;
2000 while (buflen > 0) {
2001 elength = buffer[0];
2003 dev_err(&intf->dev, "skipping garbage byte\n");
2007 if ((buflen < elength) || (elength < 3)) {
2008 dev_err(&intf->dev, "invalid descriptor buffer length\n");
2011 if (buffer[1] != USB_DT_CS_INTERFACE) {
2012 dev_err(&intf->dev, "skipping garbage\n");
2016 switch (buffer[2]) {
2017 case USB_CDC_UNION_TYPE: /* we've found it */
2018 if (elength < sizeof(struct usb_cdc_union_desc))
2021 dev_err(&intf->dev, "More than one union descriptor, skipping ...\n");
2024 union_header = (struct usb_cdc_union_desc *)buffer;
2026 case USB_CDC_COUNTRY_TYPE:
2027 if (elength < sizeof(struct usb_cdc_country_functional_desc))
2029 hdr->usb_cdc_country_functional_desc =
2030 (struct usb_cdc_country_functional_desc *)buffer;
2032 case USB_CDC_HEADER_TYPE:
2033 if (elength != sizeof(struct usb_cdc_header_desc))
2037 header = (struct usb_cdc_header_desc *)buffer;
2039 case USB_CDC_ACM_TYPE:
2040 if (elength < sizeof(struct usb_cdc_acm_descriptor))
2042 hdr->usb_cdc_acm_descriptor =
2043 (struct usb_cdc_acm_descriptor *)buffer;
2045 case USB_CDC_ETHERNET_TYPE:
2046 if (elength != sizeof(struct usb_cdc_ether_desc))
2050 ether = (struct usb_cdc_ether_desc *)buffer;
2052 case USB_CDC_CALL_MANAGEMENT_TYPE:
2053 if (elength < sizeof(struct usb_cdc_call_mgmt_descriptor))
2055 hdr->usb_cdc_call_mgmt_descriptor =
2056 (struct usb_cdc_call_mgmt_descriptor *)buffer;
2058 case USB_CDC_DMM_TYPE:
2059 if (elength < sizeof(struct usb_cdc_dmm_desc))
2061 hdr->usb_cdc_dmm_desc =
2062 (struct usb_cdc_dmm_desc *)buffer;
2064 case USB_CDC_MDLM_TYPE:
2065 if (elength < sizeof(struct usb_cdc_mdlm_desc *))
2069 desc = (struct usb_cdc_mdlm_desc *)buffer;
2071 case USB_CDC_MDLM_DETAIL_TYPE:
2072 if (elength < sizeof(struct usb_cdc_mdlm_detail_desc *))
2076 detail = (struct usb_cdc_mdlm_detail_desc *)buffer;
2078 case USB_CDC_NCM_TYPE:
2079 if (elength < sizeof(struct usb_cdc_ncm_desc))
2081 hdr->usb_cdc_ncm_desc = (struct usb_cdc_ncm_desc *)buffer;
2083 case USB_CDC_MBIM_TYPE:
2084 if (elength < sizeof(struct usb_cdc_mbim_desc))
2087 hdr->usb_cdc_mbim_desc = (struct usb_cdc_mbim_desc *)buffer;
2089 case USB_CDC_MBIM_EXTENDED_TYPE:
2090 if (elength < sizeof(struct usb_cdc_mbim_extended_desc))
2092 hdr->usb_cdc_mbim_extended_desc =
2093 (struct usb_cdc_mbim_extended_desc *)buffer;
2095 case CDC_PHONET_MAGIC_NUMBER:
2096 hdr->phonet_magic_present = true;
2100 * there are LOTS more CDC descriptors that
2101 * could legitimately be found here.
2103 dev_dbg(&intf->dev, "Ignoring descriptor: type %02x, length %ud\n",
2104 buffer[2], elength);
2112 hdr->usb_cdc_union_desc = union_header;
2113 hdr->usb_cdc_header_desc = header;
2114 hdr->usb_cdc_mdlm_detail_desc = detail;
2115 hdr->usb_cdc_mdlm_desc = desc;
2116 hdr->usb_cdc_ether_desc = ether;
2120 EXPORT_SYMBOL(cdc_parse_cdc_header);
2123 * The function can't be called inside suspend/resume callback,
2124 * otherwise deadlock will be caused.
2126 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2127 u16 value, u16 index, void *data, u16 size)
2131 if (usb_autopm_get_interface(dev->intf) < 0)
2133 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2135 usb_autopm_put_interface(dev->intf);
2138 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
2141 * The function can't be called inside suspend/resume callback,
2142 * otherwise deadlock will be caused.
2144 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
2145 u16 value, u16 index, const void *data, u16 size)
2149 if (usb_autopm_get_interface(dev->intf) < 0)
2151 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2153 usb_autopm_put_interface(dev->intf);
2156 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
2159 * The function can be called inside suspend/resume callback safely
2160 * and should only be called by suspend/resume callback generally.
2162 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2163 u16 value, u16 index, void *data, u16 size)
2165 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
2168 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
2171 * The function can be called inside suspend/resume callback safely
2172 * and should only be called by suspend/resume callback generally.
2174 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
2175 u16 value, u16 index, const void *data,
2178 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
2181 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
2183 static void usbnet_async_cmd_cb(struct urb *urb)
2185 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
2186 int status = urb->status;
2189 dev_dbg(&urb->dev->dev, "%s failed with %d",
2197 * The caller must make sure that device can't be put into suspend
2198 * state until the control URB completes.
2200 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
2201 u16 value, u16 index, const void *data, u16 size)
2203 struct usb_ctrlrequest *req = NULL;
2208 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2209 " value=0x%04x index=0x%04x size=%d\n",
2210 cmd, reqtype, value, index, size);
2212 urb = usb_alloc_urb(0, GFP_ATOMIC);
2214 netdev_err(dev->net, "Error allocating URB in"
2215 " %s!\n", __func__);
2220 buf = kmemdup(data, size, GFP_ATOMIC);
2222 netdev_err(dev->net, "Error allocating buffer"
2223 " in %s!\n", __func__);
2228 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2232 req->bRequestType = reqtype;
2233 req->bRequest = cmd;
2234 req->wValue = cpu_to_le16(value);
2235 req->wIndex = cpu_to_le16(index);
2236 req->wLength = cpu_to_le16(size);
2238 usb_fill_control_urb(urb, dev->udev,
2239 usb_sndctrlpipe(dev->udev, 0),
2240 (void *)req, buf, size,
2241 usbnet_async_cmd_cb, req);
2242 urb->transfer_flags |= URB_FREE_BUFFER;
2244 err = usb_submit_urb(urb, GFP_ATOMIC);
2246 netdev_err(dev->net, "Error submitting the control"
2247 " message: status=%d\n", err);
2261 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2262 /*-------------------------------------------------------------------------*/
2264 static int __init usbnet_init(void)
2266 /* Compiler should optimize this out. */
2268 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
2270 eth_random_addr(node_id);
2273 module_init(usbnet_init);
2275 static void __exit usbnet_exit(void)
2278 module_exit(usbnet_exit);
2280 MODULE_AUTHOR("David Brownell");
2281 MODULE_DESCRIPTION("USB network driver framework");
2282 MODULE_LICENSE("GPL");