2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 * This is a generic "USB networking" framework that works with several
22 * kinds of full and high speed networking devices: host-to-host cables,
23 * smart usb peripherals, and actual Ethernet adapters.
25 * These devices usually differ in terms of control protocols (if they
26 * even have one!) and sometimes they define new framing to wrap or batch
27 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
28 * so interface (un)binding, endpoint I/O queues, fault handling, and other
29 * issues can usefully be addressed by this framework.
32 // #define DEBUG // error path messages, extra info
33 // #define VERBOSE // more; success messages
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/netdevice.h>
38 #include <linux/etherdevice.h>
39 #include <linux/ctype.h>
40 #include <linux/ethtool.h>
41 #include <linux/workqueue.h>
42 #include <linux/mii.h>
43 #include <linux/usb.h>
44 #include <linux/usb/usbnet.h>
45 #include <linux/slab.h>
46 #include <linux/kernel.h>
47 #include <linux/pm_runtime.h>
49 #define DRIVER_VERSION "22-Aug-2005"
52 /*-------------------------------------------------------------------------*/
55 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
56 * Several dozen bytes of IPv4 data can fit in two such transactions.
57 * One maximum size Ethernet packet takes twenty four of them.
58 * For high speed, each frame comfortably fits almost 36 max size
59 * Ethernet packets (so queues should be bigger).
61 * The goal is to let the USB host controller be busy for 5msec or
62 * more before an irq is required, under load. Jumbograms change
65 #define MAX_QUEUE_MEMORY (60 * 1518)
66 #define RX_QLEN(dev) ((dev)->rx_qlen)
67 #define TX_QLEN(dev) ((dev)->tx_qlen)
69 // reawaken network queue this soon after stopping; else watchdog barks
70 #define TX_TIMEOUT_JIFFIES (5*HZ)
72 /* throttle rx/tx briefly after some faults, so hub_wq might disconnect()
73 * us (it polls at HZ/4 usually) before we report too many false errors.
75 #define THROTTLE_JIFFIES (HZ/8)
78 #define UNLINK_TIMEOUT_MS 3
80 /*-------------------------------------------------------------------------*/
82 // randomly generated ethernet address
83 static u8 node_id
[ETH_ALEN
];
85 static const char driver_name
[] = "usbnet";
87 /* use ethtool to change the level for any given device */
88 static int msg_level
= -1;
89 module_param (msg_level
, int, 0);
90 MODULE_PARM_DESC (msg_level
, "Override default message level");
92 /*-------------------------------------------------------------------------*/
94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
95 int usbnet_get_endpoints(struct usbnet
*dev
, struct usb_interface
*intf
)
98 struct usb_host_interface
*alt
= NULL
;
99 struct usb_host_endpoint
*in
= NULL
, *out
= NULL
;
100 struct usb_host_endpoint
*status
= NULL
;
102 for (tmp
= 0; tmp
< intf
->num_altsetting
; tmp
++) {
105 in
= out
= status
= NULL
;
106 alt
= intf
->altsetting
+ tmp
;
108 /* take the first altsetting with in-bulk + out-bulk;
109 * remember any status endpoint, just in case;
110 * ignore other endpoints and altsettings.
112 for (ep
= 0; ep
< alt
->desc
.bNumEndpoints
; ep
++) {
113 struct usb_host_endpoint
*e
;
116 e
= alt
->endpoint
+ ep
;
117 switch (e
->desc
.bmAttributes
) {
118 case USB_ENDPOINT_XFER_INT
:
119 if (!usb_endpoint_dir_in(&e
->desc
))
123 case USB_ENDPOINT_XFER_BULK
:
128 if (usb_endpoint_dir_in(&e
->desc
)) {
131 else if (intr
&& !status
)
141 if (!alt
|| !in
|| !out
)
144 if (alt
->desc
.bAlternateSetting
!= 0 ||
145 !(dev
->driver_info
->flags
& FLAG_NO_SETINT
)) {
146 tmp
= usb_set_interface (dev
->udev
, alt
->desc
.bInterfaceNumber
,
147 alt
->desc
.bAlternateSetting
);
152 dev
->in
= usb_rcvbulkpipe (dev
->udev
,
153 in
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
154 dev
->out
= usb_sndbulkpipe (dev
->udev
,
155 out
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
156 dev
->status
= status
;
159 EXPORT_SYMBOL_GPL(usbnet_get_endpoints
);
161 int usbnet_get_ethernet_addr(struct usbnet
*dev
, int iMACAddress
)
164 unsigned char buf
[13];
166 ret
= usb_string(dev
->udev
, iMACAddress
, buf
, sizeof buf
);
168 tmp
= hex2bin(dev
->net
->dev_addr
, buf
, 6);
170 dev_dbg(&dev
->udev
->dev
,
171 "bad MAC string %d fetch, %d\n", iMACAddress
, tmp
);
178 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr
);
180 static void intr_complete (struct urb
*urb
)
182 struct usbnet
*dev
= urb
->context
;
183 int status
= urb
->status
;
188 dev
->driver_info
->status(dev
, urb
);
191 /* software-driven interface shutdown */
192 case -ENOENT
: /* urb killed */
193 case -ESHUTDOWN
: /* hardware gone */
194 netif_dbg(dev
, ifdown
, dev
->net
,
195 "intr shutdown, code %d\n", status
);
198 /* NOTE: not throttling like RX/TX, since this endpoint
199 * already polls infrequently
202 netdev_dbg(dev
->net
, "intr status %d\n", status
);
206 status
= usb_submit_urb (urb
, GFP_ATOMIC
);
208 netif_err(dev
, timer
, dev
->net
,
209 "intr resubmit --> %d\n", status
);
212 static int init_status (struct usbnet
*dev
, struct usb_interface
*intf
)
219 if (!dev
->driver_info
->status
)
222 pipe
= usb_rcvintpipe (dev
->udev
,
223 dev
->status
->desc
.bEndpointAddress
224 & USB_ENDPOINT_NUMBER_MASK
);
225 maxp
= usb_maxpacket (dev
->udev
, pipe
, 0);
227 /* avoid 1 msec chatter: min 8 msec poll rate */
228 period
= max ((int) dev
->status
->desc
.bInterval
,
229 (dev
->udev
->speed
== USB_SPEED_HIGH
) ? 7 : 3);
231 buf
= kmalloc (maxp
, GFP_KERNEL
);
233 dev
->interrupt
= usb_alloc_urb (0, GFP_KERNEL
);
234 if (!dev
->interrupt
) {
238 usb_fill_int_urb(dev
->interrupt
, dev
->udev
, pipe
,
239 buf
, maxp
, intr_complete
, dev
, period
);
240 dev
->interrupt
->transfer_flags
|= URB_FREE_BUFFER
;
242 "status ep%din, %d bytes period %d\n",
243 usb_pipeendpoint(pipe
), maxp
, period
);
249 /* Submit the interrupt URB if not previously submitted, increasing refcount */
250 int usbnet_status_start(struct usbnet
*dev
, gfp_t mem_flags
)
254 WARN_ON_ONCE(dev
->interrupt
== NULL
);
255 if (dev
->interrupt
) {
256 mutex_lock(&dev
->interrupt_mutex
);
258 if (++dev
->interrupt_count
== 1)
259 ret
= usb_submit_urb(dev
->interrupt
, mem_flags
);
261 dev_dbg(&dev
->udev
->dev
, "incremented interrupt URB count to %d\n",
262 dev
->interrupt_count
);
263 mutex_unlock(&dev
->interrupt_mutex
);
267 EXPORT_SYMBOL_GPL(usbnet_status_start
);
269 /* For resume; submit interrupt URB if previously submitted */
270 static int __usbnet_status_start_force(struct usbnet
*dev
, gfp_t mem_flags
)
274 mutex_lock(&dev
->interrupt_mutex
);
275 if (dev
->interrupt_count
) {
276 ret
= usb_submit_urb(dev
->interrupt
, mem_flags
);
277 dev_dbg(&dev
->udev
->dev
,
278 "submitted interrupt URB for resume\n");
280 mutex_unlock(&dev
->interrupt_mutex
);
284 /* Kill the interrupt URB if all submitters want it killed */
285 void usbnet_status_stop(struct usbnet
*dev
)
287 if (dev
->interrupt
) {
288 mutex_lock(&dev
->interrupt_mutex
);
289 WARN_ON(dev
->interrupt_count
== 0);
291 if (dev
->interrupt_count
&& --dev
->interrupt_count
== 0)
292 usb_kill_urb(dev
->interrupt
);
294 dev_dbg(&dev
->udev
->dev
,
295 "decremented interrupt URB count to %d\n",
296 dev
->interrupt_count
);
297 mutex_unlock(&dev
->interrupt_mutex
);
300 EXPORT_SYMBOL_GPL(usbnet_status_stop
);
302 /* For suspend; always kill interrupt URB */
303 static void __usbnet_status_stop_force(struct usbnet
*dev
)
305 if (dev
->interrupt
) {
306 mutex_lock(&dev
->interrupt_mutex
);
307 usb_kill_urb(dev
->interrupt
);
308 dev_dbg(&dev
->udev
->dev
, "killed interrupt URB for suspend\n");
309 mutex_unlock(&dev
->interrupt_mutex
);
313 /* Passes this packet up the stack, updating its accounting.
314 * Some link protocols batch packets, so their rx_fixup paths
315 * can return clones as well as just modify the original skb.
317 void usbnet_skb_return (struct usbnet
*dev
, struct sk_buff
*skb
)
321 if (test_bit(EVENT_RX_PAUSED
, &dev
->flags
)) {
322 skb_queue_tail(&dev
->rxq_pause
, skb
);
326 skb
->protocol
= eth_type_trans (skb
, dev
->net
);
327 dev
->net
->stats
.rx_packets
++;
328 dev
->net
->stats
.rx_bytes
+= skb
->len
;
330 netif_dbg(dev
, rx_status
, dev
->net
, "< rx, len %zu, type 0x%x\n",
331 skb
->len
+ sizeof (struct ethhdr
), skb
->protocol
);
332 memset (skb
->cb
, 0, sizeof (struct skb_data
));
334 if (skb_defer_rx_timestamp(skb
))
337 status
= netif_rx (skb
);
338 if (status
!= NET_RX_SUCCESS
)
339 netif_dbg(dev
, rx_err
, dev
->net
,
340 "netif_rx status %d\n", status
);
342 EXPORT_SYMBOL_GPL(usbnet_skb_return
);
344 /* must be called if hard_mtu or rx_urb_size changed */
345 void usbnet_update_max_qlen(struct usbnet
*dev
)
347 enum usb_device_speed speed
= dev
->udev
->speed
;
351 dev
->rx_qlen
= MAX_QUEUE_MEMORY
/ dev
->rx_urb_size
;
352 dev
->tx_qlen
= MAX_QUEUE_MEMORY
/ dev
->hard_mtu
;
354 case USB_SPEED_SUPER
:
356 * Not take default 5ms qlen for super speed HC to
357 * save memory, and iperf tests show 2.5ms qlen can
360 dev
->rx_qlen
= 5 * MAX_QUEUE_MEMORY
/ dev
->rx_urb_size
;
361 dev
->tx_qlen
= 5 * MAX_QUEUE_MEMORY
/ dev
->hard_mtu
;
364 dev
->rx_qlen
= dev
->tx_qlen
= 4;
367 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen
);
370 /*-------------------------------------------------------------------------
372 * Network Device Driver (peer link to "Host Device", from USB host)
374 *-------------------------------------------------------------------------*/
376 int usbnet_change_mtu (struct net_device
*net
, int new_mtu
)
378 struct usbnet
*dev
= netdev_priv(net
);
379 int ll_mtu
= new_mtu
+ net
->hard_header_len
;
380 int old_hard_mtu
= dev
->hard_mtu
;
381 int old_rx_urb_size
= dev
->rx_urb_size
;
385 // no second zero-length packet read wanted after mtu-sized packets
386 if ((ll_mtu
% dev
->maxpacket
) == 0)
390 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
391 if (dev
->rx_urb_size
== old_hard_mtu
) {
392 dev
->rx_urb_size
= dev
->hard_mtu
;
393 if (dev
->rx_urb_size
> old_rx_urb_size
)
394 usbnet_unlink_rx_urbs(dev
);
397 /* max qlen depend on hard_mtu and rx_urb_size */
398 usbnet_update_max_qlen(dev
);
402 EXPORT_SYMBOL_GPL(usbnet_change_mtu
);
404 /* The caller must hold list->lock */
405 static void __usbnet_queue_skb(struct sk_buff_head
*list
,
406 struct sk_buff
*newsk
, enum skb_state state
)
408 struct skb_data
*entry
= (struct skb_data
*) newsk
->cb
;
410 __skb_queue_tail(list
, newsk
);
411 entry
->state
= state
;
414 /*-------------------------------------------------------------------------*/
416 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
417 * completion callbacks. 2.5 should have fixed those bugs...
420 static enum skb_state
defer_bh(struct usbnet
*dev
, struct sk_buff
*skb
,
421 struct sk_buff_head
*list
, enum skb_state state
)
424 enum skb_state old_state
;
425 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
427 spin_lock_irqsave(&list
->lock
, flags
);
428 old_state
= entry
->state
;
429 entry
->state
= state
;
430 __skb_unlink(skb
, list
);
431 spin_unlock(&list
->lock
);
432 spin_lock(&dev
->done
.lock
);
433 __skb_queue_tail(&dev
->done
, skb
);
434 if (dev
->done
.qlen
== 1)
435 tasklet_schedule(&dev
->bh
);
436 spin_unlock_irqrestore(&dev
->done
.lock
, flags
);
440 /* some work can't be done in tasklets, so we use keventd
442 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
443 * but tasklet_schedule() doesn't. hope the failure is rare.
445 void usbnet_defer_kevent (struct usbnet
*dev
, int work
)
447 set_bit (work
, &dev
->flags
);
448 if (!schedule_work (&dev
->kevent
)) {
450 netdev_err(dev
->net
, "kevent %d may have been dropped\n", work
);
452 netdev_dbg(dev
->net
, "kevent %d scheduled\n", work
);
455 EXPORT_SYMBOL_GPL(usbnet_defer_kevent
);
457 /*-------------------------------------------------------------------------*/
459 static void rx_complete (struct urb
*urb
);
461 static int rx_submit (struct usbnet
*dev
, struct urb
*urb
, gfp_t flags
)
464 struct skb_data
*entry
;
466 unsigned long lockflags
;
467 size_t size
= dev
->rx_urb_size
;
469 /* prevent rx skb allocation when error ratio is high */
470 if (test_bit(EVENT_RX_KILL
, &dev
->flags
)) {
475 skb
= __netdev_alloc_skb_ip_align(dev
->net
, size
, flags
);
477 netif_dbg(dev
, rx_err
, dev
->net
, "no rx skb\n");
478 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
483 entry
= (struct skb_data
*) skb
->cb
;
488 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->in
,
489 skb
->data
, size
, rx_complete
, skb
);
491 spin_lock_irqsave (&dev
->rxq
.lock
, lockflags
);
493 if (netif_running (dev
->net
) &&
494 netif_device_present (dev
->net
) &&
495 !test_bit (EVENT_RX_HALT
, &dev
->flags
) &&
496 !test_bit (EVENT_DEV_ASLEEP
, &dev
->flags
)) {
497 switch (retval
= usb_submit_urb (urb
, GFP_ATOMIC
)) {
499 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
502 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
505 netif_dbg(dev
, ifdown
, dev
->net
, "device gone\n");
506 netif_device_detach (dev
->net
);
512 netif_dbg(dev
, rx_err
, dev
->net
,
513 "rx submit, %d\n", retval
);
514 tasklet_schedule (&dev
->bh
);
517 __usbnet_queue_skb(&dev
->rxq
, skb
, rx_start
);
520 netif_dbg(dev
, ifdown
, dev
->net
, "rx: stopped\n");
523 spin_unlock_irqrestore (&dev
->rxq
.lock
, lockflags
);
525 dev_kfree_skb_any (skb
);
532 /*-------------------------------------------------------------------------*/
534 static inline void rx_process (struct usbnet
*dev
, struct sk_buff
*skb
)
536 if (dev
->driver_info
->rx_fixup
&&
537 !dev
->driver_info
->rx_fixup (dev
, skb
)) {
538 /* With RX_ASSEMBLE, rx_fixup() must update counters */
539 if (!(dev
->driver_info
->flags
& FLAG_RX_ASSEMBLE
))
540 dev
->net
->stats
.rx_errors
++;
543 // else network stack removes extra byte if we forced a short packet
545 /* all data was already cloned from skb inside the driver */
546 if (dev
->driver_info
->flags
& FLAG_MULTI_PACKET
)
549 if (skb
->len
< ETH_HLEN
) {
550 dev
->net
->stats
.rx_errors
++;
551 dev
->net
->stats
.rx_length_errors
++;
552 netif_dbg(dev
, rx_err
, dev
->net
, "rx length %d\n", skb
->len
);
554 usbnet_skb_return(dev
, skb
);
559 skb_queue_tail(&dev
->done
, skb
);
562 /*-------------------------------------------------------------------------*/
564 static void rx_complete (struct urb
*urb
)
566 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
567 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
568 struct usbnet
*dev
= entry
->dev
;
569 int urb_status
= urb
->status
;
570 enum skb_state state
;
572 skb_put (skb
, urb
->actual_length
);
576 switch (urb_status
) {
581 /* stalls need manual reset. this is rare ... except that
582 * when going through USB 2.0 TTs, unplug appears this way.
583 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
584 * storm, recovering as needed.
587 dev
->net
->stats
.rx_errors
++;
588 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
591 /* software-driven interface shutdown */
592 case -ECONNRESET
: /* async unlink */
593 case -ESHUTDOWN
: /* hardware gone */
594 netif_dbg(dev
, ifdown
, dev
->net
,
595 "rx shutdown, code %d\n", urb_status
);
598 /* we get controller i/o faults during hub_wq disconnect() delays.
599 * throttle down resubmits, to avoid log floods; just temporarily,
600 * so we still recover when the fault isn't a hub_wq delay.
605 dev
->net
->stats
.rx_errors
++;
606 if (!timer_pending (&dev
->delay
)) {
607 mod_timer (&dev
->delay
, jiffies
+ THROTTLE_JIFFIES
);
608 netif_dbg(dev
, link
, dev
->net
,
609 "rx throttle %d\n", urb_status
);
617 /* data overrun ... flush fifo? */
619 dev
->net
->stats
.rx_over_errors
++;
624 dev
->net
->stats
.rx_errors
++;
625 netif_dbg(dev
, rx_err
, dev
->net
, "rx status %d\n", urb_status
);
629 /* stop rx if packet error rate is high */
630 if (++dev
->pkt_cnt
> 30) {
634 if (state
== rx_cleanup
)
636 if (dev
->pkt_err
> 20)
637 set_bit(EVENT_RX_KILL
, &dev
->flags
);
640 state
= defer_bh(dev
, skb
, &dev
->rxq
, state
);
643 if (netif_running (dev
->net
) &&
644 !test_bit (EVENT_RX_HALT
, &dev
->flags
) &&
645 state
!= unlink_start
) {
646 rx_submit (dev
, urb
, GFP_ATOMIC
);
647 usb_mark_last_busy(dev
->udev
);
652 netif_dbg(dev
, rx_err
, dev
->net
, "no read resubmitted\n");
655 /*-------------------------------------------------------------------------*/
656 void usbnet_pause_rx(struct usbnet
*dev
)
658 set_bit(EVENT_RX_PAUSED
, &dev
->flags
);
660 netif_dbg(dev
, rx_status
, dev
->net
, "paused rx queue enabled\n");
662 EXPORT_SYMBOL_GPL(usbnet_pause_rx
);
664 void usbnet_resume_rx(struct usbnet
*dev
)
669 clear_bit(EVENT_RX_PAUSED
, &dev
->flags
);
671 while ((skb
= skb_dequeue(&dev
->rxq_pause
)) != NULL
) {
672 usbnet_skb_return(dev
, skb
);
676 tasklet_schedule(&dev
->bh
);
678 netif_dbg(dev
, rx_status
, dev
->net
,
679 "paused rx queue disabled, %d skbs requeued\n", num
);
681 EXPORT_SYMBOL_GPL(usbnet_resume_rx
);
683 void usbnet_purge_paused_rxq(struct usbnet
*dev
)
685 skb_queue_purge(&dev
->rxq_pause
);
687 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq
);
689 /*-------------------------------------------------------------------------*/
691 // unlink pending rx/tx; completion handlers do all other cleanup
693 static int unlink_urbs (struct usbnet
*dev
, struct sk_buff_head
*q
)
699 spin_lock_irqsave (&q
->lock
, flags
);
700 while (!skb_queue_empty(q
)) {
701 struct skb_data
*entry
;
705 skb_queue_walk(q
, skb
) {
706 entry
= (struct skb_data
*) skb
->cb
;
707 if (entry
->state
!= unlink_start
)
712 entry
->state
= unlink_start
;
716 * Get reference count of the URB to avoid it to be
717 * freed during usb_unlink_urb, which may trigger
718 * use-after-free problem inside usb_unlink_urb since
719 * usb_unlink_urb is always racing with .complete
720 * handler(include defer_bh).
723 spin_unlock_irqrestore(&q
->lock
, flags
);
724 // during some PM-driven resume scenarios,
725 // these (async) unlinks complete immediately
726 retval
= usb_unlink_urb (urb
);
727 if (retval
!= -EINPROGRESS
&& retval
!= 0)
728 netdev_dbg(dev
->net
, "unlink urb err, %d\n", retval
);
732 spin_lock_irqsave(&q
->lock
, flags
);
734 spin_unlock_irqrestore (&q
->lock
, flags
);
738 // Flush all pending rx urbs
739 // minidrivers may need to do this when the MTU changes
741 void usbnet_unlink_rx_urbs(struct usbnet
*dev
)
743 if (netif_running(dev
->net
)) {
744 (void) unlink_urbs (dev
, &dev
->rxq
);
745 tasklet_schedule(&dev
->bh
);
748 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs
);
750 /*-------------------------------------------------------------------------*/
752 // precondition: never called in_interrupt
753 static void usbnet_terminate_urbs(struct usbnet
*dev
)
755 DECLARE_WAITQUEUE(wait
, current
);
758 /* ensure there are no more active urbs */
759 add_wait_queue(&dev
->wait
, &wait
);
760 set_current_state(TASK_UNINTERRUPTIBLE
);
761 temp
= unlink_urbs(dev
, &dev
->txq
) +
762 unlink_urbs(dev
, &dev
->rxq
);
764 /* maybe wait for deletions to finish. */
765 while (!skb_queue_empty(&dev
->rxq
)
766 && !skb_queue_empty(&dev
->txq
)
767 && !skb_queue_empty(&dev
->done
)) {
768 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS
));
769 set_current_state(TASK_UNINTERRUPTIBLE
);
770 netif_dbg(dev
, ifdown
, dev
->net
,
771 "waited for %d urb completions\n", temp
);
773 set_current_state(TASK_RUNNING
);
774 remove_wait_queue(&dev
->wait
, &wait
);
777 int usbnet_stop (struct net_device
*net
)
779 struct usbnet
*dev
= netdev_priv(net
);
780 struct driver_info
*info
= dev
->driver_info
;
783 clear_bit(EVENT_DEV_OPEN
, &dev
->flags
);
784 netif_stop_queue (net
);
786 netif_info(dev
, ifdown
, dev
->net
,
787 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
788 net
->stats
.rx_packets
, net
->stats
.tx_packets
,
789 net
->stats
.rx_errors
, net
->stats
.tx_errors
);
791 /* to not race resume */
792 pm
= usb_autopm_get_interface(dev
->intf
);
793 /* allow minidriver to stop correctly (wireless devices to turn off
796 retval
= info
->stop(dev
);
798 netif_info(dev
, ifdown
, dev
->net
,
799 "stop fail (%d) usbnet usb-%s-%s, %s\n",
801 dev
->udev
->bus
->bus_name
, dev
->udev
->devpath
,
805 if (!(info
->flags
& FLAG_AVOID_UNLINK_URBS
))
806 usbnet_terminate_urbs(dev
);
808 usbnet_status_stop(dev
);
810 usbnet_purge_paused_rxq(dev
);
812 mpn
= !test_and_clear_bit(EVENT_NO_RUNTIME_PM
, &dev
->flags
);
814 /* deferred work (task, timer, softirq) must also stop.
815 * can't flush_scheduled_work() until we drop rtnl (later),
816 * else workers could deadlock; so make workers a NOP.
819 del_timer_sync (&dev
->delay
);
820 tasklet_kill (&dev
->bh
);
822 usb_autopm_put_interface(dev
->intf
);
824 if (info
->manage_power
&& mpn
)
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 static void usbnet_set_rx_mode(struct net_device
*net
)
1057 struct usbnet
*dev
= netdev_priv(net
);
1059 usbnet_defer_kevent(dev
, EVENT_SET_RX_MODE
);
1062 static void __handle_set_rx_mode(struct usbnet
*dev
)
1064 if (dev
->driver_info
->set_rx_mode
)
1065 (dev
->driver_info
->set_rx_mode
)(dev
);
1067 clear_bit(EVENT_SET_RX_MODE
, &dev
->flags
);
1070 /* work that cannot be done in interrupt context uses keventd.
1072 * NOTE: with 2.5 we could do more of this using completion callbacks,
1073 * especially now that control transfers can be queued.
1076 usbnet_deferred_kevent (struct work_struct
*work
)
1078 struct usbnet
*dev
=
1079 container_of(work
, struct usbnet
, kevent
);
1082 /* usb_clear_halt() needs a thread context */
1083 if (test_bit (EVENT_TX_HALT
, &dev
->flags
)) {
1084 unlink_urbs (dev
, &dev
->txq
);
1085 status
= usb_autopm_get_interface(dev
->intf
);
1088 status
= usb_clear_halt (dev
->udev
, dev
->out
);
1089 usb_autopm_put_interface(dev
->intf
);
1092 status
!= -ESHUTDOWN
) {
1093 if (netif_msg_tx_err (dev
))
1095 netdev_err(dev
->net
, "can't clear tx halt, status %d\n",
1098 clear_bit (EVENT_TX_HALT
, &dev
->flags
);
1099 if (status
!= -ESHUTDOWN
)
1100 netif_wake_queue (dev
->net
);
1103 if (test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
1104 unlink_urbs (dev
, &dev
->rxq
);
1105 status
= usb_autopm_get_interface(dev
->intf
);
1108 status
= usb_clear_halt (dev
->udev
, dev
->in
);
1109 usb_autopm_put_interface(dev
->intf
);
1112 status
!= -ESHUTDOWN
) {
1113 if (netif_msg_rx_err (dev
))
1115 netdev_err(dev
->net
, "can't clear rx halt, status %d\n",
1118 clear_bit (EVENT_RX_HALT
, &dev
->flags
);
1119 tasklet_schedule (&dev
->bh
);
1123 /* tasklet could resubmit itself forever if memory is tight */
1124 if (test_bit (EVENT_RX_MEMORY
, &dev
->flags
)) {
1125 struct urb
*urb
= NULL
;
1128 if (netif_running (dev
->net
))
1129 urb
= usb_alloc_urb (0, GFP_KERNEL
);
1131 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
1133 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
1134 status
= usb_autopm_get_interface(dev
->intf
);
1139 if (rx_submit (dev
, urb
, GFP_KERNEL
) == -ENOLINK
)
1141 usb_autopm_put_interface(dev
->intf
);
1144 tasklet_schedule (&dev
->bh
);
1148 if (test_bit (EVENT_LINK_RESET
, &dev
->flags
)) {
1149 struct driver_info
*info
= dev
->driver_info
;
1152 clear_bit (EVENT_LINK_RESET
, &dev
->flags
);
1153 status
= usb_autopm_get_interface(dev
->intf
);
1156 if(info
->link_reset
&& (retval
= info
->link_reset(dev
)) < 0) {
1157 usb_autopm_put_interface(dev
->intf
);
1159 netdev_info(dev
->net
, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1161 dev
->udev
->bus
->bus_name
,
1165 usb_autopm_put_interface(dev
->intf
);
1168 /* handle link change from link resetting */
1169 __handle_link_change(dev
);
1172 if (test_bit (EVENT_LINK_CHANGE
, &dev
->flags
))
1173 __handle_link_change(dev
);
1175 if (test_bit (EVENT_SET_RX_MODE
, &dev
->flags
))
1176 __handle_set_rx_mode(dev
);
1180 netdev_dbg(dev
->net
, "kevent done, flags = 0x%lx\n", dev
->flags
);
1183 /*-------------------------------------------------------------------------*/
1185 static void tx_complete (struct urb
*urb
)
1187 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
1188 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
1189 struct usbnet
*dev
= entry
->dev
;
1191 if (urb
->status
== 0) {
1192 dev
->net
->stats
.tx_packets
+= entry
->packets
;
1193 dev
->net
->stats
.tx_bytes
+= entry
->length
;
1195 dev
->net
->stats
.tx_errors
++;
1197 switch (urb
->status
) {
1199 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
1202 /* software-driven interface shutdown */
1203 case -ECONNRESET
: // async unlink
1204 case -ESHUTDOWN
: // hardware gone
1207 /* like rx, tx gets controller i/o faults during hub_wq
1208 * delays and so it uses the same throttling mechanism.
1213 usb_mark_last_busy(dev
->udev
);
1214 if (!timer_pending (&dev
->delay
)) {
1215 mod_timer (&dev
->delay
,
1216 jiffies
+ THROTTLE_JIFFIES
);
1217 netif_dbg(dev
, link
, dev
->net
,
1218 "tx throttle %d\n", urb
->status
);
1220 netif_stop_queue (dev
->net
);
1223 netif_dbg(dev
, tx_err
, dev
->net
,
1224 "tx err %d\n", entry
->urb
->status
);
1229 usb_autopm_put_interface_async(dev
->intf
);
1230 (void) defer_bh(dev
, skb
, &dev
->txq
, tx_done
);
1233 /*-------------------------------------------------------------------------*/
1235 void usbnet_tx_timeout (struct net_device
*net
)
1237 struct usbnet
*dev
= netdev_priv(net
);
1239 unlink_urbs (dev
, &dev
->txq
);
1240 tasklet_schedule (&dev
->bh
);
1241 /* this needs to be handled individually because the generic layer
1242 * doesn't know what is sufficient and could not restore private
1243 * information if a remedy of an unconditional reset were used.
1245 if (dev
->driver_info
->recover
)
1246 (dev
->driver_info
->recover
)(dev
);
1248 EXPORT_SYMBOL_GPL(usbnet_tx_timeout
);
1250 /*-------------------------------------------------------------------------*/
1252 static int build_dma_sg(const struct sk_buff
*skb
, struct urb
*urb
)
1254 unsigned num_sgs
, total_len
= 0;
1257 num_sgs
= skb_shinfo(skb
)->nr_frags
+ 1;
1261 /* reserve one for zero packet */
1262 urb
->sg
= kmalloc((num_sgs
+ 1) * sizeof(struct scatterlist
),
1267 urb
->num_sgs
= num_sgs
;
1268 sg_init_table(urb
->sg
, urb
->num_sgs
+ 1);
1270 sg_set_buf(&urb
->sg
[s
++], skb
->data
, skb_headlen(skb
));
1271 total_len
+= skb_headlen(skb
);
1273 for (i
= 0; i
< skb_shinfo(skb
)->nr_frags
; i
++) {
1274 struct skb_frag_struct
*f
= &skb_shinfo(skb
)->frags
[i
];
1276 total_len
+= skb_frag_size(f
);
1277 sg_set_page(&urb
->sg
[i
+ s
], f
->page
.p
, f
->size
,
1280 urb
->transfer_buffer_length
= total_len
;
1285 netdev_tx_t
usbnet_start_xmit (struct sk_buff
*skb
,
1286 struct net_device
*net
)
1288 struct usbnet
*dev
= netdev_priv(net
);
1289 unsigned int length
;
1290 struct urb
*urb
= NULL
;
1291 struct skb_data
*entry
;
1292 struct driver_info
*info
= dev
->driver_info
;
1293 unsigned long flags
;
1297 skb_tx_timestamp(skb
);
1299 // some devices want funky USB-level framing, for
1300 // win32 driver (usually) and/or hardware quirks
1301 if (info
->tx_fixup
) {
1302 skb
= info
->tx_fixup (dev
, skb
, GFP_ATOMIC
);
1304 /* packet collected; minidriver waiting for more */
1305 if (info
->flags
& FLAG_MULTI_PACKET
)
1307 netif_dbg(dev
, tx_err
, dev
->net
, "can't tx_fixup skb\n");
1312 if (!(urb
= usb_alloc_urb (0, GFP_ATOMIC
))) {
1313 netif_dbg(dev
, tx_err
, dev
->net
, "no urb\n");
1317 entry
= (struct skb_data
*) skb
->cb
;
1321 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->out
,
1322 skb
->data
, skb
->len
, tx_complete
, skb
);
1323 if (dev
->can_dma_sg
) {
1324 if (build_dma_sg(skb
, urb
) < 0)
1327 length
= urb
->transfer_buffer_length
;
1329 /* don't assume the hardware handles USB_ZERO_PACKET
1330 * NOTE: strictly conforming cdc-ether devices should expect
1331 * the ZLP here, but ignore the one-byte packet.
1332 * NOTE2: CDC NCM specification is different from CDC ECM when
1333 * handling ZLP/short packets, so cdc_ncm driver will make short
1334 * packet itself if needed.
1336 if (length
% dev
->maxpacket
== 0) {
1337 if (!(info
->flags
& FLAG_SEND_ZLP
)) {
1338 if (!(info
->flags
& FLAG_MULTI_PACKET
)) {
1340 if (skb_tailroom(skb
) && !urb
->num_sgs
) {
1341 skb
->data
[skb
->len
] = 0;
1343 } else if (urb
->num_sgs
)
1344 sg_set_buf(&urb
->sg
[urb
->num_sgs
++],
1345 dev
->padding_pkt
, 1);
1348 urb
->transfer_flags
|= URB_ZERO_PACKET
;
1350 urb
->transfer_buffer_length
= length
;
1352 if (info
->flags
& FLAG_MULTI_PACKET
) {
1353 /* Driver has set number of packets and a length delta.
1354 * Calculate the complete length and ensure that it's
1357 entry
->length
+= length
;
1358 if (WARN_ON_ONCE(entry
->length
<= 0))
1359 entry
->length
= length
;
1361 usbnet_set_skb_tx_stats(skb
, 1, length
);
1364 spin_lock_irqsave(&dev
->txq
.lock
, flags
);
1365 retval
= usb_autopm_get_interface_async(dev
->intf
);
1367 spin_unlock_irqrestore(&dev
->txq
.lock
, flags
);
1372 /* if this triggers the device is still a sleep */
1373 if (test_bit(EVENT_DEV_ASLEEP
, &dev
->flags
)) {
1374 /* transmission will be done in resume */
1375 usb_anchor_urb(urb
, &dev
->deferred
);
1376 /* no use to process more packets */
1377 netif_stop_queue(net
);
1379 spin_unlock_irqrestore(&dev
->txq
.lock
, flags
);
1380 netdev_dbg(dev
->net
, "Delaying transmission for resumption\n");
1385 switch ((retval
= usb_submit_urb (urb
, GFP_ATOMIC
))) {
1387 netif_stop_queue (net
);
1388 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
1389 usb_autopm_put_interface_async(dev
->intf
);
1392 usb_autopm_put_interface_async(dev
->intf
);
1393 netif_dbg(dev
, tx_err
, dev
->net
,
1394 "tx: submit urb err %d\n", retval
);
1397 net
->trans_start
= jiffies
;
1398 __usbnet_queue_skb(&dev
->txq
, skb
, tx_start
);
1399 if (dev
->txq
.qlen
>= TX_QLEN (dev
))
1400 netif_stop_queue (net
);
1402 spin_unlock_irqrestore (&dev
->txq
.lock
, flags
);
1405 netif_dbg(dev
, tx_err
, dev
->net
, "drop, code %d\n", retval
);
1407 dev
->net
->stats
.tx_dropped
++;
1410 dev_kfree_skb_any (skb
);
1416 netif_dbg(dev
, tx_queued
, dev
->net
,
1417 "> tx, len %u, type 0x%x\n", length
, skb
->protocol
);
1421 return NETDEV_TX_OK
;
1423 EXPORT_SYMBOL_GPL(usbnet_start_xmit
);
1425 static int rx_alloc_submit(struct usbnet
*dev
, gfp_t flags
)
1431 /* don't refill the queue all at once */
1432 for (i
= 0; i
< 10 && dev
->rxq
.qlen
< RX_QLEN(dev
); i
++) {
1433 urb
= usb_alloc_urb(0, flags
);
1435 ret
= rx_submit(dev
, urb
, flags
);
1447 /*-------------------------------------------------------------------------*/
1449 // tasklet (work deferred from completions, in_irq) or timer
1451 static void usbnet_bh (unsigned long param
)
1453 struct usbnet
*dev
= (struct usbnet
*) param
;
1454 struct sk_buff
*skb
;
1455 struct skb_data
*entry
;
1457 while ((skb
= skb_dequeue (&dev
->done
))) {
1458 entry
= (struct skb_data
*) skb
->cb
;
1459 switch (entry
->state
) {
1461 entry
->state
= rx_cleanup
;
1462 rx_process (dev
, skb
);
1465 kfree(entry
->urb
->sg
);
1467 usb_free_urb (entry
->urb
);
1468 dev_kfree_skb (skb
);
1471 netdev_dbg(dev
->net
, "bogus skb state %d\n", entry
->state
);
1475 /* restart RX again after disabling due to high error rate */
1476 clear_bit(EVENT_RX_KILL
, &dev
->flags
);
1478 /* waiting for all pending urbs to complete?
1479 * only then can we forgo submitting anew
1481 if (waitqueue_active(&dev
->wait
)) {
1482 if (dev
->txq
.qlen
+ dev
->rxq
.qlen
+ dev
->done
.qlen
== 0)
1483 wake_up_all(&dev
->wait
);
1485 // or are we maybe short a few urbs?
1486 } else if (netif_running (dev
->net
) &&
1487 netif_device_present (dev
->net
) &&
1488 netif_carrier_ok(dev
->net
) &&
1489 !timer_pending (&dev
->delay
) &&
1490 !test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
1491 int temp
= dev
->rxq
.qlen
;
1493 if (temp
< RX_QLEN(dev
)) {
1494 if (rx_alloc_submit(dev
, GFP_ATOMIC
) == -ENOLINK
)
1496 if (temp
!= dev
->rxq
.qlen
)
1497 netif_dbg(dev
, link
, dev
->net
,
1498 "rxqlen %d --> %d\n",
1499 temp
, dev
->rxq
.qlen
);
1500 if (dev
->rxq
.qlen
< RX_QLEN(dev
))
1501 tasklet_schedule (&dev
->bh
);
1503 if (dev
->txq
.qlen
< TX_QLEN (dev
))
1504 netif_wake_queue (dev
->net
);
1509 /*-------------------------------------------------------------------------
1511 * USB Device Driver support
1513 *-------------------------------------------------------------------------*/
1515 // precondition: never called in_interrupt
1517 void usbnet_disconnect (struct usb_interface
*intf
)
1520 struct usb_device
*xdev
;
1521 struct net_device
*net
;
1523 dev
= usb_get_intfdata(intf
);
1524 usb_set_intfdata(intf
, NULL
);
1528 xdev
= interface_to_usbdev (intf
);
1530 netif_info(dev
, probe
, dev
->net
, "unregister '%s' usb-%s-%s, %s\n",
1531 intf
->dev
.driver
->name
,
1532 xdev
->bus
->bus_name
, xdev
->devpath
,
1533 dev
->driver_info
->description
);
1536 unregister_netdev (net
);
1538 cancel_work_sync(&dev
->kevent
);
1540 usb_scuttle_anchored_urbs(&dev
->deferred
);
1542 if (dev
->driver_info
->unbind
)
1543 dev
->driver_info
->unbind (dev
, intf
);
1545 usb_kill_urb(dev
->interrupt
);
1546 usb_free_urb(dev
->interrupt
);
1547 kfree(dev
->padding_pkt
);
1551 EXPORT_SYMBOL_GPL(usbnet_disconnect
);
1553 static const struct net_device_ops usbnet_netdev_ops
= {
1554 .ndo_open
= usbnet_open
,
1555 .ndo_stop
= usbnet_stop
,
1556 .ndo_start_xmit
= usbnet_start_xmit
,
1557 .ndo_tx_timeout
= usbnet_tx_timeout
,
1558 .ndo_set_rx_mode
= usbnet_set_rx_mode
,
1559 .ndo_change_mtu
= usbnet_change_mtu
,
1560 .ndo_set_mac_address
= eth_mac_addr
,
1561 .ndo_validate_addr
= eth_validate_addr
,
1564 /*-------------------------------------------------------------------------*/
1566 // precondition: never called in_interrupt
1568 static struct device_type wlan_type
= {
1572 static struct device_type wwan_type
= {
1577 usbnet_probe (struct usb_interface
*udev
, const struct usb_device_id
*prod
)
1580 struct net_device
*net
;
1581 struct usb_host_interface
*interface
;
1582 struct driver_info
*info
;
1583 struct usb_device
*xdev
;
1586 struct usb_driver
*driver
= to_usb_driver(udev
->dev
.driver
);
1588 /* usbnet already took usb runtime pm, so have to enable the feature
1589 * for usb interface, otherwise usb_autopm_get_interface may return
1590 * failure if RUNTIME_PM is enabled.
1592 if (!driver
->supports_autosuspend
) {
1593 driver
->supports_autosuspend
= 1;
1594 pm_runtime_enable(&udev
->dev
);
1597 name
= udev
->dev
.driver
->name
;
1598 info
= (struct driver_info
*) prod
->driver_info
;
1600 dev_dbg (&udev
->dev
, "blacklisted by %s\n", name
);
1603 xdev
= interface_to_usbdev (udev
);
1604 interface
= udev
->cur_altsetting
;
1608 // set up our own records
1609 net
= alloc_etherdev(sizeof(*dev
));
1613 /* netdev_printk() needs this so do it as early as possible */
1614 SET_NETDEV_DEV(net
, &udev
->dev
);
1616 dev
= netdev_priv(net
);
1619 dev
->driver_info
= info
;
1620 dev
->driver_name
= name
;
1621 dev
->msg_enable
= netif_msg_init (msg_level
, NETIF_MSG_DRV
1622 | NETIF_MSG_PROBE
| NETIF_MSG_LINK
);
1623 init_waitqueue_head(&dev
->wait
);
1624 skb_queue_head_init (&dev
->rxq
);
1625 skb_queue_head_init (&dev
->txq
);
1626 skb_queue_head_init (&dev
->done
);
1627 skb_queue_head_init(&dev
->rxq_pause
);
1628 dev
->bh
.func
= usbnet_bh
;
1629 dev
->bh
.data
= (unsigned long) dev
;
1630 INIT_WORK (&dev
->kevent
, usbnet_deferred_kevent
);
1631 init_usb_anchor(&dev
->deferred
);
1632 dev
->delay
.function
= usbnet_bh
;
1633 dev
->delay
.data
= (unsigned long) dev
;
1634 init_timer (&dev
->delay
);
1635 mutex_init (&dev
->phy_mutex
);
1636 mutex_init(&dev
->interrupt_mutex
);
1637 dev
->interrupt_count
= 0;
1640 strcpy (net
->name
, "usb%d");
1641 memcpy (net
->dev_addr
, node_id
, sizeof node_id
);
1643 /* rx and tx sides can use different message sizes;
1644 * bind() should set rx_urb_size in that case.
1646 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
1648 // dma_supported() is deeply broken on almost all architectures
1649 // possible with some EHCI controllers
1650 if (dma_supported (&udev
->dev
, DMA_BIT_MASK(64)))
1651 net
->features
|= NETIF_F_HIGHDMA
;
1654 net
->netdev_ops
= &usbnet_netdev_ops
;
1655 net
->watchdog_timeo
= TX_TIMEOUT_JIFFIES
;
1656 net
->ethtool_ops
= &usbnet_ethtool_ops
;
1658 // allow device-specific bind/init procedures
1659 // NOTE net->name still not usable ...
1661 status
= info
->bind (dev
, udev
);
1665 // heuristic: "usb%d" for links we know are two-host,
1666 // else "eth%d" when there's reasonable doubt. userspace
1667 // can rename the link if it knows better.
1668 if ((dev
->driver_info
->flags
& FLAG_ETHER
) != 0 &&
1669 ((dev
->driver_info
->flags
& FLAG_POINTTOPOINT
) == 0 ||
1670 (net
->dev_addr
[0] & 0x02) == 0))
1671 strcpy (net
->name
, "eth%d");
1672 /* WLAN devices should always be named "wlan%d" */
1673 if ((dev
->driver_info
->flags
& FLAG_WLAN
) != 0)
1674 strcpy(net
->name
, "wlan%d");
1675 /* WWAN devices should always be named "wwan%d" */
1676 if ((dev
->driver_info
->flags
& FLAG_WWAN
) != 0)
1677 strcpy(net
->name
, "wwan%d");
1679 /* devices that cannot do ARP */
1680 if ((dev
->driver_info
->flags
& FLAG_NOARP
) != 0)
1681 net
->flags
|= IFF_NOARP
;
1683 /* maybe the remote can't receive an Ethernet MTU */
1684 if (net
->mtu
> (dev
->hard_mtu
- net
->hard_header_len
))
1685 net
->mtu
= dev
->hard_mtu
- net
->hard_header_len
;
1686 } else if (!info
->in
|| !info
->out
)
1687 status
= usbnet_get_endpoints (dev
, udev
);
1689 dev
->in
= usb_rcvbulkpipe (xdev
, info
->in
);
1690 dev
->out
= usb_sndbulkpipe (xdev
, info
->out
);
1691 if (!(info
->flags
& FLAG_NO_SETINT
))
1692 status
= usb_set_interface (xdev
,
1693 interface
->desc
.bInterfaceNumber
,
1694 interface
->desc
.bAlternateSetting
);
1699 if (status
>= 0 && dev
->status
)
1700 status
= init_status (dev
, udev
);
1704 if (!dev
->rx_urb_size
)
1705 dev
->rx_urb_size
= dev
->hard_mtu
;
1706 dev
->maxpacket
= usb_maxpacket (dev
->udev
, dev
->out
, 1);
1708 /* let userspace know we have a random address */
1709 if (ether_addr_equal(net
->dev_addr
, node_id
))
1710 net
->addr_assign_type
= NET_ADDR_RANDOM
;
1712 if ((dev
->driver_info
->flags
& FLAG_WLAN
) != 0)
1713 SET_NETDEV_DEVTYPE(net
, &wlan_type
);
1714 if ((dev
->driver_info
->flags
& FLAG_WWAN
) != 0)
1715 SET_NETDEV_DEVTYPE(net
, &wwan_type
);
1717 /* initialize max rx_qlen and tx_qlen */
1718 usbnet_update_max_qlen(dev
);
1720 if (dev
->can_dma_sg
&& !(info
->flags
& FLAG_SEND_ZLP
) &&
1721 !(info
->flags
& FLAG_MULTI_PACKET
)) {
1722 dev
->padding_pkt
= kzalloc(1, GFP_KERNEL
);
1723 if (!dev
->padding_pkt
) {
1729 status
= register_netdev (net
);
1732 netif_info(dev
, probe
, dev
->net
,
1733 "register '%s' at usb-%s-%s, %s, %pM\n",
1734 udev
->dev
.driver
->name
,
1735 xdev
->bus
->bus_name
, xdev
->devpath
,
1736 dev
->driver_info
->description
,
1739 // ok, it's ready to go.
1740 usb_set_intfdata (udev
, dev
);
1742 netif_device_attach (net
);
1744 if (dev
->driver_info
->flags
& FLAG_LINK_INTR
)
1745 usbnet_link_change(dev
, 0, 0);
1750 kfree(dev
->padding_pkt
);
1752 usb_free_urb(dev
->interrupt
);
1755 info
->unbind (dev
, udev
);
1761 EXPORT_SYMBOL_GPL(usbnet_probe
);
1763 /*-------------------------------------------------------------------------*/
1766 * suspend the whole driver as soon as the first interface is suspended
1767 * resume only when the last interface is resumed
1770 int usbnet_suspend (struct usb_interface
*intf
, pm_message_t message
)
1772 struct usbnet
*dev
= usb_get_intfdata(intf
);
1774 if (!dev
->suspend_count
++) {
1775 spin_lock_irq(&dev
->txq
.lock
);
1776 /* don't autosuspend while transmitting */
1777 if (dev
->txq
.qlen
&& PMSG_IS_AUTO(message
)) {
1778 dev
->suspend_count
--;
1779 spin_unlock_irq(&dev
->txq
.lock
);
1782 set_bit(EVENT_DEV_ASLEEP
, &dev
->flags
);
1783 spin_unlock_irq(&dev
->txq
.lock
);
1786 * accelerate emptying of the rx and queues, to avoid
1787 * having everything error out.
1789 netif_device_detach (dev
->net
);
1790 usbnet_terminate_urbs(dev
);
1791 __usbnet_status_stop_force(dev
);
1794 * reattach so runtime management can use and
1797 netif_device_attach (dev
->net
);
1801 EXPORT_SYMBOL_GPL(usbnet_suspend
);
1803 int usbnet_resume (struct usb_interface
*intf
)
1805 struct usbnet
*dev
= usb_get_intfdata(intf
);
1806 struct sk_buff
*skb
;
1810 if (!--dev
->suspend_count
) {
1811 /* resume interrupt URB if it was previously submitted */
1812 __usbnet_status_start_force(dev
, GFP_NOIO
);
1814 spin_lock_irq(&dev
->txq
.lock
);
1815 while ((res
= usb_get_from_anchor(&dev
->deferred
))) {
1817 skb
= (struct sk_buff
*)res
->context
;
1818 retval
= usb_submit_urb(res
, GFP_ATOMIC
);
1820 dev_kfree_skb_any(skb
);
1823 usb_autopm_put_interface_async(dev
->intf
);
1825 dev
->net
->trans_start
= jiffies
;
1826 __skb_queue_tail(&dev
->txq
, skb
);
1831 clear_bit(EVENT_DEV_ASLEEP
, &dev
->flags
);
1832 spin_unlock_irq(&dev
->txq
.lock
);
1834 if (test_bit(EVENT_DEV_OPEN
, &dev
->flags
)) {
1835 /* handle remote wakeup ASAP
1836 * we cannot race against stop
1838 if (netif_device_present(dev
->net
) &&
1839 !timer_pending(&dev
->delay
) &&
1840 !test_bit(EVENT_RX_HALT
, &dev
->flags
))
1841 rx_alloc_submit(dev
, GFP_NOIO
);
1843 if (!(dev
->txq
.qlen
>= TX_QLEN(dev
)))
1844 netif_tx_wake_all_queues(dev
->net
);
1845 tasklet_schedule (&dev
->bh
);
1849 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE
, &dev
->flags
))
1850 usb_autopm_get_interface_no_resume(intf
);
1854 EXPORT_SYMBOL_GPL(usbnet_resume
);
1857 * Either a subdriver implements manage_power, then it is assumed to always
1858 * be ready to be suspended or it reports the readiness to be suspended
1861 void usbnet_device_suggests_idle(struct usbnet
*dev
)
1863 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE
, &dev
->flags
)) {
1864 dev
->intf
->needs_remote_wakeup
= 1;
1865 usb_autopm_put_interface_async(dev
->intf
);
1868 EXPORT_SYMBOL(usbnet_device_suggests_idle
);
1871 * For devices that can do without special commands
1873 int usbnet_manage_power(struct usbnet
*dev
, int on
)
1875 dev
->intf
->needs_remote_wakeup
= on
;
1878 EXPORT_SYMBOL(usbnet_manage_power
);
1880 void usbnet_link_change(struct usbnet
*dev
, bool link
, bool need_reset
)
1882 /* update link after link is reseted */
1883 if (link
&& !need_reset
)
1884 netif_carrier_on(dev
->net
);
1886 netif_carrier_off(dev
->net
);
1888 if (need_reset
&& link
)
1889 usbnet_defer_kevent(dev
, EVENT_LINK_RESET
);
1891 usbnet_defer_kevent(dev
, EVENT_LINK_CHANGE
);
1893 EXPORT_SYMBOL(usbnet_link_change
);
1895 /*-------------------------------------------------------------------------*/
1896 static int __usbnet_read_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1897 u16 value
, u16 index
, void *data
, u16 size
)
1902 netdev_dbg(dev
->net
, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1903 " value=0x%04x index=0x%04x size=%d\n",
1904 cmd
, reqtype
, value
, index
, size
);
1907 buf
= kmalloc(size
, GFP_KERNEL
);
1912 err
= usb_control_msg(dev
->udev
, usb_rcvctrlpipe(dev
->udev
, 0),
1913 cmd
, reqtype
, value
, index
, buf
, size
,
1914 USB_CTRL_GET_TIMEOUT
);
1915 if (err
> 0 && err
<= size
)
1916 memcpy(data
, buf
, err
);
1922 static int __usbnet_write_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1923 u16 value
, u16 index
, const void *data
,
1929 netdev_dbg(dev
->net
, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1930 " value=0x%04x index=0x%04x size=%d\n",
1931 cmd
, reqtype
, value
, index
, size
);
1934 buf
= kmemdup(data
, size
, GFP_KERNEL
);
1939 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, 0),
1940 cmd
, reqtype
, value
, index
, buf
, size
,
1941 USB_CTRL_SET_TIMEOUT
);
1949 * The function can't be called inside suspend/resume callback,
1950 * otherwise deadlock will be caused.
1952 int usbnet_read_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1953 u16 value
, u16 index
, void *data
, u16 size
)
1957 if (usb_autopm_get_interface(dev
->intf
) < 0)
1959 ret
= __usbnet_read_cmd(dev
, cmd
, reqtype
, value
, index
,
1961 usb_autopm_put_interface(dev
->intf
);
1964 EXPORT_SYMBOL_GPL(usbnet_read_cmd
);
1967 * The function can't be called inside suspend/resume callback,
1968 * otherwise deadlock will be caused.
1970 int usbnet_write_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1971 u16 value
, u16 index
, const void *data
, u16 size
)
1975 if (usb_autopm_get_interface(dev
->intf
) < 0)
1977 ret
= __usbnet_write_cmd(dev
, cmd
, reqtype
, value
, index
,
1979 usb_autopm_put_interface(dev
->intf
);
1982 EXPORT_SYMBOL_GPL(usbnet_write_cmd
);
1985 * The function can be called inside suspend/resume callback safely
1986 * and should only be called by suspend/resume callback generally.
1988 int usbnet_read_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1989 u16 value
, u16 index
, void *data
, u16 size
)
1991 return __usbnet_read_cmd(dev
, cmd
, reqtype
, value
, index
,
1994 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm
);
1997 * The function can be called inside suspend/resume callback safely
1998 * and should only be called by suspend/resume callback generally.
2000 int usbnet_write_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
2001 u16 value
, u16 index
, const void *data
,
2004 return __usbnet_write_cmd(dev
, cmd
, reqtype
, value
, index
,
2007 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm
);
2009 static void usbnet_async_cmd_cb(struct urb
*urb
)
2011 struct usb_ctrlrequest
*req
= (struct usb_ctrlrequest
*)urb
->context
;
2012 int status
= urb
->status
;
2015 dev_dbg(&urb
->dev
->dev
, "%s failed with %d",
2023 * The caller must make sure that device can't be put into suspend
2024 * state until the control URB completes.
2026 int usbnet_write_cmd_async(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
2027 u16 value
, u16 index
, const void *data
, u16 size
)
2029 struct usb_ctrlrequest
*req
= NULL
;
2034 netdev_dbg(dev
->net
, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2035 " value=0x%04x index=0x%04x size=%d\n",
2036 cmd
, reqtype
, value
, index
, size
);
2038 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
2040 netdev_err(dev
->net
, "Error allocating URB in"
2041 " %s!\n", __func__
);
2046 buf
= kmemdup(data
, size
, GFP_ATOMIC
);
2048 netdev_err(dev
->net
, "Error allocating buffer"
2049 " in %s!\n", __func__
);
2054 req
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_ATOMIC
);
2058 req
->bRequestType
= reqtype
;
2059 req
->bRequest
= cmd
;
2060 req
->wValue
= cpu_to_le16(value
);
2061 req
->wIndex
= cpu_to_le16(index
);
2062 req
->wLength
= cpu_to_le16(size
);
2064 usb_fill_control_urb(urb
, dev
->udev
,
2065 usb_sndctrlpipe(dev
->udev
, 0),
2066 (void *)req
, buf
, size
,
2067 usbnet_async_cmd_cb
, req
);
2068 urb
->transfer_flags
|= URB_FREE_BUFFER
;
2070 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
2072 netdev_err(dev
->net
, "Error submitting the control"
2073 " message: status=%d\n", err
);
2087 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async
);
2088 /*-------------------------------------------------------------------------*/
2090 static int __init
usbnet_init(void)
2092 /* Compiler should optimize this out. */
2094 FIELD_SIZEOF(struct sk_buff
, cb
) < sizeof(struct skb_data
));
2096 eth_random_addr(node_id
);
2099 module_init(usbnet_init
);
2101 static void __exit
usbnet_exit(void)
2104 module_exit(usbnet_exit
);
2106 MODULE_AUTHOR("David Brownell");
2107 MODULE_DESCRIPTION("USB network driver framework");
2108 MODULE_LICENSE("GPL");