2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 * This is a generic "USB networking" framework that works with several
22 * kinds of full and high speed networking devices: host-to-host cables,
23 * smart usb peripherals, and actual Ethernet adapters.
25 * These devices usually differ in terms of control protocols (if they
26 * even have one!) and sometimes they define new framing to wrap or batch
27 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
28 * so interface (un)binding, endpoint I/O queues, fault handling, and other
29 * issues can usefully be addressed by this framework.
32 // #define DEBUG // error path messages, extra info
33 // #define VERBOSE // more; success messages
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/netdevice.h>
38 #include <linux/etherdevice.h>
39 #include <linux/ctype.h>
40 #include <linux/ethtool.h>
41 #include <linux/workqueue.h>
42 #include <linux/mii.h>
43 #include <linux/usb.h>
44 #include <linux/usb/usbnet.h>
45 #include <linux/slab.h>
46 #include <linux/kernel.h>
47 #include <linux/pm_runtime.h>
49 #define DRIVER_VERSION "22-Aug-2005"
52 /*-------------------------------------------------------------------------*/
55 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
56 * Several dozen bytes of IPv4 data can fit in two such transactions.
57 * One maximum size Ethernet packet takes twenty four of them.
58 * For high speed, each frame comfortably fits almost 36 max size
59 * Ethernet packets (so queues should be bigger).
61 * The goal is to let the USB host controller be busy for 5msec or
62 * more before an irq is required, under load. Jumbograms change
65 #define MAX_QUEUE_MEMORY (60 * 1518)
66 #define RX_QLEN(dev) ((dev)->rx_qlen)
67 #define TX_QLEN(dev) ((dev)->tx_qlen)
69 // reawaken network queue this soon after stopping; else watchdog barks
70 #define TX_TIMEOUT_JIFFIES (5*HZ)
72 /* throttle rx/tx briefly after some faults, so hub_wq might disconnect()
73 * us (it polls at HZ/4 usually) before we report too many false errors.
75 #define THROTTLE_JIFFIES (HZ/8)
78 #define UNLINK_TIMEOUT_MS 3
80 /*-------------------------------------------------------------------------*/
82 // randomly generated ethernet address
83 static u8 node_id [ETH_ALEN];
85 static const char driver_name [] = "usbnet";
87 /* use ethtool to change the level for any given device */
88 static int msg_level = -1;
89 module_param (msg_level, int, 0);
90 MODULE_PARM_DESC (msg_level, "Override default message level");
92 /*-------------------------------------------------------------------------*/
94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
95 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
98 struct usb_host_interface *alt = NULL;
99 struct usb_host_endpoint *in = NULL, *out = NULL;
100 struct usb_host_endpoint *status = NULL;
102 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
105 in = out = status = NULL;
106 alt = intf->altsetting + tmp;
108 /* take the first altsetting with in-bulk + out-bulk;
109 * remember any status endpoint, just in case;
110 * ignore other endpoints and altsettings.
112 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
113 struct usb_host_endpoint *e;
116 e = alt->endpoint + ep;
117 switch (e->desc.bmAttributes) {
118 case USB_ENDPOINT_XFER_INT:
119 if (!usb_endpoint_dir_in(&e->desc))
123 case USB_ENDPOINT_XFER_BULK:
128 if (usb_endpoint_dir_in(&e->desc)) {
131 else if (intr && !status)
141 if (!alt || !in || !out)
144 if (alt->desc.bAlternateSetting != 0 ||
145 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
146 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
147 alt->desc.bAlternateSetting);
152 dev->in = usb_rcvbulkpipe (dev->udev,
153 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
154 dev->out = usb_sndbulkpipe (dev->udev,
155 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156 dev->status = status;
159 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
161 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(dev->net->dev_addr, buf, 6);
170 dev_dbg(&dev->udev->dev,
171 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
178 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
180 static void intr_complete (struct urb *urb)
182 struct usbnet *dev = urb->context;
183 int status = urb->status;
188 dev->driver_info->status(dev, urb);
191 /* software-driven interface shutdown */
192 case -ENOENT: /* urb killed */
193 case -ESHUTDOWN: /* hardware gone */
194 netif_dbg(dev, ifdown, dev->net,
195 "intr shutdown, code %d\n", status);
198 /* NOTE: not throttling like RX/TX, since this endpoint
199 * already polls infrequently
202 netdev_dbg(dev->net, "intr status %d\n", status);
206 status = usb_submit_urb (urb, GFP_ATOMIC);
208 netif_err(dev, timer, dev->net,
209 "intr resubmit --> %d\n", status);
212 static int init_status (struct usbnet *dev, struct usb_interface *intf)
219 if (!dev->driver_info->status)
222 pipe = usb_rcvintpipe (dev->udev,
223 dev->status->desc.bEndpointAddress
224 & USB_ENDPOINT_NUMBER_MASK);
225 maxp = usb_maxpacket (dev->udev, pipe, 0);
227 /* avoid 1 msec chatter: min 8 msec poll rate */
228 period = max ((int) dev->status->desc.bInterval,
229 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
231 buf = kmalloc (maxp, GFP_KERNEL);
233 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
234 if (!dev->interrupt) {
238 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
239 buf, maxp, intr_complete, dev, period);
240 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
242 "status ep%din, %d bytes period %d\n",
243 usb_pipeendpoint(pipe), maxp, period);
249 /* Submit the interrupt URB if not previously submitted, increasing refcount */
250 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
254 WARN_ON_ONCE(dev->interrupt == NULL);
255 if (dev->interrupt) {
256 mutex_lock(&dev->interrupt_mutex);
258 if (++dev->interrupt_count == 1)
259 ret = usb_submit_urb(dev->interrupt, mem_flags);
261 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
262 dev->interrupt_count);
263 mutex_unlock(&dev->interrupt_mutex);
267 EXPORT_SYMBOL_GPL(usbnet_status_start);
269 /* For resume; submit interrupt URB if previously submitted */
270 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
274 mutex_lock(&dev->interrupt_mutex);
275 if (dev->interrupt_count) {
276 ret = usb_submit_urb(dev->interrupt, mem_flags);
277 dev_dbg(&dev->udev->dev,
278 "submitted interrupt URB for resume\n");
280 mutex_unlock(&dev->interrupt_mutex);
284 /* Kill the interrupt URB if all submitters want it killed */
285 void usbnet_status_stop(struct usbnet *dev)
287 if (dev->interrupt) {
288 mutex_lock(&dev->interrupt_mutex);
289 WARN_ON(dev->interrupt_count == 0);
291 if (dev->interrupt_count && --dev->interrupt_count == 0)
292 usb_kill_urb(dev->interrupt);
294 dev_dbg(&dev->udev->dev,
295 "decremented interrupt URB count to %d\n",
296 dev->interrupt_count);
297 mutex_unlock(&dev->interrupt_mutex);
300 EXPORT_SYMBOL_GPL(usbnet_status_stop);
302 /* For suspend; always kill interrupt URB */
303 static void __usbnet_status_stop_force(struct usbnet *dev)
305 if (dev->interrupt) {
306 mutex_lock(&dev->interrupt_mutex);
307 usb_kill_urb(dev->interrupt);
308 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
309 mutex_unlock(&dev->interrupt_mutex);
313 /* Passes this packet up the stack, updating its accounting.
314 * Some link protocols batch packets, so their rx_fixup paths
315 * can return clones as well as just modify the original skb.
317 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
321 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
322 skb_queue_tail(&dev->rxq_pause, skb);
326 skb->protocol = eth_type_trans (skb, dev->net);
327 dev->net->stats.rx_packets++;
328 dev->net->stats.rx_bytes += skb->len;
330 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
331 skb->len + sizeof (struct ethhdr), skb->protocol);
332 memset (skb->cb, 0, sizeof (struct skb_data));
334 if (skb_defer_rx_timestamp(skb))
337 status = netif_rx (skb);
338 if (status != NET_RX_SUCCESS)
339 netif_dbg(dev, rx_err, dev->net,
340 "netif_rx status %d\n", status);
342 EXPORT_SYMBOL_GPL(usbnet_skb_return);
344 /* must be called if hard_mtu or rx_urb_size changed */
345 void usbnet_update_max_qlen(struct usbnet *dev)
347 enum usb_device_speed speed = dev->udev->speed;
351 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
352 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
354 case USB_SPEED_SUPER:
356 * Not take default 5ms qlen for super speed HC to
357 * save memory, and iperf tests show 2.5ms qlen can
360 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
361 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
364 dev->rx_qlen = dev->tx_qlen = 4;
367 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
370 /*-------------------------------------------------------------------------
372 * Network Device Driver (peer link to "Host Device", from USB host)
374 *-------------------------------------------------------------------------*/
376 int usbnet_change_mtu (struct net_device *net, int new_mtu)
378 struct usbnet *dev = netdev_priv(net);
379 int ll_mtu = new_mtu + net->hard_header_len;
380 int old_hard_mtu = dev->hard_mtu;
381 int old_rx_urb_size = dev->rx_urb_size;
385 // no second zero-length packet read wanted after mtu-sized packets
386 if ((ll_mtu % dev->maxpacket) == 0)
390 dev->hard_mtu = net->mtu + net->hard_header_len;
391 if (dev->rx_urb_size == old_hard_mtu) {
392 dev->rx_urb_size = dev->hard_mtu;
393 if (dev->rx_urb_size > old_rx_urb_size)
394 usbnet_unlink_rx_urbs(dev);
397 /* max qlen depend on hard_mtu and rx_urb_size */
398 usbnet_update_max_qlen(dev);
402 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
404 /* The caller must hold list->lock */
405 static void __usbnet_queue_skb(struct sk_buff_head *list,
406 struct sk_buff *newsk, enum skb_state state)
408 struct skb_data *entry = (struct skb_data *) newsk->cb;
410 __skb_queue_tail(list, newsk);
411 entry->state = state;
414 /*-------------------------------------------------------------------------*/
416 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
417 * completion callbacks. 2.5 should have fixed those bugs...
420 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
421 struct sk_buff_head *list, enum skb_state state)
424 enum skb_state old_state;
425 struct skb_data *entry = (struct skb_data *) skb->cb;
427 spin_lock_irqsave(&list->lock, flags);
428 old_state = entry->state;
429 entry->state = state;
430 __skb_unlink(skb, list);
431 spin_unlock(&list->lock);
432 spin_lock(&dev->done.lock);
433 __skb_queue_tail(&dev->done, skb);
434 if (dev->done.qlen == 1)
435 tasklet_schedule(&dev->bh);
436 spin_unlock_irqrestore(&dev->done.lock, flags);
440 /* some work can't be done in tasklets, so we use keventd
442 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
443 * but tasklet_schedule() doesn't. hope the failure is rare.
445 void usbnet_defer_kevent (struct usbnet *dev, int work)
447 set_bit (work, &dev->flags);
448 if (!schedule_work (&dev->kevent)) {
450 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
452 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
455 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
457 /*-------------------------------------------------------------------------*/
459 static void rx_complete (struct urb *urb);
461 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
464 struct skb_data *entry;
466 unsigned long lockflags;
467 size_t size = dev->rx_urb_size;
469 /* prevent rx skb allocation when error ratio is high */
470 if (test_bit(EVENT_RX_KILL, &dev->flags)) {
475 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
477 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
478 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
483 entry = (struct skb_data *) skb->cb;
488 usb_fill_bulk_urb (urb, dev->udev, dev->in,
489 skb->data, size, rx_complete, skb);
491 spin_lock_irqsave (&dev->rxq.lock, lockflags);
493 if (netif_running (dev->net) &&
494 netif_device_present (dev->net) &&
495 !test_bit (EVENT_RX_HALT, &dev->flags) &&
496 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
497 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
499 usbnet_defer_kevent (dev, EVENT_RX_HALT);
502 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
505 netif_dbg(dev, ifdown, dev->net, "device gone\n");
506 netif_device_detach (dev->net);
512 netif_dbg(dev, rx_err, dev->net,
513 "rx submit, %d\n", retval);
514 tasklet_schedule (&dev->bh);
517 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
520 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
523 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
525 dev_kfree_skb_any (skb);
532 /*-------------------------------------------------------------------------*/
534 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
536 if (dev->driver_info->rx_fixup &&
537 !dev->driver_info->rx_fixup (dev, skb)) {
538 /* With RX_ASSEMBLE, rx_fixup() must update counters */
539 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
540 dev->net->stats.rx_errors++;
543 // else network stack removes extra byte if we forced a short packet
545 /* all data was already cloned from skb inside the driver */
546 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
549 if (skb->len < ETH_HLEN) {
550 dev->net->stats.rx_errors++;
551 dev->net->stats.rx_length_errors++;
552 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
554 usbnet_skb_return(dev, skb);
559 skb_queue_tail(&dev->done, skb);
562 /*-------------------------------------------------------------------------*/
564 static void rx_complete (struct urb *urb)
566 struct sk_buff *skb = (struct sk_buff *) urb->context;
567 struct skb_data *entry = (struct skb_data *) skb->cb;
568 struct usbnet *dev = entry->dev;
569 int urb_status = urb->status;
570 enum skb_state state;
572 skb_put (skb, urb->actual_length);
576 switch (urb_status) {
581 /* stalls need manual reset. this is rare ... except that
582 * when going through USB 2.0 TTs, unplug appears this way.
583 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
584 * storm, recovering as needed.
587 dev->net->stats.rx_errors++;
588 usbnet_defer_kevent (dev, EVENT_RX_HALT);
591 /* software-driven interface shutdown */
592 case -ECONNRESET: /* async unlink */
593 case -ESHUTDOWN: /* hardware gone */
594 netif_dbg(dev, ifdown, dev->net,
595 "rx shutdown, code %d\n", urb_status);
598 /* we get controller i/o faults during hub_wq disconnect() delays.
599 * throttle down resubmits, to avoid log floods; just temporarily,
600 * so we still recover when the fault isn't a hub_wq delay.
605 dev->net->stats.rx_errors++;
606 if (!timer_pending (&dev->delay)) {
607 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
608 netif_dbg(dev, link, dev->net,
609 "rx throttle %d\n", urb_status);
617 /* data overrun ... flush fifo? */
619 dev->net->stats.rx_over_errors++;
624 dev->net->stats.rx_errors++;
625 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
629 /* stop rx if packet error rate is high */
630 if (++dev->pkt_cnt > 30) {
634 if (state == rx_cleanup)
636 if (dev->pkt_err > 20)
637 set_bit(EVENT_RX_KILL, &dev->flags);
640 state = defer_bh(dev, skb, &dev->rxq, state);
643 if (netif_running (dev->net) &&
644 !test_bit (EVENT_RX_HALT, &dev->flags) &&
645 state != unlink_start) {
646 rx_submit (dev, urb, GFP_ATOMIC);
647 usb_mark_last_busy(dev->udev);
652 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
655 /*-------------------------------------------------------------------------*/
656 void usbnet_pause_rx(struct usbnet *dev)
658 set_bit(EVENT_RX_PAUSED, &dev->flags);
660 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
662 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
664 void usbnet_resume_rx(struct usbnet *dev)
669 clear_bit(EVENT_RX_PAUSED, &dev->flags);
671 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
672 usbnet_skb_return(dev, skb);
676 tasklet_schedule(&dev->bh);
678 netif_dbg(dev, rx_status, dev->net,
679 "paused rx queue disabled, %d skbs requeued\n", num);
681 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
683 void usbnet_purge_paused_rxq(struct usbnet *dev)
685 skb_queue_purge(&dev->rxq_pause);
687 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
689 /*-------------------------------------------------------------------------*/
691 // unlink pending rx/tx; completion handlers do all other cleanup
693 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
699 spin_lock_irqsave (&q->lock, flags);
700 while (!skb_queue_empty(q)) {
701 struct skb_data *entry;
705 skb_queue_walk(q, skb) {
706 entry = (struct skb_data *) skb->cb;
707 if (entry->state != unlink_start)
712 entry->state = unlink_start;
716 * Get reference count of the URB to avoid it to be
717 * freed during usb_unlink_urb, which may trigger
718 * use-after-free problem inside usb_unlink_urb since
719 * usb_unlink_urb is always racing with .complete
720 * handler(include defer_bh).
723 spin_unlock_irqrestore(&q->lock, flags);
724 // during some PM-driven resume scenarios,
725 // these (async) unlinks complete immediately
726 retval = usb_unlink_urb (urb);
727 if (retval != -EINPROGRESS && retval != 0)
728 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
732 spin_lock_irqsave(&q->lock, flags);
734 spin_unlock_irqrestore (&q->lock, flags);
738 // Flush all pending rx urbs
739 // minidrivers may need to do this when the MTU changes
741 void usbnet_unlink_rx_urbs(struct usbnet *dev)
743 if (netif_running(dev->net)) {
744 (void) unlink_urbs (dev, &dev->rxq);
745 tasklet_schedule(&dev->bh);
748 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
750 /*-------------------------------------------------------------------------*/
752 // precondition: never called in_interrupt
753 static void usbnet_terminate_urbs(struct usbnet *dev)
755 DECLARE_WAITQUEUE(wait, current);
758 /* ensure there are no more active urbs */
759 add_wait_queue(&dev->wait, &wait);
760 set_current_state(TASK_UNINTERRUPTIBLE);
761 temp = unlink_urbs(dev, &dev->txq) +
762 unlink_urbs(dev, &dev->rxq);
764 /* maybe wait for deletions to finish. */
765 while (!skb_queue_empty(&dev->rxq)
766 && !skb_queue_empty(&dev->txq)
767 && !skb_queue_empty(&dev->done)) {
768 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
769 set_current_state(TASK_UNINTERRUPTIBLE);
770 netif_dbg(dev, ifdown, dev->net,
771 "waited for %d urb completions\n", temp);
773 set_current_state(TASK_RUNNING);
774 remove_wait_queue(&dev->wait, &wait);
777 int usbnet_stop (struct net_device *net)
779 struct usbnet *dev = netdev_priv(net);
780 struct driver_info *info = dev->driver_info;
783 clear_bit(EVENT_DEV_OPEN, &dev->flags);
784 netif_stop_queue (net);
786 netif_info(dev, ifdown, dev->net,
787 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
788 net->stats.rx_packets, net->stats.tx_packets,
789 net->stats.rx_errors, net->stats.tx_errors);
791 /* to not race resume */
792 pm = usb_autopm_get_interface(dev->intf);
793 /* allow minidriver to stop correctly (wireless devices to turn off
796 retval = info->stop(dev);
798 netif_info(dev, ifdown, dev->net,
799 "stop fail (%d) usbnet usb-%s-%s, %s\n",
801 dev->udev->bus->bus_name, dev->udev->devpath,
805 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
806 usbnet_terminate_urbs(dev);
808 usbnet_status_stop(dev);
810 usbnet_purge_paused_rxq(dev);
812 /* deferred work (task, timer, softirq) must also stop.
813 * can't flush_scheduled_work() until we drop rtnl (later),
814 * else workers could deadlock; so make workers a NOP.
817 del_timer_sync (&dev->delay);
818 tasklet_kill (&dev->bh);
820 usb_autopm_put_interface(dev->intf);
822 if (info->manage_power &&
823 !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags))
824 info->manage_power(dev, 0);
826 usb_autopm_put_interface(dev->intf);
830 EXPORT_SYMBOL_GPL(usbnet_stop);
832 /*-------------------------------------------------------------------------*/
834 // posts reads, and enables write queuing
836 // precondition: never called in_interrupt
838 int usbnet_open (struct net_device *net)
840 struct usbnet *dev = netdev_priv(net);
842 struct driver_info *info = dev->driver_info;
844 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
845 netif_info(dev, ifup, dev->net,
846 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
848 dev->udev->bus->bus_name,
854 // put into "known safe" state
855 if (info->reset && (retval = info->reset (dev)) < 0) {
856 netif_info(dev, ifup, dev->net,
857 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
859 dev->udev->bus->bus_name,
865 /* hard_mtu or rx_urb_size may change in reset() */
866 usbnet_update_max_qlen(dev);
868 // insist peer be connected
869 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
870 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
874 /* start any status interrupt transfer */
875 if (dev->interrupt) {
876 retval = usbnet_status_start(dev, GFP_KERNEL);
878 netif_err(dev, ifup, dev->net,
879 "intr submit %d\n", retval);
884 set_bit(EVENT_DEV_OPEN, &dev->flags);
885 netif_start_queue (net);
886 netif_info(dev, ifup, dev->net,
887 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
888 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
890 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
891 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
892 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
893 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
894 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
897 /* reset rx error state */
900 clear_bit(EVENT_RX_KILL, &dev->flags);
902 // delay posting reads until we're fully open
903 tasklet_schedule (&dev->bh);
904 if (info->manage_power) {
905 retval = info->manage_power(dev, 1);
908 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
910 usb_autopm_put_interface(dev->intf);
915 usb_autopm_put_interface(dev->intf);
919 EXPORT_SYMBOL_GPL(usbnet_open);
921 /*-------------------------------------------------------------------------*/
923 /* ethtool methods; minidrivers may need to add some more, but
924 * they'll probably want to use this base set.
927 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
929 struct usbnet *dev = netdev_priv(net);
931 if (!dev->mii.mdio_read)
934 return mii_ethtool_gset(&dev->mii, cmd);
936 EXPORT_SYMBOL_GPL(usbnet_get_settings);
938 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
940 struct usbnet *dev = netdev_priv(net);
943 if (!dev->mii.mdio_write)
946 retval = mii_ethtool_sset(&dev->mii, cmd);
948 /* link speed/duplex might have changed */
949 if (dev->driver_info->link_reset)
950 dev->driver_info->link_reset(dev);
952 /* hard_mtu or rx_urb_size may change in link_reset() */
953 usbnet_update_max_qlen(dev);
958 EXPORT_SYMBOL_GPL(usbnet_set_settings);
960 u32 usbnet_get_link (struct net_device *net)
962 struct usbnet *dev = netdev_priv(net);
964 /* If a check_connect is defined, return its result */
965 if (dev->driver_info->check_connect)
966 return dev->driver_info->check_connect (dev) == 0;
968 /* if the device has mii operations, use those */
969 if (dev->mii.mdio_read)
970 return mii_link_ok(&dev->mii);
972 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
973 return ethtool_op_get_link(net);
975 EXPORT_SYMBOL_GPL(usbnet_get_link);
977 int usbnet_nway_reset(struct net_device *net)
979 struct usbnet *dev = netdev_priv(net);
981 if (!dev->mii.mdio_write)
984 return mii_nway_restart(&dev->mii);
986 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
988 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
990 struct usbnet *dev = netdev_priv(net);
992 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
993 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
994 strlcpy (info->fw_version, dev->driver_info->description,
995 sizeof info->fw_version);
996 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
998 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
1000 u32 usbnet_get_msglevel (struct net_device *net)
1002 struct usbnet *dev = netdev_priv(net);
1004 return dev->msg_enable;
1006 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1008 void usbnet_set_msglevel (struct net_device *net, u32 level)
1010 struct usbnet *dev = netdev_priv(net);
1012 dev->msg_enable = level;
1014 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1016 /* drivers may override default ethtool_ops in their bind() routine */
1017 static const struct ethtool_ops usbnet_ethtool_ops = {
1018 .get_settings = usbnet_get_settings,
1019 .set_settings = usbnet_set_settings,
1020 .get_link = usbnet_get_link,
1021 .nway_reset = usbnet_nway_reset,
1022 .get_drvinfo = usbnet_get_drvinfo,
1023 .get_msglevel = usbnet_get_msglevel,
1024 .set_msglevel = usbnet_set_msglevel,
1025 .get_ts_info = ethtool_op_get_ts_info,
1028 /*-------------------------------------------------------------------------*/
1030 static void __handle_link_change(struct usbnet *dev)
1032 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1035 if (!netif_carrier_ok(dev->net)) {
1036 /* kill URBs for reading packets to save bus bandwidth */
1037 unlink_urbs(dev, &dev->rxq);
1040 * tx_timeout will unlink URBs for sending packets and
1041 * tx queue is stopped by netcore after link becomes off
1044 /* submitting URBs for reading packets */
1045 tasklet_schedule(&dev->bh);
1048 /* hard_mtu or rx_urb_size may change during link change */
1049 usbnet_update_max_qlen(dev);
1051 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1054 static void usbnet_set_rx_mode(struct net_device *net)
1056 struct usbnet *dev = netdev_priv(net);
1058 usbnet_defer_kevent(dev, EVENT_SET_RX_MODE);
1061 static void __handle_set_rx_mode(struct usbnet *dev)
1063 if (dev->driver_info->set_rx_mode)
1064 (dev->driver_info->set_rx_mode)(dev);
1066 clear_bit(EVENT_SET_RX_MODE, &dev->flags);
1069 /* work that cannot be done in interrupt context uses keventd.
1071 * NOTE: with 2.5 we could do more of this using completion callbacks,
1072 * especially now that control transfers can be queued.
1075 kevent (struct work_struct *work)
1077 struct usbnet *dev =
1078 container_of(work, struct usbnet, kevent);
1081 /* usb_clear_halt() needs a thread context */
1082 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1083 unlink_urbs (dev, &dev->txq);
1084 status = usb_autopm_get_interface(dev->intf);
1087 status = usb_clear_halt (dev->udev, dev->out);
1088 usb_autopm_put_interface(dev->intf);
1091 status != -ESHUTDOWN) {
1092 if (netif_msg_tx_err (dev))
1094 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1097 clear_bit (EVENT_TX_HALT, &dev->flags);
1098 if (status != -ESHUTDOWN)
1099 netif_wake_queue (dev->net);
1102 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1103 unlink_urbs (dev, &dev->rxq);
1104 status = usb_autopm_get_interface(dev->intf);
1107 status = usb_clear_halt (dev->udev, dev->in);
1108 usb_autopm_put_interface(dev->intf);
1111 status != -ESHUTDOWN) {
1112 if (netif_msg_rx_err (dev))
1114 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1117 clear_bit (EVENT_RX_HALT, &dev->flags);
1118 tasklet_schedule (&dev->bh);
1122 /* tasklet could resubmit itself forever if memory is tight */
1123 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1124 struct urb *urb = NULL;
1127 if (netif_running (dev->net))
1128 urb = usb_alloc_urb (0, GFP_KERNEL);
1130 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1132 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1133 status = usb_autopm_get_interface(dev->intf);
1138 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1140 usb_autopm_put_interface(dev->intf);
1143 tasklet_schedule (&dev->bh);
1147 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1148 struct driver_info *info = dev->driver_info;
1151 clear_bit (EVENT_LINK_RESET, &dev->flags);
1152 status = usb_autopm_get_interface(dev->intf);
1155 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1156 usb_autopm_put_interface(dev->intf);
1158 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1160 dev->udev->bus->bus_name,
1164 usb_autopm_put_interface(dev->intf);
1167 /* handle link change from link resetting */
1168 __handle_link_change(dev);
1171 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1172 __handle_link_change(dev);
1174 if (test_bit (EVENT_SET_RX_MODE, &dev->flags))
1175 __handle_set_rx_mode(dev);
1179 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1182 /*-------------------------------------------------------------------------*/
1184 static void tx_complete (struct urb *urb)
1186 struct sk_buff *skb = (struct sk_buff *) urb->context;
1187 struct skb_data *entry = (struct skb_data *) skb->cb;
1188 struct usbnet *dev = entry->dev;
1190 if (urb->status == 0) {
1191 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1192 dev->net->stats.tx_packets++;
1193 dev->net->stats.tx_bytes += entry->length;
1195 dev->net->stats.tx_errors++;
1197 switch (urb->status) {
1199 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1202 /* software-driven interface shutdown */
1203 case -ECONNRESET: // async unlink
1204 case -ESHUTDOWN: // hardware gone
1207 /* like rx, tx gets controller i/o faults during hub_wq
1208 * delays and so it uses the same throttling mechanism.
1213 usb_mark_last_busy(dev->udev);
1214 if (!timer_pending (&dev->delay)) {
1215 mod_timer (&dev->delay,
1216 jiffies + THROTTLE_JIFFIES);
1217 netif_dbg(dev, link, dev->net,
1218 "tx throttle %d\n", urb->status);
1220 netif_stop_queue (dev->net);
1223 netif_dbg(dev, tx_err, dev->net,
1224 "tx err %d\n", entry->urb->status);
1229 usb_autopm_put_interface_async(dev->intf);
1230 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1233 /*-------------------------------------------------------------------------*/
1235 void usbnet_tx_timeout (struct net_device *net)
1237 struct usbnet *dev = netdev_priv(net);
1239 unlink_urbs (dev, &dev->txq);
1240 tasklet_schedule (&dev->bh);
1241 /* this needs to be handled individually because the generic layer
1242 * doesn't know what is sufficient and could not restore private
1243 * information if a remedy of an unconditional reset were used.
1245 if (dev->driver_info->recover)
1246 (dev->driver_info->recover)(dev);
1248 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1250 /*-------------------------------------------------------------------------*/
1252 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1254 unsigned num_sgs, total_len = 0;
1257 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1261 /* reserve one for zero packet */
1262 urb->sg = kmalloc((num_sgs + 1) * sizeof(struct scatterlist),
1267 urb->num_sgs = num_sgs;
1268 sg_init_table(urb->sg, urb->num_sgs + 1);
1270 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1271 total_len += skb_headlen(skb);
1273 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1274 struct skb_frag_struct *f = &skb_shinfo(skb)->frags[i];
1276 total_len += skb_frag_size(f);
1277 sg_set_page(&urb->sg[i + s], f->page.p, f->size,
1280 urb->transfer_buffer_length = total_len;
1285 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1286 struct net_device *net)
1288 struct usbnet *dev = netdev_priv(net);
1290 struct urb *urb = NULL;
1291 struct skb_data *entry;
1292 struct driver_info *info = dev->driver_info;
1293 unsigned long flags;
1297 skb_tx_timestamp(skb);
1299 // some devices want funky USB-level framing, for
1300 // win32 driver (usually) and/or hardware quirks
1301 if (info->tx_fixup) {
1302 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1304 /* packet collected; minidriver waiting for more */
1305 if (info->flags & FLAG_MULTI_PACKET)
1307 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1312 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1313 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1317 entry = (struct skb_data *) skb->cb;
1321 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1322 skb->data, skb->len, tx_complete, skb);
1323 if (dev->can_dma_sg) {
1324 if (build_dma_sg(skb, urb) < 0)
1327 length = urb->transfer_buffer_length;
1329 /* don't assume the hardware handles USB_ZERO_PACKET
1330 * NOTE: strictly conforming cdc-ether devices should expect
1331 * the ZLP here, but ignore the one-byte packet.
1332 * NOTE2: CDC NCM specification is different from CDC ECM when
1333 * handling ZLP/short packets, so cdc_ncm driver will make short
1334 * packet itself if needed.
1336 if (length % dev->maxpacket == 0) {
1337 if (!(info->flags & FLAG_SEND_ZLP)) {
1338 if (!(info->flags & FLAG_MULTI_PACKET)) {
1340 if (skb_tailroom(skb) && !urb->num_sgs) {
1341 skb->data[skb->len] = 0;
1343 } else if (urb->num_sgs)
1344 sg_set_buf(&urb->sg[urb->num_sgs++],
1345 dev->padding_pkt, 1);
1348 urb->transfer_flags |= URB_ZERO_PACKET;
1350 entry->length = urb->transfer_buffer_length = length;
1352 spin_lock_irqsave(&dev->txq.lock, flags);
1353 retval = usb_autopm_get_interface_async(dev->intf);
1355 spin_unlock_irqrestore(&dev->txq.lock, flags);
1360 /* if this triggers the device is still a sleep */
1361 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1362 /* transmission will be done in resume */
1363 usb_anchor_urb(urb, &dev->deferred);
1364 /* no use to process more packets */
1365 netif_stop_queue(net);
1367 spin_unlock_irqrestore(&dev->txq.lock, flags);
1368 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1373 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1375 netif_stop_queue (net);
1376 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1377 usb_autopm_put_interface_async(dev->intf);
1380 usb_autopm_put_interface_async(dev->intf);
1381 netif_dbg(dev, tx_err, dev->net,
1382 "tx: submit urb err %d\n", retval);
1385 net->trans_start = jiffies;
1386 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1387 if (dev->txq.qlen >= TX_QLEN (dev))
1388 netif_stop_queue (net);
1390 spin_unlock_irqrestore (&dev->txq.lock, flags);
1393 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1395 dev->net->stats.tx_dropped++;
1398 dev_kfree_skb_any (skb);
1404 netif_dbg(dev, tx_queued, dev->net,
1405 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1409 return NETDEV_TX_OK;
1411 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1413 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1419 /* don't refill the queue all at once */
1420 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1421 urb = usb_alloc_urb(0, flags);
1423 ret = rx_submit(dev, urb, flags);
1435 /*-------------------------------------------------------------------------*/
1437 // tasklet (work deferred from completions, in_irq) or timer
1439 static void usbnet_bh (unsigned long param)
1441 struct usbnet *dev = (struct usbnet *) param;
1442 struct sk_buff *skb;
1443 struct skb_data *entry;
1445 while ((skb = skb_dequeue (&dev->done))) {
1446 entry = (struct skb_data *) skb->cb;
1447 switch (entry->state) {
1449 entry->state = rx_cleanup;
1450 rx_process (dev, skb);
1453 kfree(entry->urb->sg);
1455 usb_free_urb (entry->urb);
1456 dev_kfree_skb (skb);
1459 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1463 /* restart RX again after disabling due to high error rate */
1464 clear_bit(EVENT_RX_KILL, &dev->flags);
1466 /* waiting for all pending urbs to complete?
1467 * only then can we forgo submitting anew
1469 if (waitqueue_active(&dev->wait)) {
1470 if (dev->txq.qlen + dev->rxq.qlen + dev->done.qlen == 0)
1471 wake_up_all(&dev->wait);
1473 // or are we maybe short a few urbs?
1474 } else if (netif_running (dev->net) &&
1475 netif_device_present (dev->net) &&
1476 netif_carrier_ok(dev->net) &&
1477 !timer_pending (&dev->delay) &&
1478 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1479 int temp = dev->rxq.qlen;
1481 if (temp < RX_QLEN(dev)) {
1482 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1484 if (temp != dev->rxq.qlen)
1485 netif_dbg(dev, link, dev->net,
1486 "rxqlen %d --> %d\n",
1487 temp, dev->rxq.qlen);
1488 if (dev->rxq.qlen < RX_QLEN(dev))
1489 tasklet_schedule (&dev->bh);
1491 if (dev->txq.qlen < TX_QLEN (dev))
1492 netif_wake_queue (dev->net);
1497 /*-------------------------------------------------------------------------
1499 * USB Device Driver support
1501 *-------------------------------------------------------------------------*/
1503 // precondition: never called in_interrupt
1505 void usbnet_disconnect (struct usb_interface *intf)
1508 struct usb_device *xdev;
1509 struct net_device *net;
1511 dev = usb_get_intfdata(intf);
1512 usb_set_intfdata(intf, NULL);
1516 xdev = interface_to_usbdev (intf);
1518 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1519 intf->dev.driver->name,
1520 xdev->bus->bus_name, xdev->devpath,
1521 dev->driver_info->description);
1524 unregister_netdev (net);
1526 cancel_work_sync(&dev->kevent);
1528 usb_scuttle_anchored_urbs(&dev->deferred);
1530 if (dev->driver_info->unbind)
1531 dev->driver_info->unbind (dev, intf);
1533 usb_kill_urb(dev->interrupt);
1534 usb_free_urb(dev->interrupt);
1535 kfree(dev->padding_pkt);
1539 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1541 static const struct net_device_ops usbnet_netdev_ops = {
1542 .ndo_open = usbnet_open,
1543 .ndo_stop = usbnet_stop,
1544 .ndo_start_xmit = usbnet_start_xmit,
1545 .ndo_tx_timeout = usbnet_tx_timeout,
1546 .ndo_set_rx_mode = usbnet_set_rx_mode,
1547 .ndo_change_mtu = usbnet_change_mtu,
1548 .ndo_set_mac_address = eth_mac_addr,
1549 .ndo_validate_addr = eth_validate_addr,
1552 /*-------------------------------------------------------------------------*/
1554 // precondition: never called in_interrupt
1556 static struct device_type wlan_type = {
1560 static struct device_type wwan_type = {
1565 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1568 struct net_device *net;
1569 struct usb_host_interface *interface;
1570 struct driver_info *info;
1571 struct usb_device *xdev;
1574 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1576 /* usbnet already took usb runtime pm, so have to enable the feature
1577 * for usb interface, otherwise usb_autopm_get_interface may return
1578 * failure if RUNTIME_PM is enabled.
1580 if (!driver->supports_autosuspend) {
1581 driver->supports_autosuspend = 1;
1582 pm_runtime_enable(&udev->dev);
1585 name = udev->dev.driver->name;
1586 info = (struct driver_info *) prod->driver_info;
1588 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1591 xdev = interface_to_usbdev (udev);
1592 interface = udev->cur_altsetting;
1596 // set up our own records
1597 net = alloc_etherdev(sizeof(*dev));
1601 /* netdev_printk() needs this so do it as early as possible */
1602 SET_NETDEV_DEV(net, &udev->dev);
1604 dev = netdev_priv(net);
1607 dev->driver_info = info;
1608 dev->driver_name = name;
1609 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1610 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1611 init_waitqueue_head(&dev->wait);
1612 skb_queue_head_init (&dev->rxq);
1613 skb_queue_head_init (&dev->txq);
1614 skb_queue_head_init (&dev->done);
1615 skb_queue_head_init(&dev->rxq_pause);
1616 dev->bh.func = usbnet_bh;
1617 dev->bh.data = (unsigned long) dev;
1618 INIT_WORK (&dev->kevent, kevent);
1619 init_usb_anchor(&dev->deferred);
1620 dev->delay.function = usbnet_bh;
1621 dev->delay.data = (unsigned long) dev;
1622 init_timer (&dev->delay);
1623 mutex_init (&dev->phy_mutex);
1624 mutex_init(&dev->interrupt_mutex);
1625 dev->interrupt_count = 0;
1628 strcpy (net->name, "usb%d");
1629 memcpy (net->dev_addr, node_id, sizeof node_id);
1631 /* rx and tx sides can use different message sizes;
1632 * bind() should set rx_urb_size in that case.
1634 dev->hard_mtu = net->mtu + net->hard_header_len;
1636 // dma_supported() is deeply broken on almost all architectures
1637 // possible with some EHCI controllers
1638 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1639 net->features |= NETIF_F_HIGHDMA;
1642 net->netdev_ops = &usbnet_netdev_ops;
1643 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1644 net->ethtool_ops = &usbnet_ethtool_ops;
1646 // allow device-specific bind/init procedures
1647 // NOTE net->name still not usable ...
1649 status = info->bind (dev, udev);
1653 // heuristic: "usb%d" for links we know are two-host,
1654 // else "eth%d" when there's reasonable doubt. userspace
1655 // can rename the link if it knows better.
1656 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1657 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1658 (net->dev_addr [0] & 0x02) == 0))
1659 strcpy (net->name, "eth%d");
1660 /* WLAN devices should always be named "wlan%d" */
1661 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1662 strcpy(net->name, "wlan%d");
1663 /* WWAN devices should always be named "wwan%d" */
1664 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1665 strcpy(net->name, "wwan%d");
1667 /* devices that cannot do ARP */
1668 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1669 net->flags |= IFF_NOARP;
1671 /* maybe the remote can't receive an Ethernet MTU */
1672 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1673 net->mtu = dev->hard_mtu - net->hard_header_len;
1674 } else if (!info->in || !info->out)
1675 status = usbnet_get_endpoints (dev, udev);
1677 dev->in = usb_rcvbulkpipe (xdev, info->in);
1678 dev->out = usb_sndbulkpipe (xdev, info->out);
1679 if (!(info->flags & FLAG_NO_SETINT))
1680 status = usb_set_interface (xdev,
1681 interface->desc.bInterfaceNumber,
1682 interface->desc.bAlternateSetting);
1687 if (status >= 0 && dev->status)
1688 status = init_status (dev, udev);
1692 if (!dev->rx_urb_size)
1693 dev->rx_urb_size = dev->hard_mtu;
1694 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1696 /* let userspace know we have a random address */
1697 if (ether_addr_equal(net->dev_addr, node_id))
1698 net->addr_assign_type = NET_ADDR_RANDOM;
1700 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1701 SET_NETDEV_DEVTYPE(net, &wlan_type);
1702 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1703 SET_NETDEV_DEVTYPE(net, &wwan_type);
1705 /* initialize max rx_qlen and tx_qlen */
1706 usbnet_update_max_qlen(dev);
1708 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1709 !(info->flags & FLAG_MULTI_PACKET)) {
1710 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1711 if (!dev->padding_pkt) {
1717 status = register_netdev (net);
1720 netif_info(dev, probe, dev->net,
1721 "register '%s' at usb-%s-%s, %s, %pM\n",
1722 udev->dev.driver->name,
1723 xdev->bus->bus_name, xdev->devpath,
1724 dev->driver_info->description,
1727 // ok, it's ready to go.
1728 usb_set_intfdata (udev, dev);
1730 netif_device_attach (net);
1732 if (dev->driver_info->flags & FLAG_LINK_INTR)
1733 usbnet_link_change(dev, 0, 0);
1738 kfree(dev->padding_pkt);
1740 usb_free_urb(dev->interrupt);
1743 info->unbind (dev, udev);
1749 EXPORT_SYMBOL_GPL(usbnet_probe);
1751 /*-------------------------------------------------------------------------*/
1754 * suspend the whole driver as soon as the first interface is suspended
1755 * resume only when the last interface is resumed
1758 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1760 struct usbnet *dev = usb_get_intfdata(intf);
1762 if (!dev->suspend_count++) {
1763 spin_lock_irq(&dev->txq.lock);
1764 /* don't autosuspend while transmitting */
1765 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1766 dev->suspend_count--;
1767 spin_unlock_irq(&dev->txq.lock);
1770 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1771 spin_unlock_irq(&dev->txq.lock);
1774 * accelerate emptying of the rx and queues, to avoid
1775 * having everything error out.
1777 netif_device_detach (dev->net);
1778 usbnet_terminate_urbs(dev);
1779 __usbnet_status_stop_force(dev);
1782 * reattach so runtime management can use and
1785 netif_device_attach (dev->net);
1789 EXPORT_SYMBOL_GPL(usbnet_suspend);
1791 int usbnet_resume (struct usb_interface *intf)
1793 struct usbnet *dev = usb_get_intfdata(intf);
1794 struct sk_buff *skb;
1798 if (!--dev->suspend_count) {
1799 /* resume interrupt URB if it was previously submitted */
1800 __usbnet_status_start_force(dev, GFP_NOIO);
1802 spin_lock_irq(&dev->txq.lock);
1803 while ((res = usb_get_from_anchor(&dev->deferred))) {
1805 skb = (struct sk_buff *)res->context;
1806 retval = usb_submit_urb(res, GFP_ATOMIC);
1808 dev_kfree_skb_any(skb);
1811 usb_autopm_put_interface_async(dev->intf);
1813 dev->net->trans_start = jiffies;
1814 __skb_queue_tail(&dev->txq, skb);
1819 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1820 spin_unlock_irq(&dev->txq.lock);
1822 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1823 /* handle remote wakeup ASAP
1824 * we cannot race against stop
1826 if (netif_device_present(dev->net) &&
1827 !timer_pending(&dev->delay) &&
1828 !test_bit(EVENT_RX_HALT, &dev->flags))
1829 rx_alloc_submit(dev, GFP_NOIO);
1831 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1832 netif_tx_wake_all_queues(dev->net);
1833 tasklet_schedule (&dev->bh);
1837 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1838 usb_autopm_get_interface_no_resume(intf);
1842 EXPORT_SYMBOL_GPL(usbnet_resume);
1845 * Either a subdriver implements manage_power, then it is assumed to always
1846 * be ready to be suspended or it reports the readiness to be suspended
1849 void usbnet_device_suggests_idle(struct usbnet *dev)
1851 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1852 dev->intf->needs_remote_wakeup = 1;
1853 usb_autopm_put_interface_async(dev->intf);
1856 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1859 * For devices that can do without special commands
1861 int usbnet_manage_power(struct usbnet *dev, int on)
1863 dev->intf->needs_remote_wakeup = on;
1866 EXPORT_SYMBOL(usbnet_manage_power);
1868 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1870 /* update link after link is reseted */
1871 if (link && !need_reset)
1872 netif_carrier_on(dev->net);
1874 netif_carrier_off(dev->net);
1876 if (need_reset && link)
1877 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1879 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1881 EXPORT_SYMBOL(usbnet_link_change);
1883 /*-------------------------------------------------------------------------*/
1884 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1885 u16 value, u16 index, void *data, u16 size)
1890 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1891 " value=0x%04x index=0x%04x size=%d\n",
1892 cmd, reqtype, value, index, size);
1895 buf = kmalloc(size, GFP_KERNEL);
1900 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1901 cmd, reqtype, value, index, buf, size,
1902 USB_CTRL_GET_TIMEOUT);
1903 if (err > 0 && err <= size)
1904 memcpy(data, buf, err);
1910 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1911 u16 value, u16 index, const void *data,
1917 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1918 " value=0x%04x index=0x%04x size=%d\n",
1919 cmd, reqtype, value, index, size);
1922 buf = kmemdup(data, size, GFP_KERNEL);
1927 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1928 cmd, reqtype, value, index, buf, size,
1929 USB_CTRL_SET_TIMEOUT);
1937 * The function can't be called inside suspend/resume callback,
1938 * otherwise deadlock will be caused.
1940 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1941 u16 value, u16 index, void *data, u16 size)
1945 if (usb_autopm_get_interface(dev->intf) < 0)
1947 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1949 usb_autopm_put_interface(dev->intf);
1952 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
1955 * The function can't be called inside suspend/resume callback,
1956 * otherwise deadlock will be caused.
1958 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1959 u16 value, u16 index, const void *data, u16 size)
1963 if (usb_autopm_get_interface(dev->intf) < 0)
1965 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1967 usb_autopm_put_interface(dev->intf);
1970 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
1973 * The function can be called inside suspend/resume callback safely
1974 * and should only be called by suspend/resume callback generally.
1976 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1977 u16 value, u16 index, void *data, u16 size)
1979 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1982 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
1985 * The function can be called inside suspend/resume callback safely
1986 * and should only be called by suspend/resume callback generally.
1988 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1989 u16 value, u16 index, const void *data,
1992 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1995 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
1997 static void usbnet_async_cmd_cb(struct urb *urb)
1999 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
2000 int status = urb->status;
2003 dev_dbg(&urb->dev->dev, "%s failed with %d",
2011 * The caller must make sure that device can't be put into suspend
2012 * state until the control URB completes.
2014 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
2015 u16 value, u16 index, const void *data, u16 size)
2017 struct usb_ctrlrequest *req = NULL;
2022 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2023 " value=0x%04x index=0x%04x size=%d\n",
2024 cmd, reqtype, value, index, size);
2026 urb = usb_alloc_urb(0, GFP_ATOMIC);
2028 netdev_err(dev->net, "Error allocating URB in"
2029 " %s!\n", __func__);
2034 buf = kmemdup(data, size, GFP_ATOMIC);
2036 netdev_err(dev->net, "Error allocating buffer"
2037 " in %s!\n", __func__);
2042 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2046 req->bRequestType = reqtype;
2047 req->bRequest = cmd;
2048 req->wValue = cpu_to_le16(value);
2049 req->wIndex = cpu_to_le16(index);
2050 req->wLength = cpu_to_le16(size);
2052 usb_fill_control_urb(urb, dev->udev,
2053 usb_sndctrlpipe(dev->udev, 0),
2054 (void *)req, buf, size,
2055 usbnet_async_cmd_cb, req);
2056 urb->transfer_flags |= URB_FREE_BUFFER;
2058 err = usb_submit_urb(urb, GFP_ATOMIC);
2060 netdev_err(dev->net, "Error submitting the control"
2061 " message: status=%d\n", err);
2075 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2076 /*-------------------------------------------------------------------------*/
2078 static int __init usbnet_init(void)
2080 /* Compiler should optimize this out. */
2082 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
2084 eth_random_addr(node_id);
2087 module_init(usbnet_init);
2089 static void __exit usbnet_exit(void)
2092 module_exit(usbnet_exit);
2094 MODULE_AUTHOR("David Brownell");
2095 MODULE_DESCRIPTION("USB network driver framework");
2096 MODULE_LICENSE("GPL");