2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 * This is a generic "USB networking" framework that works with several
22 * kinds of full and high speed networking devices: host-to-host cables,
23 * smart usb peripherals, and actual Ethernet adapters.
25 * These devices usually differ in terms of control protocols (if they
26 * even have one!) and sometimes they define new framing to wrap or batch
27 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
28 * so interface (un)binding, endpoint I/O queues, fault handling, and other
29 * issues can usefully be addressed by this framework.
32 // #define DEBUG // error path messages, extra info
33 // #define VERBOSE // more; success messages
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/netdevice.h>
38 #include <linux/etherdevice.h>
39 #include <linux/ctype.h>
40 #include <linux/ethtool.h>
41 #include <linux/workqueue.h>
42 #include <linux/mii.h>
43 #include <linux/usb.h>
44 #include <linux/usb/usbnet.h>
45 #include <linux/slab.h>
46 #include <linux/kernel.h>
47 #include <linux/pm_runtime.h>
49 #define DRIVER_VERSION "22-Aug-2005"
52 /*-------------------------------------------------------------------------*/
55 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
56 * Several dozen bytes of IPv4 data can fit in two such transactions.
57 * One maximum size Ethernet packet takes twenty four of them.
58 * For high speed, each frame comfortably fits almost 36 max size
59 * Ethernet packets (so queues should be bigger).
61 * The goal is to let the USB host controller be busy for 5msec or
62 * more before an irq is required, under load. Jumbograms change
65 #define MAX_QUEUE_MEMORY (60 * 1518)
66 #define RX_QLEN(dev) ((dev)->rx_qlen)
67 #define TX_QLEN(dev) ((dev)->tx_qlen)
69 // reawaken network queue this soon after stopping; else watchdog barks
70 #define TX_TIMEOUT_JIFFIES (5*HZ)
72 /* throttle rx/tx briefly after some faults, so hub_wq might disconnect()
73 * us (it polls at HZ/4 usually) before we report too many false errors.
75 #define THROTTLE_JIFFIES (HZ/8)
78 #define UNLINK_TIMEOUT_MS 3
80 /*-------------------------------------------------------------------------*/
82 // randomly generated ethernet address
83 static u8 node_id [ETH_ALEN];
85 static const char driver_name [] = "usbnet";
87 /* use ethtool to change the level for any given device */
88 static int msg_level = -1;
89 module_param (msg_level, int, 0);
90 MODULE_PARM_DESC (msg_level, "Override default message level");
92 /*-------------------------------------------------------------------------*/
94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
95 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
98 struct usb_host_interface *alt = NULL;
99 struct usb_host_endpoint *in = NULL, *out = NULL;
100 struct usb_host_endpoint *status = NULL;
102 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
105 in = out = status = NULL;
106 alt = intf->altsetting + tmp;
108 /* take the first altsetting with in-bulk + out-bulk;
109 * remember any status endpoint, just in case;
110 * ignore other endpoints and altsettings.
112 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
113 struct usb_host_endpoint *e;
116 e = alt->endpoint + ep;
117 switch (e->desc.bmAttributes) {
118 case USB_ENDPOINT_XFER_INT:
119 if (!usb_endpoint_dir_in(&e->desc))
123 case USB_ENDPOINT_XFER_BULK:
128 if (usb_endpoint_dir_in(&e->desc)) {
131 else if (intr && !status)
141 if (!alt || !in || !out)
144 if (alt->desc.bAlternateSetting != 0 ||
145 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
146 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
147 alt->desc.bAlternateSetting);
152 dev->in = usb_rcvbulkpipe (dev->udev,
153 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
154 dev->out = usb_sndbulkpipe (dev->udev,
155 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156 dev->status = status;
159 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
161 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
164 unsigned char buf [13];
166 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 status = usb_submit_urb (urb, GFP_ATOMIC);
209 netif_err(dev, timer, dev->net,
210 "intr resubmit --> %d\n", status);
213 static int init_status (struct usbnet *dev, struct usb_interface *intf)
220 if (!dev->driver_info->status)
223 pipe = usb_rcvintpipe (dev->udev,
224 dev->status->desc.bEndpointAddress
225 & USB_ENDPOINT_NUMBER_MASK);
226 maxp = usb_maxpacket (dev->udev, pipe, 0);
228 /* avoid 1 msec chatter: min 8 msec poll rate */
229 period = max ((int) dev->status->desc.bInterval,
230 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
232 buf = kmalloc (maxp, GFP_KERNEL);
234 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
235 if (!dev->interrupt) {
239 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
240 buf, maxp, intr_complete, dev, period);
241 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
243 "status ep%din, %d bytes period %d\n",
244 usb_pipeendpoint(pipe), maxp, period);
250 /* Submit the interrupt URB if not previously submitted, increasing refcount */
251 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
255 WARN_ON_ONCE(dev->interrupt == NULL);
256 if (dev->interrupt) {
257 mutex_lock(&dev->interrupt_mutex);
259 if (++dev->interrupt_count == 1)
260 ret = usb_submit_urb(dev->interrupt, mem_flags);
262 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
263 dev->interrupt_count);
264 mutex_unlock(&dev->interrupt_mutex);
268 EXPORT_SYMBOL_GPL(usbnet_status_start);
270 /* For resume; submit interrupt URB if previously submitted */
271 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
275 mutex_lock(&dev->interrupt_mutex);
276 if (dev->interrupt_count) {
277 ret = usb_submit_urb(dev->interrupt, mem_flags);
278 dev_dbg(&dev->udev->dev,
279 "submitted interrupt URB for resume\n");
281 mutex_unlock(&dev->interrupt_mutex);
285 /* Kill the interrupt URB if all submitters want it killed */
286 void usbnet_status_stop(struct usbnet *dev)
288 if (dev->interrupt) {
289 mutex_lock(&dev->interrupt_mutex);
290 WARN_ON(dev->interrupt_count == 0);
292 if (dev->interrupt_count && --dev->interrupt_count == 0)
293 usb_kill_urb(dev->interrupt);
295 dev_dbg(&dev->udev->dev,
296 "decremented interrupt URB count to %d\n",
297 dev->interrupt_count);
298 mutex_unlock(&dev->interrupt_mutex);
301 EXPORT_SYMBOL_GPL(usbnet_status_stop);
303 /* For suspend; always kill interrupt URB */
304 static void __usbnet_status_stop_force(struct usbnet *dev)
306 if (dev->interrupt) {
307 mutex_lock(&dev->interrupt_mutex);
308 usb_kill_urb(dev->interrupt);
309 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
310 mutex_unlock(&dev->interrupt_mutex);
314 /* Passes this packet up the stack, updating its accounting.
315 * Some link protocols batch packets, so their rx_fixup paths
316 * can return clones as well as just modify the original skb.
318 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
322 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
323 skb_queue_tail(&dev->rxq_pause, skb);
327 skb->protocol = eth_type_trans (skb, dev->net);
328 dev->net->stats.rx_packets++;
329 dev->net->stats.rx_bytes += skb->len;
331 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
332 skb->len + sizeof (struct ethhdr), skb->protocol);
333 memset (skb->cb, 0, sizeof (struct skb_data));
335 if (skb_defer_rx_timestamp(skb))
338 status = netif_rx (skb);
339 if (status != NET_RX_SUCCESS)
340 netif_dbg(dev, rx_err, dev->net,
341 "netif_rx status %d\n", status);
343 EXPORT_SYMBOL_GPL(usbnet_skb_return);
345 /* must be called if hard_mtu or rx_urb_size changed */
346 void usbnet_update_max_qlen(struct usbnet *dev)
348 enum usb_device_speed speed = dev->udev->speed;
352 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
353 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
355 case USB_SPEED_SUPER:
357 * Not take default 5ms qlen for super speed HC to
358 * save memory, and iperf tests show 2.5ms qlen can
361 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
362 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
365 dev->rx_qlen = dev->tx_qlen = 4;
368 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
371 /*-------------------------------------------------------------------------
373 * Network Device Driver (peer link to "Host Device", from USB host)
375 *-------------------------------------------------------------------------*/
377 int usbnet_change_mtu (struct net_device *net, int new_mtu)
379 struct usbnet *dev = netdev_priv(net);
380 int ll_mtu = new_mtu + net->hard_header_len;
381 int old_hard_mtu = dev->hard_mtu;
382 int old_rx_urb_size = dev->rx_urb_size;
386 // no second zero-length packet read wanted after mtu-sized packets
387 if ((ll_mtu % dev->maxpacket) == 0)
391 dev->hard_mtu = net->mtu + net->hard_header_len;
392 if (dev->rx_urb_size == old_hard_mtu) {
393 dev->rx_urb_size = dev->hard_mtu;
394 if (dev->rx_urb_size > old_rx_urb_size)
395 usbnet_unlink_rx_urbs(dev);
398 /* max qlen depend on hard_mtu and rx_urb_size */
399 usbnet_update_max_qlen(dev);
403 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
405 /* The caller must hold list->lock */
406 static void __usbnet_queue_skb(struct sk_buff_head *list,
407 struct sk_buff *newsk, enum skb_state state)
409 struct skb_data *entry = (struct skb_data *) newsk->cb;
411 __skb_queue_tail(list, newsk);
412 entry->state = state;
415 /*-------------------------------------------------------------------------*/
417 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
418 * completion callbacks. 2.5 should have fixed those bugs...
421 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
422 struct sk_buff_head *list, enum skb_state state)
425 enum skb_state old_state;
426 struct skb_data *entry = (struct skb_data *) skb->cb;
428 spin_lock_irqsave(&list->lock, flags);
429 old_state = entry->state;
430 entry->state = state;
431 __skb_unlink(skb, list);
432 spin_unlock(&list->lock);
433 spin_lock(&dev->done.lock);
434 __skb_queue_tail(&dev->done, skb);
435 if (dev->done.qlen == 1)
436 tasklet_schedule(&dev->bh);
437 spin_unlock_irqrestore(&dev->done.lock, flags);
441 /* some work can't be done in tasklets, so we use keventd
443 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
444 * but tasklet_schedule() doesn't. hope the failure is rare.
446 void usbnet_defer_kevent (struct usbnet *dev, int work)
448 set_bit (work, &dev->flags);
449 if (!schedule_work (&dev->kevent)) {
451 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
453 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
456 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
458 /*-------------------------------------------------------------------------*/
460 static void rx_complete (struct urb *urb);
462 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
465 struct skb_data *entry;
467 unsigned long lockflags;
468 size_t size = dev->rx_urb_size;
470 /* prevent rx skb allocation when error ratio is high */
471 if (test_bit(EVENT_RX_KILL, &dev->flags)) {
476 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
478 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
479 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
484 entry = (struct skb_data *) skb->cb;
489 usb_fill_bulk_urb (urb, dev->udev, dev->in,
490 skb->data, size, rx_complete, skb);
492 spin_lock_irqsave (&dev->rxq.lock, lockflags);
494 if (netif_running (dev->net) &&
495 netif_device_present (dev->net) &&
496 !test_bit (EVENT_RX_HALT, &dev->flags) &&
497 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
498 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
500 usbnet_defer_kevent (dev, EVENT_RX_HALT);
503 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
506 netif_dbg(dev, ifdown, dev->net, "device gone\n");
507 netif_device_detach (dev->net);
513 netif_dbg(dev, rx_err, dev->net,
514 "rx submit, %d\n", retval);
515 tasklet_schedule (&dev->bh);
518 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
521 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
524 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
526 dev_kfree_skb_any (skb);
533 /*-------------------------------------------------------------------------*/
535 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
537 if (dev->driver_info->rx_fixup &&
538 !dev->driver_info->rx_fixup (dev, skb)) {
539 /* With RX_ASSEMBLE, rx_fixup() must update counters */
540 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
541 dev->net->stats.rx_errors++;
544 // else network stack removes extra byte if we forced a short packet
546 /* all data was already cloned from skb inside the driver */
547 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
550 if (skb->len < ETH_HLEN) {
551 dev->net->stats.rx_errors++;
552 dev->net->stats.rx_length_errors++;
553 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
555 usbnet_skb_return(dev, skb);
560 skb_queue_tail(&dev->done, skb);
563 /*-------------------------------------------------------------------------*/
565 static void rx_complete (struct urb *urb)
567 struct sk_buff *skb = (struct sk_buff *) urb->context;
568 struct skb_data *entry = (struct skb_data *) skb->cb;
569 struct usbnet *dev = entry->dev;
570 int urb_status = urb->status;
571 enum skb_state state;
573 skb_put (skb, urb->actual_length);
577 switch (urb_status) {
582 /* stalls need manual reset. this is rare ... except that
583 * when going through USB 2.0 TTs, unplug appears this way.
584 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
585 * storm, recovering as needed.
588 dev->net->stats.rx_errors++;
589 usbnet_defer_kevent (dev, EVENT_RX_HALT);
592 /* software-driven interface shutdown */
593 case -ECONNRESET: /* async unlink */
594 case -ESHUTDOWN: /* hardware gone */
595 netif_dbg(dev, ifdown, dev->net,
596 "rx shutdown, code %d\n", urb_status);
599 /* we get controller i/o faults during hub_wq disconnect() delays.
600 * throttle down resubmits, to avoid log floods; just temporarily,
601 * so we still recover when the fault isn't a hub_wq delay.
606 dev->net->stats.rx_errors++;
607 if (!timer_pending (&dev->delay)) {
608 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
609 netif_dbg(dev, link, dev->net,
610 "rx throttle %d\n", urb_status);
618 /* data overrun ... flush fifo? */
620 dev->net->stats.rx_over_errors++;
625 dev->net->stats.rx_errors++;
626 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
630 /* stop rx if packet error rate is high */
631 if (++dev->pkt_cnt > 30) {
635 if (state == rx_cleanup)
637 if (dev->pkt_err > 20)
638 set_bit(EVENT_RX_KILL, &dev->flags);
641 state = defer_bh(dev, skb, &dev->rxq, state);
644 if (netif_running (dev->net) &&
645 !test_bit (EVENT_RX_HALT, &dev->flags) &&
646 state != unlink_start) {
647 rx_submit (dev, urb, GFP_ATOMIC);
648 usb_mark_last_busy(dev->udev);
653 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
656 /*-------------------------------------------------------------------------*/
657 void usbnet_pause_rx(struct usbnet *dev)
659 set_bit(EVENT_RX_PAUSED, &dev->flags);
661 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
663 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
665 void usbnet_resume_rx(struct usbnet *dev)
670 clear_bit(EVENT_RX_PAUSED, &dev->flags);
672 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
673 usbnet_skb_return(dev, skb);
677 tasklet_schedule(&dev->bh);
679 netif_dbg(dev, rx_status, dev->net,
680 "paused rx queue disabled, %d skbs requeued\n", num);
682 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
684 void usbnet_purge_paused_rxq(struct usbnet *dev)
686 skb_queue_purge(&dev->rxq_pause);
688 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
690 /*-------------------------------------------------------------------------*/
692 // unlink pending rx/tx; completion handlers do all other cleanup
694 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
700 spin_lock_irqsave (&q->lock, flags);
701 while (!skb_queue_empty(q)) {
702 struct skb_data *entry;
706 skb_queue_walk(q, skb) {
707 entry = (struct skb_data *) skb->cb;
708 if (entry->state != unlink_start)
713 entry->state = unlink_start;
717 * Get reference count of the URB to avoid it to be
718 * freed during usb_unlink_urb, which may trigger
719 * use-after-free problem inside usb_unlink_urb since
720 * usb_unlink_urb is always racing with .complete
721 * handler(include defer_bh).
724 spin_unlock_irqrestore(&q->lock, flags);
725 // during some PM-driven resume scenarios,
726 // these (async) unlinks complete immediately
727 retval = usb_unlink_urb (urb);
728 if (retval != -EINPROGRESS && retval != 0)
729 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
733 spin_lock_irqsave(&q->lock, flags);
735 spin_unlock_irqrestore (&q->lock, flags);
739 // Flush all pending rx urbs
740 // minidrivers may need to do this when the MTU changes
742 void usbnet_unlink_rx_urbs(struct usbnet *dev)
744 if (netif_running(dev->net)) {
745 (void) unlink_urbs (dev, &dev->rxq);
746 tasklet_schedule(&dev->bh);
749 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
751 /*-------------------------------------------------------------------------*/
753 // precondition: never called in_interrupt
754 static void usbnet_terminate_urbs(struct usbnet *dev)
756 DECLARE_WAITQUEUE(wait, current);
759 /* ensure there are no more active urbs */
760 add_wait_queue(&dev->wait, &wait);
761 set_current_state(TASK_UNINTERRUPTIBLE);
762 temp = unlink_urbs(dev, &dev->txq) +
763 unlink_urbs(dev, &dev->rxq);
765 /* maybe wait for deletions to finish. */
766 while (!skb_queue_empty(&dev->rxq)
767 && !skb_queue_empty(&dev->txq)
768 && !skb_queue_empty(&dev->done)) {
769 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
770 set_current_state(TASK_UNINTERRUPTIBLE);
771 netif_dbg(dev, ifdown, dev->net,
772 "waited for %d urb completions\n", temp);
774 set_current_state(TASK_RUNNING);
775 remove_wait_queue(&dev->wait, &wait);
778 int usbnet_stop (struct net_device *net)
780 struct usbnet *dev = netdev_priv(net);
781 struct driver_info *info = dev->driver_info;
784 clear_bit(EVENT_DEV_OPEN, &dev->flags);
785 netif_stop_queue (net);
787 netif_info(dev, ifdown, dev->net,
788 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
789 net->stats.rx_packets, net->stats.tx_packets,
790 net->stats.rx_errors, net->stats.tx_errors);
792 /* to not race resume */
793 pm = usb_autopm_get_interface(dev->intf);
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);
821 usb_autopm_put_interface(dev->intf);
823 if (info->manage_power &&
824 !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags))
825 info->manage_power(dev, 0);
827 usb_autopm_put_interface(dev->intf);
831 EXPORT_SYMBOL_GPL(usbnet_stop);
833 /*-------------------------------------------------------------------------*/
835 // posts reads, and enables write queuing
837 // precondition: never called in_interrupt
839 int usbnet_open (struct net_device *net)
841 struct usbnet *dev = netdev_priv(net);
843 struct driver_info *info = dev->driver_info;
845 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
846 netif_info(dev, ifup, dev->net,
847 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
849 dev->udev->bus->bus_name,
855 // put into "known safe" state
856 if (info->reset && (retval = info->reset (dev)) < 0) {
857 netif_info(dev, ifup, dev->net,
858 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
860 dev->udev->bus->bus_name,
866 /* hard_mtu or rx_urb_size may change in reset() */
867 usbnet_update_max_qlen(dev);
869 // insist peer be connected
870 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
871 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
875 /* start any status interrupt transfer */
876 if (dev->interrupt) {
877 retval = usbnet_status_start(dev, GFP_KERNEL);
879 netif_err(dev, ifup, dev->net,
880 "intr submit %d\n", retval);
885 set_bit(EVENT_DEV_OPEN, &dev->flags);
886 netif_start_queue (net);
887 netif_info(dev, ifup, dev->net,
888 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
889 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
891 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
892 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
893 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
894 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
895 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
898 /* reset rx error state */
901 clear_bit(EVENT_RX_KILL, &dev->flags);
903 // delay posting reads until we're fully open
904 tasklet_schedule (&dev->bh);
905 if (info->manage_power) {
906 retval = info->manage_power(dev, 1);
909 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
911 usb_autopm_put_interface(dev->intf);
916 usb_autopm_put_interface(dev->intf);
920 EXPORT_SYMBOL_GPL(usbnet_open);
922 /*-------------------------------------------------------------------------*/
924 /* ethtool methods; minidrivers may need to add some more, but
925 * they'll probably want to use this base set.
928 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
930 struct usbnet *dev = netdev_priv(net);
932 if (!dev->mii.mdio_read)
935 return mii_ethtool_gset(&dev->mii, cmd);
937 EXPORT_SYMBOL_GPL(usbnet_get_settings);
939 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
941 struct usbnet *dev = netdev_priv(net);
944 if (!dev->mii.mdio_write)
947 retval = mii_ethtool_sset(&dev->mii, cmd);
949 /* link speed/duplex might have changed */
950 if (dev->driver_info->link_reset)
951 dev->driver_info->link_reset(dev);
953 /* hard_mtu or rx_urb_size may change in link_reset() */
954 usbnet_update_max_qlen(dev);
959 EXPORT_SYMBOL_GPL(usbnet_set_settings);
961 u32 usbnet_get_link (struct net_device *net)
963 struct usbnet *dev = netdev_priv(net);
965 /* If a check_connect is defined, return its result */
966 if (dev->driver_info->check_connect)
967 return dev->driver_info->check_connect (dev) == 0;
969 /* if the device has mii operations, use those */
970 if (dev->mii.mdio_read)
971 return mii_link_ok(&dev->mii);
973 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
974 return ethtool_op_get_link(net);
976 EXPORT_SYMBOL_GPL(usbnet_get_link);
978 int usbnet_nway_reset(struct net_device *net)
980 struct usbnet *dev = netdev_priv(net);
982 if (!dev->mii.mdio_write)
985 return mii_nway_restart(&dev->mii);
987 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
989 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
991 struct usbnet *dev = netdev_priv(net);
993 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
994 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
995 strlcpy (info->fw_version, dev->driver_info->description,
996 sizeof info->fw_version);
997 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
999 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
1001 u32 usbnet_get_msglevel (struct net_device *net)
1003 struct usbnet *dev = netdev_priv(net);
1005 return dev->msg_enable;
1007 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1009 void usbnet_set_msglevel (struct net_device *net, u32 level)
1011 struct usbnet *dev = netdev_priv(net);
1013 dev->msg_enable = level;
1015 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1017 /* drivers may override default ethtool_ops in their bind() routine */
1018 static const struct ethtool_ops usbnet_ethtool_ops = {
1019 .get_settings = usbnet_get_settings,
1020 .set_settings = usbnet_set_settings,
1021 .get_link = usbnet_get_link,
1022 .nway_reset = usbnet_nway_reset,
1023 .get_drvinfo = usbnet_get_drvinfo,
1024 .get_msglevel = usbnet_get_msglevel,
1025 .set_msglevel = usbnet_set_msglevel,
1026 .get_ts_info = ethtool_op_get_ts_info,
1029 /*-------------------------------------------------------------------------*/
1031 static void __handle_link_change(struct usbnet *dev)
1033 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1036 if (!netif_carrier_ok(dev->net)) {
1037 /* kill URBs for reading packets to save bus bandwidth */
1038 unlink_urbs(dev, &dev->rxq);
1041 * tx_timeout will unlink URBs for sending packets and
1042 * tx queue is stopped by netcore after link becomes off
1045 /* submitting URBs for reading packets */
1046 tasklet_schedule(&dev->bh);
1049 /* hard_mtu or rx_urb_size may change during link change */
1050 usbnet_update_max_qlen(dev);
1052 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1055 /* work that cannot be done in interrupt context uses keventd.
1057 * NOTE: with 2.5 we could do more of this using completion callbacks,
1058 * especially now that control transfers can be queued.
1061 kevent (struct work_struct *work)
1063 struct usbnet *dev =
1064 container_of(work, struct usbnet, kevent);
1067 /* usb_clear_halt() needs a thread context */
1068 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1069 unlink_urbs (dev, &dev->txq);
1070 status = usb_autopm_get_interface(dev->intf);
1073 status = usb_clear_halt (dev->udev, dev->out);
1074 usb_autopm_put_interface(dev->intf);
1077 status != -ESHUTDOWN) {
1078 if (netif_msg_tx_err (dev))
1080 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1083 clear_bit (EVENT_TX_HALT, &dev->flags);
1084 if (status != -ESHUTDOWN)
1085 netif_wake_queue (dev->net);
1088 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1089 unlink_urbs (dev, &dev->rxq);
1090 status = usb_autopm_get_interface(dev->intf);
1093 status = usb_clear_halt (dev->udev, dev->in);
1094 usb_autopm_put_interface(dev->intf);
1097 status != -ESHUTDOWN) {
1098 if (netif_msg_rx_err (dev))
1100 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1103 clear_bit (EVENT_RX_HALT, &dev->flags);
1104 tasklet_schedule (&dev->bh);
1108 /* tasklet could resubmit itself forever if memory is tight */
1109 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1110 struct urb *urb = NULL;
1113 if (netif_running (dev->net))
1114 urb = usb_alloc_urb (0, GFP_KERNEL);
1116 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1118 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1119 status = usb_autopm_get_interface(dev->intf);
1124 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1126 usb_autopm_put_interface(dev->intf);
1129 tasklet_schedule (&dev->bh);
1133 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1134 struct driver_info *info = dev->driver_info;
1137 clear_bit (EVENT_LINK_RESET, &dev->flags);
1138 status = usb_autopm_get_interface(dev->intf);
1141 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1142 usb_autopm_put_interface(dev->intf);
1144 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1146 dev->udev->bus->bus_name,
1150 usb_autopm_put_interface(dev->intf);
1153 /* handle link change from link resetting */
1154 __handle_link_change(dev);
1157 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1158 __handle_link_change(dev);
1161 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1164 /*-------------------------------------------------------------------------*/
1166 static void tx_complete (struct urb *urb)
1168 struct sk_buff *skb = (struct sk_buff *) urb->context;
1169 struct skb_data *entry = (struct skb_data *) skb->cb;
1170 struct usbnet *dev = entry->dev;
1172 if (urb->status == 0) {
1173 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1174 dev->net->stats.tx_packets++;
1175 dev->net->stats.tx_bytes += entry->length;
1177 dev->net->stats.tx_errors++;
1179 switch (urb->status) {
1181 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1184 /* software-driven interface shutdown */
1185 case -ECONNRESET: // async unlink
1186 case -ESHUTDOWN: // hardware gone
1189 /* like rx, tx gets controller i/o faults during hub_wq
1190 * delays and so it uses the same throttling mechanism.
1195 usb_mark_last_busy(dev->udev);
1196 if (!timer_pending (&dev->delay)) {
1197 mod_timer (&dev->delay,
1198 jiffies + THROTTLE_JIFFIES);
1199 netif_dbg(dev, link, dev->net,
1200 "tx throttle %d\n", urb->status);
1202 netif_stop_queue (dev->net);
1205 netif_dbg(dev, tx_err, dev->net,
1206 "tx err %d\n", entry->urb->status);
1211 usb_autopm_put_interface_async(dev->intf);
1212 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1215 /*-------------------------------------------------------------------------*/
1217 void usbnet_tx_timeout (struct net_device *net)
1219 struct usbnet *dev = netdev_priv(net);
1221 unlink_urbs (dev, &dev->txq);
1222 tasklet_schedule (&dev->bh);
1223 /* this needs to be handled individually because the generic layer
1224 * doesn't know what is sufficient and could not restore private
1225 * information if a remedy of an unconditional reset were used.
1227 if (dev->driver_info->recover)
1228 (dev->driver_info->recover)(dev);
1230 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1232 /*-------------------------------------------------------------------------*/
1234 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1236 unsigned num_sgs, total_len = 0;
1239 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1243 /* reserve one for zero packet */
1244 urb->sg = kmalloc((num_sgs + 1) * sizeof(struct scatterlist),
1249 urb->num_sgs = num_sgs;
1250 sg_init_table(urb->sg, urb->num_sgs + 1);
1252 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1253 total_len += skb_headlen(skb);
1255 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1256 struct skb_frag_struct *f = &skb_shinfo(skb)->frags[i];
1258 total_len += skb_frag_size(f);
1259 sg_set_page(&urb->sg[i + s], f->page.p, f->size,
1262 urb->transfer_buffer_length = total_len;
1267 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1268 struct net_device *net)
1270 struct usbnet *dev = netdev_priv(net);
1272 struct urb *urb = NULL;
1273 struct skb_data *entry;
1274 struct driver_info *info = dev->driver_info;
1275 unsigned long flags;
1279 skb_tx_timestamp(skb);
1281 // some devices want funky USB-level framing, for
1282 // win32 driver (usually) and/or hardware quirks
1283 if (info->tx_fixup) {
1284 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1286 /* packet collected; minidriver waiting for more */
1287 if (info->flags & FLAG_MULTI_PACKET)
1289 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1294 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1295 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1299 entry = (struct skb_data *) skb->cb;
1303 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1304 skb->data, skb->len, tx_complete, skb);
1305 if (dev->can_dma_sg) {
1306 if (build_dma_sg(skb, urb) < 0)
1309 length = urb->transfer_buffer_length;
1311 /* don't assume the hardware handles USB_ZERO_PACKET
1312 * NOTE: strictly conforming cdc-ether devices should expect
1313 * the ZLP here, but ignore the one-byte packet.
1314 * NOTE2: CDC NCM specification is different from CDC ECM when
1315 * handling ZLP/short packets, so cdc_ncm driver will make short
1316 * packet itself if needed.
1318 if (length % dev->maxpacket == 0) {
1319 if (!(info->flags & FLAG_SEND_ZLP)) {
1320 if (!(info->flags & FLAG_MULTI_PACKET)) {
1322 if (skb_tailroom(skb) && !urb->num_sgs) {
1323 skb->data[skb->len] = 0;
1325 } else if (urb->num_sgs)
1326 sg_set_buf(&urb->sg[urb->num_sgs++],
1327 dev->padding_pkt, 1);
1330 urb->transfer_flags |= URB_ZERO_PACKET;
1332 entry->length = urb->transfer_buffer_length = length;
1334 spin_lock_irqsave(&dev->txq.lock, flags);
1335 retval = usb_autopm_get_interface_async(dev->intf);
1337 spin_unlock_irqrestore(&dev->txq.lock, flags);
1342 /* if this triggers the device is still a sleep */
1343 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1344 /* transmission will be done in resume */
1345 usb_anchor_urb(urb, &dev->deferred);
1346 /* no use to process more packets */
1347 netif_stop_queue(net);
1349 spin_unlock_irqrestore(&dev->txq.lock, flags);
1350 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1355 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1357 netif_stop_queue (net);
1358 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1359 usb_autopm_put_interface_async(dev->intf);
1362 usb_autopm_put_interface_async(dev->intf);
1363 netif_dbg(dev, tx_err, dev->net,
1364 "tx: submit urb err %d\n", retval);
1367 net->trans_start = jiffies;
1368 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1369 if (dev->txq.qlen >= TX_QLEN (dev))
1370 netif_stop_queue (net);
1372 spin_unlock_irqrestore (&dev->txq.lock, flags);
1375 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1377 dev->net->stats.tx_dropped++;
1380 dev_kfree_skb_any (skb);
1386 netif_dbg(dev, tx_queued, dev->net,
1387 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1391 return NETDEV_TX_OK;
1393 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1395 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1401 /* don't refill the queue all at once */
1402 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1403 urb = usb_alloc_urb(0, flags);
1405 ret = rx_submit(dev, urb, flags);
1417 /*-------------------------------------------------------------------------*/
1419 // tasklet (work deferred from completions, in_irq) or timer
1421 static void usbnet_bh (unsigned long param)
1423 struct usbnet *dev = (struct usbnet *) param;
1424 struct sk_buff *skb;
1425 struct skb_data *entry;
1427 while ((skb = skb_dequeue (&dev->done))) {
1428 entry = (struct skb_data *) skb->cb;
1429 switch (entry->state) {
1431 entry->state = rx_cleanup;
1432 rx_process (dev, skb);
1435 kfree(entry->urb->sg);
1437 usb_free_urb (entry->urb);
1438 dev_kfree_skb (skb);
1441 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1445 /* restart RX again after disabling due to high error rate */
1446 clear_bit(EVENT_RX_KILL, &dev->flags);
1448 /* waiting for all pending urbs to complete?
1449 * only then can we forgo submitting anew
1451 if (waitqueue_active(&dev->wait)) {
1452 if (dev->txq.qlen + dev->rxq.qlen + dev->done.qlen == 0)
1453 wake_up_all(&dev->wait);
1455 // or are we maybe short a few urbs?
1456 } else if (netif_running (dev->net) &&
1457 netif_device_present (dev->net) &&
1458 netif_carrier_ok(dev->net) &&
1459 !timer_pending (&dev->delay) &&
1460 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1461 int temp = dev->rxq.qlen;
1463 if (temp < RX_QLEN(dev)) {
1464 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1466 if (temp != dev->rxq.qlen)
1467 netif_dbg(dev, link, dev->net,
1468 "rxqlen %d --> %d\n",
1469 temp, dev->rxq.qlen);
1470 if (dev->rxq.qlen < RX_QLEN(dev))
1471 tasklet_schedule (&dev->bh);
1473 if (dev->txq.qlen < TX_QLEN (dev))
1474 netif_wake_queue (dev->net);
1479 /*-------------------------------------------------------------------------
1481 * USB Device Driver support
1483 *-------------------------------------------------------------------------*/
1485 // precondition: never called in_interrupt
1487 void usbnet_disconnect (struct usb_interface *intf)
1490 struct usb_device *xdev;
1491 struct net_device *net;
1493 dev = usb_get_intfdata(intf);
1494 usb_set_intfdata(intf, NULL);
1498 xdev = interface_to_usbdev (intf);
1500 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1501 intf->dev.driver->name,
1502 xdev->bus->bus_name, xdev->devpath,
1503 dev->driver_info->description);
1506 unregister_netdev (net);
1508 cancel_work_sync(&dev->kevent);
1510 usb_scuttle_anchored_urbs(&dev->deferred);
1512 if (dev->driver_info->unbind)
1513 dev->driver_info->unbind (dev, intf);
1515 usb_kill_urb(dev->interrupt);
1516 usb_free_urb(dev->interrupt);
1517 kfree(dev->padding_pkt);
1521 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1523 static const struct net_device_ops usbnet_netdev_ops = {
1524 .ndo_open = usbnet_open,
1525 .ndo_stop = usbnet_stop,
1526 .ndo_start_xmit = usbnet_start_xmit,
1527 .ndo_tx_timeout = usbnet_tx_timeout,
1528 .ndo_change_mtu = usbnet_change_mtu,
1529 .ndo_set_mac_address = eth_mac_addr,
1530 .ndo_validate_addr = eth_validate_addr,
1533 /*-------------------------------------------------------------------------*/
1535 // precondition: never called in_interrupt
1537 static struct device_type wlan_type = {
1541 static struct device_type wwan_type = {
1546 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1549 struct net_device *net;
1550 struct usb_host_interface *interface;
1551 struct driver_info *info;
1552 struct usb_device *xdev;
1555 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1557 /* usbnet already took usb runtime pm, so have to enable the feature
1558 * for usb interface, otherwise usb_autopm_get_interface may return
1559 * failure if RUNTIME_PM is enabled.
1561 if (!driver->supports_autosuspend) {
1562 driver->supports_autosuspend = 1;
1563 pm_runtime_enable(&udev->dev);
1566 name = udev->dev.driver->name;
1567 info = (struct driver_info *) prod->driver_info;
1569 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1572 xdev = interface_to_usbdev (udev);
1573 interface = udev->cur_altsetting;
1577 // set up our own records
1578 net = alloc_etherdev(sizeof(*dev));
1582 /* netdev_printk() needs this so do it as early as possible */
1583 SET_NETDEV_DEV(net, &udev->dev);
1585 dev = netdev_priv(net);
1588 dev->driver_info = info;
1589 dev->driver_name = name;
1590 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1591 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1592 init_waitqueue_head(&dev->wait);
1593 skb_queue_head_init (&dev->rxq);
1594 skb_queue_head_init (&dev->txq);
1595 skb_queue_head_init (&dev->done);
1596 skb_queue_head_init(&dev->rxq_pause);
1597 dev->bh.func = usbnet_bh;
1598 dev->bh.data = (unsigned long) dev;
1599 INIT_WORK (&dev->kevent, kevent);
1600 init_usb_anchor(&dev->deferred);
1601 dev->delay.function = usbnet_bh;
1602 dev->delay.data = (unsigned long) dev;
1603 init_timer (&dev->delay);
1604 mutex_init (&dev->phy_mutex);
1605 mutex_init(&dev->interrupt_mutex);
1606 dev->interrupt_count = 0;
1609 strcpy (net->name, "usb%d");
1610 memcpy (net->dev_addr, node_id, sizeof node_id);
1612 /* rx and tx sides can use different message sizes;
1613 * bind() should set rx_urb_size in that case.
1615 dev->hard_mtu = net->mtu + net->hard_header_len;
1617 // dma_supported() is deeply broken on almost all architectures
1618 // possible with some EHCI controllers
1619 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1620 net->features |= NETIF_F_HIGHDMA;
1623 net->netdev_ops = &usbnet_netdev_ops;
1624 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1625 net->ethtool_ops = &usbnet_ethtool_ops;
1627 // allow device-specific bind/init procedures
1628 // NOTE net->name still not usable ...
1630 status = info->bind (dev, udev);
1634 // heuristic: "usb%d" for links we know are two-host,
1635 // else "eth%d" when there's reasonable doubt. userspace
1636 // can rename the link if it knows better.
1637 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1638 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1639 (net->dev_addr [0] & 0x02) == 0))
1640 strcpy (net->name, "eth%d");
1641 /* WLAN devices should always be named "wlan%d" */
1642 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1643 strcpy(net->name, "wlan%d");
1644 /* WWAN devices should always be named "wwan%d" */
1645 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1646 strcpy(net->name, "wwan%d");
1648 /* devices that cannot do ARP */
1649 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1650 net->flags |= IFF_NOARP;
1652 /* maybe the remote can't receive an Ethernet MTU */
1653 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1654 net->mtu = dev->hard_mtu - net->hard_header_len;
1655 } else if (!info->in || !info->out)
1656 status = usbnet_get_endpoints (dev, udev);
1658 dev->in = usb_rcvbulkpipe (xdev, info->in);
1659 dev->out = usb_sndbulkpipe (xdev, info->out);
1660 if (!(info->flags & FLAG_NO_SETINT))
1661 status = usb_set_interface (xdev,
1662 interface->desc.bInterfaceNumber,
1663 interface->desc.bAlternateSetting);
1668 if (status >= 0 && dev->status)
1669 status = init_status (dev, udev);
1673 if (!dev->rx_urb_size)
1674 dev->rx_urb_size = dev->hard_mtu;
1675 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1677 /* let userspace know we have a random address */
1678 if (ether_addr_equal(net->dev_addr, node_id))
1679 net->addr_assign_type = NET_ADDR_RANDOM;
1681 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1682 SET_NETDEV_DEVTYPE(net, &wlan_type);
1683 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1684 SET_NETDEV_DEVTYPE(net, &wwan_type);
1686 /* initialize max rx_qlen and tx_qlen */
1687 usbnet_update_max_qlen(dev);
1689 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1690 !(info->flags & FLAG_MULTI_PACKET)) {
1691 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1692 if (!dev->padding_pkt) {
1698 status = register_netdev (net);
1701 netif_info(dev, probe, dev->net,
1702 "register '%s' at usb-%s-%s, %s, %pM\n",
1703 udev->dev.driver->name,
1704 xdev->bus->bus_name, xdev->devpath,
1705 dev->driver_info->description,
1708 // ok, it's ready to go.
1709 usb_set_intfdata (udev, dev);
1711 netif_device_attach (net);
1713 if (dev->driver_info->flags & FLAG_LINK_INTR)
1714 usbnet_link_change(dev, 0, 0);
1719 kfree(dev->padding_pkt);
1721 usb_free_urb(dev->interrupt);
1724 info->unbind (dev, udev);
1730 EXPORT_SYMBOL_GPL(usbnet_probe);
1732 /*-------------------------------------------------------------------------*/
1735 * suspend the whole driver as soon as the first interface is suspended
1736 * resume only when the last interface is resumed
1739 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1741 struct usbnet *dev = usb_get_intfdata(intf);
1743 if (!dev->suspend_count++) {
1744 spin_lock_irq(&dev->txq.lock);
1745 /* don't autosuspend while transmitting */
1746 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1747 dev->suspend_count--;
1748 spin_unlock_irq(&dev->txq.lock);
1751 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1752 spin_unlock_irq(&dev->txq.lock);
1755 * accelerate emptying of the rx and queues, to avoid
1756 * having everything error out.
1758 netif_device_detach (dev->net);
1759 usbnet_terminate_urbs(dev);
1760 __usbnet_status_stop_force(dev);
1763 * reattach so runtime management can use and
1766 netif_device_attach (dev->net);
1770 EXPORT_SYMBOL_GPL(usbnet_suspend);
1772 int usbnet_resume (struct usb_interface *intf)
1774 struct usbnet *dev = usb_get_intfdata(intf);
1775 struct sk_buff *skb;
1779 if (!--dev->suspend_count) {
1780 /* resume interrupt URB if it was previously submitted */
1781 __usbnet_status_start_force(dev, GFP_NOIO);
1783 spin_lock_irq(&dev->txq.lock);
1784 while ((res = usb_get_from_anchor(&dev->deferred))) {
1786 skb = (struct sk_buff *)res->context;
1787 retval = usb_submit_urb(res, GFP_ATOMIC);
1789 dev_kfree_skb_any(skb);
1792 usb_autopm_put_interface_async(dev->intf);
1794 dev->net->trans_start = jiffies;
1795 __skb_queue_tail(&dev->txq, skb);
1800 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1801 spin_unlock_irq(&dev->txq.lock);
1803 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1804 /* handle remote wakeup ASAP
1805 * we cannot race against stop
1807 if (netif_device_present(dev->net) &&
1808 !timer_pending(&dev->delay) &&
1809 !test_bit(EVENT_RX_HALT, &dev->flags))
1810 rx_alloc_submit(dev, GFP_NOIO);
1812 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1813 netif_tx_wake_all_queues(dev->net);
1814 tasklet_schedule (&dev->bh);
1818 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1819 usb_autopm_get_interface_no_resume(intf);
1823 EXPORT_SYMBOL_GPL(usbnet_resume);
1826 * Either a subdriver implements manage_power, then it is assumed to always
1827 * be ready to be suspended or it reports the readiness to be suspended
1830 void usbnet_device_suggests_idle(struct usbnet *dev)
1832 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1833 dev->intf->needs_remote_wakeup = 1;
1834 usb_autopm_put_interface_async(dev->intf);
1837 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1840 * For devices that can do without special commands
1842 int usbnet_manage_power(struct usbnet *dev, int on)
1844 dev->intf->needs_remote_wakeup = on;
1847 EXPORT_SYMBOL(usbnet_manage_power);
1849 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1851 /* update link after link is reseted */
1852 if (link && !need_reset)
1853 netif_carrier_on(dev->net);
1855 netif_carrier_off(dev->net);
1857 if (need_reset && link)
1858 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1860 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1862 EXPORT_SYMBOL(usbnet_link_change);
1864 /*-------------------------------------------------------------------------*/
1865 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1866 u16 value, u16 index, void *data, u16 size)
1871 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1872 " value=0x%04x index=0x%04x size=%d\n",
1873 cmd, reqtype, value, index, size);
1876 buf = kmalloc(size, GFP_KERNEL);
1881 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1882 cmd, reqtype, value, index, buf, size,
1883 USB_CTRL_GET_TIMEOUT);
1884 if (err > 0 && err <= size)
1885 memcpy(data, buf, err);
1891 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1892 u16 value, u16 index, const void *data,
1898 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1899 " value=0x%04x index=0x%04x size=%d\n",
1900 cmd, reqtype, value, index, size);
1903 buf = kmemdup(data, size, GFP_KERNEL);
1908 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1909 cmd, reqtype, value, index, buf, size,
1910 USB_CTRL_SET_TIMEOUT);
1918 * The function can't be called inside suspend/resume callback,
1919 * otherwise deadlock will be caused.
1921 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1922 u16 value, u16 index, void *data, u16 size)
1926 if (usb_autopm_get_interface(dev->intf) < 0)
1928 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1930 usb_autopm_put_interface(dev->intf);
1933 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
1936 * The function can't be called inside suspend/resume callback,
1937 * otherwise deadlock will be caused.
1939 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1940 u16 value, u16 index, const void *data, u16 size)
1944 if (usb_autopm_get_interface(dev->intf) < 0)
1946 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1948 usb_autopm_put_interface(dev->intf);
1951 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
1954 * The function can be called inside suspend/resume callback safely
1955 * and should only be called by suspend/resume callback generally.
1957 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1958 u16 value, u16 index, void *data, u16 size)
1960 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1963 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
1966 * The function can be called inside suspend/resume callback safely
1967 * and should only be called by suspend/resume callback generally.
1969 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1970 u16 value, u16 index, const void *data,
1973 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1976 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
1978 static void usbnet_async_cmd_cb(struct urb *urb)
1980 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
1981 int status = urb->status;
1984 dev_dbg(&urb->dev->dev, "%s failed with %d",
1992 * The caller must make sure that device can't be put into suspend
1993 * state until the control URB completes.
1995 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
1996 u16 value, u16 index, const void *data, u16 size)
1998 struct usb_ctrlrequest *req = NULL;
2003 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2004 " value=0x%04x index=0x%04x size=%d\n",
2005 cmd, reqtype, value, index, size);
2007 urb = usb_alloc_urb(0, GFP_ATOMIC);
2009 netdev_err(dev->net, "Error allocating URB in"
2010 " %s!\n", __func__);
2015 buf = kmemdup(data, size, GFP_ATOMIC);
2017 netdev_err(dev->net, "Error allocating buffer"
2018 " in %s!\n", __func__);
2023 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2027 req->bRequestType = reqtype;
2028 req->bRequest = cmd;
2029 req->wValue = cpu_to_le16(value);
2030 req->wIndex = cpu_to_le16(index);
2031 req->wLength = cpu_to_le16(size);
2033 usb_fill_control_urb(urb, dev->udev,
2034 usb_sndctrlpipe(dev->udev, 0),
2035 (void *)req, buf, size,
2036 usbnet_async_cmd_cb, req);
2037 urb->transfer_flags |= URB_FREE_BUFFER;
2039 err = usb_submit_urb(urb, GFP_ATOMIC);
2041 netdev_err(dev->net, "Error submitting the control"
2042 " message: status=%d\n", err);
2056 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2057 /*-------------------------------------------------------------------------*/
2059 static int __init usbnet_init(void)
2061 /* Compiler should optimize this out. */
2063 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
2065 eth_random_addr(node_id);
2068 module_init(usbnet_init);
2070 static void __exit usbnet_exit(void)
2073 module_exit(usbnet_exit);
2075 MODULE_AUTHOR("David Brownell");
2076 MODULE_DESCRIPTION("USB network driver framework");
2077 MODULE_LICENSE("GPL");