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 khubd might disconnect()
73 // us (it polls at HZ/4 usually) before we report too many false errors.
74 #define THROTTLE_JIFFIES (HZ/8)
77 #define UNLINK_TIMEOUT_MS 3
79 /*-------------------------------------------------------------------------*/
81 // randomly generated ethernet address
82 static u8 node_id [ETH_ALEN];
84 static const char driver_name [] = "usbnet";
86 /* use ethtool to change the level for any given device */
87 static int msg_level = -1;
88 module_param (msg_level, int, 0);
89 MODULE_PARM_DESC (msg_level, "Override default message level");
91 /*-------------------------------------------------------------------------*/
93 /* handles CDC Ethernet and many other network "bulk data" interfaces */
94 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
97 struct usb_host_interface *alt = NULL;
98 struct usb_host_endpoint *in = NULL, *out = NULL;
99 struct usb_host_endpoint *status = NULL;
101 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
104 in = out = status = NULL;
105 alt = intf->altsetting + tmp;
107 /* take the first altsetting with in-bulk + out-bulk;
108 * remember any status endpoint, just in case;
109 * ignore other endpoints and altsettings.
111 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
112 struct usb_host_endpoint *e;
115 e = alt->endpoint + ep;
116 switch (e->desc.bmAttributes) {
117 case USB_ENDPOINT_XFER_INT:
118 if (!usb_endpoint_dir_in(&e->desc))
122 case USB_ENDPOINT_XFER_BULK:
127 if (usb_endpoint_dir_in(&e->desc)) {
130 else if (intr && !status)
140 if (!alt || !in || !out)
143 if (alt->desc.bAlternateSetting != 0 ||
144 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
145 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
146 alt->desc.bAlternateSetting);
151 dev->in = usb_rcvbulkpipe (dev->udev,
152 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
153 dev->out = usb_sndbulkpipe (dev->udev,
154 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
155 dev->status = status;
158 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
160 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
163 unsigned char buf [13];
165 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
167 dev_dbg(&dev->udev->dev,
168 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
173 for (i = tmp = 0; i < 6; i++, tmp += 2)
174 dev->net->dev_addr [i] =
175 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
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 khubd disconnect() delays.
599 * throttle down resubmits, to avoid log floods; just temporarily,
600 * so we still recover when the fault isn't a khubd 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_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
756 DECLARE_WAITQUEUE(wait, current);
759 /* ensure there are no more active urbs */
760 add_wait_queue(&unlink_wakeup, &wait);
761 set_current_state(TASK_UNINTERRUPTIBLE);
762 dev->wait = &unlink_wakeup;
763 temp = unlink_urbs(dev, &dev->txq) +
764 unlink_urbs(dev, &dev->rxq);
766 /* maybe wait for deletions to finish. */
767 while (!skb_queue_empty(&dev->rxq)
768 && !skb_queue_empty(&dev->txq)
769 && !skb_queue_empty(&dev->done)) {
770 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
771 set_current_state(TASK_UNINTERRUPTIBLE);
772 netif_dbg(dev, ifdown, dev->net,
773 "waited for %d urb completions\n", temp);
775 set_current_state(TASK_RUNNING);
777 remove_wait_queue(&unlink_wakeup, &wait);
780 int usbnet_stop (struct net_device *net)
782 struct usbnet *dev = netdev_priv(net);
783 struct driver_info *info = dev->driver_info;
786 clear_bit(EVENT_DEV_OPEN, &dev->flags);
787 netif_stop_queue (net);
789 netif_info(dev, ifdown, dev->net,
790 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
791 net->stats.rx_packets, net->stats.tx_packets,
792 net->stats.rx_errors, net->stats.tx_errors);
794 /* allow minidriver to stop correctly (wireless devices to turn off
797 retval = info->stop(dev);
799 netif_info(dev, ifdown, dev->net,
800 "stop fail (%d) usbnet usb-%s-%s, %s\n",
802 dev->udev->bus->bus_name, dev->udev->devpath,
806 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
807 usbnet_terminate_urbs(dev);
809 usbnet_status_stop(dev);
811 usbnet_purge_paused_rxq(dev);
813 /* deferred work (task, timer, softirq) must also stop.
814 * can't flush_scheduled_work() until we drop rtnl (later),
815 * else workers could deadlock; so make workers a NOP.
818 del_timer_sync (&dev->delay);
819 tasklet_kill (&dev->bh);
820 if (info->manage_power &&
821 !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags))
822 info->manage_power(dev, 0);
824 usb_autopm_put_interface(dev->intf);
828 EXPORT_SYMBOL_GPL(usbnet_stop);
830 /*-------------------------------------------------------------------------*/
832 // posts reads, and enables write queuing
834 // precondition: never called in_interrupt
836 int usbnet_open (struct net_device *net)
838 struct usbnet *dev = netdev_priv(net);
840 struct driver_info *info = dev->driver_info;
842 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
843 netif_info(dev, ifup, dev->net,
844 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
846 dev->udev->bus->bus_name,
852 // put into "known safe" state
853 if (info->reset && (retval = info->reset (dev)) < 0) {
854 netif_info(dev, ifup, dev->net,
855 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
857 dev->udev->bus->bus_name,
863 /* hard_mtu or rx_urb_size may change in reset() */
864 usbnet_update_max_qlen(dev);
866 // insist peer be connected
867 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
868 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
872 /* start any status interrupt transfer */
873 if (dev->interrupt) {
874 retval = usbnet_status_start(dev, GFP_KERNEL);
876 netif_err(dev, ifup, dev->net,
877 "intr submit %d\n", retval);
882 set_bit(EVENT_DEV_OPEN, &dev->flags);
883 netif_start_queue (net);
884 netif_info(dev, ifup, dev->net,
885 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
886 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
888 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
889 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
890 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
891 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
892 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
895 /* reset rx error state */
898 clear_bit(EVENT_RX_KILL, &dev->flags);
900 // delay posting reads until we're fully open
901 tasklet_schedule (&dev->bh);
902 if (info->manage_power) {
903 retval = info->manage_power(dev, 1);
906 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
908 usb_autopm_put_interface(dev->intf);
913 usb_autopm_put_interface(dev->intf);
917 EXPORT_SYMBOL_GPL(usbnet_open);
919 /*-------------------------------------------------------------------------*/
921 /* ethtool methods; minidrivers may need to add some more, but
922 * they'll probably want to use this base set.
925 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
927 struct usbnet *dev = netdev_priv(net);
929 if (!dev->mii.mdio_read)
932 return mii_ethtool_gset(&dev->mii, cmd);
934 EXPORT_SYMBOL_GPL(usbnet_get_settings);
936 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
938 struct usbnet *dev = netdev_priv(net);
941 if (!dev->mii.mdio_write)
944 retval = mii_ethtool_sset(&dev->mii, cmd);
946 /* link speed/duplex might have changed */
947 if (dev->driver_info->link_reset)
948 dev->driver_info->link_reset(dev);
950 /* hard_mtu or rx_urb_size may change in link_reset() */
951 usbnet_update_max_qlen(dev);
956 EXPORT_SYMBOL_GPL(usbnet_set_settings);
958 u32 usbnet_get_link (struct net_device *net)
960 struct usbnet *dev = netdev_priv(net);
962 /* If a check_connect is defined, return its result */
963 if (dev->driver_info->check_connect)
964 return dev->driver_info->check_connect (dev) == 0;
966 /* if the device has mii operations, use those */
967 if (dev->mii.mdio_read)
968 return mii_link_ok(&dev->mii);
970 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
971 return ethtool_op_get_link(net);
973 EXPORT_SYMBOL_GPL(usbnet_get_link);
975 int usbnet_nway_reset(struct net_device *net)
977 struct usbnet *dev = netdev_priv(net);
979 if (!dev->mii.mdio_write)
982 return mii_nway_restart(&dev->mii);
984 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
986 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
988 struct usbnet *dev = netdev_priv(net);
990 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
991 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
992 strlcpy (info->fw_version, dev->driver_info->description,
993 sizeof info->fw_version);
994 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
996 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
998 u32 usbnet_get_msglevel (struct net_device *net)
1000 struct usbnet *dev = netdev_priv(net);
1002 return dev->msg_enable;
1004 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1006 void usbnet_set_msglevel (struct net_device *net, u32 level)
1008 struct usbnet *dev = netdev_priv(net);
1010 dev->msg_enable = level;
1012 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1014 /* drivers may override default ethtool_ops in their bind() routine */
1015 static const struct ethtool_ops usbnet_ethtool_ops = {
1016 .get_settings = usbnet_get_settings,
1017 .set_settings = usbnet_set_settings,
1018 .get_link = usbnet_get_link,
1019 .nway_reset = usbnet_nway_reset,
1020 .get_drvinfo = usbnet_get_drvinfo,
1021 .get_msglevel = usbnet_get_msglevel,
1022 .set_msglevel = usbnet_set_msglevel,
1023 .get_ts_info = ethtool_op_get_ts_info,
1026 /*-------------------------------------------------------------------------*/
1028 static void __handle_link_change(struct usbnet *dev)
1030 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1033 if (!netif_carrier_ok(dev->net)) {
1034 /* kill URBs for reading packets to save bus bandwidth */
1035 unlink_urbs(dev, &dev->rxq);
1038 * tx_timeout will unlink URBs for sending packets and
1039 * tx queue is stopped by netcore after link becomes off
1042 /* submitting URBs for reading packets */
1043 tasklet_schedule(&dev->bh);
1046 /* hard_mtu or rx_urb_size may change during link change */
1047 usbnet_update_max_qlen(dev);
1049 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1052 /* work that cannot be done in interrupt context uses keventd.
1054 * NOTE: with 2.5 we could do more of this using completion callbacks,
1055 * especially now that control transfers can be queued.
1058 kevent (struct work_struct *work)
1060 struct usbnet *dev =
1061 container_of(work, struct usbnet, kevent);
1064 /* usb_clear_halt() needs a thread context */
1065 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1066 unlink_urbs (dev, &dev->txq);
1067 status = usb_autopm_get_interface(dev->intf);
1070 status = usb_clear_halt (dev->udev, dev->out);
1071 usb_autopm_put_interface(dev->intf);
1074 status != -ESHUTDOWN) {
1075 if (netif_msg_tx_err (dev))
1077 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1080 clear_bit (EVENT_TX_HALT, &dev->flags);
1081 if (status != -ESHUTDOWN)
1082 netif_wake_queue (dev->net);
1085 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1086 unlink_urbs (dev, &dev->rxq);
1087 status = usb_autopm_get_interface(dev->intf);
1090 status = usb_clear_halt (dev->udev, dev->in);
1091 usb_autopm_put_interface(dev->intf);
1094 status != -ESHUTDOWN) {
1095 if (netif_msg_rx_err (dev))
1097 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1100 clear_bit (EVENT_RX_HALT, &dev->flags);
1101 tasklet_schedule (&dev->bh);
1105 /* tasklet could resubmit itself forever if memory is tight */
1106 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1107 struct urb *urb = NULL;
1110 if (netif_running (dev->net))
1111 urb = usb_alloc_urb (0, GFP_KERNEL);
1113 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1115 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1116 status = usb_autopm_get_interface(dev->intf);
1121 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1123 usb_autopm_put_interface(dev->intf);
1126 tasklet_schedule (&dev->bh);
1130 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1131 struct driver_info *info = dev->driver_info;
1134 clear_bit (EVENT_LINK_RESET, &dev->flags);
1135 status = usb_autopm_get_interface(dev->intf);
1138 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1139 usb_autopm_put_interface(dev->intf);
1141 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1143 dev->udev->bus->bus_name,
1147 usb_autopm_put_interface(dev->intf);
1150 /* handle link change from link resetting */
1151 __handle_link_change(dev);
1154 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1155 __handle_link_change(dev);
1158 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1161 /*-------------------------------------------------------------------------*/
1163 static void tx_complete (struct urb *urb)
1165 struct sk_buff *skb = (struct sk_buff *) urb->context;
1166 struct skb_data *entry = (struct skb_data *) skb->cb;
1167 struct usbnet *dev = entry->dev;
1169 if (urb->status == 0) {
1170 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1171 dev->net->stats.tx_packets++;
1172 dev->net->stats.tx_bytes += entry->length;
1174 dev->net->stats.tx_errors++;
1176 switch (urb->status) {
1178 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1181 /* software-driven interface shutdown */
1182 case -ECONNRESET: // async unlink
1183 case -ESHUTDOWN: // hardware gone
1186 // like rx, tx gets controller i/o faults during khubd delays
1187 // and so it uses the same throttling mechanism.
1191 usb_mark_last_busy(dev->udev);
1192 if (!timer_pending (&dev->delay)) {
1193 mod_timer (&dev->delay,
1194 jiffies + THROTTLE_JIFFIES);
1195 netif_dbg(dev, link, dev->net,
1196 "tx throttle %d\n", urb->status);
1198 netif_stop_queue (dev->net);
1201 netif_dbg(dev, tx_err, dev->net,
1202 "tx err %d\n", entry->urb->status);
1207 usb_autopm_put_interface_async(dev->intf);
1208 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1211 /*-------------------------------------------------------------------------*/
1213 void usbnet_tx_timeout (struct net_device *net)
1215 struct usbnet *dev = netdev_priv(net);
1217 unlink_urbs (dev, &dev->txq);
1218 tasklet_schedule (&dev->bh);
1220 // FIXME: device recovery -- reset?
1222 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1224 /*-------------------------------------------------------------------------*/
1226 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1228 unsigned num_sgs, total_len = 0;
1231 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1235 /* reserve one for zero packet */
1236 urb->sg = kmalloc((num_sgs + 1) * sizeof(struct scatterlist),
1241 urb->num_sgs = num_sgs;
1242 sg_init_table(urb->sg, urb->num_sgs + 1);
1244 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1245 total_len += skb_headlen(skb);
1247 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1248 struct skb_frag_struct *f = &skb_shinfo(skb)->frags[i];
1250 total_len += skb_frag_size(f);
1251 sg_set_page(&urb->sg[i + s], f->page.p, f->size,
1254 urb->transfer_buffer_length = total_len;
1259 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1260 struct net_device *net)
1262 struct usbnet *dev = netdev_priv(net);
1264 struct urb *urb = NULL;
1265 struct skb_data *entry;
1266 struct driver_info *info = dev->driver_info;
1267 unsigned long flags;
1271 skb_tx_timestamp(skb);
1273 // some devices want funky USB-level framing, for
1274 // win32 driver (usually) and/or hardware quirks
1275 if (info->tx_fixup) {
1276 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1278 /* packet collected; minidriver waiting for more */
1279 if (info->flags & FLAG_MULTI_PACKET)
1281 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1286 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1287 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1291 entry = (struct skb_data *) skb->cb;
1295 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1296 skb->data, skb->len, tx_complete, skb);
1297 if (dev->can_dma_sg) {
1298 if (build_dma_sg(skb, urb) < 0)
1301 length = urb->transfer_buffer_length;
1303 /* don't assume the hardware handles USB_ZERO_PACKET
1304 * NOTE: strictly conforming cdc-ether devices should expect
1305 * the ZLP here, but ignore the one-byte packet.
1306 * NOTE2: CDC NCM specification is different from CDC ECM when
1307 * handling ZLP/short packets, so cdc_ncm driver will make short
1308 * packet itself if needed.
1310 if (length % dev->maxpacket == 0) {
1311 if (!(info->flags & FLAG_SEND_ZLP)) {
1312 if (!(info->flags & FLAG_MULTI_PACKET)) {
1314 if (skb_tailroom(skb) && !urb->num_sgs) {
1315 skb->data[skb->len] = 0;
1317 } else if (urb->num_sgs)
1318 sg_set_buf(&urb->sg[urb->num_sgs++],
1319 dev->padding_pkt, 1);
1322 urb->transfer_flags |= URB_ZERO_PACKET;
1324 entry->length = urb->transfer_buffer_length = length;
1326 spin_lock_irqsave(&dev->txq.lock, flags);
1327 retval = usb_autopm_get_interface_async(dev->intf);
1329 spin_unlock_irqrestore(&dev->txq.lock, flags);
1334 /* if this triggers the device is still a sleep */
1335 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1336 /* transmission will be done in resume */
1337 usb_anchor_urb(urb, &dev->deferred);
1338 /* no use to process more packets */
1339 netif_stop_queue(net);
1341 spin_unlock_irqrestore(&dev->txq.lock, flags);
1342 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1347 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1349 netif_stop_queue (net);
1350 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1351 usb_autopm_put_interface_async(dev->intf);
1354 usb_autopm_put_interface_async(dev->intf);
1355 netif_dbg(dev, tx_err, dev->net,
1356 "tx: submit urb err %d\n", retval);
1359 net->trans_start = jiffies;
1360 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1361 if (dev->txq.qlen >= TX_QLEN (dev))
1362 netif_stop_queue (net);
1364 spin_unlock_irqrestore (&dev->txq.lock, flags);
1367 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1369 dev->net->stats.tx_dropped++;
1372 dev_kfree_skb_any (skb);
1378 netif_dbg(dev, tx_queued, dev->net,
1379 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1383 return NETDEV_TX_OK;
1385 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1387 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1393 /* don't refill the queue all at once */
1394 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1395 urb = usb_alloc_urb(0, flags);
1397 ret = rx_submit(dev, urb, flags);
1409 /*-------------------------------------------------------------------------*/
1411 // tasklet (work deferred from completions, in_irq) or timer
1413 static void usbnet_bh (unsigned long param)
1415 struct usbnet *dev = (struct usbnet *) param;
1416 struct sk_buff *skb;
1417 struct skb_data *entry;
1419 while ((skb = skb_dequeue (&dev->done))) {
1420 entry = (struct skb_data *) skb->cb;
1421 switch (entry->state) {
1423 entry->state = rx_cleanup;
1424 rx_process (dev, skb);
1427 kfree(entry->urb->sg);
1429 usb_free_urb (entry->urb);
1430 dev_kfree_skb (skb);
1433 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1437 /* restart RX again after disabling due to high error rate */
1438 clear_bit(EVENT_RX_KILL, &dev->flags);
1440 // waiting for all pending urbs to complete?
1442 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1443 wake_up (dev->wait);
1446 // or are we maybe short a few urbs?
1447 } else if (netif_running (dev->net) &&
1448 netif_device_present (dev->net) &&
1449 netif_carrier_ok(dev->net) &&
1450 !timer_pending (&dev->delay) &&
1451 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1452 int temp = dev->rxq.qlen;
1454 if (temp < RX_QLEN(dev)) {
1455 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1457 if (temp != dev->rxq.qlen)
1458 netif_dbg(dev, link, dev->net,
1459 "rxqlen %d --> %d\n",
1460 temp, dev->rxq.qlen);
1461 if (dev->rxq.qlen < RX_QLEN(dev))
1462 tasklet_schedule (&dev->bh);
1464 if (dev->txq.qlen < TX_QLEN (dev))
1465 netif_wake_queue (dev->net);
1470 /*-------------------------------------------------------------------------
1472 * USB Device Driver support
1474 *-------------------------------------------------------------------------*/
1476 // precondition: never called in_interrupt
1478 void usbnet_disconnect (struct usb_interface *intf)
1481 struct usb_device *xdev;
1482 struct net_device *net;
1484 dev = usb_get_intfdata(intf);
1485 usb_set_intfdata(intf, NULL);
1489 xdev = interface_to_usbdev (intf);
1491 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1492 intf->dev.driver->name,
1493 xdev->bus->bus_name, xdev->devpath,
1494 dev->driver_info->description);
1497 unregister_netdev (net);
1499 cancel_work_sync(&dev->kevent);
1501 usb_scuttle_anchored_urbs(&dev->deferred);
1503 if (dev->driver_info->unbind)
1504 dev->driver_info->unbind (dev, intf);
1506 usb_kill_urb(dev->interrupt);
1507 usb_free_urb(dev->interrupt);
1508 kfree(dev->padding_pkt);
1512 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1514 static const struct net_device_ops usbnet_netdev_ops = {
1515 .ndo_open = usbnet_open,
1516 .ndo_stop = usbnet_stop,
1517 .ndo_start_xmit = usbnet_start_xmit,
1518 .ndo_tx_timeout = usbnet_tx_timeout,
1519 .ndo_change_mtu = usbnet_change_mtu,
1520 .ndo_set_mac_address = eth_mac_addr,
1521 .ndo_validate_addr = eth_validate_addr,
1524 /*-------------------------------------------------------------------------*/
1526 // precondition: never called in_interrupt
1528 static struct device_type wlan_type = {
1532 static struct device_type wwan_type = {
1537 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1540 struct net_device *net;
1541 struct usb_host_interface *interface;
1542 struct driver_info *info;
1543 struct usb_device *xdev;
1546 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1548 /* usbnet already took usb runtime pm, so have to enable the feature
1549 * for usb interface, otherwise usb_autopm_get_interface may return
1550 * failure if RUNTIME_PM is enabled.
1552 if (!driver->supports_autosuspend) {
1553 driver->supports_autosuspend = 1;
1554 pm_runtime_enable(&udev->dev);
1557 name = udev->dev.driver->name;
1558 info = (struct driver_info *) prod->driver_info;
1560 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1563 xdev = interface_to_usbdev (udev);
1564 interface = udev->cur_altsetting;
1568 // set up our own records
1569 net = alloc_etherdev(sizeof(*dev));
1573 /* netdev_printk() needs this so do it as early as possible */
1574 SET_NETDEV_DEV(net, &udev->dev);
1576 dev = netdev_priv(net);
1579 dev->driver_info = info;
1580 dev->driver_name = name;
1581 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1582 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1583 skb_queue_head_init (&dev->rxq);
1584 skb_queue_head_init (&dev->txq);
1585 skb_queue_head_init (&dev->done);
1586 skb_queue_head_init(&dev->rxq_pause);
1587 dev->bh.func = usbnet_bh;
1588 dev->bh.data = (unsigned long) dev;
1589 INIT_WORK (&dev->kevent, kevent);
1590 init_usb_anchor(&dev->deferred);
1591 dev->delay.function = usbnet_bh;
1592 dev->delay.data = (unsigned long) dev;
1593 init_timer (&dev->delay);
1594 mutex_init (&dev->phy_mutex);
1595 mutex_init(&dev->interrupt_mutex);
1596 dev->interrupt_count = 0;
1599 strcpy (net->name, "usb%d");
1600 memcpy (net->dev_addr, node_id, sizeof node_id);
1602 /* rx and tx sides can use different message sizes;
1603 * bind() should set rx_urb_size in that case.
1605 dev->hard_mtu = net->mtu + net->hard_header_len;
1607 // dma_supported() is deeply broken on almost all architectures
1608 // possible with some EHCI controllers
1609 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1610 net->features |= NETIF_F_HIGHDMA;
1613 net->netdev_ops = &usbnet_netdev_ops;
1614 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1615 net->ethtool_ops = &usbnet_ethtool_ops;
1617 // allow device-specific bind/init procedures
1618 // NOTE net->name still not usable ...
1620 status = info->bind (dev, udev);
1624 // heuristic: "usb%d" for links we know are two-host,
1625 // else "eth%d" when there's reasonable doubt. userspace
1626 // can rename the link if it knows better.
1627 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1628 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1629 (net->dev_addr [0] & 0x02) == 0))
1630 strcpy (net->name, "eth%d");
1631 /* WLAN devices should always be named "wlan%d" */
1632 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1633 strcpy(net->name, "wlan%d");
1634 /* WWAN devices should always be named "wwan%d" */
1635 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1636 strcpy(net->name, "wwan%d");
1638 /* devices that cannot do ARP */
1639 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1640 net->flags |= IFF_NOARP;
1642 /* maybe the remote can't receive an Ethernet MTU */
1643 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1644 net->mtu = dev->hard_mtu - net->hard_header_len;
1645 } else if (!info->in || !info->out)
1646 status = usbnet_get_endpoints (dev, udev);
1648 dev->in = usb_rcvbulkpipe (xdev, info->in);
1649 dev->out = usb_sndbulkpipe (xdev, info->out);
1650 if (!(info->flags & FLAG_NO_SETINT))
1651 status = usb_set_interface (xdev,
1652 interface->desc.bInterfaceNumber,
1653 interface->desc.bAlternateSetting);
1658 if (status >= 0 && dev->status)
1659 status = init_status (dev, udev);
1663 if (!dev->rx_urb_size)
1664 dev->rx_urb_size = dev->hard_mtu;
1665 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1667 /* let userspace know we have a random address */
1668 if (ether_addr_equal(net->dev_addr, node_id))
1669 net->addr_assign_type = NET_ADDR_RANDOM;
1671 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1672 SET_NETDEV_DEVTYPE(net, &wlan_type);
1673 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1674 SET_NETDEV_DEVTYPE(net, &wwan_type);
1676 /* initialize max rx_qlen and tx_qlen */
1677 usbnet_update_max_qlen(dev);
1679 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1680 !(info->flags & FLAG_MULTI_PACKET)) {
1681 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1682 if (!dev->padding_pkt) {
1688 status = register_netdev (net);
1691 netif_info(dev, probe, dev->net,
1692 "register '%s' at usb-%s-%s, %s, %pM\n",
1693 udev->dev.driver->name,
1694 xdev->bus->bus_name, xdev->devpath,
1695 dev->driver_info->description,
1698 // ok, it's ready to go.
1699 usb_set_intfdata (udev, dev);
1701 netif_device_attach (net);
1703 if (dev->driver_info->flags & FLAG_LINK_INTR)
1704 usbnet_link_change(dev, 0, 0);
1709 kfree(dev->padding_pkt);
1711 usb_free_urb(dev->interrupt);
1714 info->unbind (dev, udev);
1720 EXPORT_SYMBOL_GPL(usbnet_probe);
1722 /*-------------------------------------------------------------------------*/
1725 * suspend the whole driver as soon as the first interface is suspended
1726 * resume only when the last interface is resumed
1729 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1731 struct usbnet *dev = usb_get_intfdata(intf);
1733 if (!dev->suspend_count++) {
1734 spin_lock_irq(&dev->txq.lock);
1735 /* don't autosuspend while transmitting */
1736 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1737 dev->suspend_count--;
1738 spin_unlock_irq(&dev->txq.lock);
1741 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1742 spin_unlock_irq(&dev->txq.lock);
1745 * accelerate emptying of the rx and queues, to avoid
1746 * having everything error out.
1748 netif_device_detach (dev->net);
1749 usbnet_terminate_urbs(dev);
1750 __usbnet_status_stop_force(dev);
1753 * reattach so runtime management can use and
1756 netif_device_attach (dev->net);
1760 EXPORT_SYMBOL_GPL(usbnet_suspend);
1762 int usbnet_resume (struct usb_interface *intf)
1764 struct usbnet *dev = usb_get_intfdata(intf);
1765 struct sk_buff *skb;
1769 if (!--dev->suspend_count) {
1770 /* resume interrupt URB if it was previously submitted */
1771 __usbnet_status_start_force(dev, GFP_NOIO);
1773 spin_lock_irq(&dev->txq.lock);
1774 while ((res = usb_get_from_anchor(&dev->deferred))) {
1776 skb = (struct sk_buff *)res->context;
1777 retval = usb_submit_urb(res, GFP_ATOMIC);
1779 dev_kfree_skb_any(skb);
1782 usb_autopm_put_interface_async(dev->intf);
1784 dev->net->trans_start = jiffies;
1785 __skb_queue_tail(&dev->txq, skb);
1790 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1791 spin_unlock_irq(&dev->txq.lock);
1793 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1794 /* handle remote wakeup ASAP */
1796 netif_device_present(dev->net) &&
1797 !timer_pending(&dev->delay) &&
1798 !test_bit(EVENT_RX_HALT, &dev->flags))
1799 rx_alloc_submit(dev, GFP_NOIO);
1801 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1802 netif_tx_wake_all_queues(dev->net);
1803 tasklet_schedule (&dev->bh);
1807 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1808 usb_autopm_get_interface_no_resume(intf);
1812 EXPORT_SYMBOL_GPL(usbnet_resume);
1815 * Either a subdriver implements manage_power, then it is assumed to always
1816 * be ready to be suspended or it reports the readiness to be suspended
1819 void usbnet_device_suggests_idle(struct usbnet *dev)
1821 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1822 dev->intf->needs_remote_wakeup = 1;
1823 usb_autopm_put_interface_async(dev->intf);
1826 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1829 * For devices that can do without special commands
1831 int usbnet_manage_power(struct usbnet *dev, int on)
1833 dev->intf->needs_remote_wakeup = on;
1836 EXPORT_SYMBOL(usbnet_manage_power);
1838 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1840 /* update link after link is reseted */
1841 if (link && !need_reset)
1842 netif_carrier_on(dev->net);
1844 netif_carrier_off(dev->net);
1846 if (need_reset && link)
1847 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1849 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1851 EXPORT_SYMBOL(usbnet_link_change);
1853 /*-------------------------------------------------------------------------*/
1854 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1855 u16 value, u16 index, void *data, u16 size)
1860 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1861 " value=0x%04x index=0x%04x size=%d\n",
1862 cmd, reqtype, value, index, size);
1865 buf = kmalloc(size, GFP_KERNEL);
1870 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1871 cmd, reqtype, value, index, buf, size,
1872 USB_CTRL_GET_TIMEOUT);
1873 if (err > 0 && err <= size)
1874 memcpy(data, buf, err);
1880 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1881 u16 value, u16 index, const void *data,
1887 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1888 " value=0x%04x index=0x%04x size=%d\n",
1889 cmd, reqtype, value, index, size);
1892 buf = kmemdup(data, size, GFP_KERNEL);
1897 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1898 cmd, reqtype, value, index, buf, size,
1899 USB_CTRL_SET_TIMEOUT);
1907 * The function can't be called inside suspend/resume callback,
1908 * otherwise deadlock will be caused.
1910 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1911 u16 value, u16 index, void *data, u16 size)
1915 if (usb_autopm_get_interface(dev->intf) < 0)
1917 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1919 usb_autopm_put_interface(dev->intf);
1922 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
1925 * The function can't be called inside suspend/resume callback,
1926 * otherwise deadlock will be caused.
1928 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1929 u16 value, u16 index, const void *data, u16 size)
1933 if (usb_autopm_get_interface(dev->intf) < 0)
1935 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1937 usb_autopm_put_interface(dev->intf);
1940 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
1943 * The function can be called inside suspend/resume callback safely
1944 * and should only be called by suspend/resume callback generally.
1946 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1947 u16 value, u16 index, void *data, u16 size)
1949 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1952 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
1955 * The function can be called inside suspend/resume callback safely
1956 * and should only be called by suspend/resume callback generally.
1958 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1959 u16 value, u16 index, const void *data,
1962 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1965 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
1967 static void usbnet_async_cmd_cb(struct urb *urb)
1969 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
1970 int status = urb->status;
1973 dev_dbg(&urb->dev->dev, "%s failed with %d",
1981 * The caller must make sure that device can't be put into suspend
1982 * state until the control URB completes.
1984 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
1985 u16 value, u16 index, const void *data, u16 size)
1987 struct usb_ctrlrequest *req = NULL;
1992 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1993 " value=0x%04x index=0x%04x size=%d\n",
1994 cmd, reqtype, value, index, size);
1996 urb = usb_alloc_urb(0, GFP_ATOMIC);
1998 netdev_err(dev->net, "Error allocating URB in"
1999 " %s!\n", __func__);
2004 buf = kmemdup(data, size, GFP_ATOMIC);
2006 netdev_err(dev->net, "Error allocating buffer"
2007 " in %s!\n", __func__);
2012 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2016 req->bRequestType = reqtype;
2017 req->bRequest = cmd;
2018 req->wValue = cpu_to_le16(value);
2019 req->wIndex = cpu_to_le16(index);
2020 req->wLength = cpu_to_le16(size);
2022 usb_fill_control_urb(urb, dev->udev,
2023 usb_sndctrlpipe(dev->udev, 0),
2024 (void *)req, buf, size,
2025 usbnet_async_cmd_cb, req);
2026 urb->transfer_flags |= URB_FREE_BUFFER;
2028 err = usb_submit_urb(urb, GFP_ATOMIC);
2030 netdev_err(dev->net, "Error submitting the control"
2031 " message: status=%d\n", err);
2045 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2046 /*-------------------------------------------------------------------------*/
2048 static int __init usbnet_init(void)
2050 /* Compiler should optimize this out. */
2052 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
2054 eth_random_addr(node_id);
2057 module_init(usbnet_init);
2059 static void __exit usbnet_exit(void)
2062 module_exit(usbnet_exit);
2064 MODULE_AUTHOR("David Brownell");
2065 MODULE_DESCRIPTION("USB network driver framework");
2066 MODULE_LICENSE("GPL");