2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 * This is a generic "USB networking" framework that works with several
22 * kinds of full and high speed networking devices: host-to-host cables,
23 * smart usb peripherals, and actual Ethernet adapters.
25 * These devices usually differ in terms of control protocols (if they
26 * even have one!) and sometimes they define new framing to wrap or batch
27 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
28 * so interface (un)binding, endpoint I/O queues, fault handling, and other
29 * issues can usefully be addressed by this framework.
32 // #define DEBUG // error path messages, extra info
33 // #define VERBOSE // more; success messages
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/netdevice.h>
38 #include <linux/etherdevice.h>
39 #include <linux/ctype.h>
40 #include <linux/ethtool.h>
41 #include <linux/workqueue.h>
42 #include <linux/mii.h>
43 #include <linux/usb.h>
44 #include <linux/usb/usbnet.h>
45 #include <linux/slab.h>
46 #include <linux/kernel.h>
47 #include <linux/pm_runtime.h>
49 #define DRIVER_VERSION "22-Aug-2005"
52 /*-------------------------------------------------------------------------*/
55 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
56 * Several dozen bytes of IPv4 data can fit in two such transactions.
57 * One maximum size Ethernet packet takes twenty four of them.
58 * For high speed, each frame comfortably fits almost 36 max size
59 * Ethernet packets (so queues should be bigger).
61 * The goal is to let the USB host controller be busy for 5msec or
62 * more before an irq is required, under load. Jumbograms change
65 #define MAX_QUEUE_MEMORY (60 * 1518)
66 #define RX_QLEN(dev) ((dev)->rx_qlen)
67 #define TX_QLEN(dev) ((dev)->tx_qlen)
69 // reawaken network queue this soon after stopping; else watchdog barks
70 #define TX_TIMEOUT_JIFFIES (5*HZ)
72 /* throttle rx/tx briefly after some faults, so hub_wq might disconnect()
73 * us (it polls at HZ/4 usually) before we report too many false errors.
75 #define THROTTLE_JIFFIES (HZ/8)
78 #define UNLINK_TIMEOUT_MS 3
80 /*-------------------------------------------------------------------------*/
82 // randomly generated ethernet address
83 static u8 node_id
[ETH_ALEN
];
85 static const char driver_name
[] = "usbnet";
87 /* use ethtool to change the level for any given device */
88 static int msg_level
= -1;
89 module_param (msg_level
, int, 0);
90 MODULE_PARM_DESC (msg_level
, "Override default message level");
92 /*-------------------------------------------------------------------------*/
94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
95 int usbnet_get_endpoints(struct usbnet
*dev
, struct usb_interface
*intf
)
98 struct usb_host_interface
*alt
= NULL
;
99 struct usb_host_endpoint
*in
= NULL
, *out
= NULL
;
100 struct usb_host_endpoint
*status
= NULL
;
102 for (tmp
= 0; tmp
< intf
->num_altsetting
; tmp
++) {
105 in
= out
= status
= NULL
;
106 alt
= intf
->altsetting
+ tmp
;
108 /* take the first altsetting with in-bulk + out-bulk;
109 * remember any status endpoint, just in case;
110 * ignore other endpoints and altsettings.
112 for (ep
= 0; ep
< alt
->desc
.bNumEndpoints
; ep
++) {
113 struct usb_host_endpoint
*e
;
116 e
= alt
->endpoint
+ ep
;
117 switch (e
->desc
.bmAttributes
) {
118 case USB_ENDPOINT_XFER_INT
:
119 if (!usb_endpoint_dir_in(&e
->desc
))
123 case USB_ENDPOINT_XFER_BULK
:
128 if (usb_endpoint_dir_in(&e
->desc
)) {
131 else if (intr
&& !status
)
141 if (!alt
|| !in
|| !out
)
144 if (alt
->desc
.bAlternateSetting
!= 0 ||
145 !(dev
->driver_info
->flags
& FLAG_NO_SETINT
)) {
146 tmp
= usb_set_interface (dev
->udev
, alt
->desc
.bInterfaceNumber
,
147 alt
->desc
.bAlternateSetting
);
152 dev
->in
= usb_rcvbulkpipe (dev
->udev
,
153 in
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
154 dev
->out
= usb_sndbulkpipe (dev
->udev
,
155 out
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
156 dev
->status
= status
;
159 EXPORT_SYMBOL_GPL(usbnet_get_endpoints
);
161 int usbnet_get_ethernet_addr(struct usbnet
*dev
, int iMACAddress
)
164 unsigned char buf
[13];
166 ret
= usb_string(dev
->udev
, iMACAddress
, buf
, sizeof buf
);
168 tmp
= hex2bin(dev
->net
->dev_addr
, buf
, 6);
170 dev_dbg(&dev
->udev
->dev
,
171 "bad MAC string %d fetch, %d\n", iMACAddress
, tmp
);
178 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr
);
180 static void intr_complete (struct urb
*urb
)
182 struct usbnet
*dev
= urb
->context
;
183 int status
= urb
->status
;
188 dev
->driver_info
->status(dev
, urb
);
191 /* software-driven interface shutdown */
192 case -ENOENT
: /* urb killed */
193 case -ESHUTDOWN
: /* hardware gone */
194 netif_dbg(dev
, ifdown
, dev
->net
,
195 "intr shutdown, code %d\n", status
);
198 /* NOTE: not throttling like RX/TX, since this endpoint
199 * already polls infrequently
202 netdev_dbg(dev
->net
, "intr status %d\n", status
);
206 status
= usb_submit_urb (urb
, GFP_ATOMIC
);
208 netif_err(dev
, timer
, dev
->net
,
209 "intr resubmit --> %d\n", status
);
212 static int init_status (struct usbnet
*dev
, struct usb_interface
*intf
)
219 if (!dev
->driver_info
->status
)
222 pipe
= usb_rcvintpipe (dev
->udev
,
223 dev
->status
->desc
.bEndpointAddress
224 & USB_ENDPOINT_NUMBER_MASK
);
225 maxp
= usb_maxpacket (dev
->udev
, pipe
, 0);
227 /* avoid 1 msec chatter: min 8 msec poll rate */
228 period
= max ((int) dev
->status
->desc
.bInterval
,
229 (dev
->udev
->speed
== USB_SPEED_HIGH
) ? 7 : 3);
231 buf
= kmalloc (maxp
, GFP_KERNEL
);
233 dev
->interrupt
= usb_alloc_urb (0, GFP_KERNEL
);
234 if (!dev
->interrupt
) {
238 usb_fill_int_urb(dev
->interrupt
, dev
->udev
, pipe
,
239 buf
, maxp
, intr_complete
, dev
, period
);
240 dev
->interrupt
->transfer_flags
|= URB_FREE_BUFFER
;
242 "status ep%din, %d bytes period %d\n",
243 usb_pipeendpoint(pipe
), maxp
, period
);
249 /* Submit the interrupt URB if not previously submitted, increasing refcount */
250 int usbnet_status_start(struct usbnet
*dev
, gfp_t mem_flags
)
254 WARN_ON_ONCE(dev
->interrupt
== NULL
);
255 if (dev
->interrupt
) {
256 mutex_lock(&dev
->interrupt_mutex
);
258 if (++dev
->interrupt_count
== 1)
259 ret
= usb_submit_urb(dev
->interrupt
, mem_flags
);
261 dev_dbg(&dev
->udev
->dev
, "incremented interrupt URB count to %d\n",
262 dev
->interrupt_count
);
263 mutex_unlock(&dev
->interrupt_mutex
);
267 EXPORT_SYMBOL_GPL(usbnet_status_start
);
269 /* For resume; submit interrupt URB if previously submitted */
270 static int __usbnet_status_start_force(struct usbnet
*dev
, gfp_t mem_flags
)
274 mutex_lock(&dev
->interrupt_mutex
);
275 if (dev
->interrupt_count
) {
276 ret
= usb_submit_urb(dev
->interrupt
, mem_flags
);
277 dev_dbg(&dev
->udev
->dev
,
278 "submitted interrupt URB for resume\n");
280 mutex_unlock(&dev
->interrupt_mutex
);
284 /* Kill the interrupt URB if all submitters want it killed */
285 void usbnet_status_stop(struct usbnet
*dev
)
287 if (dev
->interrupt
) {
288 mutex_lock(&dev
->interrupt_mutex
);
289 WARN_ON(dev
->interrupt_count
== 0);
291 if (dev
->interrupt_count
&& --dev
->interrupt_count
== 0)
292 usb_kill_urb(dev
->interrupt
);
294 dev_dbg(&dev
->udev
->dev
,
295 "decremented interrupt URB count to %d\n",
296 dev
->interrupt_count
);
297 mutex_unlock(&dev
->interrupt_mutex
);
300 EXPORT_SYMBOL_GPL(usbnet_status_stop
);
302 /* For suspend; always kill interrupt URB */
303 static void __usbnet_status_stop_force(struct usbnet
*dev
)
305 if (dev
->interrupt
) {
306 mutex_lock(&dev
->interrupt_mutex
);
307 usb_kill_urb(dev
->interrupt
);
308 dev_dbg(&dev
->udev
->dev
, "killed interrupt URB for suspend\n");
309 mutex_unlock(&dev
->interrupt_mutex
);
313 /* Passes this packet up the stack, updating its accounting.
314 * Some link protocols batch packets, so their rx_fixup paths
315 * can return clones as well as just modify the original skb.
317 void usbnet_skb_return (struct usbnet
*dev
, struct sk_buff
*skb
)
321 if (test_bit(EVENT_RX_PAUSED
, &dev
->flags
)) {
322 skb_queue_tail(&dev
->rxq_pause
, skb
);
326 /* only update if unset to allow minidriver rx_fixup override */
327 if (skb
->protocol
== 0)
328 skb
->protocol
= eth_type_trans (skb
, dev
->net
);
330 dev
->net
->stats
.rx_packets
++;
331 dev
->net
->stats
.rx_bytes
+= skb
->len
;
333 netif_dbg(dev
, rx_status
, dev
->net
, "< rx, len %zu, type 0x%x\n",
334 skb
->len
+ sizeof (struct ethhdr
), skb
->protocol
);
335 memset (skb
->cb
, 0, sizeof (struct skb_data
));
337 if (skb_defer_rx_timestamp(skb
))
340 status
= netif_rx (skb
);
341 if (status
!= NET_RX_SUCCESS
)
342 netif_dbg(dev
, rx_err
, dev
->net
,
343 "netif_rx status %d\n", status
);
345 EXPORT_SYMBOL_GPL(usbnet_skb_return
);
347 /* must be called if hard_mtu or rx_urb_size changed */
348 void usbnet_update_max_qlen(struct usbnet
*dev
)
350 enum usb_device_speed speed
= dev
->udev
->speed
;
354 dev
->rx_qlen
= MAX_QUEUE_MEMORY
/ dev
->rx_urb_size
;
355 dev
->tx_qlen
= MAX_QUEUE_MEMORY
/ dev
->hard_mtu
;
357 case USB_SPEED_SUPER
:
358 case USB_SPEED_SUPER_PLUS
:
360 * Not take default 5ms qlen for super speed HC to
361 * save memory, and iperf tests show 2.5ms qlen can
364 dev
->rx_qlen
= 5 * MAX_QUEUE_MEMORY
/ dev
->rx_urb_size
;
365 dev
->tx_qlen
= 5 * MAX_QUEUE_MEMORY
/ dev
->hard_mtu
;
368 dev
->rx_qlen
= dev
->tx_qlen
= 4;
371 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen
);
374 /*-------------------------------------------------------------------------
376 * Network Device Driver (peer link to "Host Device", from USB host)
378 *-------------------------------------------------------------------------*/
380 int usbnet_change_mtu (struct net_device
*net
, int new_mtu
)
382 struct usbnet
*dev
= netdev_priv(net
);
383 int ll_mtu
= new_mtu
+ net
->hard_header_len
;
384 int old_hard_mtu
= dev
->hard_mtu
;
385 int old_rx_urb_size
= dev
->rx_urb_size
;
389 // no second zero-length packet read wanted after mtu-sized packets
390 if ((ll_mtu
% dev
->maxpacket
) == 0)
394 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
395 if (dev
->rx_urb_size
== old_hard_mtu
) {
396 dev
->rx_urb_size
= dev
->hard_mtu
;
397 if (dev
->rx_urb_size
> old_rx_urb_size
) {
398 usbnet_pause_rx(dev
);
399 usbnet_unlink_rx_urbs(dev
);
400 usbnet_resume_rx(dev
);
404 /* max qlen depend on hard_mtu and rx_urb_size */
405 usbnet_update_max_qlen(dev
);
409 EXPORT_SYMBOL_GPL(usbnet_change_mtu
);
411 /* The caller must hold list->lock */
412 static void __usbnet_queue_skb(struct sk_buff_head
*list
,
413 struct sk_buff
*newsk
, enum skb_state state
)
415 struct skb_data
*entry
= (struct skb_data
*) newsk
->cb
;
417 __skb_queue_tail(list
, newsk
);
418 entry
->state
= state
;
421 /*-------------------------------------------------------------------------*/
423 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
424 * completion callbacks. 2.5 should have fixed those bugs...
427 static enum skb_state
defer_bh(struct usbnet
*dev
, struct sk_buff
*skb
,
428 struct sk_buff_head
*list
, enum skb_state state
)
431 enum skb_state old_state
;
432 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
434 spin_lock_irqsave(&list
->lock
, flags
);
435 old_state
= entry
->state
;
436 entry
->state
= state
;
437 __skb_unlink(skb
, list
);
439 /* defer_bh() is never called with list == &dev->done.
440 * spin_lock_nested() tells lockdep that it is OK to take
441 * dev->done.lock here with list->lock held.
443 spin_lock_nested(&dev
->done
.lock
, SINGLE_DEPTH_NESTING
);
445 __skb_queue_tail(&dev
->done
, skb
);
446 if (dev
->done
.qlen
== 1)
447 tasklet_schedule(&dev
->bh
);
448 spin_unlock(&dev
->done
.lock
);
449 spin_unlock_irqrestore(&list
->lock
, flags
);
453 /* some work can't be done in tasklets, so we use keventd
455 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
456 * but tasklet_schedule() doesn't. hope the failure is rare.
458 void usbnet_defer_kevent (struct usbnet
*dev
, int work
)
460 set_bit (work
, &dev
->flags
);
461 if (!schedule_work (&dev
->kevent
)) {
463 netdev_err(dev
->net
, "kevent %d may have been dropped\n", work
);
465 netdev_dbg(dev
->net
, "kevent %d scheduled\n", work
);
468 EXPORT_SYMBOL_GPL(usbnet_defer_kevent
);
470 /*-------------------------------------------------------------------------*/
472 static void rx_complete (struct urb
*urb
);
474 static int rx_submit (struct usbnet
*dev
, struct urb
*urb
, gfp_t flags
)
477 struct skb_data
*entry
;
479 unsigned long lockflags
;
480 size_t size
= dev
->rx_urb_size
;
482 /* prevent rx skb allocation when error ratio is high */
483 if (test_bit(EVENT_RX_KILL
, &dev
->flags
)) {
488 skb
= __netdev_alloc_skb_ip_align(dev
->net
, size
, flags
);
490 netif_dbg(dev
, rx_err
, dev
->net
, "no rx skb\n");
491 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
496 entry
= (struct skb_data
*) skb
->cb
;
501 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->in
,
502 skb
->data
, size
, rx_complete
, skb
);
504 spin_lock_irqsave (&dev
->rxq
.lock
, lockflags
);
506 if (netif_running (dev
->net
) &&
507 netif_device_present (dev
->net
) &&
508 !test_bit (EVENT_RX_HALT
, &dev
->flags
) &&
509 !test_bit (EVENT_DEV_ASLEEP
, &dev
->flags
)) {
510 switch (retval
= usb_submit_urb (urb
, GFP_ATOMIC
)) {
512 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
515 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
518 netif_dbg(dev
, ifdown
, dev
->net
, "device gone\n");
519 netif_device_detach (dev
->net
);
525 netif_dbg(dev
, rx_err
, dev
->net
,
526 "rx submit, %d\n", retval
);
527 tasklet_schedule (&dev
->bh
);
530 __usbnet_queue_skb(&dev
->rxq
, skb
, rx_start
);
533 netif_dbg(dev
, ifdown
, dev
->net
, "rx: stopped\n");
536 spin_unlock_irqrestore (&dev
->rxq
.lock
, lockflags
);
538 dev_kfree_skb_any (skb
);
545 /*-------------------------------------------------------------------------*/
547 static inline void rx_process (struct usbnet
*dev
, struct sk_buff
*skb
)
549 if (dev
->driver_info
->rx_fixup
&&
550 !dev
->driver_info
->rx_fixup (dev
, skb
)) {
551 /* With RX_ASSEMBLE, rx_fixup() must update counters */
552 if (!(dev
->driver_info
->flags
& FLAG_RX_ASSEMBLE
))
553 dev
->net
->stats
.rx_errors
++;
556 // else network stack removes extra byte if we forced a short packet
558 /* all data was already cloned from skb inside the driver */
559 if (dev
->driver_info
->flags
& FLAG_MULTI_PACKET
)
562 if (skb
->len
< ETH_HLEN
) {
563 dev
->net
->stats
.rx_errors
++;
564 dev
->net
->stats
.rx_length_errors
++;
565 netif_dbg(dev
, rx_err
, dev
->net
, "rx length %d\n", skb
->len
);
567 usbnet_skb_return(dev
, skb
);
572 skb_queue_tail(&dev
->done
, skb
);
575 /*-------------------------------------------------------------------------*/
577 static void rx_complete (struct urb
*urb
)
579 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
580 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
581 struct usbnet
*dev
= entry
->dev
;
582 int urb_status
= urb
->status
;
583 enum skb_state state
;
585 skb_put (skb
, urb
->actual_length
);
589 switch (urb_status
) {
594 /* stalls need manual reset. this is rare ... except that
595 * when going through USB 2.0 TTs, unplug appears this way.
596 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
597 * storm, recovering as needed.
600 dev
->net
->stats
.rx_errors
++;
601 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
604 /* software-driven interface shutdown */
605 case -ECONNRESET
: /* async unlink */
606 case -ESHUTDOWN
: /* hardware gone */
607 netif_dbg(dev
, ifdown
, dev
->net
,
608 "rx shutdown, code %d\n", urb_status
);
611 /* we get controller i/o faults during hub_wq disconnect() delays.
612 * throttle down resubmits, to avoid log floods; just temporarily,
613 * so we still recover when the fault isn't a hub_wq delay.
618 dev
->net
->stats
.rx_errors
++;
619 if (!timer_pending (&dev
->delay
)) {
620 mod_timer (&dev
->delay
, jiffies
+ THROTTLE_JIFFIES
);
621 netif_dbg(dev
, link
, dev
->net
,
622 "rx throttle %d\n", urb_status
);
630 /* data overrun ... flush fifo? */
632 dev
->net
->stats
.rx_over_errors
++;
637 dev
->net
->stats
.rx_errors
++;
638 netif_dbg(dev
, rx_err
, dev
->net
, "rx status %d\n", urb_status
);
642 /* stop rx if packet error rate is high */
643 if (++dev
->pkt_cnt
> 30) {
647 if (state
== rx_cleanup
)
649 if (dev
->pkt_err
> 20)
650 set_bit(EVENT_RX_KILL
, &dev
->flags
);
653 state
= defer_bh(dev
, skb
, &dev
->rxq
, state
);
656 if (netif_running (dev
->net
) &&
657 !test_bit (EVENT_RX_HALT
, &dev
->flags
) &&
658 state
!= unlink_start
) {
659 rx_submit (dev
, urb
, GFP_ATOMIC
);
660 usb_mark_last_busy(dev
->udev
);
665 netif_dbg(dev
, rx_err
, dev
->net
, "no read resubmitted\n");
668 /*-------------------------------------------------------------------------*/
669 void usbnet_pause_rx(struct usbnet
*dev
)
671 set_bit(EVENT_RX_PAUSED
, &dev
->flags
);
673 netif_dbg(dev
, rx_status
, dev
->net
, "paused rx queue enabled\n");
675 EXPORT_SYMBOL_GPL(usbnet_pause_rx
);
677 void usbnet_resume_rx(struct usbnet
*dev
)
682 clear_bit(EVENT_RX_PAUSED
, &dev
->flags
);
684 while ((skb
= skb_dequeue(&dev
->rxq_pause
)) != NULL
) {
685 usbnet_skb_return(dev
, skb
);
689 tasklet_schedule(&dev
->bh
);
691 netif_dbg(dev
, rx_status
, dev
->net
,
692 "paused rx queue disabled, %d skbs requeued\n", num
);
694 EXPORT_SYMBOL_GPL(usbnet_resume_rx
);
696 void usbnet_purge_paused_rxq(struct usbnet
*dev
)
698 skb_queue_purge(&dev
->rxq_pause
);
700 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq
);
702 /*-------------------------------------------------------------------------*/
704 // unlink pending rx/tx; completion handlers do all other cleanup
706 static int unlink_urbs (struct usbnet
*dev
, struct sk_buff_head
*q
)
712 spin_lock_irqsave (&q
->lock
, flags
);
713 while (!skb_queue_empty(q
)) {
714 struct skb_data
*entry
;
718 skb_queue_walk(q
, skb
) {
719 entry
= (struct skb_data
*) skb
->cb
;
720 if (entry
->state
!= unlink_start
)
725 entry
->state
= unlink_start
;
729 * Get reference count of the URB to avoid it to be
730 * freed during usb_unlink_urb, which may trigger
731 * use-after-free problem inside usb_unlink_urb since
732 * usb_unlink_urb is always racing with .complete
733 * handler(include defer_bh).
736 spin_unlock_irqrestore(&q
->lock
, flags
);
737 // during some PM-driven resume scenarios,
738 // these (async) unlinks complete immediately
739 retval
= usb_unlink_urb (urb
);
740 if (retval
!= -EINPROGRESS
&& retval
!= 0)
741 netdev_dbg(dev
->net
, "unlink urb err, %d\n", retval
);
745 spin_lock_irqsave(&q
->lock
, flags
);
747 spin_unlock_irqrestore (&q
->lock
, flags
);
751 // Flush all pending rx urbs
752 // minidrivers may need to do this when the MTU changes
754 void usbnet_unlink_rx_urbs(struct usbnet
*dev
)
756 if (netif_running(dev
->net
)) {
757 (void) unlink_urbs (dev
, &dev
->rxq
);
758 tasklet_schedule(&dev
->bh
);
761 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs
);
763 /*-------------------------------------------------------------------------*/
765 static void wait_skb_queue_empty(struct sk_buff_head
*q
)
769 spin_lock_irqsave(&q
->lock
, flags
);
770 while (!skb_queue_empty(q
)) {
771 spin_unlock_irqrestore(&q
->lock
, flags
);
772 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS
));
773 set_current_state(TASK_UNINTERRUPTIBLE
);
774 spin_lock_irqsave(&q
->lock
, flags
);
776 spin_unlock_irqrestore(&q
->lock
, flags
);
779 // precondition: never called in_interrupt
780 static void usbnet_terminate_urbs(struct usbnet
*dev
)
782 DECLARE_WAITQUEUE(wait
, current
);
785 /* ensure there are no more active urbs */
786 add_wait_queue(&dev
->wait
, &wait
);
787 set_current_state(TASK_UNINTERRUPTIBLE
);
788 temp
= unlink_urbs(dev
, &dev
->txq
) +
789 unlink_urbs(dev
, &dev
->rxq
);
791 /* maybe wait for deletions to finish. */
792 wait_skb_queue_empty(&dev
->rxq
);
793 wait_skb_queue_empty(&dev
->txq
);
794 wait_skb_queue_empty(&dev
->done
);
795 netif_dbg(dev
, ifdown
, dev
->net
,
796 "waited for %d urb completions\n", temp
);
797 set_current_state(TASK_RUNNING
);
798 remove_wait_queue(&dev
->wait
, &wait
);
801 int usbnet_stop (struct net_device
*net
)
803 struct usbnet
*dev
= netdev_priv(net
);
804 struct driver_info
*info
= dev
->driver_info
;
807 clear_bit(EVENT_DEV_OPEN
, &dev
->flags
);
808 netif_stop_queue (net
);
810 netif_info(dev
, ifdown
, dev
->net
,
811 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
812 net
->stats
.rx_packets
, net
->stats
.tx_packets
,
813 net
->stats
.rx_errors
, net
->stats
.tx_errors
);
815 /* to not race resume */
816 pm
= usb_autopm_get_interface(dev
->intf
);
817 /* allow minidriver to stop correctly (wireless devices to turn off
820 retval
= info
->stop(dev
);
822 netif_info(dev
, ifdown
, dev
->net
,
823 "stop fail (%d) usbnet usb-%s-%s, %s\n",
825 dev
->udev
->bus
->bus_name
, dev
->udev
->devpath
,
829 if (!(info
->flags
& FLAG_AVOID_UNLINK_URBS
))
830 usbnet_terminate_urbs(dev
);
832 usbnet_status_stop(dev
);
834 usbnet_purge_paused_rxq(dev
);
836 mpn
= !test_and_clear_bit(EVENT_NO_RUNTIME_PM
, &dev
->flags
);
838 /* deferred work (task, timer, softirq) must also stop.
839 * can't flush_scheduled_work() until we drop rtnl (later),
840 * else workers could deadlock; so make workers a NOP.
843 del_timer_sync (&dev
->delay
);
844 tasklet_kill (&dev
->bh
);
846 usb_autopm_put_interface(dev
->intf
);
848 if (info
->manage_power
&& mpn
)
849 info
->manage_power(dev
, 0);
851 usb_autopm_put_interface(dev
->intf
);
855 EXPORT_SYMBOL_GPL(usbnet_stop
);
857 /*-------------------------------------------------------------------------*/
859 // posts reads, and enables write queuing
861 // precondition: never called in_interrupt
863 int usbnet_open (struct net_device
*net
)
865 struct usbnet
*dev
= netdev_priv(net
);
867 struct driver_info
*info
= dev
->driver_info
;
869 if ((retval
= usb_autopm_get_interface(dev
->intf
)) < 0) {
870 netif_info(dev
, ifup
, dev
->net
,
871 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
873 dev
->udev
->bus
->bus_name
,
879 // put into "known safe" state
880 if (info
->reset
&& (retval
= info
->reset (dev
)) < 0) {
881 netif_info(dev
, ifup
, dev
->net
,
882 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
884 dev
->udev
->bus
->bus_name
,
890 /* hard_mtu or rx_urb_size may change in reset() */
891 usbnet_update_max_qlen(dev
);
893 // insist peer be connected
894 if (info
->check_connect
&& (retval
= info
->check_connect (dev
)) < 0) {
895 netif_dbg(dev
, ifup
, dev
->net
, "can't open; %d\n", retval
);
899 /* start any status interrupt transfer */
900 if (dev
->interrupt
) {
901 retval
= usbnet_status_start(dev
, GFP_KERNEL
);
903 netif_err(dev
, ifup
, dev
->net
,
904 "intr submit %d\n", retval
);
909 set_bit(EVENT_DEV_OPEN
, &dev
->flags
);
910 netif_start_queue (net
);
911 netif_info(dev
, ifup
, dev
->net
,
912 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
913 (int)RX_QLEN(dev
), (int)TX_QLEN(dev
),
915 (dev
->driver_info
->flags
& FLAG_FRAMING_NC
) ? "NetChip" :
916 (dev
->driver_info
->flags
& FLAG_FRAMING_GL
) ? "GeneSys" :
917 (dev
->driver_info
->flags
& FLAG_FRAMING_Z
) ? "Zaurus" :
918 (dev
->driver_info
->flags
& FLAG_FRAMING_RN
) ? "RNDIS" :
919 (dev
->driver_info
->flags
& FLAG_FRAMING_AX
) ? "ASIX" :
922 /* reset rx error state */
925 clear_bit(EVENT_RX_KILL
, &dev
->flags
);
927 // delay posting reads until we're fully open
928 tasklet_schedule (&dev
->bh
);
929 if (info
->manage_power
) {
930 retval
= info
->manage_power(dev
, 1);
933 set_bit(EVENT_NO_RUNTIME_PM
, &dev
->flags
);
935 usb_autopm_put_interface(dev
->intf
);
940 usb_autopm_put_interface(dev
->intf
);
944 EXPORT_SYMBOL_GPL(usbnet_open
);
946 /*-------------------------------------------------------------------------*/
948 /* ethtool methods; minidrivers may need to add some more, but
949 * they'll probably want to use this base set.
952 int usbnet_get_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
)
954 struct usbnet
*dev
= netdev_priv(net
);
956 if (!dev
->mii
.mdio_read
)
959 return mii_ethtool_gset(&dev
->mii
, cmd
);
961 EXPORT_SYMBOL_GPL(usbnet_get_settings
);
963 int usbnet_set_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
)
965 struct usbnet
*dev
= netdev_priv(net
);
968 if (!dev
->mii
.mdio_write
)
971 retval
= mii_ethtool_sset(&dev
->mii
, cmd
);
973 /* link speed/duplex might have changed */
974 if (dev
->driver_info
->link_reset
)
975 dev
->driver_info
->link_reset(dev
);
977 /* hard_mtu or rx_urb_size may change in link_reset() */
978 usbnet_update_max_qlen(dev
);
983 EXPORT_SYMBOL_GPL(usbnet_set_settings
);
985 u32
usbnet_get_link (struct net_device
*net
)
987 struct usbnet
*dev
= netdev_priv(net
);
989 /* If a check_connect is defined, return its result */
990 if (dev
->driver_info
->check_connect
)
991 return dev
->driver_info
->check_connect (dev
) == 0;
993 /* if the device has mii operations, use those */
994 if (dev
->mii
.mdio_read
)
995 return mii_link_ok(&dev
->mii
);
997 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
998 return ethtool_op_get_link(net
);
1000 EXPORT_SYMBOL_GPL(usbnet_get_link
);
1002 int usbnet_nway_reset(struct net_device
*net
)
1004 struct usbnet
*dev
= netdev_priv(net
);
1006 if (!dev
->mii
.mdio_write
)
1009 return mii_nway_restart(&dev
->mii
);
1011 EXPORT_SYMBOL_GPL(usbnet_nway_reset
);
1013 void usbnet_get_drvinfo (struct net_device
*net
, struct ethtool_drvinfo
*info
)
1015 struct usbnet
*dev
= netdev_priv(net
);
1017 strlcpy (info
->driver
, dev
->driver_name
, sizeof info
->driver
);
1018 strlcpy (info
->version
, DRIVER_VERSION
, sizeof info
->version
);
1019 strlcpy (info
->fw_version
, dev
->driver_info
->description
,
1020 sizeof info
->fw_version
);
1021 usb_make_path (dev
->udev
, info
->bus_info
, sizeof info
->bus_info
);
1023 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo
);
1025 u32
usbnet_get_msglevel (struct net_device
*net
)
1027 struct usbnet
*dev
= netdev_priv(net
);
1029 return dev
->msg_enable
;
1031 EXPORT_SYMBOL_GPL(usbnet_get_msglevel
);
1033 void usbnet_set_msglevel (struct net_device
*net
, u32 level
)
1035 struct usbnet
*dev
= netdev_priv(net
);
1037 dev
->msg_enable
= level
;
1039 EXPORT_SYMBOL_GPL(usbnet_set_msglevel
);
1041 /* drivers may override default ethtool_ops in their bind() routine */
1042 static const struct ethtool_ops usbnet_ethtool_ops
= {
1043 .get_settings
= usbnet_get_settings
,
1044 .set_settings
= usbnet_set_settings
,
1045 .get_link
= usbnet_get_link
,
1046 .nway_reset
= usbnet_nway_reset
,
1047 .get_drvinfo
= usbnet_get_drvinfo
,
1048 .get_msglevel
= usbnet_get_msglevel
,
1049 .set_msglevel
= usbnet_set_msglevel
,
1050 .get_ts_info
= ethtool_op_get_ts_info
,
1053 /*-------------------------------------------------------------------------*/
1055 static void __handle_link_change(struct usbnet
*dev
)
1057 if (!test_bit(EVENT_DEV_OPEN
, &dev
->flags
))
1060 if (!netif_carrier_ok(dev
->net
)) {
1061 /* kill URBs for reading packets to save bus bandwidth */
1062 unlink_urbs(dev
, &dev
->rxq
);
1065 * tx_timeout will unlink URBs for sending packets and
1066 * tx queue is stopped by netcore after link becomes off
1069 /* submitting URBs for reading packets */
1070 tasklet_schedule(&dev
->bh
);
1073 /* hard_mtu or rx_urb_size may change during link change */
1074 usbnet_update_max_qlen(dev
);
1076 clear_bit(EVENT_LINK_CHANGE
, &dev
->flags
);
1079 static void usbnet_set_rx_mode(struct net_device
*net
)
1081 struct usbnet
*dev
= netdev_priv(net
);
1083 usbnet_defer_kevent(dev
, EVENT_SET_RX_MODE
);
1086 static void __handle_set_rx_mode(struct usbnet
*dev
)
1088 if (dev
->driver_info
->set_rx_mode
)
1089 (dev
->driver_info
->set_rx_mode
)(dev
);
1091 clear_bit(EVENT_SET_RX_MODE
, &dev
->flags
);
1094 /* work that cannot be done in interrupt context uses keventd.
1096 * NOTE: with 2.5 we could do more of this using completion callbacks,
1097 * especially now that control transfers can be queued.
1100 usbnet_deferred_kevent (struct work_struct
*work
)
1102 struct usbnet
*dev
=
1103 container_of(work
, struct usbnet
, kevent
);
1106 /* usb_clear_halt() needs a thread context */
1107 if (test_bit (EVENT_TX_HALT
, &dev
->flags
)) {
1108 unlink_urbs (dev
, &dev
->txq
);
1109 status
= usb_autopm_get_interface(dev
->intf
);
1112 status
= usb_clear_halt (dev
->udev
, dev
->out
);
1113 usb_autopm_put_interface(dev
->intf
);
1116 status
!= -ESHUTDOWN
) {
1117 if (netif_msg_tx_err (dev
))
1119 netdev_err(dev
->net
, "can't clear tx halt, status %d\n",
1122 clear_bit (EVENT_TX_HALT
, &dev
->flags
);
1123 if (status
!= -ESHUTDOWN
)
1124 netif_wake_queue (dev
->net
);
1127 if (test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
1128 unlink_urbs (dev
, &dev
->rxq
);
1129 status
= usb_autopm_get_interface(dev
->intf
);
1132 status
= usb_clear_halt (dev
->udev
, dev
->in
);
1133 usb_autopm_put_interface(dev
->intf
);
1136 status
!= -ESHUTDOWN
) {
1137 if (netif_msg_rx_err (dev
))
1139 netdev_err(dev
->net
, "can't clear rx halt, status %d\n",
1142 clear_bit (EVENT_RX_HALT
, &dev
->flags
);
1143 tasklet_schedule (&dev
->bh
);
1147 /* tasklet could resubmit itself forever if memory is tight */
1148 if (test_bit (EVENT_RX_MEMORY
, &dev
->flags
)) {
1149 struct urb
*urb
= NULL
;
1152 if (netif_running (dev
->net
))
1153 urb
= usb_alloc_urb (0, GFP_KERNEL
);
1155 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
1157 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
1158 status
= usb_autopm_get_interface(dev
->intf
);
1163 if (rx_submit (dev
, urb
, GFP_KERNEL
) == -ENOLINK
)
1165 usb_autopm_put_interface(dev
->intf
);
1168 tasklet_schedule (&dev
->bh
);
1172 if (test_bit (EVENT_LINK_RESET
, &dev
->flags
)) {
1173 struct driver_info
*info
= dev
->driver_info
;
1176 clear_bit (EVENT_LINK_RESET
, &dev
->flags
);
1177 status
= usb_autopm_get_interface(dev
->intf
);
1180 if(info
->link_reset
&& (retval
= info
->link_reset(dev
)) < 0) {
1181 usb_autopm_put_interface(dev
->intf
);
1183 netdev_info(dev
->net
, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1185 dev
->udev
->bus
->bus_name
,
1189 usb_autopm_put_interface(dev
->intf
);
1192 /* handle link change from link resetting */
1193 __handle_link_change(dev
);
1196 if (test_bit (EVENT_LINK_CHANGE
, &dev
->flags
))
1197 __handle_link_change(dev
);
1199 if (test_bit (EVENT_SET_RX_MODE
, &dev
->flags
))
1200 __handle_set_rx_mode(dev
);
1204 netdev_dbg(dev
->net
, "kevent done, flags = 0x%lx\n", dev
->flags
);
1207 /*-------------------------------------------------------------------------*/
1209 static void tx_complete (struct urb
*urb
)
1211 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
1212 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
1213 struct usbnet
*dev
= entry
->dev
;
1215 if (urb
->status
== 0) {
1216 dev
->net
->stats
.tx_packets
+= entry
->packets
;
1217 dev
->net
->stats
.tx_bytes
+= entry
->length
;
1219 dev
->net
->stats
.tx_errors
++;
1221 switch (urb
->status
) {
1223 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
1226 /* software-driven interface shutdown */
1227 case -ECONNRESET
: // async unlink
1228 case -ESHUTDOWN
: // hardware gone
1231 /* like rx, tx gets controller i/o faults during hub_wq
1232 * delays and so it uses the same throttling mechanism.
1237 usb_mark_last_busy(dev
->udev
);
1238 if (!timer_pending (&dev
->delay
)) {
1239 mod_timer (&dev
->delay
,
1240 jiffies
+ THROTTLE_JIFFIES
);
1241 netif_dbg(dev
, link
, dev
->net
,
1242 "tx throttle %d\n", urb
->status
);
1244 netif_stop_queue (dev
->net
);
1247 netif_dbg(dev
, tx_err
, dev
->net
,
1248 "tx err %d\n", entry
->urb
->status
);
1253 usb_autopm_put_interface_async(dev
->intf
);
1254 (void) defer_bh(dev
, skb
, &dev
->txq
, tx_done
);
1257 /*-------------------------------------------------------------------------*/
1259 void usbnet_tx_timeout (struct net_device
*net
)
1261 struct usbnet
*dev
= netdev_priv(net
);
1263 unlink_urbs (dev
, &dev
->txq
);
1264 tasklet_schedule (&dev
->bh
);
1265 /* this needs to be handled individually because the generic layer
1266 * doesn't know what is sufficient and could not restore private
1267 * information if a remedy of an unconditional reset were used.
1269 if (dev
->driver_info
->recover
)
1270 (dev
->driver_info
->recover
)(dev
);
1272 EXPORT_SYMBOL_GPL(usbnet_tx_timeout
);
1274 /*-------------------------------------------------------------------------*/
1276 static int build_dma_sg(const struct sk_buff
*skb
, struct urb
*urb
)
1278 unsigned num_sgs
, total_len
= 0;
1281 num_sgs
= skb_shinfo(skb
)->nr_frags
+ 1;
1285 /* reserve one for zero packet */
1286 urb
->sg
= kmalloc((num_sgs
+ 1) * sizeof(struct scatterlist
),
1291 urb
->num_sgs
= num_sgs
;
1292 sg_init_table(urb
->sg
, urb
->num_sgs
+ 1);
1294 sg_set_buf(&urb
->sg
[s
++], skb
->data
, skb_headlen(skb
));
1295 total_len
+= skb_headlen(skb
);
1297 for (i
= 0; i
< skb_shinfo(skb
)->nr_frags
; i
++) {
1298 struct skb_frag_struct
*f
= &skb_shinfo(skb
)->frags
[i
];
1300 total_len
+= skb_frag_size(f
);
1301 sg_set_page(&urb
->sg
[i
+ s
], f
->page
.p
, f
->size
,
1304 urb
->transfer_buffer_length
= total_len
;
1309 netdev_tx_t
usbnet_start_xmit (struct sk_buff
*skb
,
1310 struct net_device
*net
)
1312 struct usbnet
*dev
= netdev_priv(net
);
1313 unsigned int length
;
1314 struct urb
*urb
= NULL
;
1315 struct skb_data
*entry
;
1316 struct driver_info
*info
= dev
->driver_info
;
1317 unsigned long flags
;
1321 skb_tx_timestamp(skb
);
1323 // some devices want funky USB-level framing, for
1324 // win32 driver (usually) and/or hardware quirks
1325 if (info
->tx_fixup
) {
1326 skb
= info
->tx_fixup (dev
, skb
, GFP_ATOMIC
);
1328 /* packet collected; minidriver waiting for more */
1329 if (info
->flags
& FLAG_MULTI_PACKET
)
1331 netif_dbg(dev
, tx_err
, dev
->net
, "can't tx_fixup skb\n");
1336 if (!(urb
= usb_alloc_urb (0, GFP_ATOMIC
))) {
1337 netif_dbg(dev
, tx_err
, dev
->net
, "no urb\n");
1341 entry
= (struct skb_data
*) skb
->cb
;
1345 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->out
,
1346 skb
->data
, skb
->len
, tx_complete
, skb
);
1347 if (dev
->can_dma_sg
) {
1348 if (build_dma_sg(skb
, urb
) < 0)
1351 length
= urb
->transfer_buffer_length
;
1353 /* don't assume the hardware handles USB_ZERO_PACKET
1354 * NOTE: strictly conforming cdc-ether devices should expect
1355 * the ZLP here, but ignore the one-byte packet.
1356 * NOTE2: CDC NCM specification is different from CDC ECM when
1357 * handling ZLP/short packets, so cdc_ncm driver will make short
1358 * packet itself if needed.
1360 if (length
% dev
->maxpacket
== 0) {
1361 if (!(info
->flags
& FLAG_SEND_ZLP
)) {
1362 if (!(info
->flags
& FLAG_MULTI_PACKET
)) {
1364 if (skb_tailroom(skb
) && !urb
->num_sgs
) {
1365 skb
->data
[skb
->len
] = 0;
1367 } else if (urb
->num_sgs
)
1368 sg_set_buf(&urb
->sg
[urb
->num_sgs
++],
1369 dev
->padding_pkt
, 1);
1372 urb
->transfer_flags
|= URB_ZERO_PACKET
;
1374 urb
->transfer_buffer_length
= length
;
1376 if (info
->flags
& FLAG_MULTI_PACKET
) {
1377 /* Driver has set number of packets and a length delta.
1378 * Calculate the complete length and ensure that it's
1381 entry
->length
+= length
;
1382 if (WARN_ON_ONCE(entry
->length
<= 0))
1383 entry
->length
= length
;
1385 usbnet_set_skb_tx_stats(skb
, 1, length
);
1388 spin_lock_irqsave(&dev
->txq
.lock
, flags
);
1389 retval
= usb_autopm_get_interface_async(dev
->intf
);
1391 spin_unlock_irqrestore(&dev
->txq
.lock
, flags
);
1396 /* if this triggers the device is still a sleep */
1397 if (test_bit(EVENT_DEV_ASLEEP
, &dev
->flags
)) {
1398 /* transmission will be done in resume */
1399 usb_anchor_urb(urb
, &dev
->deferred
);
1400 /* no use to process more packets */
1401 netif_stop_queue(net
);
1403 spin_unlock_irqrestore(&dev
->txq
.lock
, flags
);
1404 netdev_dbg(dev
->net
, "Delaying transmission for resumption\n");
1409 switch ((retval
= usb_submit_urb (urb
, GFP_ATOMIC
))) {
1411 netif_stop_queue (net
);
1412 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
1413 usb_autopm_put_interface_async(dev
->intf
);
1416 usb_autopm_put_interface_async(dev
->intf
);
1417 netif_dbg(dev
, tx_err
, dev
->net
,
1418 "tx: submit urb err %d\n", retval
);
1421 netif_trans_update(net
);
1422 __usbnet_queue_skb(&dev
->txq
, skb
, tx_start
);
1423 if (dev
->txq
.qlen
>= TX_QLEN (dev
))
1424 netif_stop_queue (net
);
1426 spin_unlock_irqrestore (&dev
->txq
.lock
, flags
);
1429 netif_dbg(dev
, tx_err
, dev
->net
, "drop, code %d\n", retval
);
1431 dev
->net
->stats
.tx_dropped
++;
1434 dev_kfree_skb_any (skb
);
1440 netif_dbg(dev
, tx_queued
, dev
->net
,
1441 "> tx, len %u, type 0x%x\n", length
, skb
->protocol
);
1445 return NETDEV_TX_OK
;
1447 EXPORT_SYMBOL_GPL(usbnet_start_xmit
);
1449 static int rx_alloc_submit(struct usbnet
*dev
, gfp_t flags
)
1455 /* don't refill the queue all at once */
1456 for (i
= 0; i
< 10 && dev
->rxq
.qlen
< RX_QLEN(dev
); i
++) {
1457 urb
= usb_alloc_urb(0, flags
);
1459 ret
= rx_submit(dev
, urb
, flags
);
1471 /*-------------------------------------------------------------------------*/
1473 // tasklet (work deferred from completions, in_irq) or timer
1475 static void usbnet_bh (unsigned long param
)
1477 struct usbnet
*dev
= (struct usbnet
*) param
;
1478 struct sk_buff
*skb
;
1479 struct skb_data
*entry
;
1481 while ((skb
= skb_dequeue (&dev
->done
))) {
1482 entry
= (struct skb_data
*) skb
->cb
;
1483 switch (entry
->state
) {
1485 entry
->state
= rx_cleanup
;
1486 rx_process (dev
, skb
);
1489 kfree(entry
->urb
->sg
);
1491 usb_free_urb (entry
->urb
);
1492 dev_kfree_skb (skb
);
1495 netdev_dbg(dev
->net
, "bogus skb state %d\n", entry
->state
);
1499 /* restart RX again after disabling due to high error rate */
1500 clear_bit(EVENT_RX_KILL
, &dev
->flags
);
1502 /* waiting for all pending urbs to complete?
1503 * only then can we forgo submitting anew
1505 if (waitqueue_active(&dev
->wait
)) {
1506 if (dev
->txq
.qlen
+ dev
->rxq
.qlen
+ dev
->done
.qlen
== 0)
1507 wake_up_all(&dev
->wait
);
1509 // or are we maybe short a few urbs?
1510 } else if (netif_running (dev
->net
) &&
1511 netif_device_present (dev
->net
) &&
1512 netif_carrier_ok(dev
->net
) &&
1513 !timer_pending(&dev
->delay
) &&
1514 !test_bit(EVENT_RX_PAUSED
, &dev
->flags
) &&
1515 !test_bit(EVENT_RX_HALT
, &dev
->flags
)) {
1516 int temp
= dev
->rxq
.qlen
;
1518 if (temp
< RX_QLEN(dev
)) {
1519 if (rx_alloc_submit(dev
, GFP_ATOMIC
) == -ENOLINK
)
1521 if (temp
!= dev
->rxq
.qlen
)
1522 netif_dbg(dev
, link
, dev
->net
,
1523 "rxqlen %d --> %d\n",
1524 temp
, dev
->rxq
.qlen
);
1525 if (dev
->rxq
.qlen
< RX_QLEN(dev
))
1526 tasklet_schedule (&dev
->bh
);
1528 if (dev
->txq
.qlen
< TX_QLEN (dev
))
1529 netif_wake_queue (dev
->net
);
1534 /*-------------------------------------------------------------------------
1536 * USB Device Driver support
1538 *-------------------------------------------------------------------------*/
1540 // precondition: never called in_interrupt
1542 void usbnet_disconnect (struct usb_interface
*intf
)
1545 struct usb_device
*xdev
;
1546 struct net_device
*net
;
1548 dev
= usb_get_intfdata(intf
);
1549 usb_set_intfdata(intf
, NULL
);
1553 xdev
= interface_to_usbdev (intf
);
1555 netif_info(dev
, probe
, dev
->net
, "unregister '%s' usb-%s-%s, %s\n",
1556 intf
->dev
.driver
->name
,
1557 xdev
->bus
->bus_name
, xdev
->devpath
,
1558 dev
->driver_info
->description
);
1561 unregister_netdev (net
);
1563 cancel_work_sync(&dev
->kevent
);
1565 usb_scuttle_anchored_urbs(&dev
->deferred
);
1567 if (dev
->driver_info
->unbind
)
1568 dev
->driver_info
->unbind (dev
, intf
);
1570 usb_kill_urb(dev
->interrupt
);
1571 usb_free_urb(dev
->interrupt
);
1572 kfree(dev
->padding_pkt
);
1576 EXPORT_SYMBOL_GPL(usbnet_disconnect
);
1578 static const struct net_device_ops usbnet_netdev_ops
= {
1579 .ndo_open
= usbnet_open
,
1580 .ndo_stop
= usbnet_stop
,
1581 .ndo_start_xmit
= usbnet_start_xmit
,
1582 .ndo_tx_timeout
= usbnet_tx_timeout
,
1583 .ndo_set_rx_mode
= usbnet_set_rx_mode
,
1584 .ndo_change_mtu
= usbnet_change_mtu
,
1585 .ndo_set_mac_address
= eth_mac_addr
,
1586 .ndo_validate_addr
= eth_validate_addr
,
1589 /*-------------------------------------------------------------------------*/
1591 // precondition: never called in_interrupt
1593 static struct device_type wlan_type
= {
1597 static struct device_type wwan_type
= {
1602 usbnet_probe (struct usb_interface
*udev
, const struct usb_device_id
*prod
)
1605 struct net_device
*net
;
1606 struct usb_host_interface
*interface
;
1607 struct driver_info
*info
;
1608 struct usb_device
*xdev
;
1611 struct usb_driver
*driver
= to_usb_driver(udev
->dev
.driver
);
1613 /* usbnet already took usb runtime pm, so have to enable the feature
1614 * for usb interface, otherwise usb_autopm_get_interface may return
1615 * failure if RUNTIME_PM is enabled.
1617 if (!driver
->supports_autosuspend
) {
1618 driver
->supports_autosuspend
= 1;
1619 pm_runtime_enable(&udev
->dev
);
1622 name
= udev
->dev
.driver
->name
;
1623 info
= (struct driver_info
*) prod
->driver_info
;
1625 dev_dbg (&udev
->dev
, "blacklisted by %s\n", name
);
1628 xdev
= interface_to_usbdev (udev
);
1629 interface
= udev
->cur_altsetting
;
1633 // set up our own records
1634 net
= alloc_etherdev(sizeof(*dev
));
1638 /* netdev_printk() needs this so do it as early as possible */
1639 SET_NETDEV_DEV(net
, &udev
->dev
);
1641 dev
= netdev_priv(net
);
1644 dev
->driver_info
= info
;
1645 dev
->driver_name
= name
;
1646 dev
->msg_enable
= netif_msg_init (msg_level
, NETIF_MSG_DRV
1647 | NETIF_MSG_PROBE
| NETIF_MSG_LINK
);
1648 init_waitqueue_head(&dev
->wait
);
1649 skb_queue_head_init (&dev
->rxq
);
1650 skb_queue_head_init (&dev
->txq
);
1651 skb_queue_head_init (&dev
->done
);
1652 skb_queue_head_init(&dev
->rxq_pause
);
1653 dev
->bh
.func
= usbnet_bh
;
1654 dev
->bh
.data
= (unsigned long) dev
;
1655 INIT_WORK (&dev
->kevent
, usbnet_deferred_kevent
);
1656 init_usb_anchor(&dev
->deferred
);
1657 dev
->delay
.function
= usbnet_bh
;
1658 dev
->delay
.data
= (unsigned long) dev
;
1659 init_timer (&dev
->delay
);
1660 mutex_init (&dev
->phy_mutex
);
1661 mutex_init(&dev
->interrupt_mutex
);
1662 dev
->interrupt_count
= 0;
1665 strcpy (net
->name
, "usb%d");
1666 memcpy (net
->dev_addr
, node_id
, sizeof node_id
);
1668 /* rx and tx sides can use different message sizes;
1669 * bind() should set rx_urb_size in that case.
1671 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
1673 net
->netdev_ops
= &usbnet_netdev_ops
;
1674 net
->watchdog_timeo
= TX_TIMEOUT_JIFFIES
;
1675 net
->ethtool_ops
= &usbnet_ethtool_ops
;
1677 // allow device-specific bind/init procedures
1678 // NOTE net->name still not usable ...
1680 status
= info
->bind (dev
, udev
);
1684 // heuristic: "usb%d" for links we know are two-host,
1685 // else "eth%d" when there's reasonable doubt. userspace
1686 // can rename the link if it knows better.
1687 if ((dev
->driver_info
->flags
& FLAG_ETHER
) != 0 &&
1688 ((dev
->driver_info
->flags
& FLAG_POINTTOPOINT
) == 0 ||
1689 (net
->dev_addr
[0] & 0x02) == 0))
1690 strcpy (net
->name
, "eth%d");
1691 /* WLAN devices should always be named "wlan%d" */
1692 if ((dev
->driver_info
->flags
& FLAG_WLAN
) != 0)
1693 strcpy(net
->name
, "wlan%d");
1694 /* WWAN devices should always be named "wwan%d" */
1695 if ((dev
->driver_info
->flags
& FLAG_WWAN
) != 0)
1696 strcpy(net
->name
, "wwan%d");
1698 /* devices that cannot do ARP */
1699 if ((dev
->driver_info
->flags
& FLAG_NOARP
) != 0)
1700 net
->flags
|= IFF_NOARP
;
1702 /* maybe the remote can't receive an Ethernet MTU */
1703 if (net
->mtu
> (dev
->hard_mtu
- net
->hard_header_len
))
1704 net
->mtu
= dev
->hard_mtu
- net
->hard_header_len
;
1705 } else if (!info
->in
|| !info
->out
)
1706 status
= usbnet_get_endpoints (dev
, udev
);
1708 dev
->in
= usb_rcvbulkpipe (xdev
, info
->in
);
1709 dev
->out
= usb_sndbulkpipe (xdev
, info
->out
);
1710 if (!(info
->flags
& FLAG_NO_SETINT
))
1711 status
= usb_set_interface (xdev
,
1712 interface
->desc
.bInterfaceNumber
,
1713 interface
->desc
.bAlternateSetting
);
1718 if (status
>= 0 && dev
->status
)
1719 status
= init_status (dev
, udev
);
1723 if (!dev
->rx_urb_size
)
1724 dev
->rx_urb_size
= dev
->hard_mtu
;
1725 dev
->maxpacket
= usb_maxpacket (dev
->udev
, dev
->out
, 1);
1727 /* let userspace know we have a random address */
1728 if (ether_addr_equal(net
->dev_addr
, node_id
))
1729 net
->addr_assign_type
= NET_ADDR_RANDOM
;
1731 if ((dev
->driver_info
->flags
& FLAG_WLAN
) != 0)
1732 SET_NETDEV_DEVTYPE(net
, &wlan_type
);
1733 if ((dev
->driver_info
->flags
& FLAG_WWAN
) != 0)
1734 SET_NETDEV_DEVTYPE(net
, &wwan_type
);
1736 /* initialize max rx_qlen and tx_qlen */
1737 usbnet_update_max_qlen(dev
);
1739 if (dev
->can_dma_sg
&& !(info
->flags
& FLAG_SEND_ZLP
) &&
1740 !(info
->flags
& FLAG_MULTI_PACKET
)) {
1741 dev
->padding_pkt
= kzalloc(1, GFP_KERNEL
);
1742 if (!dev
->padding_pkt
) {
1748 status
= register_netdev (net
);
1751 netif_info(dev
, probe
, dev
->net
,
1752 "register '%s' at usb-%s-%s, %s, %pM\n",
1753 udev
->dev
.driver
->name
,
1754 xdev
->bus
->bus_name
, xdev
->devpath
,
1755 dev
->driver_info
->description
,
1758 // ok, it's ready to go.
1759 usb_set_intfdata (udev
, dev
);
1761 netif_device_attach (net
);
1763 if (dev
->driver_info
->flags
& FLAG_LINK_INTR
)
1764 usbnet_link_change(dev
, 0, 0);
1769 kfree(dev
->padding_pkt
);
1771 usb_free_urb(dev
->interrupt
);
1774 info
->unbind (dev
, udev
);
1776 /* subdrivers must undo all they did in bind() if they
1777 * fail it, but we may fail later and a deferred kevent
1778 * may trigger an error resubmitting itself and, worse,
1779 * schedule a timer. So we kill it all just in case.
1781 cancel_work_sync(&dev
->kevent
);
1782 del_timer_sync(&dev
->delay
);
1787 EXPORT_SYMBOL_GPL(usbnet_probe
);
1789 /*-------------------------------------------------------------------------*/
1792 * suspend the whole driver as soon as the first interface is suspended
1793 * resume only when the last interface is resumed
1796 int usbnet_suspend (struct usb_interface
*intf
, pm_message_t message
)
1798 struct usbnet
*dev
= usb_get_intfdata(intf
);
1800 if (!dev
->suspend_count
++) {
1801 spin_lock_irq(&dev
->txq
.lock
);
1802 /* don't autosuspend while transmitting */
1803 if (dev
->txq
.qlen
&& PMSG_IS_AUTO(message
)) {
1804 dev
->suspend_count
--;
1805 spin_unlock_irq(&dev
->txq
.lock
);
1808 set_bit(EVENT_DEV_ASLEEP
, &dev
->flags
);
1809 spin_unlock_irq(&dev
->txq
.lock
);
1812 * accelerate emptying of the rx and queues, to avoid
1813 * having everything error out.
1815 netif_device_detach (dev
->net
);
1816 usbnet_terminate_urbs(dev
);
1817 __usbnet_status_stop_force(dev
);
1820 * reattach so runtime management can use and
1823 netif_device_attach (dev
->net
);
1827 EXPORT_SYMBOL_GPL(usbnet_suspend
);
1829 int usbnet_resume (struct usb_interface
*intf
)
1831 struct usbnet
*dev
= usb_get_intfdata(intf
);
1832 struct sk_buff
*skb
;
1836 if (!--dev
->suspend_count
) {
1837 /* resume interrupt URB if it was previously submitted */
1838 __usbnet_status_start_force(dev
, GFP_NOIO
);
1840 spin_lock_irq(&dev
->txq
.lock
);
1841 while ((res
= usb_get_from_anchor(&dev
->deferred
))) {
1843 skb
= (struct sk_buff
*)res
->context
;
1844 retval
= usb_submit_urb(res
, GFP_ATOMIC
);
1846 dev_kfree_skb_any(skb
);
1849 usb_autopm_put_interface_async(dev
->intf
);
1851 netif_trans_update(dev
->net
);
1852 __skb_queue_tail(&dev
->txq
, skb
);
1857 clear_bit(EVENT_DEV_ASLEEP
, &dev
->flags
);
1858 spin_unlock_irq(&dev
->txq
.lock
);
1860 if (test_bit(EVENT_DEV_OPEN
, &dev
->flags
)) {
1861 /* handle remote wakeup ASAP
1862 * we cannot race against stop
1864 if (netif_device_present(dev
->net
) &&
1865 !timer_pending(&dev
->delay
) &&
1866 !test_bit(EVENT_RX_HALT
, &dev
->flags
))
1867 rx_alloc_submit(dev
, GFP_NOIO
);
1869 if (!(dev
->txq
.qlen
>= TX_QLEN(dev
)))
1870 netif_tx_wake_all_queues(dev
->net
);
1871 tasklet_schedule (&dev
->bh
);
1875 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE
, &dev
->flags
))
1876 usb_autopm_get_interface_no_resume(intf
);
1880 EXPORT_SYMBOL_GPL(usbnet_resume
);
1883 * Either a subdriver implements manage_power, then it is assumed to always
1884 * be ready to be suspended or it reports the readiness to be suspended
1887 void usbnet_device_suggests_idle(struct usbnet
*dev
)
1889 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE
, &dev
->flags
)) {
1890 dev
->intf
->needs_remote_wakeup
= 1;
1891 usb_autopm_put_interface_async(dev
->intf
);
1894 EXPORT_SYMBOL(usbnet_device_suggests_idle
);
1897 * For devices that can do without special commands
1899 int usbnet_manage_power(struct usbnet
*dev
, int on
)
1901 dev
->intf
->needs_remote_wakeup
= on
;
1904 EXPORT_SYMBOL(usbnet_manage_power
);
1906 void usbnet_link_change(struct usbnet
*dev
, bool link
, bool need_reset
)
1908 /* update link after link is reseted */
1909 if (link
&& !need_reset
)
1910 netif_carrier_on(dev
->net
);
1912 netif_carrier_off(dev
->net
);
1914 if (need_reset
&& link
)
1915 usbnet_defer_kevent(dev
, EVENT_LINK_RESET
);
1917 usbnet_defer_kevent(dev
, EVENT_LINK_CHANGE
);
1919 EXPORT_SYMBOL(usbnet_link_change
);
1921 /*-------------------------------------------------------------------------*/
1922 static int __usbnet_read_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1923 u16 value
, u16 index
, void *data
, u16 size
)
1928 netdev_dbg(dev
->net
, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1929 " value=0x%04x index=0x%04x size=%d\n",
1930 cmd
, reqtype
, value
, index
, size
);
1933 buf
= kmalloc(size
, GFP_KERNEL
);
1938 err
= usb_control_msg(dev
->udev
, usb_rcvctrlpipe(dev
->udev
, 0),
1939 cmd
, reqtype
, value
, index
, buf
, size
,
1940 USB_CTRL_GET_TIMEOUT
);
1941 if (err
> 0 && err
<= size
)
1942 memcpy(data
, buf
, err
);
1948 static int __usbnet_write_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1949 u16 value
, u16 index
, const void *data
,
1955 netdev_dbg(dev
->net
, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1956 " value=0x%04x index=0x%04x size=%d\n",
1957 cmd
, reqtype
, value
, index
, size
);
1960 buf
= kmemdup(data
, size
, GFP_KERNEL
);
1965 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, 0),
1966 cmd
, reqtype
, value
, index
, buf
, size
,
1967 USB_CTRL_SET_TIMEOUT
);
1975 * The function can't be called inside suspend/resume callback,
1976 * otherwise deadlock will be caused.
1978 int usbnet_read_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1979 u16 value
, u16 index
, void *data
, u16 size
)
1983 if (usb_autopm_get_interface(dev
->intf
) < 0)
1985 ret
= __usbnet_read_cmd(dev
, cmd
, reqtype
, value
, index
,
1987 usb_autopm_put_interface(dev
->intf
);
1990 EXPORT_SYMBOL_GPL(usbnet_read_cmd
);
1993 * The function can't be called inside suspend/resume callback,
1994 * otherwise deadlock will be caused.
1996 int usbnet_write_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1997 u16 value
, u16 index
, const void *data
, u16 size
)
2001 if (usb_autopm_get_interface(dev
->intf
) < 0)
2003 ret
= __usbnet_write_cmd(dev
, cmd
, reqtype
, value
, index
,
2005 usb_autopm_put_interface(dev
->intf
);
2008 EXPORT_SYMBOL_GPL(usbnet_write_cmd
);
2011 * The function can be called inside suspend/resume callback safely
2012 * and should only be called by suspend/resume callback generally.
2014 int usbnet_read_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
2015 u16 value
, u16 index
, void *data
, u16 size
)
2017 return __usbnet_read_cmd(dev
, cmd
, reqtype
, value
, index
,
2020 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm
);
2023 * The function can be called inside suspend/resume callback safely
2024 * and should only be called by suspend/resume callback generally.
2026 int usbnet_write_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
2027 u16 value
, u16 index
, const void *data
,
2030 return __usbnet_write_cmd(dev
, cmd
, reqtype
, value
, index
,
2033 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm
);
2035 static void usbnet_async_cmd_cb(struct urb
*urb
)
2037 struct usb_ctrlrequest
*req
= (struct usb_ctrlrequest
*)urb
->context
;
2038 int status
= urb
->status
;
2041 dev_dbg(&urb
->dev
->dev
, "%s failed with %d",
2049 * The caller must make sure that device can't be put into suspend
2050 * state until the control URB completes.
2052 int usbnet_write_cmd_async(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
2053 u16 value
, u16 index
, const void *data
, u16 size
)
2055 struct usb_ctrlrequest
*req
= NULL
;
2060 netdev_dbg(dev
->net
, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2061 " value=0x%04x index=0x%04x size=%d\n",
2062 cmd
, reqtype
, value
, index
, size
);
2064 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
2069 buf
= kmemdup(data
, size
, GFP_ATOMIC
);
2071 netdev_err(dev
->net
, "Error allocating buffer"
2072 " in %s!\n", __func__
);
2077 req
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_ATOMIC
);
2081 req
->bRequestType
= reqtype
;
2082 req
->bRequest
= cmd
;
2083 req
->wValue
= cpu_to_le16(value
);
2084 req
->wIndex
= cpu_to_le16(index
);
2085 req
->wLength
= cpu_to_le16(size
);
2087 usb_fill_control_urb(urb
, dev
->udev
,
2088 usb_sndctrlpipe(dev
->udev
, 0),
2089 (void *)req
, buf
, size
,
2090 usbnet_async_cmd_cb
, req
);
2091 urb
->transfer_flags
|= URB_FREE_BUFFER
;
2093 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
2095 netdev_err(dev
->net
, "Error submitting the control"
2096 " message: status=%d\n", err
);
2110 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async
);
2111 /*-------------------------------------------------------------------------*/
2113 static int __init
usbnet_init(void)
2115 /* Compiler should optimize this out. */
2117 FIELD_SIZEOF(struct sk_buff
, cb
) < sizeof(struct skb_data
));
2119 eth_random_addr(node_id
);
2122 module_init(usbnet_init
);
2124 static void __exit
usbnet_exit(void)
2127 module_exit(usbnet_exit
);
2129 MODULE_AUTHOR("David Brownell");
2130 MODULE_DESCRIPTION("USB network driver framework");
2131 MODULE_LICENSE("GPL");