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 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
63 * let the USB host controller be busy for 5msec or more before an irq
64 * is required, under load. Jumbograms change the equation.
66 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
67 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
68 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
69 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
70 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
72 // reawaken network queue this soon after stopping; else watchdog barks
73 #define TX_TIMEOUT_JIFFIES (5*HZ)
75 // throttle rx/tx briefly after some faults, so khubd might disconnect()
76 // us (it polls at HZ/4 usually) before we report too many false errors.
77 #define THROTTLE_JIFFIES (HZ/8)
80 #define UNLINK_TIMEOUT_MS 3
82 /*-------------------------------------------------------------------------*/
84 // randomly generated ethernet address
85 static u8 node_id [ETH_ALEN];
87 static const char driver_name [] = "usbnet";
89 /* use ethtool to change the level for any given device */
90 static int msg_level = -1;
91 module_param (msg_level, int, 0);
92 MODULE_PARM_DESC (msg_level, "Override default message level");
94 /*-------------------------------------------------------------------------*/
96 /* handles CDC Ethernet and many other network "bulk data" interfaces */
97 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
100 struct usb_host_interface *alt = NULL;
101 struct usb_host_endpoint *in = NULL, *out = NULL;
102 struct usb_host_endpoint *status = NULL;
104 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
107 in = out = status = NULL;
108 alt = intf->altsetting + tmp;
110 /* take the first altsetting with in-bulk + out-bulk;
111 * remember any status endpoint, just in case;
112 * ignore other endpoints and altsettings.
114 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
115 struct usb_host_endpoint *e;
118 e = alt->endpoint + ep;
119 switch (e->desc.bmAttributes) {
120 case USB_ENDPOINT_XFER_INT:
121 if (!usb_endpoint_dir_in(&e->desc))
125 case USB_ENDPOINT_XFER_BULK:
130 if (usb_endpoint_dir_in(&e->desc)) {
133 else if (intr && !status)
143 if (!alt || !in || !out)
146 if (alt->desc.bAlternateSetting != 0 ||
147 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
148 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
149 alt->desc.bAlternateSetting);
154 dev->in = usb_rcvbulkpipe (dev->udev,
155 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156 dev->out = usb_sndbulkpipe (dev->udev,
157 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
158 dev->status = status;
161 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
163 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
166 unsigned char buf [13];
168 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
170 dev_dbg(&dev->udev->dev,
171 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
176 for (i = tmp = 0; i < 6; i++, tmp += 2)
177 dev->net->dev_addr [i] =
178 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
181 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
183 static void intr_complete (struct urb *urb)
185 struct usbnet *dev = urb->context;
186 int status = urb->status;
191 dev->driver_info->status(dev, urb);
194 /* software-driven interface shutdown */
195 case -ENOENT: /* urb killed */
196 case -ESHUTDOWN: /* hardware gone */
197 netif_dbg(dev, ifdown, dev->net,
198 "intr shutdown, code %d\n", status);
201 /* NOTE: not throttling like RX/TX, since this endpoint
202 * already polls infrequently
205 netdev_dbg(dev->net, "intr status %d\n", status);
209 if (!netif_running (dev->net))
212 status = usb_submit_urb (urb, GFP_ATOMIC);
214 netif_err(dev, timer, dev->net,
215 "intr resubmit --> %d\n", status);
218 static int init_status (struct usbnet *dev, struct usb_interface *intf)
225 if (!dev->driver_info->status)
228 pipe = usb_rcvintpipe (dev->udev,
229 dev->status->desc.bEndpointAddress
230 & USB_ENDPOINT_NUMBER_MASK);
231 maxp = usb_maxpacket (dev->udev, pipe, 0);
233 /* avoid 1 msec chatter: min 8 msec poll rate */
234 period = max ((int) dev->status->desc.bInterval,
235 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
237 buf = kmalloc (maxp, GFP_KERNEL);
239 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
240 if (!dev->interrupt) {
244 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
245 buf, maxp, intr_complete, dev, period);
246 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
248 "status ep%din, %d bytes period %d\n",
249 usb_pipeendpoint(pipe), maxp, period);
255 /* Passes this packet up the stack, updating its accounting.
256 * Some link protocols batch packets, so their rx_fixup paths
257 * can return clones as well as just modify the original skb.
259 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
263 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
264 skb_queue_tail(&dev->rxq_pause, skb);
268 skb->protocol = eth_type_trans (skb, dev->net);
269 dev->net->stats.rx_packets++;
270 dev->net->stats.rx_bytes += skb->len;
272 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
273 skb->len + sizeof (struct ethhdr), skb->protocol);
274 memset (skb->cb, 0, sizeof (struct skb_data));
276 if (skb_defer_rx_timestamp(skb))
279 status = netif_rx (skb);
280 if (status != NET_RX_SUCCESS)
281 netif_dbg(dev, rx_err, dev->net,
282 "netif_rx status %d\n", status);
284 EXPORT_SYMBOL_GPL(usbnet_skb_return);
287 /*-------------------------------------------------------------------------
289 * Network Device Driver (peer link to "Host Device", from USB host)
291 *-------------------------------------------------------------------------*/
293 int usbnet_change_mtu (struct net_device *net, int new_mtu)
295 struct usbnet *dev = netdev_priv(net);
296 int ll_mtu = new_mtu + net->hard_header_len;
297 int old_hard_mtu = dev->hard_mtu;
298 int old_rx_urb_size = dev->rx_urb_size;
302 // no second zero-length packet read wanted after mtu-sized packets
303 if ((ll_mtu % dev->maxpacket) == 0)
307 dev->hard_mtu = net->mtu + net->hard_header_len;
308 if (dev->rx_urb_size == old_hard_mtu) {
309 dev->rx_urb_size = dev->hard_mtu;
310 if (dev->rx_urb_size > old_rx_urb_size)
311 usbnet_unlink_rx_urbs(dev);
316 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
318 /* The caller must hold list->lock */
319 static void __usbnet_queue_skb(struct sk_buff_head *list,
320 struct sk_buff *newsk, enum skb_state state)
322 struct skb_data *entry = (struct skb_data *) newsk->cb;
324 __skb_queue_tail(list, newsk);
325 entry->state = state;
328 /*-------------------------------------------------------------------------*/
330 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
331 * completion callbacks. 2.5 should have fixed those bugs...
334 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
335 struct sk_buff_head *list, enum skb_state state)
338 enum skb_state old_state;
339 struct skb_data *entry = (struct skb_data *) skb->cb;
341 spin_lock_irqsave(&list->lock, flags);
342 old_state = entry->state;
343 entry->state = state;
344 __skb_unlink(skb, list);
345 spin_unlock(&list->lock);
346 spin_lock(&dev->done.lock);
347 __skb_queue_tail(&dev->done, skb);
348 if (dev->done.qlen == 1)
349 tasklet_schedule(&dev->bh);
350 spin_unlock_irqrestore(&dev->done.lock, flags);
354 /* some work can't be done in tasklets, so we use keventd
356 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
357 * but tasklet_schedule() doesn't. hope the failure is rare.
359 void usbnet_defer_kevent (struct usbnet *dev, int work)
361 set_bit (work, &dev->flags);
362 if (!schedule_work (&dev->kevent)) {
364 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
366 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
369 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
371 /*-------------------------------------------------------------------------*/
373 static void rx_complete (struct urb *urb);
375 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
378 struct skb_data *entry;
380 unsigned long lockflags;
381 size_t size = dev->rx_urb_size;
383 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
385 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
386 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
391 entry = (struct skb_data *) skb->cb;
396 usb_fill_bulk_urb (urb, dev->udev, dev->in,
397 skb->data, size, rx_complete, skb);
399 spin_lock_irqsave (&dev->rxq.lock, lockflags);
401 if (netif_running (dev->net) &&
402 netif_device_present (dev->net) &&
403 !test_bit (EVENT_RX_HALT, &dev->flags) &&
404 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
405 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
407 usbnet_defer_kevent (dev, EVENT_RX_HALT);
410 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
413 netif_dbg(dev, ifdown, dev->net, "device gone\n");
414 netif_device_detach (dev->net);
420 netif_dbg(dev, rx_err, dev->net,
421 "rx submit, %d\n", retval);
422 tasklet_schedule (&dev->bh);
425 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
428 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
431 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
433 dev_kfree_skb_any (skb);
440 /*-------------------------------------------------------------------------*/
442 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
444 if (dev->driver_info->rx_fixup &&
445 !dev->driver_info->rx_fixup (dev, skb)) {
446 /* With RX_ASSEMBLE, rx_fixup() must update counters */
447 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
448 dev->net->stats.rx_errors++;
451 // else network stack removes extra byte if we forced a short packet
454 /* all data was already cloned from skb inside the driver */
455 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
456 dev_kfree_skb_any(skb);
458 usbnet_skb_return(dev, skb);
462 netif_dbg(dev, rx_err, dev->net, "drop\n");
463 dev->net->stats.rx_errors++;
465 skb_queue_tail(&dev->done, skb);
468 /*-------------------------------------------------------------------------*/
470 static void rx_complete (struct urb *urb)
472 struct sk_buff *skb = (struct sk_buff *) urb->context;
473 struct skb_data *entry = (struct skb_data *) skb->cb;
474 struct usbnet *dev = entry->dev;
475 int urb_status = urb->status;
476 enum skb_state state;
478 skb_put (skb, urb->actual_length);
482 switch (urb_status) {
485 if (skb->len < dev->net->hard_header_len) {
487 dev->net->stats.rx_errors++;
488 dev->net->stats.rx_length_errors++;
489 netif_dbg(dev, rx_err, dev->net,
490 "rx length %d\n", skb->len);
494 /* stalls need manual reset. this is rare ... except that
495 * when going through USB 2.0 TTs, unplug appears this way.
496 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
497 * storm, recovering as needed.
500 dev->net->stats.rx_errors++;
501 usbnet_defer_kevent (dev, EVENT_RX_HALT);
504 /* software-driven interface shutdown */
505 case -ECONNRESET: /* async unlink */
506 case -ESHUTDOWN: /* hardware gone */
507 netif_dbg(dev, ifdown, dev->net,
508 "rx shutdown, code %d\n", urb_status);
511 /* we get controller i/o faults during khubd disconnect() delays.
512 * throttle down resubmits, to avoid log floods; just temporarily,
513 * so we still recover when the fault isn't a khubd delay.
518 dev->net->stats.rx_errors++;
519 if (!timer_pending (&dev->delay)) {
520 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
521 netif_dbg(dev, link, dev->net,
522 "rx throttle %d\n", urb_status);
530 /* data overrun ... flush fifo? */
532 dev->net->stats.rx_over_errors++;
537 dev->net->stats.rx_errors++;
538 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
542 state = defer_bh(dev, skb, &dev->rxq, state);
545 if (netif_running (dev->net) &&
546 !test_bit (EVENT_RX_HALT, &dev->flags) &&
547 state != unlink_start) {
548 rx_submit (dev, urb, GFP_ATOMIC);
549 usb_mark_last_busy(dev->udev);
554 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
557 /*-------------------------------------------------------------------------*/
558 void usbnet_pause_rx(struct usbnet *dev)
560 set_bit(EVENT_RX_PAUSED, &dev->flags);
562 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
564 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
566 void usbnet_resume_rx(struct usbnet *dev)
571 clear_bit(EVENT_RX_PAUSED, &dev->flags);
573 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
574 usbnet_skb_return(dev, skb);
578 tasklet_schedule(&dev->bh);
580 netif_dbg(dev, rx_status, dev->net,
581 "paused rx queue disabled, %d skbs requeued\n", num);
583 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
585 void usbnet_purge_paused_rxq(struct usbnet *dev)
587 skb_queue_purge(&dev->rxq_pause);
589 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
591 /*-------------------------------------------------------------------------*/
593 // unlink pending rx/tx; completion handlers do all other cleanup
595 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
601 spin_lock_irqsave (&q->lock, flags);
602 while (!skb_queue_empty(q)) {
603 struct skb_data *entry;
607 skb_queue_walk(q, skb) {
608 entry = (struct skb_data *) skb->cb;
609 if (entry->state != unlink_start)
614 entry->state = unlink_start;
618 * Get reference count of the URB to avoid it to be
619 * freed during usb_unlink_urb, which may trigger
620 * use-after-free problem inside usb_unlink_urb since
621 * usb_unlink_urb is always racing with .complete
622 * handler(include defer_bh).
625 spin_unlock_irqrestore(&q->lock, flags);
626 // during some PM-driven resume scenarios,
627 // these (async) unlinks complete immediately
628 retval = usb_unlink_urb (urb);
629 if (retval != -EINPROGRESS && retval != 0)
630 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
634 spin_lock_irqsave(&q->lock, flags);
636 spin_unlock_irqrestore (&q->lock, flags);
640 // Flush all pending rx urbs
641 // minidrivers may need to do this when the MTU changes
643 void usbnet_unlink_rx_urbs(struct usbnet *dev)
645 if (netif_running(dev->net)) {
646 (void) unlink_urbs (dev, &dev->rxq);
647 tasklet_schedule(&dev->bh);
650 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
652 /*-------------------------------------------------------------------------*/
654 // precondition: never called in_interrupt
655 static void usbnet_terminate_urbs(struct usbnet *dev)
657 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
658 DECLARE_WAITQUEUE(wait, current);
661 /* ensure there are no more active urbs */
662 add_wait_queue(&unlink_wakeup, &wait);
663 set_current_state(TASK_UNINTERRUPTIBLE);
664 dev->wait = &unlink_wakeup;
665 temp = unlink_urbs(dev, &dev->txq) +
666 unlink_urbs(dev, &dev->rxq);
668 /* maybe wait for deletions to finish. */
669 while (!skb_queue_empty(&dev->rxq)
670 && !skb_queue_empty(&dev->txq)
671 && !skb_queue_empty(&dev->done)) {
672 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
673 set_current_state(TASK_UNINTERRUPTIBLE);
674 netif_dbg(dev, ifdown, dev->net,
675 "waited for %d urb completions\n", temp);
677 set_current_state(TASK_RUNNING);
679 remove_wait_queue(&unlink_wakeup, &wait);
682 int usbnet_stop (struct net_device *net)
684 struct usbnet *dev = netdev_priv(net);
685 struct driver_info *info = dev->driver_info;
688 clear_bit(EVENT_DEV_OPEN, &dev->flags);
689 netif_stop_queue (net);
691 netif_info(dev, ifdown, dev->net,
692 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
693 net->stats.rx_packets, net->stats.tx_packets,
694 net->stats.rx_errors, net->stats.tx_errors);
696 /* allow minidriver to stop correctly (wireless devices to turn off
699 retval = info->stop(dev);
701 netif_info(dev, ifdown, dev->net,
702 "stop fail (%d) usbnet usb-%s-%s, %s\n",
704 dev->udev->bus->bus_name, dev->udev->devpath,
708 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
709 usbnet_terminate_urbs(dev);
711 usb_kill_urb(dev->interrupt);
713 usbnet_purge_paused_rxq(dev);
715 /* deferred work (task, timer, softirq) must also stop.
716 * can't flush_scheduled_work() until we drop rtnl (later),
717 * else workers could deadlock; so make workers a NOP.
720 del_timer_sync (&dev->delay);
721 tasklet_kill (&dev->bh);
722 if (info->manage_power &&
723 !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags))
724 info->manage_power(dev, 0);
726 usb_autopm_put_interface(dev->intf);
730 EXPORT_SYMBOL_GPL(usbnet_stop);
732 /*-------------------------------------------------------------------------*/
734 // posts reads, and enables write queuing
736 // precondition: never called in_interrupt
738 int usbnet_open (struct net_device *net)
740 struct usbnet *dev = netdev_priv(net);
742 struct driver_info *info = dev->driver_info;
744 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
745 netif_info(dev, ifup, dev->net,
746 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
748 dev->udev->bus->bus_name,
754 // put into "known safe" state
755 if (info->reset && (retval = info->reset (dev)) < 0) {
756 netif_info(dev, ifup, dev->net,
757 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
759 dev->udev->bus->bus_name,
765 // insist peer be connected
766 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
767 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
771 /* start any status interrupt transfer */
772 if (dev->interrupt) {
773 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
775 netif_err(dev, ifup, dev->net,
776 "intr submit %d\n", retval);
781 set_bit(EVENT_DEV_OPEN, &dev->flags);
782 netif_start_queue (net);
783 netif_info(dev, ifup, dev->net,
784 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
785 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
787 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
788 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
789 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
790 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
791 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
794 // delay posting reads until we're fully open
795 tasklet_schedule (&dev->bh);
796 if (info->manage_power) {
797 retval = info->manage_power(dev, 1);
800 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
802 usb_autopm_put_interface(dev->intf);
807 usb_autopm_put_interface(dev->intf);
811 EXPORT_SYMBOL_GPL(usbnet_open);
813 /*-------------------------------------------------------------------------*/
815 /* ethtool methods; minidrivers may need to add some more, but
816 * they'll probably want to use this base set.
819 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
821 struct usbnet *dev = netdev_priv(net);
823 if (!dev->mii.mdio_read)
826 return mii_ethtool_gset(&dev->mii, cmd);
828 EXPORT_SYMBOL_GPL(usbnet_get_settings);
830 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
832 struct usbnet *dev = netdev_priv(net);
835 if (!dev->mii.mdio_write)
838 retval = mii_ethtool_sset(&dev->mii, cmd);
840 /* link speed/duplex might have changed */
841 if (dev->driver_info->link_reset)
842 dev->driver_info->link_reset(dev);
847 EXPORT_SYMBOL_GPL(usbnet_set_settings);
849 u32 usbnet_get_link (struct net_device *net)
851 struct usbnet *dev = netdev_priv(net);
853 /* If a check_connect is defined, return its result */
854 if (dev->driver_info->check_connect)
855 return dev->driver_info->check_connect (dev) == 0;
857 /* if the device has mii operations, use those */
858 if (dev->mii.mdio_read)
859 return mii_link_ok(&dev->mii);
861 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
862 return ethtool_op_get_link(net);
864 EXPORT_SYMBOL_GPL(usbnet_get_link);
866 int usbnet_nway_reset(struct net_device *net)
868 struct usbnet *dev = netdev_priv(net);
870 if (!dev->mii.mdio_write)
873 return mii_nway_restart(&dev->mii);
875 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
877 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
879 struct usbnet *dev = netdev_priv(net);
881 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
882 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
883 strlcpy (info->fw_version, dev->driver_info->description,
884 sizeof info->fw_version);
885 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
887 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
889 u32 usbnet_get_msglevel (struct net_device *net)
891 struct usbnet *dev = netdev_priv(net);
893 return dev->msg_enable;
895 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
897 void usbnet_set_msglevel (struct net_device *net, u32 level)
899 struct usbnet *dev = netdev_priv(net);
901 dev->msg_enable = level;
903 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
905 /* drivers may override default ethtool_ops in their bind() routine */
906 static const struct ethtool_ops usbnet_ethtool_ops = {
907 .get_settings = usbnet_get_settings,
908 .set_settings = usbnet_set_settings,
909 .get_link = usbnet_get_link,
910 .nway_reset = usbnet_nway_reset,
911 .get_drvinfo = usbnet_get_drvinfo,
912 .get_msglevel = usbnet_get_msglevel,
913 .set_msglevel = usbnet_set_msglevel,
914 .get_ts_info = ethtool_op_get_ts_info,
917 /*-------------------------------------------------------------------------*/
919 /* work that cannot be done in interrupt context uses keventd.
921 * NOTE: with 2.5 we could do more of this using completion callbacks,
922 * especially now that control transfers can be queued.
925 kevent (struct work_struct *work)
928 container_of(work, struct usbnet, kevent);
931 /* usb_clear_halt() needs a thread context */
932 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
933 unlink_urbs (dev, &dev->txq);
934 status = usb_autopm_get_interface(dev->intf);
937 status = usb_clear_halt (dev->udev, dev->out);
938 usb_autopm_put_interface(dev->intf);
941 status != -ESHUTDOWN) {
942 if (netif_msg_tx_err (dev))
944 netdev_err(dev->net, "can't clear tx halt, status %d\n",
947 clear_bit (EVENT_TX_HALT, &dev->flags);
948 if (status != -ESHUTDOWN)
949 netif_wake_queue (dev->net);
952 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
953 unlink_urbs (dev, &dev->rxq);
954 status = usb_autopm_get_interface(dev->intf);
957 status = usb_clear_halt (dev->udev, dev->in);
958 usb_autopm_put_interface(dev->intf);
961 status != -ESHUTDOWN) {
962 if (netif_msg_rx_err (dev))
964 netdev_err(dev->net, "can't clear rx halt, status %d\n",
967 clear_bit (EVENT_RX_HALT, &dev->flags);
968 tasklet_schedule (&dev->bh);
972 /* tasklet could resubmit itself forever if memory is tight */
973 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
974 struct urb *urb = NULL;
977 if (netif_running (dev->net))
978 urb = usb_alloc_urb (0, GFP_KERNEL);
980 clear_bit (EVENT_RX_MEMORY, &dev->flags);
982 clear_bit (EVENT_RX_MEMORY, &dev->flags);
983 status = usb_autopm_get_interface(dev->intf);
988 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
990 usb_autopm_put_interface(dev->intf);
993 tasklet_schedule (&dev->bh);
997 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
998 struct driver_info *info = dev->driver_info;
1001 clear_bit (EVENT_LINK_RESET, &dev->flags);
1002 status = usb_autopm_get_interface(dev->intf);
1005 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1006 usb_autopm_put_interface(dev->intf);
1008 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1010 dev->udev->bus->bus_name,
1014 usb_autopm_put_interface(dev->intf);
1019 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1022 /*-------------------------------------------------------------------------*/
1024 static void tx_complete (struct urb *urb)
1026 struct sk_buff *skb = (struct sk_buff *) urb->context;
1027 struct skb_data *entry = (struct skb_data *) skb->cb;
1028 struct usbnet *dev = entry->dev;
1030 if (urb->status == 0) {
1031 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1032 dev->net->stats.tx_packets++;
1033 dev->net->stats.tx_bytes += entry->length;
1035 dev->net->stats.tx_errors++;
1037 switch (urb->status) {
1039 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1042 /* software-driven interface shutdown */
1043 case -ECONNRESET: // async unlink
1044 case -ESHUTDOWN: // hardware gone
1047 // like rx, tx gets controller i/o faults during khubd delays
1048 // and so it uses the same throttling mechanism.
1052 usb_mark_last_busy(dev->udev);
1053 if (!timer_pending (&dev->delay)) {
1054 mod_timer (&dev->delay,
1055 jiffies + THROTTLE_JIFFIES);
1056 netif_dbg(dev, link, dev->net,
1057 "tx throttle %d\n", urb->status);
1059 netif_stop_queue (dev->net);
1062 netif_dbg(dev, tx_err, dev->net,
1063 "tx err %d\n", entry->urb->status);
1068 usb_autopm_put_interface_async(dev->intf);
1069 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1072 /*-------------------------------------------------------------------------*/
1074 void usbnet_tx_timeout (struct net_device *net)
1076 struct usbnet *dev = netdev_priv(net);
1078 unlink_urbs (dev, &dev->txq);
1079 tasklet_schedule (&dev->bh);
1081 // FIXME: device recovery -- reset?
1083 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1085 /*-------------------------------------------------------------------------*/
1087 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1088 struct net_device *net)
1090 struct usbnet *dev = netdev_priv(net);
1092 struct urb *urb = NULL;
1093 struct skb_data *entry;
1094 struct driver_info *info = dev->driver_info;
1095 unsigned long flags;
1099 skb_tx_timestamp(skb);
1101 // some devices want funky USB-level framing, for
1102 // win32 driver (usually) and/or hardware quirks
1103 if (info->tx_fixup) {
1104 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1106 if (netif_msg_tx_err(dev)) {
1107 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1110 /* cdc_ncm collected packet; waits for more */
1117 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1118 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1122 entry = (struct skb_data *) skb->cb;
1125 entry->length = length;
1127 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1128 skb->data, skb->len, tx_complete, skb);
1130 /* don't assume the hardware handles USB_ZERO_PACKET
1131 * NOTE: strictly conforming cdc-ether devices should expect
1132 * the ZLP here, but ignore the one-byte packet.
1133 * NOTE2: CDC NCM specification is different from CDC ECM when
1134 * handling ZLP/short packets, so cdc_ncm driver will make short
1135 * packet itself if needed.
1137 if (length % dev->maxpacket == 0) {
1138 if (!(info->flags & FLAG_SEND_ZLP)) {
1139 if (!(info->flags & FLAG_MULTI_PACKET)) {
1140 urb->transfer_buffer_length++;
1141 if (skb_tailroom(skb)) {
1142 skb->data[skb->len] = 0;
1147 urb->transfer_flags |= URB_ZERO_PACKET;
1150 spin_lock_irqsave(&dev->txq.lock, flags);
1151 retval = usb_autopm_get_interface_async(dev->intf);
1153 spin_unlock_irqrestore(&dev->txq.lock, flags);
1158 /* if this triggers the device is still a sleep */
1159 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1160 /* transmission will be done in resume */
1161 usb_anchor_urb(urb, &dev->deferred);
1162 /* no use to process more packets */
1163 netif_stop_queue(net);
1165 spin_unlock_irqrestore(&dev->txq.lock, flags);
1166 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1171 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1173 netif_stop_queue (net);
1174 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1175 usb_autopm_put_interface_async(dev->intf);
1178 usb_autopm_put_interface_async(dev->intf);
1179 netif_dbg(dev, tx_err, dev->net,
1180 "tx: submit urb err %d\n", retval);
1183 net->trans_start = jiffies;
1184 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1185 if (dev->txq.qlen >= TX_QLEN (dev))
1186 netif_stop_queue (net);
1188 spin_unlock_irqrestore (&dev->txq.lock, flags);
1191 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1193 dev->net->stats.tx_dropped++;
1196 dev_kfree_skb_any (skb);
1199 netif_dbg(dev, tx_queued, dev->net,
1200 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1204 return NETDEV_TX_OK;
1206 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1208 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1214 /* don't refill the queue all at once */
1215 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1216 urb = usb_alloc_urb(0, flags);
1218 ret = rx_submit(dev, urb, flags);
1230 /*-------------------------------------------------------------------------*/
1232 // tasklet (work deferred from completions, in_irq) or timer
1234 static void usbnet_bh (unsigned long param)
1236 struct usbnet *dev = (struct usbnet *) param;
1237 struct sk_buff *skb;
1238 struct skb_data *entry;
1240 while ((skb = skb_dequeue (&dev->done))) {
1241 entry = (struct skb_data *) skb->cb;
1242 switch (entry->state) {
1244 entry->state = rx_cleanup;
1245 rx_process (dev, skb);
1249 usb_free_urb (entry->urb);
1250 dev_kfree_skb (skb);
1253 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1257 // waiting for all pending urbs to complete?
1259 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1260 wake_up (dev->wait);
1263 // or are we maybe short a few urbs?
1264 } else if (netif_running (dev->net) &&
1265 netif_device_present (dev->net) &&
1266 !timer_pending (&dev->delay) &&
1267 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1268 int temp = dev->rxq.qlen;
1270 if (temp < RX_QLEN(dev)) {
1271 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1273 if (temp != dev->rxq.qlen)
1274 netif_dbg(dev, link, dev->net,
1275 "rxqlen %d --> %d\n",
1276 temp, dev->rxq.qlen);
1277 if (dev->rxq.qlen < RX_QLEN(dev))
1278 tasklet_schedule (&dev->bh);
1280 if (dev->txq.qlen < TX_QLEN (dev))
1281 netif_wake_queue (dev->net);
1286 /*-------------------------------------------------------------------------
1288 * USB Device Driver support
1290 *-------------------------------------------------------------------------*/
1292 // precondition: never called in_interrupt
1294 void usbnet_disconnect (struct usb_interface *intf)
1297 struct usb_device *xdev;
1298 struct net_device *net;
1300 dev = usb_get_intfdata(intf);
1301 usb_set_intfdata(intf, NULL);
1305 xdev = interface_to_usbdev (intf);
1307 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1308 intf->dev.driver->name,
1309 xdev->bus->bus_name, xdev->devpath,
1310 dev->driver_info->description);
1313 unregister_netdev (net);
1315 cancel_work_sync(&dev->kevent);
1317 usb_scuttle_anchored_urbs(&dev->deferred);
1319 if (dev->driver_info->unbind)
1320 dev->driver_info->unbind (dev, intf);
1322 usb_kill_urb(dev->interrupt);
1323 usb_free_urb(dev->interrupt);
1327 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1329 static const struct net_device_ops usbnet_netdev_ops = {
1330 .ndo_open = usbnet_open,
1331 .ndo_stop = usbnet_stop,
1332 .ndo_start_xmit = usbnet_start_xmit,
1333 .ndo_tx_timeout = usbnet_tx_timeout,
1334 .ndo_change_mtu = usbnet_change_mtu,
1335 .ndo_set_mac_address = eth_mac_addr,
1336 .ndo_validate_addr = eth_validate_addr,
1339 /*-------------------------------------------------------------------------*/
1341 // precondition: never called in_interrupt
1343 static struct device_type wlan_type = {
1347 static struct device_type wwan_type = {
1352 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1355 struct net_device *net;
1356 struct usb_host_interface *interface;
1357 struct driver_info *info;
1358 struct usb_device *xdev;
1361 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1363 /* usbnet already took usb runtime pm, so have to enable the feature
1364 * for usb interface, otherwise usb_autopm_get_interface may return
1365 * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1367 if (!driver->supports_autosuspend) {
1368 driver->supports_autosuspend = 1;
1369 pm_runtime_enable(&udev->dev);
1372 name = udev->dev.driver->name;
1373 info = (struct driver_info *) prod->driver_info;
1375 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1378 xdev = interface_to_usbdev (udev);
1379 interface = udev->cur_altsetting;
1383 // set up our own records
1384 net = alloc_etherdev(sizeof(*dev));
1388 /* netdev_printk() needs this so do it as early as possible */
1389 SET_NETDEV_DEV(net, &udev->dev);
1391 dev = netdev_priv(net);
1394 dev->driver_info = info;
1395 dev->driver_name = name;
1396 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1397 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1398 skb_queue_head_init (&dev->rxq);
1399 skb_queue_head_init (&dev->txq);
1400 skb_queue_head_init (&dev->done);
1401 skb_queue_head_init(&dev->rxq_pause);
1402 dev->bh.func = usbnet_bh;
1403 dev->bh.data = (unsigned long) dev;
1404 INIT_WORK (&dev->kevent, kevent);
1405 init_usb_anchor(&dev->deferred);
1406 dev->delay.function = usbnet_bh;
1407 dev->delay.data = (unsigned long) dev;
1408 init_timer (&dev->delay);
1409 mutex_init (&dev->phy_mutex);
1412 strcpy (net->name, "usb%d");
1413 memcpy (net->dev_addr, node_id, sizeof node_id);
1415 /* rx and tx sides can use different message sizes;
1416 * bind() should set rx_urb_size in that case.
1418 dev->hard_mtu = net->mtu + net->hard_header_len;
1420 // dma_supported() is deeply broken on almost all architectures
1421 // possible with some EHCI controllers
1422 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1423 net->features |= NETIF_F_HIGHDMA;
1426 net->netdev_ops = &usbnet_netdev_ops;
1427 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1428 net->ethtool_ops = &usbnet_ethtool_ops;
1430 // allow device-specific bind/init procedures
1431 // NOTE net->name still not usable ...
1433 status = info->bind (dev, udev);
1437 // heuristic: "usb%d" for links we know are two-host,
1438 // else "eth%d" when there's reasonable doubt. userspace
1439 // can rename the link if it knows better.
1440 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1441 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1442 (net->dev_addr [0] & 0x02) == 0))
1443 strcpy (net->name, "eth%d");
1444 /* WLAN devices should always be named "wlan%d" */
1445 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1446 strcpy(net->name, "wlan%d");
1447 /* WWAN devices should always be named "wwan%d" */
1448 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1449 strcpy(net->name, "wwan%d");
1451 /* maybe the remote can't receive an Ethernet MTU */
1452 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1453 net->mtu = dev->hard_mtu - net->hard_header_len;
1454 } else if (!info->in || !info->out)
1455 status = usbnet_get_endpoints (dev, udev);
1457 dev->in = usb_rcvbulkpipe (xdev, info->in);
1458 dev->out = usb_sndbulkpipe (xdev, info->out);
1459 if (!(info->flags & FLAG_NO_SETINT))
1460 status = usb_set_interface (xdev,
1461 interface->desc.bInterfaceNumber,
1462 interface->desc.bAlternateSetting);
1467 if (status >= 0 && dev->status)
1468 status = init_status (dev, udev);
1472 if (!dev->rx_urb_size)
1473 dev->rx_urb_size = dev->hard_mtu;
1474 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1476 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1477 SET_NETDEV_DEVTYPE(net, &wlan_type);
1478 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1479 SET_NETDEV_DEVTYPE(net, &wwan_type);
1481 status = register_netdev (net);
1484 netif_info(dev, probe, dev->net,
1485 "register '%s' at usb-%s-%s, %s, %pM\n",
1486 udev->dev.driver->name,
1487 xdev->bus->bus_name, xdev->devpath,
1488 dev->driver_info->description,
1491 // ok, it's ready to go.
1492 usb_set_intfdata (udev, dev);
1494 netif_device_attach (net);
1496 if (dev->driver_info->flags & FLAG_LINK_INTR)
1497 netif_carrier_off(net);
1502 usb_free_urb(dev->interrupt);
1505 info->unbind (dev, udev);
1511 EXPORT_SYMBOL_GPL(usbnet_probe);
1513 /*-------------------------------------------------------------------------*/
1516 * suspend the whole driver as soon as the first interface is suspended
1517 * resume only when the last interface is resumed
1520 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1522 struct usbnet *dev = usb_get_intfdata(intf);
1524 if (!dev->suspend_count++) {
1525 spin_lock_irq(&dev->txq.lock);
1526 /* don't autosuspend while transmitting */
1527 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1528 dev->suspend_count--;
1529 spin_unlock_irq(&dev->txq.lock);
1532 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1533 spin_unlock_irq(&dev->txq.lock);
1536 * accelerate emptying of the rx and queues, to avoid
1537 * having everything error out.
1539 netif_device_detach (dev->net);
1540 usbnet_terminate_urbs(dev);
1541 usb_kill_urb(dev->interrupt);
1544 * reattach so runtime management can use and
1547 netif_device_attach (dev->net);
1551 EXPORT_SYMBOL_GPL(usbnet_suspend);
1553 int usbnet_resume (struct usb_interface *intf)
1555 struct usbnet *dev = usb_get_intfdata(intf);
1556 struct sk_buff *skb;
1560 if (!--dev->suspend_count) {
1561 /* resume interrupt URBs */
1562 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1563 usb_submit_urb(dev->interrupt, GFP_NOIO);
1565 spin_lock_irq(&dev->txq.lock);
1566 while ((res = usb_get_from_anchor(&dev->deferred))) {
1568 skb = (struct sk_buff *)res->context;
1569 retval = usb_submit_urb(res, GFP_ATOMIC);
1571 dev_kfree_skb_any(skb);
1573 usb_autopm_put_interface_async(dev->intf);
1575 dev->net->trans_start = jiffies;
1576 __skb_queue_tail(&dev->txq, skb);
1581 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1582 spin_unlock_irq(&dev->txq.lock);
1584 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1585 /* handle remote wakeup ASAP */
1587 netif_device_present(dev->net) &&
1588 !timer_pending(&dev->delay) &&
1589 !test_bit(EVENT_RX_HALT, &dev->flags))
1590 rx_alloc_submit(dev, GFP_NOIO);
1592 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1593 netif_tx_wake_all_queues(dev->net);
1594 tasklet_schedule (&dev->bh);
1598 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1599 usb_autopm_get_interface_no_resume(intf);
1603 EXPORT_SYMBOL_GPL(usbnet_resume);
1606 * Either a subdriver implements manage_power, then it is assumed to always
1607 * be ready to be suspended or it reports the readiness to be suspended
1610 void usbnet_device_suggests_idle(struct usbnet *dev)
1612 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1613 dev->intf->needs_remote_wakeup = 1;
1614 usb_autopm_put_interface_async(dev->intf);
1617 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1620 * For devices that can do without special commands
1622 int usbnet_manage_power(struct usbnet *dev, int on)
1624 dev->intf->needs_remote_wakeup = on;
1627 EXPORT_SYMBOL(usbnet_manage_power);
1629 /*-------------------------------------------------------------------------*/
1630 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1631 u16 value, u16 index, void *data, u16 size)
1636 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1637 " value=0x%04x index=0x%04x size=%d\n",
1638 cmd, reqtype, value, index, size);
1641 buf = kmalloc(size, GFP_KERNEL);
1646 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1647 cmd, reqtype, value, index, buf, size,
1648 USB_CTRL_GET_TIMEOUT);
1649 if (err > 0 && err <= size)
1650 memcpy(data, buf, err);
1656 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1657 u16 value, u16 index, const void *data,
1663 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1664 " value=0x%04x index=0x%04x size=%d\n",
1665 cmd, reqtype, value, index, size);
1668 buf = kmemdup(data, size, GFP_KERNEL);
1673 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1674 cmd, reqtype, value, index, buf, size,
1675 USB_CTRL_SET_TIMEOUT);
1683 * The function can't be called inside suspend/resume callback,
1684 * otherwise deadlock will be caused.
1686 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1687 u16 value, u16 index, void *data, u16 size)
1691 if (usb_autopm_get_interface(dev->intf) < 0)
1693 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1695 usb_autopm_put_interface(dev->intf);
1698 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
1701 * The function can't be called inside suspend/resume callback,
1702 * otherwise deadlock will be caused.
1704 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1705 u16 value, u16 index, const void *data, u16 size)
1709 if (usb_autopm_get_interface(dev->intf) < 0)
1711 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1713 usb_autopm_put_interface(dev->intf);
1716 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
1719 * The function can be called inside suspend/resume callback safely
1720 * and should only be called by suspend/resume callback generally.
1722 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1723 u16 value, u16 index, void *data, u16 size)
1725 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1728 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
1731 * The function can be called inside suspend/resume callback safely
1732 * and should only be called by suspend/resume callback generally.
1734 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1735 u16 value, u16 index, const void *data,
1738 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1741 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
1743 static void usbnet_async_cmd_cb(struct urb *urb)
1745 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
1746 int status = urb->status;
1749 dev_dbg(&urb->dev->dev, "%s failed with %d",
1757 * The caller must make sure that device can't be put into suspend
1758 * state until the control URB completes.
1760 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
1761 u16 value, u16 index, const void *data, u16 size)
1763 struct usb_ctrlrequest *req = NULL;
1768 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1769 " value=0x%04x index=0x%04x size=%d\n",
1770 cmd, reqtype, value, index, size);
1772 urb = usb_alloc_urb(0, GFP_ATOMIC);
1774 netdev_err(dev->net, "Error allocating URB in"
1775 " %s!\n", __func__);
1780 buf = kmemdup(data, size, GFP_ATOMIC);
1782 netdev_err(dev->net, "Error allocating buffer"
1783 " in %s!\n", __func__);
1788 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
1790 netdev_err(dev->net, "Failed to allocate memory for %s\n",
1795 req->bRequestType = reqtype;
1796 req->bRequest = cmd;
1797 req->wValue = cpu_to_le16(value);
1798 req->wIndex = cpu_to_le16(index);
1799 req->wLength = cpu_to_le16(size);
1801 usb_fill_control_urb(urb, dev->udev,
1802 usb_sndctrlpipe(dev->udev, 0),
1803 (void *)req, buf, size,
1804 usbnet_async_cmd_cb, req);
1805 urb->transfer_flags |= URB_FREE_BUFFER;
1807 err = usb_submit_urb(urb, GFP_ATOMIC);
1809 netdev_err(dev->net, "Error submitting the control"
1810 " message: status=%d\n", err);
1824 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
1825 /*-------------------------------------------------------------------------*/
1827 static int __init usbnet_init(void)
1829 /* Compiler should optimize this out. */
1831 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1833 eth_random_addr(node_id);
1836 module_init(usbnet_init);
1838 static void __exit usbnet_exit(void)
1841 module_exit(usbnet_exit);
1843 MODULE_AUTHOR("David Brownell");
1844 MODULE_DESCRIPTION("USB network driver framework");
1845 MODULE_LICENSE("GPL");