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, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * This is a generic "USB networking" framework that works with several
23 * kinds of full and high speed networking devices: host-to-host cables,
24 * smart usb peripherals, and actual Ethernet adapters.
26 * These devices usually differ in terms of control protocols (if they
27 * even have one!) and sometimes they define new framing to wrap or batch
28 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
29 * so interface (un)binding, endpoint I/O queues, fault handling, and other
30 * issues can usefully be addressed by this framework.
33 // #define DEBUG // error path messages, extra info
34 // #define VERBOSE // more; success messages
36 #include <linux/module.h>
37 #include <linux/init.h>
38 #include <linux/netdevice.h>
39 #include <linux/etherdevice.h>
40 #include <linux/ctype.h>
41 #include <linux/ethtool.h>
42 #include <linux/workqueue.h>
43 #include <linux/mii.h>
44 #include <linux/usb.h>
45 #include <linux/usb/usbnet.h>
46 #include <linux/slab.h>
47 #include <linux/kernel.h>
48 #include <linux/pm_runtime.h>
50 #define DRIVER_VERSION "22-Aug-2005"
53 /*-------------------------------------------------------------------------*/
56 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
57 * Several dozen bytes of IPv4 data can fit in two such transactions.
58 * One maximum size Ethernet packet takes twenty four of them.
59 * For high speed, each frame comfortably fits almost 36 max size
60 * Ethernet packets (so queues should be bigger).
62 * The goal is to let the USB host controller be busy for 5msec or
63 * more before an irq is required, under load. Jumbograms change
66 #define MAX_QUEUE_MEMORY (60 * 1518)
67 #define RX_QLEN(dev) ((dev)->rx_qlen)
68 #define TX_QLEN(dev) ((dev)->tx_qlen)
70 // reawaken network queue this soon after stopping; else watchdog barks
71 #define TX_TIMEOUT_JIFFIES (5*HZ)
73 // throttle rx/tx briefly after some faults, so khubd might disconnect()
74 // 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 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
168 dev_dbg(&dev->udev->dev,
169 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
174 for (i = tmp = 0; i < 6; i++, tmp += 2)
175 dev->net->dev_addr [i] =
176 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
179 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
181 static void intr_complete (struct urb *urb)
183 struct usbnet *dev = urb->context;
184 int status = urb->status;
189 dev->driver_info->status(dev, urb);
192 /* software-driven interface shutdown */
193 case -ENOENT: /* urb killed */
194 case -ESHUTDOWN: /* hardware gone */
195 netif_dbg(dev, ifdown, dev->net,
196 "intr shutdown, code %d\n", status);
199 /* NOTE: not throttling like RX/TX, since this endpoint
200 * already polls infrequently
203 netdev_dbg(dev->net, "intr status %d\n", status);
207 if (!netif_running (dev->net))
210 status = usb_submit_urb (urb, GFP_ATOMIC);
212 netif_err(dev, timer, dev->net,
213 "intr resubmit --> %d\n", status);
216 static int init_status (struct usbnet *dev, struct usb_interface *intf)
223 if (!dev->driver_info->status)
226 pipe = usb_rcvintpipe (dev->udev,
227 dev->status->desc.bEndpointAddress
228 & USB_ENDPOINT_NUMBER_MASK);
229 maxp = usb_maxpacket (dev->udev, pipe, 0);
231 /* avoid 1 msec chatter: min 8 msec poll rate */
232 period = max ((int) dev->status->desc.bInterval,
233 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
235 buf = kmalloc (maxp, GFP_KERNEL);
237 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
238 if (!dev->interrupt) {
242 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
243 buf, maxp, intr_complete, dev, period);
244 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
246 "status ep%din, %d bytes period %d\n",
247 usb_pipeendpoint(pipe), maxp, period);
253 /* Submit the interrupt URB if not previously submitted, increasing refcount */
254 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
258 WARN_ON_ONCE(dev->interrupt == NULL);
259 if (dev->interrupt) {
260 mutex_lock(&dev->interrupt_mutex);
262 if (++dev->interrupt_count == 1)
263 ret = usb_submit_urb(dev->interrupt, mem_flags);
265 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
266 dev->interrupt_count);
267 mutex_unlock(&dev->interrupt_mutex);
271 EXPORT_SYMBOL_GPL(usbnet_status_start);
273 /* For resume; submit interrupt URB if previously submitted */
274 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
278 mutex_lock(&dev->interrupt_mutex);
279 if (dev->interrupt_count) {
280 ret = usb_submit_urb(dev->interrupt, mem_flags);
281 dev_dbg(&dev->udev->dev,
282 "submitted interrupt URB for resume\n");
284 mutex_unlock(&dev->interrupt_mutex);
288 /* Kill the interrupt URB if all submitters want it killed */
289 void usbnet_status_stop(struct usbnet *dev)
291 if (dev->interrupt) {
292 mutex_lock(&dev->interrupt_mutex);
293 WARN_ON(dev->interrupt_count == 0);
295 if (dev->interrupt_count && --dev->interrupt_count == 0)
296 usb_kill_urb(dev->interrupt);
298 dev_dbg(&dev->udev->dev,
299 "decremented interrupt URB count to %d\n",
300 dev->interrupt_count);
301 mutex_unlock(&dev->interrupt_mutex);
304 EXPORT_SYMBOL_GPL(usbnet_status_stop);
306 /* For suspend; always kill interrupt URB */
307 static void __usbnet_status_stop_force(struct usbnet *dev)
309 if (dev->interrupt) {
310 mutex_lock(&dev->interrupt_mutex);
311 usb_kill_urb(dev->interrupt);
312 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
313 mutex_unlock(&dev->interrupt_mutex);
317 /* Passes this packet up the stack, updating its accounting.
318 * Some link protocols batch packets, so their rx_fixup paths
319 * can return clones as well as just modify the original skb.
321 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
325 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
326 skb_queue_tail(&dev->rxq_pause, skb);
330 skb->protocol = eth_type_trans (skb, dev->net);
331 dev->net->stats.rx_packets++;
332 dev->net->stats.rx_bytes += skb->len;
334 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
335 skb->len + sizeof (struct ethhdr), skb->protocol);
336 memset (skb->cb, 0, sizeof (struct skb_data));
338 if (skb_defer_rx_timestamp(skb))
341 status = netif_rx (skb);
342 if (status != NET_RX_SUCCESS)
343 netif_dbg(dev, rx_err, dev->net,
344 "netif_rx status %d\n", status);
346 EXPORT_SYMBOL_GPL(usbnet_skb_return);
348 /* must be called if hard_mtu or rx_urb_size changed */
349 void usbnet_update_max_qlen(struct usbnet *dev)
351 enum usb_device_speed speed = dev->udev->speed;
355 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
356 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
359 dev->rx_qlen = dev->tx_qlen = 4;
362 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
365 /*-------------------------------------------------------------------------
367 * Network Device Driver (peer link to "Host Device", from USB host)
369 *-------------------------------------------------------------------------*/
371 int usbnet_change_mtu (struct net_device *net, int new_mtu)
373 struct usbnet *dev = netdev_priv(net);
374 int ll_mtu = new_mtu + net->hard_header_len;
375 int old_hard_mtu = dev->hard_mtu;
376 int old_rx_urb_size = dev->rx_urb_size;
380 // no second zero-length packet read wanted after mtu-sized packets
381 if ((ll_mtu % dev->maxpacket) == 0)
385 dev->hard_mtu = net->mtu + net->hard_header_len;
386 if (dev->rx_urb_size == old_hard_mtu) {
387 dev->rx_urb_size = dev->hard_mtu;
388 if (dev->rx_urb_size > old_rx_urb_size)
389 usbnet_unlink_rx_urbs(dev);
392 /* max qlen depend on hard_mtu and rx_urb_size */
393 usbnet_update_max_qlen(dev);
397 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
399 /* The caller must hold list->lock */
400 static void __usbnet_queue_skb(struct sk_buff_head *list,
401 struct sk_buff *newsk, enum skb_state state)
403 struct skb_data *entry = (struct skb_data *) newsk->cb;
405 __skb_queue_tail(list, newsk);
406 entry->state = state;
409 /*-------------------------------------------------------------------------*/
411 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
412 * completion callbacks. 2.5 should have fixed those bugs...
415 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
416 struct sk_buff_head *list, enum skb_state state)
419 enum skb_state old_state;
420 struct skb_data *entry = (struct skb_data *) skb->cb;
422 spin_lock_irqsave(&list->lock, flags);
423 old_state = entry->state;
424 entry->state = state;
425 __skb_unlink(skb, list);
426 spin_unlock(&list->lock);
427 spin_lock(&dev->done.lock);
428 __skb_queue_tail(&dev->done, skb);
429 if (dev->done.qlen == 1)
430 tasklet_schedule(&dev->bh);
431 spin_unlock_irqrestore(&dev->done.lock, flags);
435 /* some work can't be done in tasklets, so we use keventd
437 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
438 * but tasklet_schedule() doesn't. hope the failure is rare.
440 void usbnet_defer_kevent (struct usbnet *dev, int work)
442 set_bit (work, &dev->flags);
443 if (!schedule_work (&dev->kevent)) {
445 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
447 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
450 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
452 /*-------------------------------------------------------------------------*/
454 static void rx_complete (struct urb *urb);
456 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
459 struct skb_data *entry;
461 unsigned long lockflags;
462 size_t size = dev->rx_urb_size;
464 /* prevent rx skb allocation when error ratio is high */
465 if (test_bit(EVENT_RX_KILL, &dev->flags)) {
470 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
472 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
473 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
478 entry = (struct skb_data *) skb->cb;
483 usb_fill_bulk_urb (urb, dev->udev, dev->in,
484 skb->data, size, rx_complete, skb);
486 spin_lock_irqsave (&dev->rxq.lock, lockflags);
488 if (netif_running (dev->net) &&
489 netif_device_present (dev->net) &&
490 !test_bit (EVENT_RX_HALT, &dev->flags) &&
491 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
492 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
494 usbnet_defer_kevent (dev, EVENT_RX_HALT);
497 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
500 netif_dbg(dev, ifdown, dev->net, "device gone\n");
501 netif_device_detach (dev->net);
507 netif_dbg(dev, rx_err, dev->net,
508 "rx submit, %d\n", retval);
509 tasklet_schedule (&dev->bh);
512 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
515 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
518 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
520 dev_kfree_skb_any (skb);
527 /*-------------------------------------------------------------------------*/
529 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
531 if (dev->driver_info->rx_fixup &&
532 !dev->driver_info->rx_fixup (dev, skb)) {
533 /* With RX_ASSEMBLE, rx_fixup() must update counters */
534 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
535 dev->net->stats.rx_errors++;
538 // else network stack removes extra byte if we forced a short packet
541 /* all data was already cloned from skb inside the driver */
542 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
543 dev_kfree_skb_any(skb);
545 usbnet_skb_return(dev, skb);
549 netif_dbg(dev, rx_err, dev->net, "drop\n");
550 dev->net->stats.rx_errors++;
552 skb_queue_tail(&dev->done, skb);
555 /*-------------------------------------------------------------------------*/
557 static void rx_complete (struct urb *urb)
559 struct sk_buff *skb = (struct sk_buff *) urb->context;
560 struct skb_data *entry = (struct skb_data *) skb->cb;
561 struct usbnet *dev = entry->dev;
562 int urb_status = urb->status;
563 enum skb_state state;
565 skb_put (skb, urb->actual_length);
569 switch (urb_status) {
572 if (skb->len < dev->net->hard_header_len) {
574 dev->net->stats.rx_errors++;
575 dev->net->stats.rx_length_errors++;
576 netif_dbg(dev, rx_err, dev->net,
577 "rx length %d\n", skb->len);
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 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1227 struct net_device *net)
1229 struct usbnet *dev = netdev_priv(net);
1231 struct urb *urb = NULL;
1232 struct skb_data *entry;
1233 struct driver_info *info = dev->driver_info;
1234 unsigned long flags;
1238 skb_tx_timestamp(skb);
1240 // some devices want funky USB-level framing, for
1241 // win32 driver (usually) and/or hardware quirks
1242 if (info->tx_fixup) {
1243 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1245 /* packet collected; minidriver waiting for more */
1246 if (info->flags & FLAG_MULTI_PACKET)
1248 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1254 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1255 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1259 entry = (struct skb_data *) skb->cb;
1262 entry->length = length;
1264 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1265 skb->data, skb->len, tx_complete, skb);
1267 /* don't assume the hardware handles USB_ZERO_PACKET
1268 * NOTE: strictly conforming cdc-ether devices should expect
1269 * the ZLP here, but ignore the one-byte packet.
1270 * NOTE2: CDC NCM specification is different from CDC ECM when
1271 * handling ZLP/short packets, so cdc_ncm driver will make short
1272 * packet itself if needed.
1274 if (length % dev->maxpacket == 0) {
1275 if (!(info->flags & FLAG_SEND_ZLP)) {
1276 if (!(info->flags & FLAG_MULTI_PACKET)) {
1277 urb->transfer_buffer_length++;
1278 if (skb_tailroom(skb)) {
1279 skb->data[skb->len] = 0;
1284 urb->transfer_flags |= URB_ZERO_PACKET;
1287 spin_lock_irqsave(&dev->txq.lock, flags);
1288 retval = usb_autopm_get_interface_async(dev->intf);
1290 spin_unlock_irqrestore(&dev->txq.lock, flags);
1295 /* if this triggers the device is still a sleep */
1296 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1297 /* transmission will be done in resume */
1298 usb_anchor_urb(urb, &dev->deferred);
1299 /* no use to process more packets */
1300 netif_stop_queue(net);
1302 spin_unlock_irqrestore(&dev->txq.lock, flags);
1303 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1308 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1310 netif_stop_queue (net);
1311 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1312 usb_autopm_put_interface_async(dev->intf);
1315 usb_autopm_put_interface_async(dev->intf);
1316 netif_dbg(dev, tx_err, dev->net,
1317 "tx: submit urb err %d\n", retval);
1320 net->trans_start = jiffies;
1321 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1322 if (dev->txq.qlen >= TX_QLEN (dev))
1323 netif_stop_queue (net);
1325 spin_unlock_irqrestore (&dev->txq.lock, flags);
1328 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1330 dev->net->stats.tx_dropped++;
1333 dev_kfree_skb_any (skb);
1336 netif_dbg(dev, tx_queued, dev->net,
1337 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1341 return NETDEV_TX_OK;
1343 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1345 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1351 /* don't refill the queue all at once */
1352 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1353 urb = usb_alloc_urb(0, flags);
1355 ret = rx_submit(dev, urb, flags);
1367 /*-------------------------------------------------------------------------*/
1369 // tasklet (work deferred from completions, in_irq) or timer
1371 static void usbnet_bh (unsigned long param)
1373 struct usbnet *dev = (struct usbnet *) param;
1374 struct sk_buff *skb;
1375 struct skb_data *entry;
1377 while ((skb = skb_dequeue (&dev->done))) {
1378 entry = (struct skb_data *) skb->cb;
1379 switch (entry->state) {
1381 entry->state = rx_cleanup;
1382 rx_process (dev, skb);
1386 usb_free_urb (entry->urb);
1387 dev_kfree_skb (skb);
1390 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1394 /* restart RX again after disabling due to high error rate */
1395 clear_bit(EVENT_RX_KILL, &dev->flags);
1397 // waiting for all pending urbs to complete?
1399 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1400 wake_up (dev->wait);
1403 // or are we maybe short a few urbs?
1404 } else if (netif_running (dev->net) &&
1405 netif_device_present (dev->net) &&
1406 netif_carrier_ok(dev->net) &&
1407 !timer_pending (&dev->delay) &&
1408 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1409 int temp = dev->rxq.qlen;
1411 if (temp < RX_QLEN(dev)) {
1412 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1414 if (temp != dev->rxq.qlen)
1415 netif_dbg(dev, link, dev->net,
1416 "rxqlen %d --> %d\n",
1417 temp, dev->rxq.qlen);
1418 if (dev->rxq.qlen < RX_QLEN(dev))
1419 tasklet_schedule (&dev->bh);
1421 if (dev->txq.qlen < TX_QLEN (dev))
1422 netif_wake_queue (dev->net);
1427 /*-------------------------------------------------------------------------
1429 * USB Device Driver support
1431 *-------------------------------------------------------------------------*/
1433 // precondition: never called in_interrupt
1435 void usbnet_disconnect (struct usb_interface *intf)
1438 struct usb_device *xdev;
1439 struct net_device *net;
1441 dev = usb_get_intfdata(intf);
1442 usb_set_intfdata(intf, NULL);
1446 xdev = interface_to_usbdev (intf);
1448 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1449 intf->dev.driver->name,
1450 xdev->bus->bus_name, xdev->devpath,
1451 dev->driver_info->description);
1454 unregister_netdev (net);
1456 cancel_work_sync(&dev->kevent);
1458 usb_scuttle_anchored_urbs(&dev->deferred);
1460 if (dev->driver_info->unbind)
1461 dev->driver_info->unbind (dev, intf);
1463 usb_kill_urb(dev->interrupt);
1464 usb_free_urb(dev->interrupt);
1468 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1470 static const struct net_device_ops usbnet_netdev_ops = {
1471 .ndo_open = usbnet_open,
1472 .ndo_stop = usbnet_stop,
1473 .ndo_start_xmit = usbnet_start_xmit,
1474 .ndo_tx_timeout = usbnet_tx_timeout,
1475 .ndo_change_mtu = usbnet_change_mtu,
1476 .ndo_set_mac_address = eth_mac_addr,
1477 .ndo_validate_addr = eth_validate_addr,
1480 /*-------------------------------------------------------------------------*/
1482 // precondition: never called in_interrupt
1484 static struct device_type wlan_type = {
1488 static struct device_type wwan_type = {
1493 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1496 struct net_device *net;
1497 struct usb_host_interface *interface;
1498 struct driver_info *info;
1499 struct usb_device *xdev;
1502 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1504 /* usbnet already took usb runtime pm, so have to enable the feature
1505 * for usb interface, otherwise usb_autopm_get_interface may return
1506 * failure if RUNTIME_PM is enabled.
1508 if (!driver->supports_autosuspend) {
1509 driver->supports_autosuspend = 1;
1510 pm_runtime_enable(&udev->dev);
1513 name = udev->dev.driver->name;
1514 info = (struct driver_info *) prod->driver_info;
1516 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1519 xdev = interface_to_usbdev (udev);
1520 interface = udev->cur_altsetting;
1524 // set up our own records
1525 net = alloc_etherdev(sizeof(*dev));
1529 /* netdev_printk() needs this so do it as early as possible */
1530 SET_NETDEV_DEV(net, &udev->dev);
1532 dev = netdev_priv(net);
1535 dev->driver_info = info;
1536 dev->driver_name = name;
1537 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1538 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1539 skb_queue_head_init (&dev->rxq);
1540 skb_queue_head_init (&dev->txq);
1541 skb_queue_head_init (&dev->done);
1542 skb_queue_head_init(&dev->rxq_pause);
1543 dev->bh.func = usbnet_bh;
1544 dev->bh.data = (unsigned long) dev;
1545 INIT_WORK (&dev->kevent, kevent);
1546 init_usb_anchor(&dev->deferred);
1547 dev->delay.function = usbnet_bh;
1548 dev->delay.data = (unsigned long) dev;
1549 init_timer (&dev->delay);
1550 mutex_init (&dev->phy_mutex);
1551 mutex_init(&dev->interrupt_mutex);
1552 dev->interrupt_count = 0;
1555 strcpy (net->name, "usb%d");
1556 memcpy (net->dev_addr, node_id, sizeof node_id);
1558 /* rx and tx sides can use different message sizes;
1559 * bind() should set rx_urb_size in that case.
1561 dev->hard_mtu = net->mtu + net->hard_header_len;
1563 // dma_supported() is deeply broken on almost all architectures
1564 // possible with some EHCI controllers
1565 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1566 net->features |= NETIF_F_HIGHDMA;
1569 net->netdev_ops = &usbnet_netdev_ops;
1570 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1571 net->ethtool_ops = &usbnet_ethtool_ops;
1573 // allow device-specific bind/init procedures
1574 // NOTE net->name still not usable ...
1576 status = info->bind (dev, udev);
1580 // heuristic: "usb%d" for links we know are two-host,
1581 // else "eth%d" when there's reasonable doubt. userspace
1582 // can rename the link if it knows better.
1583 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1584 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1585 (net->dev_addr [0] & 0x02) == 0))
1586 strcpy (net->name, "eth%d");
1587 /* WLAN devices should always be named "wlan%d" */
1588 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1589 strcpy(net->name, "wlan%d");
1590 /* WWAN devices should always be named "wwan%d" */
1591 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1592 strcpy(net->name, "wwan%d");
1594 /* devices that cannot do ARP */
1595 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1596 net->flags |= IFF_NOARP;
1598 /* maybe the remote can't receive an Ethernet MTU */
1599 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1600 net->mtu = dev->hard_mtu - net->hard_header_len;
1601 } else if (!info->in || !info->out)
1602 status = usbnet_get_endpoints (dev, udev);
1604 dev->in = usb_rcvbulkpipe (xdev, info->in);
1605 dev->out = usb_sndbulkpipe (xdev, info->out);
1606 if (!(info->flags & FLAG_NO_SETINT))
1607 status = usb_set_interface (xdev,
1608 interface->desc.bInterfaceNumber,
1609 interface->desc.bAlternateSetting);
1614 if (status >= 0 && dev->status)
1615 status = init_status (dev, udev);
1619 if (!dev->rx_urb_size)
1620 dev->rx_urb_size = dev->hard_mtu;
1621 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1623 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1624 SET_NETDEV_DEVTYPE(net, &wlan_type);
1625 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1626 SET_NETDEV_DEVTYPE(net, &wwan_type);
1628 /* initialize max rx_qlen and tx_qlen */
1629 usbnet_update_max_qlen(dev);
1631 status = register_netdev (net);
1634 netif_info(dev, probe, dev->net,
1635 "register '%s' at usb-%s-%s, %s, %pM\n",
1636 udev->dev.driver->name,
1637 xdev->bus->bus_name, xdev->devpath,
1638 dev->driver_info->description,
1641 // ok, it's ready to go.
1642 usb_set_intfdata (udev, dev);
1644 netif_device_attach (net);
1646 if (dev->driver_info->flags & FLAG_LINK_INTR)
1647 usbnet_link_change(dev, 0, 0);
1652 usb_free_urb(dev->interrupt);
1655 info->unbind (dev, udev);
1661 EXPORT_SYMBOL_GPL(usbnet_probe);
1663 /*-------------------------------------------------------------------------*/
1666 * suspend the whole driver as soon as the first interface is suspended
1667 * resume only when the last interface is resumed
1670 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1672 struct usbnet *dev = usb_get_intfdata(intf);
1674 if (!dev->suspend_count++) {
1675 spin_lock_irq(&dev->txq.lock);
1676 /* don't autosuspend while transmitting */
1677 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1678 dev->suspend_count--;
1679 spin_unlock_irq(&dev->txq.lock);
1682 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1683 spin_unlock_irq(&dev->txq.lock);
1686 * accelerate emptying of the rx and queues, to avoid
1687 * having everything error out.
1689 netif_device_detach (dev->net);
1690 usbnet_terminate_urbs(dev);
1691 __usbnet_status_stop_force(dev);
1694 * reattach so runtime management can use and
1697 netif_device_attach (dev->net);
1701 EXPORT_SYMBOL_GPL(usbnet_suspend);
1703 int usbnet_resume (struct usb_interface *intf)
1705 struct usbnet *dev = usb_get_intfdata(intf);
1706 struct sk_buff *skb;
1710 if (!--dev->suspend_count) {
1711 /* resume interrupt URB if it was previously submitted */
1712 __usbnet_status_start_force(dev, GFP_NOIO);
1714 spin_lock_irq(&dev->txq.lock);
1715 while ((res = usb_get_from_anchor(&dev->deferred))) {
1717 skb = (struct sk_buff *)res->context;
1718 retval = usb_submit_urb(res, GFP_ATOMIC);
1720 dev_kfree_skb_any(skb);
1722 usb_autopm_put_interface_async(dev->intf);
1724 dev->net->trans_start = jiffies;
1725 __skb_queue_tail(&dev->txq, skb);
1730 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1731 spin_unlock_irq(&dev->txq.lock);
1733 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1734 /* handle remote wakeup ASAP */
1736 netif_device_present(dev->net) &&
1737 !timer_pending(&dev->delay) &&
1738 !test_bit(EVENT_RX_HALT, &dev->flags))
1739 rx_alloc_submit(dev, GFP_NOIO);
1741 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1742 netif_tx_wake_all_queues(dev->net);
1743 tasklet_schedule (&dev->bh);
1747 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1748 usb_autopm_get_interface_no_resume(intf);
1752 EXPORT_SYMBOL_GPL(usbnet_resume);
1755 * Either a subdriver implements manage_power, then it is assumed to always
1756 * be ready to be suspended or it reports the readiness to be suspended
1759 void usbnet_device_suggests_idle(struct usbnet *dev)
1761 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1762 dev->intf->needs_remote_wakeup = 1;
1763 usb_autopm_put_interface_async(dev->intf);
1766 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1769 * For devices that can do without special commands
1771 int usbnet_manage_power(struct usbnet *dev, int on)
1773 dev->intf->needs_remote_wakeup = on;
1776 EXPORT_SYMBOL(usbnet_manage_power);
1778 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1780 /* update link after link is reseted */
1781 if (link && !need_reset)
1782 netif_carrier_on(dev->net);
1784 netif_carrier_off(dev->net);
1786 if (need_reset && link)
1787 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1789 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1791 EXPORT_SYMBOL(usbnet_link_change);
1793 /*-------------------------------------------------------------------------*/
1794 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1795 u16 value, u16 index, void *data, u16 size)
1800 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1801 " value=0x%04x index=0x%04x size=%d\n",
1802 cmd, reqtype, value, index, size);
1805 buf = kmalloc(size, GFP_KERNEL);
1810 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1811 cmd, reqtype, value, index, buf, size,
1812 USB_CTRL_GET_TIMEOUT);
1813 if (err > 0 && err <= size)
1814 memcpy(data, buf, err);
1820 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1821 u16 value, u16 index, const void *data,
1827 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1828 " value=0x%04x index=0x%04x size=%d\n",
1829 cmd, reqtype, value, index, size);
1832 buf = kmemdup(data, size, GFP_KERNEL);
1837 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1838 cmd, reqtype, value, index, buf, size,
1839 USB_CTRL_SET_TIMEOUT);
1847 * The function can't be called inside suspend/resume callback,
1848 * otherwise deadlock will be caused.
1850 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1851 u16 value, u16 index, void *data, u16 size)
1855 if (usb_autopm_get_interface(dev->intf) < 0)
1857 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1859 usb_autopm_put_interface(dev->intf);
1862 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
1865 * The function can't be called inside suspend/resume callback,
1866 * otherwise deadlock will be caused.
1868 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1869 u16 value, u16 index, const void *data, u16 size)
1873 if (usb_autopm_get_interface(dev->intf) < 0)
1875 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1877 usb_autopm_put_interface(dev->intf);
1880 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
1883 * The function can be called inside suspend/resume callback safely
1884 * and should only be called by suspend/resume callback generally.
1886 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1887 u16 value, u16 index, void *data, u16 size)
1889 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1892 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
1895 * The function can be called inside suspend/resume callback safely
1896 * and should only be called by suspend/resume callback generally.
1898 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1899 u16 value, u16 index, const void *data,
1902 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1905 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
1907 static void usbnet_async_cmd_cb(struct urb *urb)
1909 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
1910 int status = urb->status;
1913 dev_dbg(&urb->dev->dev, "%s failed with %d",
1921 * The caller must make sure that device can't be put into suspend
1922 * state until the control URB completes.
1924 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
1925 u16 value, u16 index, const void *data, u16 size)
1927 struct usb_ctrlrequest *req = NULL;
1932 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1933 " value=0x%04x index=0x%04x size=%d\n",
1934 cmd, reqtype, value, index, size);
1936 urb = usb_alloc_urb(0, GFP_ATOMIC);
1938 netdev_err(dev->net, "Error allocating URB in"
1939 " %s!\n", __func__);
1944 buf = kmemdup(data, size, GFP_ATOMIC);
1946 netdev_err(dev->net, "Error allocating buffer"
1947 " in %s!\n", __func__);
1952 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
1956 req->bRequestType = reqtype;
1957 req->bRequest = cmd;
1958 req->wValue = cpu_to_le16(value);
1959 req->wIndex = cpu_to_le16(index);
1960 req->wLength = cpu_to_le16(size);
1962 usb_fill_control_urb(urb, dev->udev,
1963 usb_sndctrlpipe(dev->udev, 0),
1964 (void *)req, buf, size,
1965 usbnet_async_cmd_cb, req);
1966 urb->transfer_flags |= URB_FREE_BUFFER;
1968 err = usb_submit_urb(urb, GFP_ATOMIC);
1970 netdev_err(dev->net, "Error submitting the control"
1971 " message: status=%d\n", err);
1985 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
1986 /*-------------------------------------------------------------------------*/
1988 static int __init usbnet_init(void)
1990 /* Compiler should optimize this out. */
1992 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1994 eth_random_addr(node_id);
1997 module_init(usbnet_init);
1999 static void __exit usbnet_exit(void)
2002 module_exit(usbnet_exit);
2004 MODULE_AUTHOR("David Brownell");
2005 MODULE_DESCRIPTION("USB network driver framework");
2006 MODULE_LICENSE("GPL");