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>
48 #define DRIVER_VERSION "22-Aug-2005"
51 /*-------------------------------------------------------------------------*/
54 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
55 * Several dozen bytes of IPv4 data can fit in two such transactions.
56 * One maximum size Ethernet packet takes twenty four of them.
57 * For high speed, each frame comfortably fits almost 36 max size
58 * Ethernet packets (so queues should be bigger).
60 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
61 * let the USB host controller be busy for 5msec or more before an irq
62 * is required, under load. Jumbograms change the equation.
64 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
65 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
66 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
67 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
68 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
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 altsetttings.
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 static u8
nibble(unsigned char c
)
163 if (likely(isdigit(c
)))
166 if (likely(isxdigit(c
)))
171 int usbnet_get_ethernet_addr(struct usbnet
*dev
, int iMACAddress
)
174 unsigned char buf
[13];
176 tmp
= usb_string(dev
->udev
, iMACAddress
, buf
, sizeof buf
);
178 dev_dbg(&dev
->udev
->dev
,
179 "bad MAC string %d fetch, %d\n", iMACAddress
, tmp
);
184 for (i
= tmp
= 0; i
< 6; i
++, tmp
+= 2)
185 dev
->net
->dev_addr
[i
] =
186 (nibble(buf
[tmp
]) << 4) + nibble(buf
[tmp
+ 1]);
189 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr
);
191 static void intr_complete (struct urb
*urb
);
193 static int init_status (struct usbnet
*dev
, struct usb_interface
*intf
)
200 if (!dev
->driver_info
->status
)
203 pipe
= usb_rcvintpipe (dev
->udev
,
204 dev
->status
->desc
.bEndpointAddress
205 & USB_ENDPOINT_NUMBER_MASK
);
206 maxp
= usb_maxpacket (dev
->udev
, pipe
, 0);
208 /* avoid 1 msec chatter: min 8 msec poll rate */
209 period
= max ((int) dev
->status
->desc
.bInterval
,
210 (dev
->udev
->speed
== USB_SPEED_HIGH
) ? 7 : 3);
212 buf
= kmalloc (maxp
, GFP_KERNEL
);
214 dev
->interrupt
= usb_alloc_urb (0, GFP_KERNEL
);
215 if (!dev
->interrupt
) {
219 usb_fill_int_urb(dev
->interrupt
, dev
->udev
, pipe
,
220 buf
, maxp
, intr_complete
, dev
, period
);
221 dev
->interrupt
->transfer_flags
|= URB_FREE_BUFFER
;
223 "status ep%din, %d bytes period %d\n",
224 usb_pipeendpoint(pipe
), maxp
, period
);
230 /* Passes this packet up the stack, updating its accounting.
231 * Some link protocols batch packets, so their rx_fixup paths
232 * can return clones as well as just modify the original skb.
234 void usbnet_skb_return (struct usbnet
*dev
, struct sk_buff
*skb
)
238 skb
->protocol
= eth_type_trans (skb
, dev
->net
);
239 dev
->stats
.rx_packets
++;
240 dev
->stats
.rx_bytes
+= skb
->len
;
242 if (netif_msg_rx_status (dev
))
243 devdbg (dev
, "< rx, len %zu, type 0x%x",
244 skb
->len
+ sizeof (struct ethhdr
), skb
->protocol
);
245 memset (skb
->cb
, 0, sizeof (struct skb_data
));
246 status
= netif_rx (skb
);
247 if (status
!= NET_RX_SUCCESS
&& netif_msg_rx_err (dev
))
248 devdbg (dev
, "netif_rx status %d", status
);
250 EXPORT_SYMBOL_GPL(usbnet_skb_return
);
253 /*-------------------------------------------------------------------------
255 * Network Device Driver (peer link to "Host Device", from USB host)
257 *-------------------------------------------------------------------------*/
259 int usbnet_change_mtu (struct net_device
*net
, int new_mtu
)
261 struct usbnet
*dev
= netdev_priv(net
);
262 int ll_mtu
= new_mtu
+ net
->hard_header_len
;
263 int old_hard_mtu
= dev
->hard_mtu
;
264 int old_rx_urb_size
= dev
->rx_urb_size
;
268 // no second zero-length packet read wanted after mtu-sized packets
269 if ((ll_mtu
% dev
->maxpacket
) == 0)
273 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
274 if (dev
->rx_urb_size
== old_hard_mtu
) {
275 dev
->rx_urb_size
= dev
->hard_mtu
;
276 if (dev
->rx_urb_size
> old_rx_urb_size
)
277 usbnet_unlink_rx_urbs(dev
);
282 EXPORT_SYMBOL_GPL(usbnet_change_mtu
);
284 /*-------------------------------------------------------------------------*/
286 static struct net_device_stats
*usbnet_get_stats (struct net_device
*net
)
288 struct usbnet
*dev
= netdev_priv(net
);
292 /* The caller must hold list->lock */
293 static void __usbnet_queue_skb(struct sk_buff_head
*list
,
294 struct sk_buff
*newsk
, enum skb_state state
)
296 struct skb_data
*entry
= (struct skb_data
*) newsk
->cb
;
298 __skb_queue_tail(list
, newsk
);
299 entry
->state
= state
;
302 /*-------------------------------------------------------------------------*/
304 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
305 * completion callbacks. 2.5 should have fixed those bugs...
308 static enum skb_state
defer_bh(struct usbnet
*dev
, struct sk_buff
*skb
,
309 struct sk_buff_head
*list
, enum skb_state state
)
312 enum skb_state old_state
;
313 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
315 spin_lock_irqsave(&list
->lock
, flags
);
316 old_state
= entry
->state
;
317 entry
->state
= state
;
318 __skb_unlink(skb
, list
);
319 spin_unlock(&list
->lock
);
320 spin_lock(&dev
->done
.lock
);
321 __skb_queue_tail(&dev
->done
, skb
);
322 if (dev
->done
.qlen
== 1)
323 tasklet_schedule(&dev
->bh
);
324 spin_unlock_irqrestore(&dev
->done
.lock
, flags
);
328 /* some work can't be done in tasklets, so we use keventd
330 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
331 * but tasklet_schedule() doesn't. hope the failure is rare.
333 void usbnet_defer_kevent (struct usbnet
*dev
, int work
)
335 set_bit (work
, &dev
->flags
);
336 if (!schedule_work (&dev
->kevent
)) {
338 deverr (dev
, "kevent %d may have been dropped", work
);
340 devdbg (dev
, "kevent %d scheduled", work
);
343 EXPORT_SYMBOL_GPL(usbnet_defer_kevent
);
345 /*-------------------------------------------------------------------------*/
347 static void rx_complete (struct urb
*urb
);
349 static int rx_submit (struct usbnet
*dev
, struct urb
*urb
, gfp_t flags
)
352 struct skb_data
*entry
;
354 unsigned long lockflags
;
355 size_t size
= dev
->rx_urb_size
;
357 if ((skb
= alloc_skb (size
+ NET_IP_ALIGN
, flags
)) == NULL
) {
358 if (netif_msg_rx_err (dev
))
359 devdbg (dev
, "no rx skb");
360 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
364 skb_reserve (skb
, NET_IP_ALIGN
);
366 entry
= (struct skb_data
*) skb
->cb
;
371 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->in
,
372 skb
->data
, size
, rx_complete
, skb
);
374 spin_lock_irqsave (&dev
->rxq
.lock
, lockflags
);
376 if (netif_running (dev
->net
)
377 && netif_device_present (dev
->net
)
378 && !test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
379 switch (retval
= usb_submit_urb (urb
, GFP_ATOMIC
)){
381 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
384 usbnet_defer_kevent (dev
, EVENT_RX_MEMORY
);
387 if (netif_msg_ifdown (dev
))
388 devdbg (dev
, "device gone");
389 netif_device_detach (dev
->net
);
395 if (netif_msg_rx_err (dev
))
396 devdbg (dev
, "rx submit, %d", retval
);
397 tasklet_schedule (&dev
->bh
);
400 __usbnet_queue_skb(&dev
->rxq
, skb
, rx_start
);
403 if (netif_msg_ifdown (dev
))
404 devdbg (dev
, "rx: stopped");
407 spin_unlock_irqrestore (&dev
->rxq
.lock
, lockflags
);
409 dev_kfree_skb_any (skb
);
416 /*-------------------------------------------------------------------------*/
418 static inline void rx_process (struct usbnet
*dev
, struct sk_buff
*skb
)
420 if (dev
->driver_info
->rx_fixup
421 && !dev
->driver_info
->rx_fixup (dev
, skb
))
423 // else network stack removes extra byte if we forced a short packet
426 /* all data was already cloned from skb inside the driver */
427 if (dev
->driver_info
->flags
& FLAG_MULTI_PACKET
)
428 dev_kfree_skb_any(skb
);
430 usbnet_skb_return(dev
, skb
);
434 if (netif_msg_rx_err (dev
))
435 devdbg (dev
, "drop");
437 dev
->stats
.rx_errors
++;
438 skb_queue_tail(&dev
->done
, skb
);
441 /*-------------------------------------------------------------------------*/
443 static void rx_complete (struct urb
*urb
)
445 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
446 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
447 struct usbnet
*dev
= entry
->dev
;
448 int urb_status
= urb
->status
;
449 enum skb_state state
;
451 skb_put (skb
, urb
->actual_length
);
455 switch (urb_status
) {
458 if (skb
->len
< dev
->net
->hard_header_len
) {
460 dev
->stats
.rx_errors
++;
461 dev
->stats
.rx_length_errors
++;
462 if (netif_msg_rx_err (dev
))
463 devdbg (dev
, "rx length %d", skb
->len
);
467 // stalls need manual reset. this is rare ... except that
468 // when going through USB 2.0 TTs, unplug appears this way.
469 // we avoid the highspeed version of the ETIMEOUT/EILSEQ
470 // storm, recovering as needed.
472 dev
->stats
.rx_errors
++;
473 usbnet_defer_kevent (dev
, EVENT_RX_HALT
);
476 // software-driven interface shutdown
477 case -ECONNRESET
: // async unlink
478 case -ESHUTDOWN
: // hardware gone
479 if (netif_msg_ifdown (dev
))
480 devdbg (dev
, "rx shutdown, code %d", urb_status
);
483 // we get controller i/o faults during khubd disconnect() delays.
484 // throttle down resubmits, to avoid log floods; just temporarily,
485 // so we still recover when the fault isn't a khubd delay.
489 dev
->stats
.rx_errors
++;
490 if (!timer_pending (&dev
->delay
)) {
491 mod_timer (&dev
->delay
, jiffies
+ THROTTLE_JIFFIES
);
492 if (netif_msg_link (dev
))
493 devdbg (dev
, "rx throttle %d", urb_status
);
501 // data overrun ... flush fifo?
503 dev
->stats
.rx_over_errors
++;
508 dev
->stats
.rx_errors
++;
509 if (netif_msg_rx_err (dev
))
510 devdbg (dev
, "rx status %d", urb_status
);
514 state
= defer_bh(dev
, skb
, &dev
->rxq
, state
);
517 if (netif_running (dev
->net
)
518 && !test_bit (EVENT_RX_HALT
, &dev
->flags
) &&
519 state
!= unlink_start
) {
520 rx_submit (dev
, urb
, GFP_ATOMIC
);
521 usb_mark_last_busy(dev
->udev
);
526 if (netif_msg_rx_err (dev
))
527 devdbg (dev
, "no read resubmitted");
530 static void intr_complete (struct urb
*urb
)
532 struct usbnet
*dev
= urb
->context
;
533 int status
= urb
->status
;
538 dev
->driver_info
->status(dev
, urb
);
541 /* software-driven interface shutdown */
542 case -ENOENT
: // urb killed
543 case -ESHUTDOWN
: // hardware gone
544 if (netif_msg_ifdown (dev
))
545 devdbg (dev
, "intr shutdown, code %d", status
);
548 /* NOTE: not throttling like RX/TX, since this endpoint
549 * already polls infrequently
552 devdbg (dev
, "intr status %d", status
);
556 if (!netif_running (dev
->net
))
559 status
= usb_submit_urb (urb
, GFP_ATOMIC
);
560 if (status
!= 0 && netif_msg_timer (dev
))
561 deverr(dev
, "intr resubmit --> %d", status
);
564 /*-------------------------------------------------------------------------*/
566 // unlink pending rx/tx; completion handlers do all other cleanup
568 static int unlink_urbs (struct usbnet
*dev
, struct sk_buff_head
*q
)
574 spin_lock_irqsave (&q
->lock
, flags
);
575 while (!skb_queue_empty(q
)) {
576 struct skb_data
*entry
;
580 skb_queue_walk(q
, skb
) {
581 entry
= (struct skb_data
*) skb
->cb
;
582 if (entry
->state
!= unlink_start
)
587 entry
->state
= unlink_start
;
591 * Get reference count of the URB to avoid it to be
592 * freed during usb_unlink_urb, which may trigger
593 * use-after-free problem inside usb_unlink_urb since
594 * usb_unlink_urb is always racing with .complete
595 * handler(include defer_bh).
598 spin_unlock_irqrestore(&q
->lock
, flags
);
599 // during some PM-driven resume scenarios,
600 // these (async) unlinks complete immediately
601 retval
= usb_unlink_urb (urb
);
602 if (retval
!= -EINPROGRESS
&& retval
!= 0)
603 devdbg (dev
, "unlink urb err, %d", retval
);
607 spin_lock_irqsave(&q
->lock
, flags
);
609 spin_unlock_irqrestore (&q
->lock
, flags
);
613 // Flush all pending rx urbs
614 // minidrivers may need to do this when the MTU changes
616 void usbnet_unlink_rx_urbs(struct usbnet
*dev
)
618 if (netif_running(dev
->net
)) {
619 (void) unlink_urbs (dev
, &dev
->rxq
);
620 tasklet_schedule(&dev
->bh
);
623 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs
);
625 /*-------------------------------------------------------------------------*/
627 // precondition: never called in_interrupt
629 int usbnet_stop (struct net_device
*net
)
631 struct usbnet
*dev
= netdev_priv(net
);
633 DECLARE_WAIT_QUEUE_HEAD_ONSTACK (unlink_wakeup
);
634 DECLARE_WAITQUEUE (wait
, current
);
636 netif_stop_queue (net
);
638 if (netif_msg_ifdown (dev
))
639 devinfo (dev
, "stop stats: rx/tx %ld/%ld, errs %ld/%ld",
640 dev
->stats
.rx_packets
, dev
->stats
.tx_packets
,
641 dev
->stats
.rx_errors
, dev
->stats
.tx_errors
644 // ensure there are no more active urbs
645 add_wait_queue (&unlink_wakeup
, &wait
);
646 dev
->wait
= &unlink_wakeup
;
647 temp
= unlink_urbs (dev
, &dev
->txq
) + unlink_urbs (dev
, &dev
->rxq
);
649 // maybe wait for deletions to finish.
650 while (!skb_queue_empty(&dev
->rxq
) &&
651 !skb_queue_empty(&dev
->txq
) &&
652 !skb_queue_empty(&dev
->done
)) {
653 msleep(UNLINK_TIMEOUT_MS
);
654 if (netif_msg_ifdown (dev
))
655 devdbg (dev
, "waited for %d urb completions", temp
);
658 remove_wait_queue (&unlink_wakeup
, &wait
);
660 usb_kill_urb(dev
->interrupt
);
662 /* deferred work (task, timer, softirq) must also stop.
663 * can't flush_scheduled_work() until we drop rtnl (later),
664 * else workers could deadlock; so make workers a NOP.
667 del_timer_sync (&dev
->delay
);
668 tasklet_kill (&dev
->bh
);
669 usb_autopm_put_interface(dev
->intf
);
673 EXPORT_SYMBOL_GPL(usbnet_stop
);
675 /*-------------------------------------------------------------------------*/
677 // posts reads, and enables write queuing
679 // precondition: never called in_interrupt
681 int usbnet_open (struct net_device
*net
)
683 struct usbnet
*dev
= netdev_priv(net
);
685 struct driver_info
*info
= dev
->driver_info
;
687 if ((retval
= usb_autopm_get_interface(dev
->intf
)) < 0) {
688 if (netif_msg_ifup (dev
))
690 "resumption fail (%d) usbnet usb-%s-%s, %s",
692 dev
->udev
->bus
->bus_name
, dev
->udev
->devpath
,
697 // put into "known safe" state
698 if (info
->reset
&& (retval
= info
->reset (dev
)) < 0) {
699 if (netif_msg_ifup (dev
))
701 "open reset fail (%d) usbnet usb-%s-%s, %s",
703 dev
->udev
->bus
->bus_name
, dev
->udev
->devpath
,
708 // insist peer be connected
709 if (info
->check_connect
&& (retval
= info
->check_connect (dev
)) < 0) {
710 if (netif_msg_ifup (dev
))
711 devdbg (dev
, "can't open; %d", retval
);
715 /* start any status interrupt transfer */
716 if (dev
->interrupt
) {
717 retval
= usb_submit_urb (dev
->interrupt
, GFP_KERNEL
);
719 if (netif_msg_ifup (dev
))
720 deverr (dev
, "intr submit %d", retval
);
725 netif_start_queue (net
);
726 if (netif_msg_ifup (dev
)) {
729 if (dev
->driver_info
->flags
& FLAG_FRAMING_NC
)
731 else if (dev
->driver_info
->flags
& FLAG_FRAMING_GL
)
733 else if (dev
->driver_info
->flags
& FLAG_FRAMING_Z
)
735 else if (dev
->driver_info
->flags
& FLAG_FRAMING_RN
)
737 else if (dev
->driver_info
->flags
& FLAG_FRAMING_AX
)
742 devinfo (dev
, "open: enable queueing "
743 "(rx %d, tx %d) mtu %d %s framing",
744 (int)RX_QLEN (dev
), (int)TX_QLEN (dev
), dev
->net
->mtu
,
748 // delay posting reads until we're fully open
749 tasklet_schedule (&dev
->bh
);
752 usb_autopm_put_interface(dev
->intf
);
756 EXPORT_SYMBOL_GPL(usbnet_open
);
758 /*-------------------------------------------------------------------------*/
760 /* ethtool methods; minidrivers may need to add some more, but
761 * they'll probably want to use this base set.
764 #if defined(CONFIG_MII) || defined(CONFIG_MII_MODULE)
767 int usbnet_get_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
)
769 struct usbnet
*dev
= netdev_priv(net
);
771 if (!dev
->mii
.mdio_read
)
774 return mii_ethtool_gset(&dev
->mii
, cmd
);
776 EXPORT_SYMBOL_GPL(usbnet_get_settings
);
778 int usbnet_set_settings (struct net_device
*net
, struct ethtool_cmd
*cmd
)
780 struct usbnet
*dev
= netdev_priv(net
);
783 if (!dev
->mii
.mdio_write
)
786 retval
= mii_ethtool_sset(&dev
->mii
, cmd
);
788 /* link speed/duplex might have changed */
789 if (dev
->driver_info
->link_reset
)
790 dev
->driver_info
->link_reset(dev
);
795 EXPORT_SYMBOL_GPL(usbnet_set_settings
);
797 u32
usbnet_get_link (struct net_device
*net
)
799 struct usbnet
*dev
= netdev_priv(net
);
801 /* If a check_connect is defined, return its result */
802 if (dev
->driver_info
->check_connect
)
803 return dev
->driver_info
->check_connect (dev
) == 0;
805 /* if the device has mii operations, use those */
806 if (dev
->mii
.mdio_read
)
807 return mii_link_ok(&dev
->mii
);
809 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
810 return ethtool_op_get_link(net
);
812 EXPORT_SYMBOL_GPL(usbnet_get_link
);
814 int usbnet_nway_reset(struct net_device
*net
)
816 struct usbnet
*dev
= netdev_priv(net
);
818 if (!dev
->mii
.mdio_write
)
821 return mii_nway_restart(&dev
->mii
);
823 EXPORT_SYMBOL_GPL(usbnet_nway_reset
);
825 #endif /* HAVE_MII */
827 void usbnet_get_drvinfo (struct net_device
*net
, struct ethtool_drvinfo
*info
)
829 struct usbnet
*dev
= netdev_priv(net
);
831 strlcpy (info
->driver
, dev
->driver_name
, sizeof info
->driver
);
832 strlcpy (info
->version
, DRIVER_VERSION
, sizeof info
->version
);
833 strlcpy (info
->fw_version
, dev
->driver_info
->description
,
834 sizeof info
->fw_version
);
835 usb_make_path (dev
->udev
, info
->bus_info
, sizeof info
->bus_info
);
837 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo
);
839 u32
usbnet_get_msglevel (struct net_device
*net
)
841 struct usbnet
*dev
= netdev_priv(net
);
843 return dev
->msg_enable
;
845 EXPORT_SYMBOL_GPL(usbnet_get_msglevel
);
847 void usbnet_set_msglevel (struct net_device
*net
, u32 level
)
849 struct usbnet
*dev
= netdev_priv(net
);
851 dev
->msg_enable
= level
;
853 EXPORT_SYMBOL_GPL(usbnet_set_msglevel
);
855 /* drivers may override default ethtool_ops in their bind() routine */
856 static struct ethtool_ops usbnet_ethtool_ops
= {
858 .get_settings
= usbnet_get_settings
,
859 .set_settings
= usbnet_set_settings
,
860 .get_link
= usbnet_get_link
,
861 .nway_reset
= usbnet_nway_reset
,
863 .get_drvinfo
= usbnet_get_drvinfo
,
864 .get_msglevel
= usbnet_get_msglevel
,
865 .set_msglevel
= usbnet_set_msglevel
,
868 /*-------------------------------------------------------------------------*/
870 /* work that cannot be done in interrupt context uses keventd.
872 * NOTE: with 2.5 we could do more of this using completion callbacks,
873 * especially now that control transfers can be queued.
876 kevent (struct work_struct
*work
)
879 container_of(work
, struct usbnet
, kevent
);
882 /* usb_clear_halt() needs a thread context */
883 if (test_bit (EVENT_TX_HALT
, &dev
->flags
)) {
884 unlink_urbs (dev
, &dev
->txq
);
885 status
= usb_clear_halt (dev
->udev
, dev
->out
);
888 && status
!= -ESHUTDOWN
) {
889 if (netif_msg_tx_err (dev
))
890 deverr (dev
, "can't clear tx halt, status %d",
893 clear_bit (EVENT_TX_HALT
, &dev
->flags
);
894 if (status
!= -ESHUTDOWN
)
895 netif_wake_queue (dev
->net
);
898 if (test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
899 unlink_urbs (dev
, &dev
->rxq
);
900 status
= usb_clear_halt (dev
->udev
, dev
->in
);
903 && status
!= -ESHUTDOWN
) {
904 if (netif_msg_rx_err (dev
))
905 deverr (dev
, "can't clear rx halt, status %d",
908 clear_bit (EVENT_RX_HALT
, &dev
->flags
);
909 tasklet_schedule (&dev
->bh
);
913 /* tasklet could resubmit itself forever if memory is tight */
914 if (test_bit (EVENT_RX_MEMORY
, &dev
->flags
)) {
915 struct urb
*urb
= NULL
;
918 if (netif_running (dev
->net
))
919 urb
= usb_alloc_urb (0, GFP_KERNEL
);
921 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
923 clear_bit (EVENT_RX_MEMORY
, &dev
->flags
);
924 if (rx_submit (dev
, urb
, GFP_KERNEL
) == -ENOLINK
)
927 tasklet_schedule (&dev
->bh
);
931 if (test_bit (EVENT_LINK_RESET
, &dev
->flags
)) {
932 struct driver_info
*info
= dev
->driver_info
;
935 clear_bit (EVENT_LINK_RESET
, &dev
->flags
);
936 if(info
->link_reset
&& (retval
= info
->link_reset(dev
)) < 0) {
937 devinfo(dev
, "link reset failed (%d) usbnet usb-%s-%s, %s",
939 dev
->udev
->bus
->bus_name
, dev
->udev
->devpath
,
945 devdbg (dev
, "kevent done, flags = 0x%lx",
949 /*-------------------------------------------------------------------------*/
951 static void tx_complete (struct urb
*urb
)
953 struct sk_buff
*skb
= (struct sk_buff
*) urb
->context
;
954 struct skb_data
*entry
= (struct skb_data
*) skb
->cb
;
955 struct usbnet
*dev
= entry
->dev
;
957 if (urb
->status
== 0) {
958 if (!(dev
->driver_info
->flags
& FLAG_MULTI_PACKET
))
959 dev
->stats
.tx_packets
++;
960 dev
->stats
.tx_bytes
+= entry
->length
;
962 dev
->stats
.tx_errors
++;
964 switch (urb
->status
) {
966 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
969 /* software-driven interface shutdown */
970 case -ECONNRESET
: // async unlink
971 case -ESHUTDOWN
: // hardware gone
974 // like rx, tx gets controller i/o faults during khubd delays
975 // and so it uses the same throttling mechanism.
979 if (!timer_pending (&dev
->delay
)) {
980 mod_timer (&dev
->delay
,
981 jiffies
+ THROTTLE_JIFFIES
);
982 if (netif_msg_link (dev
))
983 devdbg (dev
, "tx throttle %d",
986 netif_stop_queue (dev
->net
);
989 if (netif_msg_tx_err (dev
))
990 devdbg (dev
, "tx err %d", entry
->urb
->status
);
995 (void) defer_bh(dev
, skb
, &dev
->txq
, tx_done
);
998 /*-------------------------------------------------------------------------*/
1000 void usbnet_tx_timeout (struct net_device
*net
)
1002 struct usbnet
*dev
= netdev_priv(net
);
1004 unlink_urbs (dev
, &dev
->txq
);
1005 tasklet_schedule (&dev
->bh
);
1007 // FIXME: device recovery -- reset?
1009 EXPORT_SYMBOL_GPL(usbnet_tx_timeout
);
1011 /*-------------------------------------------------------------------------*/
1013 int usbnet_start_xmit (struct sk_buff
*skb
, struct net_device
*net
)
1015 struct usbnet
*dev
= netdev_priv(net
);
1017 int retval
= NET_XMIT_SUCCESS
;
1018 struct urb
*urb
= NULL
;
1019 struct skb_data
*entry
;
1020 struct driver_info
*info
= dev
->driver_info
;
1021 unsigned long flags
;
1023 // some devices want funky USB-level framing, for
1024 // win32 driver (usually) and/or hardware quirks
1025 if (info
->tx_fixup
) {
1026 skb
= info
->tx_fixup (dev
, skb
, GFP_ATOMIC
);
1028 /* packet collected; minidriver waiting for more */
1029 if (info
->flags
& FLAG_MULTI_PACKET
)
1031 devdbg(dev
, "can't tx_fixup skb");
1037 if (!(urb
= usb_alloc_urb (0, GFP_ATOMIC
))) {
1038 if (netif_msg_tx_err (dev
))
1039 devdbg (dev
, "no urb");
1043 entry
= (struct skb_data
*) skb
->cb
;
1046 entry
->length
= length
;
1048 usb_fill_bulk_urb (urb
, dev
->udev
, dev
->out
,
1049 skb
->data
, skb
->len
, tx_complete
, skb
);
1051 /* don't assume the hardware handles USB_ZERO_PACKET
1052 * NOTE: strictly conforming cdc-ether devices should expect
1053 * the ZLP here, but ignore the one-byte packet.
1054 * NOTE2: CDC NCM specification is different from CDC ECM when
1055 * handling ZLP/short packets, so cdc_ncm driver will make short
1056 * packet itself if needed.
1058 if (length
% dev
->maxpacket
== 0) {
1059 if (!(info
->flags
& FLAG_SEND_ZLP
)) {
1060 if (!(info
->flags
& FLAG_MULTI_PACKET
)) {
1061 urb
->transfer_buffer_length
++;
1062 if (skb_tailroom(skb
)) {
1063 skb
->data
[skb
->len
] = 0;
1068 urb
->transfer_flags
|= URB_ZERO_PACKET
;
1071 spin_lock_irqsave (&dev
->txq
.lock
, flags
);
1073 switch ((retval
= usb_submit_urb (urb
, GFP_ATOMIC
))) {
1075 netif_stop_queue (net
);
1076 usbnet_defer_kevent (dev
, EVENT_TX_HALT
);
1079 if (netif_msg_tx_err (dev
))
1080 devdbg (dev
, "tx: submit urb err %d", retval
);
1083 net
->trans_start
= jiffies
;
1084 __usbnet_queue_skb(&dev
->txq
, skb
, tx_start
);
1085 if (dev
->txq
.qlen
>= TX_QLEN (dev
))
1086 netif_stop_queue (net
);
1088 spin_unlock_irqrestore (&dev
->txq
.lock
, flags
);
1091 if (netif_msg_tx_err (dev
))
1092 devdbg (dev
, "drop, code %d", retval
);
1094 retval
= NET_XMIT_SUCCESS
;
1095 dev
->stats
.tx_dropped
++;
1098 dev_kfree_skb_any (skb
);
1100 } else if (netif_msg_tx_queued (dev
)) {
1101 devdbg (dev
, "> tx, len %d, type 0x%x",
1102 length
, skb
->protocol
);
1106 EXPORT_SYMBOL_GPL(usbnet_start_xmit
);
1108 /*-------------------------------------------------------------------------*/
1110 // tasklet (work deferred from completions, in_irq) or timer
1112 static void usbnet_bh (unsigned long param
)
1114 struct usbnet
*dev
= (struct usbnet
*) param
;
1115 struct sk_buff
*skb
;
1116 struct skb_data
*entry
;
1118 while ((skb
= skb_dequeue (&dev
->done
))) {
1119 entry
= (struct skb_data
*) skb
->cb
;
1120 switch (entry
->state
) {
1122 entry
->state
= rx_cleanup
;
1123 rx_process (dev
, skb
);
1127 usb_free_urb (entry
->urb
);
1128 dev_kfree_skb (skb
);
1131 devdbg (dev
, "bogus skb state %d", entry
->state
);
1135 // waiting for all pending urbs to complete?
1137 if ((dev
->txq
.qlen
+ dev
->rxq
.qlen
+ dev
->done
.qlen
) == 0) {
1138 wake_up (dev
->wait
);
1141 // or are we maybe short a few urbs?
1142 } else if (netif_running (dev
->net
)
1143 && netif_device_present (dev
->net
)
1144 && !timer_pending (&dev
->delay
)
1145 && !test_bit (EVENT_RX_HALT
, &dev
->flags
)) {
1146 int temp
= dev
->rxq
.qlen
;
1147 int qlen
= RX_QLEN (dev
);
1153 // don't refill the queue all at once
1154 for (i
= 0; i
< 10 && dev
->rxq
.qlen
< qlen
; i
++) {
1155 urb
= usb_alloc_urb (0, GFP_ATOMIC
);
1157 if (rx_submit (dev
, urb
, GFP_ATOMIC
) ==
1162 if (temp
!= dev
->rxq
.qlen
&& netif_msg_link (dev
))
1163 devdbg (dev
, "rxqlen %d --> %d",
1164 temp
, dev
->rxq
.qlen
);
1165 if (dev
->rxq
.qlen
< qlen
)
1166 tasklet_schedule (&dev
->bh
);
1168 if (dev
->txq
.qlen
< TX_QLEN (dev
))
1169 netif_wake_queue (dev
->net
);
1175 /*-------------------------------------------------------------------------
1177 * USB Device Driver support
1179 *-------------------------------------------------------------------------*/
1181 // precondition: never called in_interrupt
1183 void usbnet_disconnect (struct usb_interface
*intf
)
1186 struct usb_device
*xdev
;
1187 struct net_device
*net
;
1189 dev
= usb_get_intfdata(intf
);
1190 usb_set_intfdata(intf
, NULL
);
1194 xdev
= interface_to_usbdev (intf
);
1196 if (netif_msg_probe (dev
))
1197 devinfo (dev
, "unregister '%s' usb-%s-%s, %s",
1198 intf
->dev
.driver
->name
,
1199 xdev
->bus
->bus_name
, xdev
->devpath
,
1200 dev
->driver_info
->description
);
1203 unregister_netdev (net
);
1205 /* we don't hold rtnl here ... */
1206 flush_scheduled_work ();
1208 if (dev
->driver_info
->unbind
)
1209 dev
->driver_info
->unbind (dev
, intf
);
1214 EXPORT_SYMBOL_GPL(usbnet_disconnect
);
1217 /*-------------------------------------------------------------------------*/
1219 // precondition: never called in_interrupt
1222 usbnet_probe (struct usb_interface
*udev
, const struct usb_device_id
*prod
)
1225 struct net_device
*net
;
1226 struct usb_host_interface
*interface
;
1227 struct driver_info
*info
;
1228 struct usb_device
*xdev
;
1232 name
= udev
->dev
.driver
->name
;
1233 info
= (struct driver_info
*) prod
->driver_info
;
1235 dev_dbg (&udev
->dev
, "blacklisted by %s\n", name
);
1238 xdev
= interface_to_usbdev (udev
);
1239 interface
= udev
->cur_altsetting
;
1245 // set up our own records
1246 net
= alloc_etherdev(sizeof(*dev
));
1248 dbg ("can't kmalloc dev");
1252 dev
= netdev_priv(net
);
1255 dev
->driver_info
= info
;
1256 dev
->driver_name
= name
;
1257 dev
->msg_enable
= netif_msg_init (msg_level
, NETIF_MSG_DRV
1258 | NETIF_MSG_PROBE
| NETIF_MSG_LINK
);
1259 skb_queue_head_init (&dev
->rxq
);
1260 skb_queue_head_init (&dev
->txq
);
1261 skb_queue_head_init (&dev
->done
);
1262 dev
->bh
.func
= usbnet_bh
;
1263 dev
->bh
.data
= (unsigned long) dev
;
1264 INIT_WORK (&dev
->kevent
, kevent
);
1265 dev
->delay
.function
= usbnet_bh
;
1266 dev
->delay
.data
= (unsigned long) dev
;
1267 init_timer (&dev
->delay
);
1268 mutex_init (&dev
->phy_mutex
);
1270 SET_MODULE_OWNER (net
);
1272 strcpy (net
->name
, "usb%d");
1273 memcpy (net
->dev_addr
, node_id
, sizeof node_id
);
1275 /* rx and tx sides can use different message sizes;
1276 * bind() should set rx_urb_size in that case.
1278 dev
->hard_mtu
= net
->mtu
+ net
->hard_header_len
;
1280 // dma_supported() is deeply broken on almost all architectures
1281 // possible with some EHCI controllers
1282 if (dma_supported (&udev
->dev
, DMA_64BIT_MASK
))
1283 net
->features
|= NETIF_F_HIGHDMA
;
1286 net
->change_mtu
= usbnet_change_mtu
;
1287 net
->get_stats
= usbnet_get_stats
;
1288 net
->hard_start_xmit
= usbnet_start_xmit
;
1289 net
->open
= usbnet_open
;
1290 net
->stop
= usbnet_stop
;
1291 net
->watchdog_timeo
= TX_TIMEOUT_JIFFIES
;
1292 net
->tx_timeout
= usbnet_tx_timeout
;
1293 net
->ethtool_ops
= &usbnet_ethtool_ops
;
1295 // allow device-specific bind/init procedures
1296 // NOTE net->name still not usable ...
1298 status
= info
->bind (dev
, udev
);
1302 // heuristic: "usb%d" for links we know are two-host,
1303 // else "eth%d" when there's reasonable doubt. userspace
1304 // can rename the link if it knows better.
1305 if ((dev
->driver_info
->flags
& FLAG_ETHER
) != 0
1306 && (net
->dev_addr
[0] & 0x02) == 0)
1307 strcpy (net
->name
, "eth%d");
1309 /* devices that cannot do ARP */
1310 if ((dev
->driver_info
->flags
& FLAG_NOARP
) != 0)
1311 net
->flags
|= IFF_NOARP
;
1313 /* maybe the remote can't receive an Ethernet MTU */
1314 if (net
->mtu
> (dev
->hard_mtu
- net
->hard_header_len
))
1315 net
->mtu
= dev
->hard_mtu
- net
->hard_header_len
;
1316 } else if (!info
->in
|| !info
->out
)
1317 status
= usbnet_get_endpoints (dev
, udev
);
1319 dev
->in
= usb_rcvbulkpipe (xdev
, info
->in
);
1320 dev
->out
= usb_sndbulkpipe (xdev
, info
->out
);
1321 if (!(info
->flags
& FLAG_NO_SETINT
))
1322 status
= usb_set_interface (xdev
,
1323 interface
->desc
.bInterfaceNumber
,
1324 interface
->desc
.bAlternateSetting
);
1329 if (status
== 0 && dev
->status
)
1330 status
= init_status (dev
, udev
);
1334 if (!dev
->rx_urb_size
)
1335 dev
->rx_urb_size
= dev
->hard_mtu
;
1336 dev
->maxpacket
= usb_maxpacket (dev
->udev
, dev
->out
, 1);
1338 SET_NETDEV_DEV(net
, &udev
->dev
);
1339 status
= register_netdev (net
);
1342 if (netif_msg_probe (dev
))
1343 devinfo (dev
, "register '%s' at usb-%s-%s, %s, "
1344 "%02x:%02x:%02x:%02x:%02x:%02x",
1345 udev
->dev
.driver
->name
,
1346 xdev
->bus
->bus_name
, xdev
->devpath
,
1347 dev
->driver_info
->description
,
1348 net
->dev_addr
[0], net
->dev_addr
[1],
1349 net
->dev_addr
[2], net
->dev_addr
[3],
1350 net
->dev_addr
[4], net
->dev_addr
[5]);
1352 // ok, it's ready to go.
1353 usb_set_intfdata (udev
, dev
);
1355 // start as if the link is up
1356 netif_device_attach (net
);
1362 info
->unbind (dev
, udev
);
1369 EXPORT_SYMBOL_GPL(usbnet_probe
);
1371 /*-------------------------------------------------------------------------*/
1374 * suspend the whole driver as soon as the first interface is suspended
1375 * resume only when the last interface is resumed
1378 int usbnet_suspend (struct usb_interface
*intf
, pm_message_t message
)
1380 struct usbnet
*dev
= usb_get_intfdata(intf
);
1382 if (!dev
->suspend_count
++) {
1384 * accelerate emptying of the rx and queues, to avoid
1385 * having everything error out.
1387 netif_device_detach (dev
->net
);
1388 (void) unlink_urbs (dev
, &dev
->rxq
);
1389 (void) unlink_urbs (dev
, &dev
->txq
);
1391 * reattach so runtime management can use and
1394 netif_device_attach (dev
->net
);
1398 EXPORT_SYMBOL_GPL(usbnet_suspend
);
1400 int usbnet_resume (struct usb_interface
*intf
)
1402 struct usbnet
*dev
= usb_get_intfdata(intf
);
1404 if (!--dev
->suspend_count
)
1405 tasklet_schedule (&dev
->bh
);
1409 EXPORT_SYMBOL_GPL(usbnet_resume
);
1412 /*-------------------------------------------------------------------------*/
1414 static int __init
usbnet_init(void)
1416 /* compiler should optimize this out */
1417 BUILD_BUG_ON (sizeof (((struct sk_buff
*)0)->cb
)
1418 < sizeof (struct skb_data
));
1420 random_ether_addr(node_id
);
1423 module_init(usbnet_init
);
1425 static void __exit
usbnet_exit(void)
1428 module_exit(usbnet_exit
);
1430 MODULE_AUTHOR("David Brownell");
1431 MODULE_DESCRIPTION("USB network driver framework");
1432 MODULE_LICENSE("GPL");