2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * This is a generic "USB networking" framework that works with several
23 * kinds of full and high speed networking devices: host-to-host cables,
24 * smart usb peripherals, and actual Ethernet adapters.
26 * These devices usually differ in terms of control protocols (if they
27 * even have one!) and sometimes they define new framing to wrap or batch
28 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
29 * so interface (un)binding, endpoint I/O queues, fault handling, and other
30 * issues can usefully be addressed by this framework.
33 // #define DEBUG // error path messages, extra info
34 // #define VERBOSE // more; success messages
36 #include <linux/module.h>
37 #include <linux/init.h>
38 #include <linux/netdevice.h>
39 #include <linux/etherdevice.h>
40 #include <linux/ctype.h>
41 #include <linux/ethtool.h>
42 #include <linux/workqueue.h>
43 #include <linux/mii.h>
44 #include <linux/usb.h>
45 #include <linux/usb/usbnet.h>
46 #include <linux/slab.h>
47 #include <linux/kernel.h>
48 #include <linux/pm_runtime.h>
50 #define DRIVER_VERSION "22-Aug-2005"
53 /*-------------------------------------------------------------------------*/
56 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
57 * Several dozen bytes of IPv4 data can fit in two such transactions.
58 * One maximum size Ethernet packet takes twenty four of them.
59 * For high speed, each frame comfortably fits almost 36 max size
60 * Ethernet packets (so queues should be bigger).
62 * The goal is to let the USB host controller be busy for 5msec or
63 * more before an irq is required, under load. Jumbograms change
66 #define MAX_QUEUE_MEMORY (60 * 1518)
67 #define RX_QLEN(dev) ((dev)->rx_qlen)
68 #define TX_QLEN(dev) ((dev)->tx_qlen)
70 // reawaken network queue this soon after stopping; else watchdog barks
71 #define TX_TIMEOUT_JIFFIES (5*HZ)
73 // throttle rx/tx briefly after some faults, so khubd might disconnect()
74 // us (it polls at HZ/4 usually) before we report too many false errors.
75 #define THROTTLE_JIFFIES (HZ/8)
78 #define UNLINK_TIMEOUT_MS 3
80 /*-------------------------------------------------------------------------*/
82 // randomly generated ethernet address
83 static u8 node_id
[ETH_ALEN
];
85 static const char driver_name
[] = "usbnet";
87 /* use ethtool to change the level for any given device */
88 static int msg_level
= -1;
89 module_param (msg_level
, int, 0);
90 MODULE_PARM_DESC (msg_level
, "Override default message level");
92 /*-------------------------------------------------------------------------*/
94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
95 int usbnet_get_endpoints(struct usbnet
*dev
, struct usb_interface
*intf
)
98 struct usb_host_interface
*alt
= NULL
;
99 struct usb_host_endpoint
*in
= NULL
, *out
= NULL
;
100 struct usb_host_endpoint
*status
= NULL
;
102 for (tmp
= 0; tmp
< intf
->num_altsetting
; tmp
++) {
105 in
= out
= status
= NULL
;
106 alt
= intf
->altsetting
+ tmp
;
108 /* take the first altsetting with in-bulk + out-bulk;
109 * remember any status endpoint, just in case;
110 * ignore other endpoints and altsettings.
112 for (ep
= 0; ep
< alt
->desc
.bNumEndpoints
; ep
++) {
113 struct usb_host_endpoint
*e
;
116 e
= alt
->endpoint
+ ep
;
117 switch (e
->desc
.bmAttributes
) {
118 case USB_ENDPOINT_XFER_INT
:
119 if (!usb_endpoint_dir_in(&e
->desc
))
123 case USB_ENDPOINT_XFER_BULK
:
128 if (usb_endpoint_dir_in(&e
->desc
)) {
131 else if (intr
&& !status
)
141 if (!alt
|| !in
|| !out
)
144 if (alt
->desc
.bAlternateSetting
!= 0 ||
145 !(dev
->driver_info
->flags
& FLAG_NO_SETINT
)) {
146 tmp
= usb_set_interface (dev
->udev
, alt
->desc
.bInterfaceNumber
,
147 alt
->desc
.bAlternateSetting
);
152 dev
->in
= usb_rcvbulkpipe (dev
->udev
,
153 in
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
154 dev
->out
= usb_sndbulkpipe (dev
->udev
,
155 out
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
156 dev
->status
= status
;
159 EXPORT_SYMBOL_GPL(usbnet_get_endpoints
);
161 int usbnet_get_ethernet_addr(struct usbnet
*dev
, int iMACAddress
)
164 unsigned char buf
[13];
166 tmp
= usb_string(dev
->udev
, iMACAddress
, buf
, sizeof buf
);
168 dev_dbg(&dev
->udev
->dev
,
169 "bad MAC string %d fetch, %d\n", iMACAddress
, tmp
);
174 for (i
= tmp
= 0; i
< 6; i
++, tmp
+= 2)
175 dev
->net
->dev_addr
[i
] =
176 (hex_to_bin(buf
[tmp
]) << 4) + hex_to_bin(buf
[tmp
+ 1]);
179 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr
);
181 static void intr_complete (struct urb
*urb
)
183 struct usbnet
*dev
= urb
->context
;
184 int status
= urb
->status
;
189 dev
->driver_info
->status(dev
, urb
);
192 /* software-driven interface shutdown */
193 case -ENOENT
: /* urb killed */
194 case -ESHUTDOWN
: /* hardware gone */
195 netif_dbg(dev
, ifdown
, dev
->net
,
196 "intr shutdown, code %d\n", status
);
199 /* NOTE: not throttling like RX/TX, since this endpoint
200 * already polls infrequently
203 netdev_dbg(dev
->net
, "intr status %d\n", status
);
207 status
= usb_submit_urb (urb
, GFP_ATOMIC
);
209 netif_err(dev
, timer
, dev
->net
,
210 "intr resubmit --> %d\n", status
);
213 static int init_status (struct usbnet
*dev
, struct usb_interface
*intf
)
220 if (!dev
->driver_info
->status
)
223 pipe
= usb_rcvintpipe (dev
->udev
,
224 dev
->status
->desc
.bEndpointAddress
225 & USB_ENDPOINT_NUMBER_MASK
);
226 maxp
= usb_maxpacket (dev
->udev
, pipe
, 0);
228 /* avoid 1 msec chatter: min 8 msec poll rate */
229 period
= max ((int) dev
->status
->desc
.bInterval
,
230 (dev
->udev
->speed
== USB_SPEED_HIGH
) ? 7 : 3);
232 buf
= kmalloc (maxp
, GFP_KERNEL
);
234 dev
->interrupt
= usb_alloc_urb (0, GFP_KERNEL
);
235 if (!dev
->interrupt
) {
239 usb_fill_int_urb(dev
->interrupt
, dev
->udev
, pipe
,
240 buf
, maxp
, intr_complete
, dev
, period
);
241 dev
->interrupt
->transfer_flags
|= URB_FREE_BUFFER
;
243 "status ep%din, %d bytes period %d\n",
244 usb_pipeendpoint(pipe
), maxp
, period
);
250 /* Submit the interrupt URB if not previously submitted, increasing refcount */
251 int usbnet_status_start(struct usbnet
*dev
, gfp_t mem_flags
)
255 WARN_ON_ONCE(dev
->interrupt
== NULL
);
256 if (dev
->interrupt
) {
257 mutex_lock(&dev
->interrupt_mutex
);
259 if (++dev
->interrupt_count
== 1)
260 ret
= usb_submit_urb(dev
->interrupt
, mem_flags
);
262 dev_dbg(&dev
->udev
->dev
, "incremented interrupt URB count to %d\n",
263 dev
->interrupt_count
);
264 mutex_unlock(&dev
->interrupt_mutex
);
268 EXPORT_SYMBOL_GPL(usbnet_status_start
);
270 /* For resume; submit interrupt URB if previously submitted */
271 static int __usbnet_status_start_force(struct usbnet
*dev
, gfp_t mem_flags
)
275 mutex_lock(&dev
->interrupt_mutex
);
276 if (dev
->interrupt_count
) {
277 ret
= usb_submit_urb(dev
->interrupt
, mem_flags
);
278 dev_dbg(&dev
->udev
->dev
,
279 "submitted interrupt URB for resume\n");
281 mutex_unlock(&dev
->interrupt_mutex
);
285 /* Kill the interrupt URB if all submitters want it killed */
286 void usbnet_status_stop(struct usbnet
*dev
)
288 if (dev
->interrupt
) {
289 mutex_lock(&dev
->interrupt_mutex
);
290 WARN_ON(dev
->interrupt_count
== 0);
292 if (dev
->interrupt_count
&& --dev
->interrupt_count
== 0)
293 usb_kill_urb(dev
->interrupt
);
295 dev_dbg(&dev
->udev
->dev
,
296 "decremented interrupt URB count to %d\n",
297 dev
->interrupt_count
);
298 mutex_unlock(&dev
->interrupt_mutex
);
301 EXPORT_SYMBOL_GPL(usbnet_status_stop
);
303 /* For suspend; always kill interrupt URB */
304 static void __usbnet_status_stop_force(struct usbnet
*dev
)
306 if (dev
->interrupt
) {
307 mutex_lock(&dev
->interrupt_mutex
);
308 usb_kill_urb(dev
->interrupt
);
309 dev_dbg(&dev
->udev
->dev
, "killed interrupt URB for suspend\n");
310 mutex_unlock(&dev
->interrupt_mutex
);
314 /* Passes this packet up the stack, updating its accounting.
315 * Some link protocols batch packets, so their rx_fixup paths
316 * can return clones as well as just modify the original skb.
318 void usbnet_skb_return (struct usbnet
*dev
, struct sk_buff
*skb
)
322 if (test_bit(EVENT_RX_PAUSED
, &dev
->flags
)) {
323 skb_queue_tail(&dev
->rxq_pause
, skb
);
327 skb
->protocol
= eth_type_trans (skb
, dev
->net
);
328 dev
->net
->stats
.rx_packets
++;
329 dev
->net
->stats
.rx_bytes
+= skb
->len
;
331 netif_dbg(dev
, rx_status
, dev
->net
, "< rx, len %zu, type 0x%x\n",
332 skb
->len
+ sizeof (struct ethhdr
), skb
->protocol
);
333 memset (skb
->cb
, 0, sizeof (struct skb_data
));
335 if (skb_defer_rx_timestamp(skb
))
338 status
= netif_rx (skb
);
339 if (status
!= NET_RX_SUCCESS
)
340 netif_dbg(dev
, rx_err
, dev
->net
,
341 "netif_rx status %d\n", status
);
343 EXPORT_SYMBOL_GPL(usbnet_skb_return
);
345 /* must be called if hard_mtu or rx_urb_size changed */
346 void usbnet_update_max_qlen(struct usbnet
*dev
)
348 enum usb_device_speed speed
= dev
->udev
->speed
;
352 dev
->rx_qlen
= MAX_QUEUE_MEMORY
/ dev
->rx_urb_size
;
353 dev
->tx_qlen
= MAX_QUEUE_MEMORY
/ dev
->hard_mtu
;
355 case USB_SPEED_SUPER
:
357 * Not take default 5ms qlen for super speed HC to
358 * save memory, and iperf tests show 2.5ms qlen can
361 dev
->rx_qlen
= 5 * MAX_QUEUE_MEMORY
/ dev
->rx_urb_size
;
362 dev
->tx_qlen
= 5 * MAX_QUEUE_MEMORY
/ dev
->hard_mtu
;
365 dev
->rx_qlen
= dev
->tx_qlen
= 4;
368 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen
);
371 /*-------------------------------------------------------------------------
373 * Network Device Driver (peer link to "Host Device", from USB host)
375 *-------------------------------------------------------------------------*/
377 int usbnet_change_mtu (struct net_device
*net
, int new_mtu
)
379 struct usbnet
*dev
= netdev_priv(net
);
380 int ll_mtu
= new_mtu
+ net
->hard_header_len
;
381 int old_hard_mtu
= dev
->hard_mtu
;
382 int old_rx_urb_size
= dev
->rx_urb_size
;
386 // no second zero-length packet read wanted after mtu-sized packets
387 if ((ll_mtu
% dev
->maxpacket
) == 0)
391 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
392 if (dev
->rx_urb_size
== old_hard_mtu
) {
393 dev
->rx_urb_size
= dev
->hard_mtu
;
394 if (dev
->rx_urb_size
> old_rx_urb_size
)
395 usbnet_unlink_rx_urbs(dev
);
398 /* max qlen depend on hard_mtu and rx_urb_size */
399 usbnet_update_max_qlen(dev
);
403 EXPORT_SYMBOL_GPL(usbnet_change_mtu
);
405 /* The caller must hold list->lock */
406 static void __usbnet_queue_skb(struct sk_buff_head
*list
,
407 struct sk_buff
*newsk
, enum skb_state state
)
409 struct skb_data
*entry
= (struct skb_data
*) newsk
->cb
;
411 __skb_queue_tail(list
, newsk
);
412 entry
->state
= state
;
415 /*-------------------------------------------------------------------------*/
417 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
418 * completion callbacks. 2.5 should have fixed those bugs...
421 static enum skb_state
defer_bh(struct usbnet
*dev
, struct sk_buff
*skb
,
422 struct sk_buff_head
*list
, enum skb_state state
)
425 enum skb_state old_state
;
426 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
428 spin_lock_irqsave(&list
->lock
, flags
);
429 old_state
= entry
->state
;
430 entry
->state
= state
;
431 __skb_unlink(skb
, list
);
432 spin_unlock(&list
->lock
);
433 spin_lock(&dev
->done
.lock
);
434 __skb_queue_tail(&dev
->done
, skb
);
435 if (dev
->done
.qlen
== 1)
436 tasklet_schedule(&dev
->bh
);
437 spin_unlock_irqrestore(&dev
->done
.lock
, flags
);
441 /* some work can't be done in tasklets, so we use keventd
443 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
444 * but tasklet_schedule() doesn't. hope the failure is rare.
446 void usbnet_defer_kevent (struct usbnet
*dev
, int work
)
448 set_bit (work
, &dev
->flags
);
449 if (!schedule_work (&dev
->kevent
)) {
451 netdev_err(dev
->net
, "kevent %d may have been dropped\n", work
);
453 netdev_dbg(dev
->net
, "kevent %d scheduled\n", work
);
456 EXPORT_SYMBOL_GPL(usbnet_defer_kevent
);
458 /*-------------------------------------------------------------------------*/
460 static void rx_complete (struct urb
*urb
);
462 static int rx_submit (struct usbnet
*dev
, struct urb
*urb
, gfp_t flags
)
465 struct skb_data
*entry
;
467 unsigned long lockflags
;
468 size_t size
= dev
->rx_urb_size
;
470 /* prevent rx skb allocation when error ratio is high */
471 if (test_bit(EVENT_RX_KILL
, &dev
->flags
)) {
476 skb
= __netdev_alloc_skb_ip_align(dev
->net
, size
, flags
);
478 netif_dbg(dev
, rx_err
, dev
->net
, "no rx skb\n");
479 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
484 entry
= (struct skb_data
*) skb
->cb
;
489 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->in
,
490 skb
->data
, size
, rx_complete
, skb
);
492 spin_lock_irqsave (&dev
->rxq
.lock
, lockflags
);
494 if (netif_running (dev
->net
) &&
495 netif_device_present (dev
->net
) &&
496 !test_bit (EVENT_RX_HALT
, &dev
->flags
) &&
497 !test_bit (EVENT_DEV_ASLEEP
, &dev
->flags
)) {
498 switch (retval
= usb_submit_urb (urb
, GFP_ATOMIC
)) {
500 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
503 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
506 netif_dbg(dev
, ifdown
, dev
->net
, "device gone\n");
507 netif_device_detach (dev
->net
);
513 netif_dbg(dev
, rx_err
, dev
->net
,
514 "rx submit, %d\n", retval
);
515 tasklet_schedule (&dev
->bh
);
518 __usbnet_queue_skb(&dev
->rxq
, skb
, rx_start
);
521 netif_dbg(dev
, ifdown
, dev
->net
, "rx: stopped\n");
524 spin_unlock_irqrestore (&dev
->rxq
.lock
, lockflags
);
526 dev_kfree_skb_any (skb
);
533 /*-------------------------------------------------------------------------*/
535 static inline void rx_process (struct usbnet
*dev
, struct sk_buff
*skb
)
537 if (dev
->driver_info
->rx_fixup
&&
538 !dev
->driver_info
->rx_fixup (dev
, skb
)) {
539 /* With RX_ASSEMBLE, rx_fixup() must update counters */
540 if (!(dev
->driver_info
->flags
& FLAG_RX_ASSEMBLE
))
541 dev
->net
->stats
.rx_errors
++;
544 // else network stack removes extra byte if we forced a short packet
546 /* all data was already cloned from skb inside the driver */
547 if (dev
->driver_info
->flags
& FLAG_MULTI_PACKET
)
550 if (skb
->len
< ETH_HLEN
) {
551 dev
->net
->stats
.rx_errors
++;
552 dev
->net
->stats
.rx_length_errors
++;
553 netif_dbg(dev
, rx_err
, dev
->net
, "rx length %d\n", skb
->len
);
555 usbnet_skb_return(dev
, skb
);
560 skb_queue_tail(&dev
->done
, skb
);
563 /*-------------------------------------------------------------------------*/
565 static void rx_complete (struct urb
*urb
)
567 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
568 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
569 struct usbnet
*dev
= entry
->dev
;
570 int urb_status
= urb
->status
;
571 enum skb_state state
;
573 skb_put (skb
, urb
->actual_length
);
577 switch (urb_status
) {
582 /* stalls need manual reset. this is rare ... except that
583 * when going through USB 2.0 TTs, unplug appears this way.
584 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
585 * storm, recovering as needed.
588 dev
->net
->stats
.rx_errors
++;
589 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
592 /* software-driven interface shutdown */
593 case -ECONNRESET
: /* async unlink */
594 case -ESHUTDOWN
: /* hardware gone */
595 netif_dbg(dev
, ifdown
, dev
->net
,
596 "rx shutdown, code %d\n", urb_status
);
599 /* we get controller i/o faults during khubd disconnect() delays.
600 * throttle down resubmits, to avoid log floods; just temporarily,
601 * so we still recover when the fault isn't a khubd delay.
606 dev
->net
->stats
.rx_errors
++;
607 if (!timer_pending (&dev
->delay
)) {
608 mod_timer (&dev
->delay
, jiffies
+ THROTTLE_JIFFIES
);
609 netif_dbg(dev
, link
, dev
->net
,
610 "rx throttle %d\n", urb_status
);
618 /* data overrun ... flush fifo? */
620 dev
->net
->stats
.rx_over_errors
++;
625 dev
->net
->stats
.rx_errors
++;
626 netif_dbg(dev
, rx_err
, dev
->net
, "rx status %d\n", urb_status
);
630 /* stop rx if packet error rate is high */
631 if (++dev
->pkt_cnt
> 30) {
635 if (state
== rx_cleanup
)
637 if (dev
->pkt_err
> 20)
638 set_bit(EVENT_RX_KILL
, &dev
->flags
);
641 state
= defer_bh(dev
, skb
, &dev
->rxq
, state
);
644 if (netif_running (dev
->net
) &&
645 !test_bit (EVENT_RX_HALT
, &dev
->flags
) &&
646 state
!= unlink_start
) {
647 rx_submit (dev
, urb
, GFP_ATOMIC
);
648 usb_mark_last_busy(dev
->udev
);
653 netif_dbg(dev
, rx_err
, dev
->net
, "no read resubmitted\n");
656 /*-------------------------------------------------------------------------*/
657 void usbnet_pause_rx(struct usbnet
*dev
)
659 set_bit(EVENT_RX_PAUSED
, &dev
->flags
);
661 netif_dbg(dev
, rx_status
, dev
->net
, "paused rx queue enabled\n");
663 EXPORT_SYMBOL_GPL(usbnet_pause_rx
);
665 void usbnet_resume_rx(struct usbnet
*dev
)
670 clear_bit(EVENT_RX_PAUSED
, &dev
->flags
);
672 while ((skb
= skb_dequeue(&dev
->rxq_pause
)) != NULL
) {
673 usbnet_skb_return(dev
, skb
);
677 tasklet_schedule(&dev
->bh
);
679 netif_dbg(dev
, rx_status
, dev
->net
,
680 "paused rx queue disabled, %d skbs requeued\n", num
);
682 EXPORT_SYMBOL_GPL(usbnet_resume_rx
);
684 void usbnet_purge_paused_rxq(struct usbnet
*dev
)
686 skb_queue_purge(&dev
->rxq_pause
);
688 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq
);
690 /*-------------------------------------------------------------------------*/
692 // unlink pending rx/tx; completion handlers do all other cleanup
694 static int unlink_urbs (struct usbnet
*dev
, struct sk_buff_head
*q
)
700 spin_lock_irqsave (&q
->lock
, flags
);
701 while (!skb_queue_empty(q
)) {
702 struct skb_data
*entry
;
706 skb_queue_walk(q
, skb
) {
707 entry
= (struct skb_data
*) skb
->cb
;
708 if (entry
->state
!= unlink_start
)
713 entry
->state
= unlink_start
;
717 * Get reference count of the URB to avoid it to be
718 * freed during usb_unlink_urb, which may trigger
719 * use-after-free problem inside usb_unlink_urb since
720 * usb_unlink_urb is always racing with .complete
721 * handler(include defer_bh).
724 spin_unlock_irqrestore(&q
->lock
, flags
);
725 // during some PM-driven resume scenarios,
726 // these (async) unlinks complete immediately
727 retval
= usb_unlink_urb (urb
);
728 if (retval
!= -EINPROGRESS
&& retval
!= 0)
729 netdev_dbg(dev
->net
, "unlink urb err, %d\n", retval
);
733 spin_lock_irqsave(&q
->lock
, flags
);
735 spin_unlock_irqrestore (&q
->lock
, flags
);
739 // Flush all pending rx urbs
740 // minidrivers may need to do this when the MTU changes
742 void usbnet_unlink_rx_urbs(struct usbnet
*dev
)
744 if (netif_running(dev
->net
)) {
745 (void) unlink_urbs (dev
, &dev
->rxq
);
746 tasklet_schedule(&dev
->bh
);
749 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs
);
751 /*-------------------------------------------------------------------------*/
753 // precondition: never called in_interrupt
754 static void usbnet_terminate_urbs(struct usbnet
*dev
)
756 DECLARE_WAITQUEUE(wait
, current
);
759 /* ensure there are no more active urbs */
760 add_wait_queue(&dev
->wait
, &wait
);
761 set_current_state(TASK_UNINTERRUPTIBLE
);
762 temp
= unlink_urbs(dev
, &dev
->txq
) +
763 unlink_urbs(dev
, &dev
->rxq
);
765 /* maybe wait for deletions to finish. */
766 while (!skb_queue_empty(&dev
->rxq
)
767 && !skb_queue_empty(&dev
->txq
)
768 && !skb_queue_empty(&dev
->done
)) {
769 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS
));
770 set_current_state(TASK_UNINTERRUPTIBLE
);
771 netif_dbg(dev
, ifdown
, dev
->net
,
772 "waited for %d urb completions\n", temp
);
774 set_current_state(TASK_RUNNING
);
775 remove_wait_queue(&dev
->wait
, &wait
);
778 int usbnet_stop (struct net_device
*net
)
780 struct usbnet
*dev
= netdev_priv(net
);
781 struct driver_info
*info
= dev
->driver_info
;
784 clear_bit(EVENT_DEV_OPEN
, &dev
->flags
);
785 netif_stop_queue (net
);
787 netif_info(dev
, ifdown
, dev
->net
,
788 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
789 net
->stats
.rx_packets
, net
->stats
.tx_packets
,
790 net
->stats
.rx_errors
, net
->stats
.tx_errors
);
792 /* to not race resume */
793 pm
= usb_autopm_get_interface(dev
->intf
);
794 /* allow minidriver to stop correctly (wireless devices to turn off
797 retval
= info
->stop(dev
);
799 netif_info(dev
, ifdown
, dev
->net
,
800 "stop fail (%d) usbnet usb-%s-%s, %s\n",
802 dev
->udev
->bus
->bus_name
, dev
->udev
->devpath
,
806 if (!(info
->flags
& FLAG_AVOID_UNLINK_URBS
))
807 usbnet_terminate_urbs(dev
);
809 usbnet_status_stop(dev
);
811 usbnet_purge_paused_rxq(dev
);
813 mpn
= !test_and_clear_bit(EVENT_NO_RUNTIME_PM
, &dev
->flags
);
815 /* deferred work (task, timer, softirq) must also stop.
816 * can't flush_scheduled_work() until we drop rtnl (later),
817 * else workers could deadlock; so make workers a NOP.
820 del_timer_sync (&dev
->delay
);
821 tasklet_kill (&dev
->bh
);
823 usb_autopm_put_interface(dev
->intf
);
825 if (info
->manage_power
&& mpn
)
826 info
->manage_power(dev
, 0);
828 usb_autopm_put_interface(dev
->intf
);
832 EXPORT_SYMBOL_GPL(usbnet_stop
);
834 /*-------------------------------------------------------------------------*/
836 // posts reads, and enables write queuing
838 // precondition: never called in_interrupt
840 int usbnet_open (struct net_device
*net
)
842 struct usbnet
*dev
= netdev_priv(net
);
844 struct driver_info
*info
= dev
->driver_info
;
846 if ((retval
= usb_autopm_get_interface(dev
->intf
)) < 0) {
847 netif_info(dev
, ifup
, dev
->net
,
848 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
850 dev
->udev
->bus
->bus_name
,
856 // put into "known safe" state
857 if (info
->reset
&& (retval
= info
->reset (dev
)) < 0) {
858 netif_info(dev
, ifup
, dev
->net
,
859 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
861 dev
->udev
->bus
->bus_name
,
867 /* hard_mtu or rx_urb_size may change in reset() */
868 usbnet_update_max_qlen(dev
);
870 // insist peer be connected
871 if (info
->check_connect
&& (retval
= info
->check_connect (dev
)) < 0) {
872 netif_dbg(dev
, ifup
, dev
->net
, "can't open; %d\n", retval
);
876 /* start any status interrupt transfer */
877 if (dev
->interrupt
) {
878 retval
= usbnet_status_start(dev
, GFP_KERNEL
);
880 netif_err(dev
, ifup
, dev
->net
,
881 "intr submit %d\n", retval
);
886 set_bit(EVENT_DEV_OPEN
, &dev
->flags
);
887 netif_start_queue (net
);
888 netif_info(dev
, ifup
, dev
->net
,
889 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
890 (int)RX_QLEN(dev
), (int)TX_QLEN(dev
),
892 (dev
->driver_info
->flags
& FLAG_FRAMING_NC
) ? "NetChip" :
893 (dev
->driver_info
->flags
& FLAG_FRAMING_GL
) ? "GeneSys" :
894 (dev
->driver_info
->flags
& FLAG_FRAMING_Z
) ? "Zaurus" :
895 (dev
->driver_info
->flags
& FLAG_FRAMING_RN
) ? "RNDIS" :
896 (dev
->driver_info
->flags
& FLAG_FRAMING_AX
) ? "ASIX" :
899 /* reset rx error state */
902 clear_bit(EVENT_RX_KILL
, &dev
->flags
);
904 // delay posting reads until we're fully open
905 tasklet_schedule (&dev
->bh
);
906 if (info
->manage_power
) {
907 retval
= info
->manage_power(dev
, 1);
910 set_bit(EVENT_NO_RUNTIME_PM
, &dev
->flags
);
912 usb_autopm_put_interface(dev
->intf
);
917 usb_autopm_put_interface(dev
->intf
);
921 EXPORT_SYMBOL_GPL(usbnet_open
);
923 /*-------------------------------------------------------------------------*/
925 /* ethtool methods; minidrivers may need to add some more, but
926 * they'll probably want to use this base set.
929 int usbnet_get_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
)
931 struct usbnet
*dev
= netdev_priv(net
);
933 if (!dev
->mii
.mdio_read
)
936 return mii_ethtool_gset(&dev
->mii
, cmd
);
938 EXPORT_SYMBOL_GPL(usbnet_get_settings
);
940 int usbnet_set_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
)
942 struct usbnet
*dev
= netdev_priv(net
);
945 if (!dev
->mii
.mdio_write
)
948 retval
= mii_ethtool_sset(&dev
->mii
, cmd
);
950 /* link speed/duplex might have changed */
951 if (dev
->driver_info
->link_reset
)
952 dev
->driver_info
->link_reset(dev
);
954 /* hard_mtu or rx_urb_size may change in link_reset() */
955 usbnet_update_max_qlen(dev
);
960 EXPORT_SYMBOL_GPL(usbnet_set_settings
);
962 u32
usbnet_get_link (struct net_device
*net
)
964 struct usbnet
*dev
= netdev_priv(net
);
966 /* If a check_connect is defined, return its result */
967 if (dev
->driver_info
->check_connect
)
968 return dev
->driver_info
->check_connect (dev
) == 0;
970 /* if the device has mii operations, use those */
971 if (dev
->mii
.mdio_read
)
972 return mii_link_ok(&dev
->mii
);
974 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
975 return ethtool_op_get_link(net
);
977 EXPORT_SYMBOL_GPL(usbnet_get_link
);
979 int usbnet_nway_reset(struct net_device
*net
)
981 struct usbnet
*dev
= netdev_priv(net
);
983 if (!dev
->mii
.mdio_write
)
986 return mii_nway_restart(&dev
->mii
);
988 EXPORT_SYMBOL_GPL(usbnet_nway_reset
);
990 void usbnet_get_drvinfo (struct net_device
*net
, struct ethtool_drvinfo
*info
)
992 struct usbnet
*dev
= netdev_priv(net
);
994 strlcpy (info
->driver
, dev
->driver_name
, sizeof info
->driver
);
995 strlcpy (info
->version
, DRIVER_VERSION
, sizeof info
->version
);
996 strlcpy (info
->fw_version
, dev
->driver_info
->description
,
997 sizeof info
->fw_version
);
998 usb_make_path (dev
->udev
, info
->bus_info
, sizeof info
->bus_info
);
1000 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo
);
1002 u32
usbnet_get_msglevel (struct net_device
*net
)
1004 struct usbnet
*dev
= netdev_priv(net
);
1006 return dev
->msg_enable
;
1008 EXPORT_SYMBOL_GPL(usbnet_get_msglevel
);
1010 void usbnet_set_msglevel (struct net_device
*net
, u32 level
)
1012 struct usbnet
*dev
= netdev_priv(net
);
1014 dev
->msg_enable
= level
;
1016 EXPORT_SYMBOL_GPL(usbnet_set_msglevel
);
1018 /* drivers may override default ethtool_ops in their bind() routine */
1019 static const struct ethtool_ops usbnet_ethtool_ops
= {
1020 .get_settings
= usbnet_get_settings
,
1021 .set_settings
= usbnet_set_settings
,
1022 .get_link
= usbnet_get_link
,
1023 .nway_reset
= usbnet_nway_reset
,
1024 .get_drvinfo
= usbnet_get_drvinfo
,
1025 .get_msglevel
= usbnet_get_msglevel
,
1026 .set_msglevel
= usbnet_set_msglevel
,
1027 .get_ts_info
= ethtool_op_get_ts_info
,
1030 /*-------------------------------------------------------------------------*/
1032 static void __handle_link_change(struct usbnet
*dev
)
1034 if (!test_bit(EVENT_DEV_OPEN
, &dev
->flags
))
1037 if (!netif_carrier_ok(dev
->net
)) {
1038 /* kill URBs for reading packets to save bus bandwidth */
1039 unlink_urbs(dev
, &dev
->rxq
);
1042 * tx_timeout will unlink URBs for sending packets and
1043 * tx queue is stopped by netcore after link becomes off
1046 /* submitting URBs for reading packets */
1047 tasklet_schedule(&dev
->bh
);
1050 /* hard_mtu or rx_urb_size may change during link change */
1051 usbnet_update_max_qlen(dev
);
1053 clear_bit(EVENT_LINK_CHANGE
, &dev
->flags
);
1056 /* work that cannot be done in interrupt context uses keventd.
1058 * NOTE: with 2.5 we could do more of this using completion callbacks,
1059 * especially now that control transfers can be queued.
1062 kevent (struct work_struct
*work
)
1064 struct usbnet
*dev
=
1065 container_of(work
, struct usbnet
, kevent
);
1068 /* usb_clear_halt() needs a thread context */
1069 if (test_bit (EVENT_TX_HALT
, &dev
->flags
)) {
1070 unlink_urbs (dev
, &dev
->txq
);
1071 status
= usb_autopm_get_interface(dev
->intf
);
1074 status
= usb_clear_halt (dev
->udev
, dev
->out
);
1075 usb_autopm_put_interface(dev
->intf
);
1078 status
!= -ESHUTDOWN
) {
1079 if (netif_msg_tx_err (dev
))
1081 netdev_err(dev
->net
, "can't clear tx halt, status %d\n",
1084 clear_bit (EVENT_TX_HALT
, &dev
->flags
);
1085 if (status
!= -ESHUTDOWN
)
1086 netif_wake_queue (dev
->net
);
1089 if (test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
1090 unlink_urbs (dev
, &dev
->rxq
);
1091 status
= usb_autopm_get_interface(dev
->intf
);
1094 status
= usb_clear_halt (dev
->udev
, dev
->in
);
1095 usb_autopm_put_interface(dev
->intf
);
1098 status
!= -ESHUTDOWN
) {
1099 if (netif_msg_rx_err (dev
))
1101 netdev_err(dev
->net
, "can't clear rx halt, status %d\n",
1104 clear_bit (EVENT_RX_HALT
, &dev
->flags
);
1105 tasklet_schedule (&dev
->bh
);
1109 /* tasklet could resubmit itself forever if memory is tight */
1110 if (test_bit (EVENT_RX_MEMORY
, &dev
->flags
)) {
1111 struct urb
*urb
= NULL
;
1114 if (netif_running (dev
->net
))
1115 urb
= usb_alloc_urb (0, GFP_KERNEL
);
1117 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
1119 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
1120 status
= usb_autopm_get_interface(dev
->intf
);
1125 if (rx_submit (dev
, urb
, GFP_KERNEL
) == -ENOLINK
)
1127 usb_autopm_put_interface(dev
->intf
);
1130 tasklet_schedule (&dev
->bh
);
1134 if (test_bit (EVENT_LINK_RESET
, &dev
->flags
)) {
1135 struct driver_info
*info
= dev
->driver_info
;
1138 clear_bit (EVENT_LINK_RESET
, &dev
->flags
);
1139 status
= usb_autopm_get_interface(dev
->intf
);
1142 if(info
->link_reset
&& (retval
= info
->link_reset(dev
)) < 0) {
1143 usb_autopm_put_interface(dev
->intf
);
1145 netdev_info(dev
->net
, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1147 dev
->udev
->bus
->bus_name
,
1151 usb_autopm_put_interface(dev
->intf
);
1154 /* handle link change from link resetting */
1155 __handle_link_change(dev
);
1158 if (test_bit (EVENT_LINK_CHANGE
, &dev
->flags
))
1159 __handle_link_change(dev
);
1162 netdev_dbg(dev
->net
, "kevent done, flags = 0x%lx\n", dev
->flags
);
1165 /*-------------------------------------------------------------------------*/
1167 static void tx_complete (struct urb
*urb
)
1169 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
1170 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
1171 struct usbnet
*dev
= entry
->dev
;
1173 if (urb
->status
== 0) {
1174 if (!(dev
->driver_info
->flags
& FLAG_MULTI_PACKET
))
1175 dev
->net
->stats
.tx_packets
++;
1176 dev
->net
->stats
.tx_bytes
+= entry
->length
;
1178 dev
->net
->stats
.tx_errors
++;
1180 switch (urb
->status
) {
1182 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
1185 /* software-driven interface shutdown */
1186 case -ECONNRESET
: // async unlink
1187 case -ESHUTDOWN
: // hardware gone
1190 // like rx, tx gets controller i/o faults during khubd delays
1191 // and so it uses the same throttling mechanism.
1195 usb_mark_last_busy(dev
->udev
);
1196 if (!timer_pending (&dev
->delay
)) {
1197 mod_timer (&dev
->delay
,
1198 jiffies
+ THROTTLE_JIFFIES
);
1199 netif_dbg(dev
, link
, dev
->net
,
1200 "tx throttle %d\n", urb
->status
);
1202 netif_stop_queue (dev
->net
);
1205 netif_dbg(dev
, tx_err
, dev
->net
,
1206 "tx err %d\n", entry
->urb
->status
);
1211 usb_autopm_put_interface_async(dev
->intf
);
1212 (void) defer_bh(dev
, skb
, &dev
->txq
, tx_done
);
1215 /*-------------------------------------------------------------------------*/
1217 void usbnet_tx_timeout (struct net_device
*net
)
1219 struct usbnet
*dev
= netdev_priv(net
);
1221 unlink_urbs (dev
, &dev
->txq
);
1222 tasklet_schedule (&dev
->bh
);
1224 // FIXME: device recovery -- reset?
1226 EXPORT_SYMBOL_GPL(usbnet_tx_timeout
);
1228 /*-------------------------------------------------------------------------*/
1230 static int build_dma_sg(const struct sk_buff
*skb
, struct urb
*urb
)
1232 unsigned num_sgs
, total_len
= 0;
1235 num_sgs
= skb_shinfo(skb
)->nr_frags
+ 1;
1239 /* reserve one for zero packet */
1240 urb
->sg
= kmalloc((num_sgs
+ 1) * sizeof(struct scatterlist
),
1245 urb
->num_sgs
= num_sgs
;
1246 sg_init_table(urb
->sg
, urb
->num_sgs
+ 1);
1248 sg_set_buf(&urb
->sg
[s
++], skb
->data
, skb_headlen(skb
));
1249 total_len
+= skb_headlen(skb
);
1251 for (i
= 0; i
< skb_shinfo(skb
)->nr_frags
; i
++) {
1252 struct skb_frag_struct
*f
= &skb_shinfo(skb
)->frags
[i
];
1254 total_len
+= skb_frag_size(f
);
1255 sg_set_page(&urb
->sg
[i
+ s
], f
->page
.p
, f
->size
,
1258 urb
->transfer_buffer_length
= total_len
;
1263 netdev_tx_t
usbnet_start_xmit (struct sk_buff
*skb
,
1264 struct net_device
*net
)
1266 struct usbnet
*dev
= netdev_priv(net
);
1268 struct urb
*urb
= NULL
;
1269 struct skb_data
*entry
;
1270 struct driver_info
*info
= dev
->driver_info
;
1271 unsigned long flags
;
1275 skb_tx_timestamp(skb
);
1277 // some devices want funky USB-level framing, for
1278 // win32 driver (usually) and/or hardware quirks
1279 if (info
->tx_fixup
) {
1280 skb
= info
->tx_fixup (dev
, skb
, GFP_ATOMIC
);
1282 /* packet collected; minidriver waiting for more */
1283 if (info
->flags
& FLAG_MULTI_PACKET
)
1285 netif_dbg(dev
, tx_err
, dev
->net
, "can't tx_fixup skb\n");
1290 if (!(urb
= usb_alloc_urb (0, GFP_ATOMIC
))) {
1291 netif_dbg(dev
, tx_err
, dev
->net
, "no urb\n");
1295 entry
= (struct skb_data
*) skb
->cb
;
1299 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->out
,
1300 skb
->data
, skb
->len
, tx_complete
, skb
);
1301 if (dev
->can_dma_sg
) {
1302 if (build_dma_sg(skb
, urb
) < 0)
1305 length
= urb
->transfer_buffer_length
;
1307 /* don't assume the hardware handles USB_ZERO_PACKET
1308 * NOTE: strictly conforming cdc-ether devices should expect
1309 * the ZLP here, but ignore the one-byte packet.
1310 * NOTE2: CDC NCM specification is different from CDC ECM when
1311 * handling ZLP/short packets, so cdc_ncm driver will make short
1312 * packet itself if needed.
1314 if (length
% dev
->maxpacket
== 0) {
1315 if (!(info
->flags
& FLAG_SEND_ZLP
)) {
1316 if (!(info
->flags
& FLAG_MULTI_PACKET
)) {
1318 if (skb_tailroom(skb
) && !urb
->num_sgs
) {
1319 skb
->data
[skb
->len
] = 0;
1321 } else if (urb
->num_sgs
)
1322 sg_set_buf(&urb
->sg
[urb
->num_sgs
++],
1323 dev
->padding_pkt
, 1);
1326 urb
->transfer_flags
|= URB_ZERO_PACKET
;
1328 entry
->length
= urb
->transfer_buffer_length
= length
;
1330 spin_lock_irqsave(&dev
->txq
.lock
, flags
);
1331 retval
= usb_autopm_get_interface_async(dev
->intf
);
1333 spin_unlock_irqrestore(&dev
->txq
.lock
, flags
);
1338 /* if this triggers the device is still a sleep */
1339 if (test_bit(EVENT_DEV_ASLEEP
, &dev
->flags
)) {
1340 /* transmission will be done in resume */
1341 usb_anchor_urb(urb
, &dev
->deferred
);
1342 /* no use to process more packets */
1343 netif_stop_queue(net
);
1345 spin_unlock_irqrestore(&dev
->txq
.lock
, flags
);
1346 netdev_dbg(dev
->net
, "Delaying transmission for resumption\n");
1351 switch ((retval
= usb_submit_urb (urb
, GFP_ATOMIC
))) {
1353 netif_stop_queue (net
);
1354 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
1355 usb_autopm_put_interface_async(dev
->intf
);
1358 usb_autopm_put_interface_async(dev
->intf
);
1359 netif_dbg(dev
, tx_err
, dev
->net
,
1360 "tx: submit urb err %d\n", retval
);
1363 net
->trans_start
= jiffies
;
1364 __usbnet_queue_skb(&dev
->txq
, skb
, tx_start
);
1365 if (dev
->txq
.qlen
>= TX_QLEN (dev
))
1366 netif_stop_queue (net
);
1368 spin_unlock_irqrestore (&dev
->txq
.lock
, flags
);
1371 netif_dbg(dev
, tx_err
, dev
->net
, "drop, code %d\n", retval
);
1373 dev
->net
->stats
.tx_dropped
++;
1376 dev_kfree_skb_any (skb
);
1382 netif_dbg(dev
, tx_queued
, dev
->net
,
1383 "> tx, len %d, type 0x%x\n", length
, skb
->protocol
);
1387 return NETDEV_TX_OK
;
1389 EXPORT_SYMBOL_GPL(usbnet_start_xmit
);
1391 static int rx_alloc_submit(struct usbnet
*dev
, gfp_t flags
)
1397 /* don't refill the queue all at once */
1398 for (i
= 0; i
< 10 && dev
->rxq
.qlen
< RX_QLEN(dev
); i
++) {
1399 urb
= usb_alloc_urb(0, flags
);
1401 ret
= rx_submit(dev
, urb
, flags
);
1413 /*-------------------------------------------------------------------------*/
1415 // tasklet (work deferred from completions, in_irq) or timer
1417 static void usbnet_bh (unsigned long param
)
1419 struct usbnet
*dev
= (struct usbnet
*) param
;
1420 struct sk_buff
*skb
;
1421 struct skb_data
*entry
;
1423 while ((skb
= skb_dequeue (&dev
->done
))) {
1424 entry
= (struct skb_data
*) skb
->cb
;
1425 switch (entry
->state
) {
1427 entry
->state
= rx_cleanup
;
1428 rx_process (dev
, skb
);
1431 kfree(entry
->urb
->sg
);
1433 usb_free_urb (entry
->urb
);
1434 dev_kfree_skb (skb
);
1437 netdev_dbg(dev
->net
, "bogus skb state %d\n", entry
->state
);
1441 /* restart RX again after disabling due to high error rate */
1442 clear_bit(EVENT_RX_KILL
, &dev
->flags
);
1444 /* waiting for all pending urbs to complete?
1445 * only then can we forgo submitting anew
1447 if (waitqueue_active(&dev
->wait
)) {
1448 if (dev
->txq
.qlen
+ dev
->rxq
.qlen
+ dev
->done
.qlen
== 0)
1449 wake_up_all(&dev
->wait
);
1451 // or are we maybe short a few urbs?
1452 } else if (netif_running (dev
->net
) &&
1453 netif_device_present (dev
->net
) &&
1454 netif_carrier_ok(dev
->net
) &&
1455 !timer_pending (&dev
->delay
) &&
1456 !test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
1457 int temp
= dev
->rxq
.qlen
;
1459 if (temp
< RX_QLEN(dev
)) {
1460 if (rx_alloc_submit(dev
, GFP_ATOMIC
) == -ENOLINK
)
1462 if (temp
!= dev
->rxq
.qlen
)
1463 netif_dbg(dev
, link
, dev
->net
,
1464 "rxqlen %d --> %d\n",
1465 temp
, dev
->rxq
.qlen
);
1466 if (dev
->rxq
.qlen
< RX_QLEN(dev
))
1467 tasklet_schedule (&dev
->bh
);
1469 if (dev
->txq
.qlen
< TX_QLEN (dev
))
1470 netif_wake_queue (dev
->net
);
1475 /*-------------------------------------------------------------------------
1477 * USB Device Driver support
1479 *-------------------------------------------------------------------------*/
1481 // precondition: never called in_interrupt
1483 void usbnet_disconnect (struct usb_interface
*intf
)
1486 struct usb_device
*xdev
;
1487 struct net_device
*net
;
1489 dev
= usb_get_intfdata(intf
);
1490 usb_set_intfdata(intf
, NULL
);
1494 xdev
= interface_to_usbdev (intf
);
1496 netif_info(dev
, probe
, dev
->net
, "unregister '%s' usb-%s-%s, %s\n",
1497 intf
->dev
.driver
->name
,
1498 xdev
->bus
->bus_name
, xdev
->devpath
,
1499 dev
->driver_info
->description
);
1502 unregister_netdev (net
);
1504 cancel_work_sync(&dev
->kevent
);
1506 usb_scuttle_anchored_urbs(&dev
->deferred
);
1508 if (dev
->driver_info
->unbind
)
1509 dev
->driver_info
->unbind (dev
, intf
);
1511 usb_kill_urb(dev
->interrupt
);
1512 usb_free_urb(dev
->interrupt
);
1513 kfree(dev
->padding_pkt
);
1517 EXPORT_SYMBOL_GPL(usbnet_disconnect
);
1519 static const struct net_device_ops usbnet_netdev_ops
= {
1520 .ndo_open
= usbnet_open
,
1521 .ndo_stop
= usbnet_stop
,
1522 .ndo_start_xmit
= usbnet_start_xmit
,
1523 .ndo_tx_timeout
= usbnet_tx_timeout
,
1524 .ndo_change_mtu
= usbnet_change_mtu
,
1525 .ndo_set_mac_address
= eth_mac_addr
,
1526 .ndo_validate_addr
= eth_validate_addr
,
1529 /*-------------------------------------------------------------------------*/
1531 // precondition: never called in_interrupt
1533 static struct device_type wlan_type
= {
1537 static struct device_type wwan_type
= {
1542 usbnet_probe (struct usb_interface
*udev
, const struct usb_device_id
*prod
)
1545 struct net_device
*net
;
1546 struct usb_host_interface
*interface
;
1547 struct driver_info
*info
;
1548 struct usb_device
*xdev
;
1551 struct usb_driver
*driver
= to_usb_driver(udev
->dev
.driver
);
1553 /* usbnet already took usb runtime pm, so have to enable the feature
1554 * for usb interface, otherwise usb_autopm_get_interface may return
1555 * failure if RUNTIME_PM is enabled.
1557 if (!driver
->supports_autosuspend
) {
1558 driver
->supports_autosuspend
= 1;
1559 pm_runtime_enable(&udev
->dev
);
1562 name
= udev
->dev
.driver
->name
;
1563 info
= (struct driver_info
*) prod
->driver_info
;
1565 dev_dbg (&udev
->dev
, "blacklisted by %s\n", name
);
1568 xdev
= interface_to_usbdev (udev
);
1569 interface
= udev
->cur_altsetting
;
1573 // set up our own records
1574 net
= alloc_etherdev(sizeof(*dev
));
1578 /* netdev_printk() needs this so do it as early as possible */
1579 SET_NETDEV_DEV(net
, &udev
->dev
);
1581 dev
= netdev_priv(net
);
1584 dev
->driver_info
= info
;
1585 dev
->driver_name
= name
;
1586 dev
->msg_enable
= netif_msg_init (msg_level
, NETIF_MSG_DRV
1587 | NETIF_MSG_PROBE
| NETIF_MSG_LINK
);
1588 init_waitqueue_head(&dev
->wait
);
1589 skb_queue_head_init (&dev
->rxq
);
1590 skb_queue_head_init (&dev
->txq
);
1591 skb_queue_head_init (&dev
->done
);
1592 skb_queue_head_init(&dev
->rxq_pause
);
1593 dev
->bh
.func
= usbnet_bh
;
1594 dev
->bh
.data
= (unsigned long) dev
;
1595 INIT_WORK (&dev
->kevent
, kevent
);
1596 init_usb_anchor(&dev
->deferred
);
1597 dev
->delay
.function
= usbnet_bh
;
1598 dev
->delay
.data
= (unsigned long) dev
;
1599 init_timer (&dev
->delay
);
1600 mutex_init (&dev
->phy_mutex
);
1601 mutex_init(&dev
->interrupt_mutex
);
1602 dev
->interrupt_count
= 0;
1605 strcpy (net
->name
, "usb%d");
1606 memcpy (net
->dev_addr
, node_id
, sizeof node_id
);
1608 /* rx and tx sides can use different message sizes;
1609 * bind() should set rx_urb_size in that case.
1611 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
1613 // dma_supported() is deeply broken on almost all architectures
1614 // possible with some EHCI controllers
1615 if (dma_supported (&udev
->dev
, DMA_BIT_MASK(64)))
1616 net
->features
|= NETIF_F_HIGHDMA
;
1619 net
->netdev_ops
= &usbnet_netdev_ops
;
1620 net
->watchdog_timeo
= TX_TIMEOUT_JIFFIES
;
1621 net
->ethtool_ops
= &usbnet_ethtool_ops
;
1623 // allow device-specific bind/init procedures
1624 // NOTE net->name still not usable ...
1626 status
= info
->bind (dev
, udev
);
1630 // heuristic: "usb%d" for links we know are two-host,
1631 // else "eth%d" when there's reasonable doubt. userspace
1632 // can rename the link if it knows better.
1633 if ((dev
->driver_info
->flags
& FLAG_ETHER
) != 0 &&
1634 ((dev
->driver_info
->flags
& FLAG_POINTTOPOINT
) == 0 ||
1635 (net
->dev_addr
[0] & 0x02) == 0))
1636 strcpy (net
->name
, "eth%d");
1637 /* WLAN devices should always be named "wlan%d" */
1638 if ((dev
->driver_info
->flags
& FLAG_WLAN
) != 0)
1639 strcpy(net
->name
, "wlan%d");
1640 /* WWAN devices should always be named "wwan%d" */
1641 if ((dev
->driver_info
->flags
& FLAG_WWAN
) != 0)
1642 strcpy(net
->name
, "wwan%d");
1644 /* devices that cannot do ARP */
1645 if ((dev
->driver_info
->flags
& FLAG_NOARP
) != 0)
1646 net
->flags
|= IFF_NOARP
;
1648 /* maybe the remote can't receive an Ethernet MTU */
1649 if (net
->mtu
> (dev
->hard_mtu
- net
->hard_header_len
))
1650 net
->mtu
= dev
->hard_mtu
- net
->hard_header_len
;
1651 } else if (!info
->in
|| !info
->out
)
1652 status
= usbnet_get_endpoints (dev
, udev
);
1654 dev
->in
= usb_rcvbulkpipe (xdev
, info
->in
);
1655 dev
->out
= usb_sndbulkpipe (xdev
, info
->out
);
1656 if (!(info
->flags
& FLAG_NO_SETINT
))
1657 status
= usb_set_interface (xdev
,
1658 interface
->desc
.bInterfaceNumber
,
1659 interface
->desc
.bAlternateSetting
);
1664 if (status
>= 0 && dev
->status
)
1665 status
= init_status (dev
, udev
);
1669 if (!dev
->rx_urb_size
)
1670 dev
->rx_urb_size
= dev
->hard_mtu
;
1671 dev
->maxpacket
= usb_maxpacket (dev
->udev
, dev
->out
, 1);
1673 /* let userspace know we have a random address */
1674 if (ether_addr_equal(net
->dev_addr
, node_id
))
1675 net
->addr_assign_type
= NET_ADDR_RANDOM
;
1677 if ((dev
->driver_info
->flags
& FLAG_WLAN
) != 0)
1678 SET_NETDEV_DEVTYPE(net
, &wlan_type
);
1679 if ((dev
->driver_info
->flags
& FLAG_WWAN
) != 0)
1680 SET_NETDEV_DEVTYPE(net
, &wwan_type
);
1682 /* initialize max rx_qlen and tx_qlen */
1683 usbnet_update_max_qlen(dev
);
1685 if (dev
->can_dma_sg
&& !(info
->flags
& FLAG_SEND_ZLP
) &&
1686 !(info
->flags
& FLAG_MULTI_PACKET
)) {
1687 dev
->padding_pkt
= kzalloc(1, GFP_KERNEL
);
1688 if (!dev
->padding_pkt
) {
1694 status
= register_netdev (net
);
1697 netif_info(dev
, probe
, dev
->net
,
1698 "register '%s' at usb-%s-%s, %s, %pM\n",
1699 udev
->dev
.driver
->name
,
1700 xdev
->bus
->bus_name
, xdev
->devpath
,
1701 dev
->driver_info
->description
,
1704 // ok, it's ready to go.
1705 usb_set_intfdata (udev
, dev
);
1707 netif_device_attach (net
);
1709 if (dev
->driver_info
->flags
& FLAG_LINK_INTR
)
1710 usbnet_link_change(dev
, 0, 0);
1715 kfree(dev
->padding_pkt
);
1717 usb_free_urb(dev
->interrupt
);
1720 info
->unbind (dev
, udev
);
1722 /* subdrivers must undo all they did in bind() if they
1723 * fail it, but we may fail later and a deferred kevent
1724 * may trigger an error resubmitting itself and, worse,
1725 * schedule a timer. So we kill it all just in case.
1727 cancel_work_sync(&dev
->kevent
);
1728 del_timer_sync(&dev
->delay
);
1733 EXPORT_SYMBOL_GPL(usbnet_probe
);
1735 /*-------------------------------------------------------------------------*/
1738 * suspend the whole driver as soon as the first interface is suspended
1739 * resume only when the last interface is resumed
1742 int usbnet_suspend (struct usb_interface
*intf
, pm_message_t message
)
1744 struct usbnet
*dev
= usb_get_intfdata(intf
);
1746 if (!dev
->suspend_count
++) {
1747 spin_lock_irq(&dev
->txq
.lock
);
1748 /* don't autosuspend while transmitting */
1749 if (dev
->txq
.qlen
&& PMSG_IS_AUTO(message
)) {
1750 dev
->suspend_count
--;
1751 spin_unlock_irq(&dev
->txq
.lock
);
1754 set_bit(EVENT_DEV_ASLEEP
, &dev
->flags
);
1755 spin_unlock_irq(&dev
->txq
.lock
);
1758 * accelerate emptying of the rx and queues, to avoid
1759 * having everything error out.
1761 netif_device_detach (dev
->net
);
1762 usbnet_terminate_urbs(dev
);
1763 __usbnet_status_stop_force(dev
);
1766 * reattach so runtime management can use and
1769 netif_device_attach (dev
->net
);
1773 EXPORT_SYMBOL_GPL(usbnet_suspend
);
1775 int usbnet_resume (struct usb_interface
*intf
)
1777 struct usbnet
*dev
= usb_get_intfdata(intf
);
1778 struct sk_buff
*skb
;
1782 if (!--dev
->suspend_count
) {
1783 /* resume interrupt URB if it was previously submitted */
1784 __usbnet_status_start_force(dev
, GFP_NOIO
);
1786 spin_lock_irq(&dev
->txq
.lock
);
1787 while ((res
= usb_get_from_anchor(&dev
->deferred
))) {
1789 skb
= (struct sk_buff
*)res
->context
;
1790 retval
= usb_submit_urb(res
, GFP_ATOMIC
);
1792 dev_kfree_skb_any(skb
);
1795 usb_autopm_put_interface_async(dev
->intf
);
1797 dev
->net
->trans_start
= jiffies
;
1798 __skb_queue_tail(&dev
->txq
, skb
);
1803 clear_bit(EVENT_DEV_ASLEEP
, &dev
->flags
);
1804 spin_unlock_irq(&dev
->txq
.lock
);
1806 if (test_bit(EVENT_DEV_OPEN
, &dev
->flags
)) {
1807 /* handle remote wakeup ASAP
1808 * we cannot race against stop
1810 if (netif_device_present(dev
->net
) &&
1811 !timer_pending(&dev
->delay
) &&
1812 !test_bit(EVENT_RX_HALT
, &dev
->flags
))
1813 rx_alloc_submit(dev
, GFP_NOIO
);
1815 if (!(dev
->txq
.qlen
>= TX_QLEN(dev
)))
1816 netif_tx_wake_all_queues(dev
->net
);
1817 tasklet_schedule (&dev
->bh
);
1821 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE
, &dev
->flags
))
1822 usb_autopm_get_interface_no_resume(intf
);
1826 EXPORT_SYMBOL_GPL(usbnet_resume
);
1829 * Either a subdriver implements manage_power, then it is assumed to always
1830 * be ready to be suspended or it reports the readiness to be suspended
1833 void usbnet_device_suggests_idle(struct usbnet
*dev
)
1835 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE
, &dev
->flags
)) {
1836 dev
->intf
->needs_remote_wakeup
= 1;
1837 usb_autopm_put_interface_async(dev
->intf
);
1840 EXPORT_SYMBOL(usbnet_device_suggests_idle
);
1843 * For devices that can do without special commands
1845 int usbnet_manage_power(struct usbnet
*dev
, int on
)
1847 dev
->intf
->needs_remote_wakeup
= on
;
1850 EXPORT_SYMBOL(usbnet_manage_power
);
1852 void usbnet_link_change(struct usbnet
*dev
, bool link
, bool need_reset
)
1854 /* update link after link is reseted */
1855 if (link
&& !need_reset
)
1856 netif_carrier_on(dev
->net
);
1858 netif_carrier_off(dev
->net
);
1860 if (need_reset
&& link
)
1861 usbnet_defer_kevent(dev
, EVENT_LINK_RESET
);
1863 usbnet_defer_kevent(dev
, EVENT_LINK_CHANGE
);
1865 EXPORT_SYMBOL(usbnet_link_change
);
1867 /*-------------------------------------------------------------------------*/
1868 static int __usbnet_read_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1869 u16 value
, u16 index
, void *data
, u16 size
)
1874 netdev_dbg(dev
->net
, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1875 " value=0x%04x index=0x%04x size=%d\n",
1876 cmd
, reqtype
, value
, index
, size
);
1879 buf
= kmalloc(size
, GFP_KERNEL
);
1884 err
= usb_control_msg(dev
->udev
, usb_rcvctrlpipe(dev
->udev
, 0),
1885 cmd
, reqtype
, value
, index
, buf
, size
,
1886 USB_CTRL_GET_TIMEOUT
);
1887 if (err
> 0 && err
<= size
)
1888 memcpy(data
, buf
, err
);
1894 static int __usbnet_write_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1895 u16 value
, u16 index
, const void *data
,
1901 netdev_dbg(dev
->net
, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1902 " value=0x%04x index=0x%04x size=%d\n",
1903 cmd
, reqtype
, value
, index
, size
);
1906 buf
= kmemdup(data
, size
, GFP_KERNEL
);
1911 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, 0),
1912 cmd
, reqtype
, value
, index
, buf
, size
,
1913 USB_CTRL_SET_TIMEOUT
);
1921 * The function can't be called inside suspend/resume callback,
1922 * otherwise deadlock will be caused.
1924 int usbnet_read_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1925 u16 value
, u16 index
, void *data
, u16 size
)
1929 if (usb_autopm_get_interface(dev
->intf
) < 0)
1931 ret
= __usbnet_read_cmd(dev
, cmd
, reqtype
, value
, index
,
1933 usb_autopm_put_interface(dev
->intf
);
1936 EXPORT_SYMBOL_GPL(usbnet_read_cmd
);
1939 * The function can't be called inside suspend/resume callback,
1940 * otherwise deadlock will be caused.
1942 int usbnet_write_cmd(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1943 u16 value
, u16 index
, const void *data
, u16 size
)
1947 if (usb_autopm_get_interface(dev
->intf
) < 0)
1949 ret
= __usbnet_write_cmd(dev
, cmd
, reqtype
, value
, index
,
1951 usb_autopm_put_interface(dev
->intf
);
1954 EXPORT_SYMBOL_GPL(usbnet_write_cmd
);
1957 * The function can be called inside suspend/resume callback safely
1958 * and should only be called by suspend/resume callback generally.
1960 int usbnet_read_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1961 u16 value
, u16 index
, void *data
, u16 size
)
1963 return __usbnet_read_cmd(dev
, cmd
, reqtype
, value
, index
,
1966 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm
);
1969 * The function can be called inside suspend/resume callback safely
1970 * and should only be called by suspend/resume callback generally.
1972 int usbnet_write_cmd_nopm(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1973 u16 value
, u16 index
, const void *data
,
1976 return __usbnet_write_cmd(dev
, cmd
, reqtype
, value
, index
,
1979 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm
);
1981 static void usbnet_async_cmd_cb(struct urb
*urb
)
1983 struct usb_ctrlrequest
*req
= (struct usb_ctrlrequest
*)urb
->context
;
1984 int status
= urb
->status
;
1987 dev_dbg(&urb
->dev
->dev
, "%s failed with %d",
1995 * The caller must make sure that device can't be put into suspend
1996 * state until the control URB completes.
1998 int usbnet_write_cmd_async(struct usbnet
*dev
, u8 cmd
, u8 reqtype
,
1999 u16 value
, u16 index
, const void *data
, u16 size
)
2001 struct usb_ctrlrequest
*req
= NULL
;
2006 netdev_dbg(dev
->net
, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
2007 " value=0x%04x index=0x%04x size=%d\n",
2008 cmd
, reqtype
, value
, index
, size
);
2010 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
2012 netdev_err(dev
->net
, "Error allocating URB in"
2013 " %s!\n", __func__
);
2018 buf
= kmemdup(data
, size
, GFP_ATOMIC
);
2020 netdev_err(dev
->net
, "Error allocating buffer"
2021 " in %s!\n", __func__
);
2026 req
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_ATOMIC
);
2030 req
->bRequestType
= reqtype
;
2031 req
->bRequest
= cmd
;
2032 req
->wValue
= cpu_to_le16(value
);
2033 req
->wIndex
= cpu_to_le16(index
);
2034 req
->wLength
= cpu_to_le16(size
);
2036 usb_fill_control_urb(urb
, dev
->udev
,
2037 usb_sndctrlpipe(dev
->udev
, 0),
2038 (void *)req
, buf
, size
,
2039 usbnet_async_cmd_cb
, req
);
2040 urb
->transfer_flags
|= URB_FREE_BUFFER
;
2042 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
2044 netdev_err(dev
->net
, "Error submitting the control"
2045 " message: status=%d\n", err
);
2059 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async
);
2060 /*-------------------------------------------------------------------------*/
2062 static int __init
usbnet_init(void)
2064 /* Compiler should optimize this out. */
2066 FIELD_SIZEOF(struct sk_buff
, cb
) < sizeof(struct skb_data
));
2068 eth_random_addr(node_id
);
2071 module_init(usbnet_init
);
2073 static void __exit
usbnet_exit(void)
2076 module_exit(usbnet_exit
);
2078 MODULE_AUTHOR("David Brownell");
2079 MODULE_DESCRIPTION("USB network driver framework");
2080 MODULE_LICENSE("GPL");