Pileus Git - ~andy/linux/blob - drivers/net/usb/usbnet.c

   1 /*
   2  * USB Network driver infrastructure
   3  * Copyright (C) 2000-2005 by David Brownell
   4  * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
   5  *
   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.
  10  *
  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.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /*
  21  * This is a generic "USB networking" framework that works with several
  22  * kinds of full and high speed networking devices:  host-to-host cables,
  23  * smart usb peripherals, and actual Ethernet adapters.
  24  *
  25  * These devices usually differ in terms of control protocols (if they
  26  * even have one!) and sometimes they define new framing to wrap or batch
  27  * Ethernet packets.  Otherwise, they talk to USB pretty much the same,
  28  * so interface (un)binding, endpoint I/O queues, fault handling, and other
  29  * issues can usefully be addressed by this framework.
  30  */
  31
  32 // #define      DEBUG                   // error path messages, extra info
  33 // #define      VERBOSE                 // more; success messages
  34
  35 #include <linux/module.h>
  36 #include <linux/init.h>
  37 #include <linux/netdevice.h>
  38 #include <linux/etherdevice.h>
  39 #include <linux/ctype.h>
  40 #include <linux/ethtool.h>
  41 #include <linux/workqueue.h>
  42 #include <linux/mii.h>
  43 #include <linux/usb.h>
  44 #include <linux/usb/usbnet.h>
  45 #include <linux/slab.h>
  46 #include <linux/kernel.h>
  47 #include <linux/pm_runtime.h>
  48
  49 #define DRIVER_VERSION          "22-Aug-2005"
  50
  51
  52 /*-------------------------------------------------------------------------*/
  53
  54 /*
  55  * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
  56  * Several dozen bytes of IPv4 data can fit in two such transactions.
  57  * One maximum size Ethernet packet takes twenty four of them.
  58  * For high speed, each frame comfortably fits almost 36 max size
  59  * Ethernet packets (so queues should be bigger).
  60  *
  61  * The goal is to let the USB host controller be busy for 5msec or
  62  * more before an irq is required, under load.  Jumbograms change
  63  * the equation.
  64  */
  65 #define MAX_QUEUE_MEMORY        (60 * 1518)
  66 #define RX_QLEN(dev)            ((dev)->rx_qlen)
  67 #define TX_QLEN(dev)            ((dev)->tx_qlen)
  68
  69 // reawaken network queue this soon after stopping; else watchdog barks
  70 #define TX_TIMEOUT_JIFFIES      (5*HZ)
  71
  72 // throttle rx/tx briefly after some faults, so khubd might disconnect()
  73 // us (it polls at HZ/4 usually) before we report too many false errors.
  74 #define THROTTLE_JIFFIES        (HZ/8)
  75
  76 // between wakeups
  77 #define UNLINK_TIMEOUT_MS       3
  78
  79 /*-------------------------------------------------------------------------*/
  80
  81 // randomly generated ethernet address
  82 static u8       node_id [ETH_ALEN];
  83
  84 static const char driver_name [] = "usbnet";
  85
  86 /* use ethtool to change the level for any given device */
  87 static int msg_level = -1;
  88 module_param (msg_level, int, 0);
  89 MODULE_PARM_DESC (msg_level, "Override default message level");
  90
  91 /*-------------------------------------------------------------------------*/
  92
  93 /* handles CDC Ethernet and many other network "bulk data" interfaces */
  94 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
  95 {
  96         int                             tmp;
  97         struct usb_host_interface       *alt = NULL;
  98         struct usb_host_endpoint        *in = NULL, *out = NULL;
  99         struct usb_host_endpoint        *status = NULL;
 100
 101         for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
 102                 unsigned        ep;
 103
 104                 in = out = status = NULL;
 105                 alt = intf->altsetting + tmp;
 106
 107                 /* take the first altsetting with in-bulk + out-bulk;
 108                  * remember any status endpoint, just in case;
 109                  * ignore other endpoints and altsettings.
 110                  */
 111                 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
 112                         struct usb_host_endpoint        *e;
 113                         int                             intr = 0;
 114
 115                         e = alt->endpoint + ep;
 116                         switch (e->desc.bmAttributes) {
 117                         case USB_ENDPOINT_XFER_INT:
 118                                 if (!usb_endpoint_dir_in(&e->desc))
 119                                         continue;
 120                                 intr = 1;
 121                                 /* FALLTHROUGH */
 122                         case USB_ENDPOINT_XFER_BULK:
 123                                 break;
 124                         default:
 125                                 continue;
 126                         }
 127                         if (usb_endpoint_dir_in(&e->desc)) {
 128                                 if (!intr && !in)
 129                                         in = e;
 130                                 else if (intr && !status)
 131                                         status = e;
 132                         } else {
 133                                 if (!out)
 134                                         out = e;
 135                         }
 136                 }
 137                 if (in && out)
 138                         break;
 139         }
 140         if (!alt || !in || !out)
 141                 return -EINVAL;
 142
 143         if (alt->desc.bAlternateSetting != 0 ||
 144             !(dev->driver_info->flags & FLAG_NO_SETINT)) {
 145                 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
 146                                 alt->desc.bAlternateSetting);
 147                 if (tmp < 0)
 148                         return tmp;
 149         }
 150
 151         dev->in = usb_rcvbulkpipe (dev->udev,
 152                         in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 153         dev->out = usb_sndbulkpipe (dev->udev,
 154                         out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 155         dev->status = status;
 156         return 0;
 157 }
 158 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
 159
 160 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
 161 {
 162         int             tmp, i;
 163         unsigned char   buf [13];
 164
 165         tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
 166         if (tmp != 12) {
 167                 dev_dbg(&dev->udev->dev,
 168                         "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
 169                 if (tmp >= 0)
 170                         tmp = -EINVAL;
 171                 return tmp;
 172         }
 173         for (i = tmp = 0; i < 6; i++, tmp += 2)
 174                 dev->net->dev_addr [i] =
 175                         (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
 176         return 0;
 177 }
 178 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
 179
 180 static void intr_complete (struct urb *urb)
 181 {
 182         struct usbnet   *dev = urb->context;
 183         int             status = urb->status;
 184
 185         switch (status) {
 186         /* success */
 187         case 0:
 188                 dev->driver_info->status(dev, urb);
 189                 break;
 190
 191         /* software-driven interface shutdown */
 192         case -ENOENT:           /* urb killed */
 193         case -ESHUTDOWN:        /* hardware gone */
 194                 netif_dbg(dev, ifdown, dev->net,
 195                           "intr shutdown, code %d\n", status);
 196                 return;
 197
 198         /* NOTE:  not throttling like RX/TX, since this endpoint
 199          * already polls infrequently
 200          */
 201         default:
 202                 netdev_dbg(dev->net, "intr status %d\n", status);
 203                 break;
 204         }
 205
 206         status = usb_submit_urb (urb, GFP_ATOMIC);
 207         if (status != 0)
 208                 netif_err(dev, timer, dev->net,
 209                           "intr resubmit --> %d\n", status);
 210 }
 211
 212 static int init_status (struct usbnet *dev, struct usb_interface *intf)
 213 {
 214         char            *buf = NULL;
 215         unsigned        pipe = 0;
 216         unsigned        maxp;
 217         unsigned        period;
 218
 219         if (!dev->driver_info->status)
 220                 return 0;
 221
 222         pipe = usb_rcvintpipe (dev->udev,
 223                         dev->status->desc.bEndpointAddress
 224                                 & USB_ENDPOINT_NUMBER_MASK);
 225         maxp = usb_maxpacket (dev->udev, pipe, 0);
 226
 227         /* avoid 1 msec chatter:  min 8 msec poll rate */
 228         period = max ((int) dev->status->desc.bInterval,
 229                 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
 230
 231         buf = kmalloc (maxp, GFP_KERNEL);
 232         if (buf) {
 233                 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
 234                 if (!dev->interrupt) {
 235                         kfree (buf);
 236                         return -ENOMEM;
 237                 } else {
 238                         usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
 239                                 buf, maxp, intr_complete, dev, period);
 240                         dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
 241                         dev_dbg(&intf->dev,
 242                                 "status ep%din, %d bytes period %d\n",
 243                                 usb_pipeendpoint(pipe), maxp, period);
 244                 }
 245         }
 246         return 0;
 247 }
 248
 249 /* Submit the interrupt URB if not previously submitted, increasing refcount */
 250 int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
 251 {
 252         int ret = 0;
 253
 254         WARN_ON_ONCE(dev->interrupt == NULL);
 255         if (dev->interrupt) {
 256                 mutex_lock(&dev->interrupt_mutex);
 257
 258                 if (++dev->interrupt_count == 1)
 259                         ret = usb_submit_urb(dev->interrupt, mem_flags);
 260
 261                 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
 262                         dev->interrupt_count);
 263                 mutex_unlock(&dev->interrupt_mutex);
 264         }
 265         return ret;
 266 }
 267 EXPORT_SYMBOL_GPL(usbnet_status_start);
 268
 269 /* For resume; submit interrupt URB if previously submitted */
 270 static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
 271 {
 272         int ret = 0;
 273
 274         mutex_lock(&dev->interrupt_mutex);
 275         if (dev->interrupt_count) {
 276                 ret = usb_submit_urb(dev->interrupt, mem_flags);
 277                 dev_dbg(&dev->udev->dev,
 278                         "submitted interrupt URB for resume\n");
 279         }
 280         mutex_unlock(&dev->interrupt_mutex);
 281         return ret;
 282 }
 283
 284 /* Kill the interrupt URB if all submitters want it killed */
 285 void usbnet_status_stop(struct usbnet *dev)
 286 {
 287         if (dev->interrupt) {
 288                 mutex_lock(&dev->interrupt_mutex);
 289                 WARN_ON(dev->interrupt_count == 0);
 290
 291                 if (dev->interrupt_count && --dev->interrupt_count == 0)
 292                         usb_kill_urb(dev->interrupt);
 293
 294                 dev_dbg(&dev->udev->dev,
 295                         "decremented interrupt URB count to %d\n",
 296                         dev->interrupt_count);
 297                 mutex_unlock(&dev->interrupt_mutex);
 298         }
 299 }
 300 EXPORT_SYMBOL_GPL(usbnet_status_stop);
 301
 302 /* For suspend; always kill interrupt URB */
 303 static void __usbnet_status_stop_force(struct usbnet *dev)
 304 {
 305         if (dev->interrupt) {
 306                 mutex_lock(&dev->interrupt_mutex);
 307                 usb_kill_urb(dev->interrupt);
 308                 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
 309                 mutex_unlock(&dev->interrupt_mutex);
 310         }
 311 }
 312
 313 /* Passes this packet up the stack, updating its accounting.
 314  * Some link protocols batch packets, so their rx_fixup paths
 315  * can return clones as well as just modify the original skb.
 316  */
 317 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
 318 {
 319         int     status;
 320
 321         if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
 322                 skb_queue_tail(&dev->rxq_pause, skb);
 323                 return;
 324         }
 325
 326         skb->protocol = eth_type_trans (skb, dev->net);
 327         dev->net->stats.rx_packets++;
 328         dev->net->stats.rx_bytes += skb->len;
 329
 330         netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
 331                   skb->len + sizeof (struct ethhdr), skb->protocol);
 332         memset (skb->cb, 0, sizeof (struct skb_data));
 333
 334         if (skb_defer_rx_timestamp(skb))
 335                 return;
 336
 337         status = netif_rx (skb);
 338         if (status != NET_RX_SUCCESS)
 339                 netif_dbg(dev, rx_err, dev->net,
 340                           "netif_rx status %d\n", status);
 341 }
 342 EXPORT_SYMBOL_GPL(usbnet_skb_return);
 343
 344 /* must be called if hard_mtu or rx_urb_size changed */
 345 void usbnet_update_max_qlen(struct usbnet *dev)
 346 {
 347         enum usb_device_speed speed = dev->udev->speed;
 348
 349         switch (speed) {
 350         case USB_SPEED_HIGH:
 351                 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
 352                 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
 353                 break;
 354         case USB_SPEED_SUPER:
 355                 /*
 356                  * Not take default 5ms qlen for super speed HC to
 357                  * save memory, and iperf tests show 2.5ms qlen can
 358                  * work well
 359                  */
 360                 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
 361                 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
 362                 break;
 363         default:
 364                 dev->rx_qlen = dev->tx_qlen = 4;
 365         }
 366 }
 367 EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
 368
 369 \f
 370 /*-------------------------------------------------------------------------
 371  *
 372  * Network Device Driver (peer link to "Host Device", from USB host)
 373  *
 374  *-------------------------------------------------------------------------*/
 375
 376 int usbnet_change_mtu (struct net_device *net, int new_mtu)
 377 {
 378         struct usbnet   *dev = netdev_priv(net);
 379         int             ll_mtu = new_mtu + net->hard_header_len;
 380         int             old_hard_mtu = dev->hard_mtu;
 381         int             old_rx_urb_size = dev->rx_urb_size;
 382
 383         if (new_mtu <= 0)
 384                 return -EINVAL;
 385         // no second zero-length packet read wanted after mtu-sized packets
 386         if ((ll_mtu % dev->maxpacket) == 0)
 387                 return -EDOM;
 388         net->mtu = new_mtu;
 389
 390         dev->hard_mtu = net->mtu + net->hard_header_len;
 391         if (dev->rx_urb_size == old_hard_mtu) {
 392                 dev->rx_urb_size = dev->hard_mtu;
 393                 if (dev->rx_urb_size > old_rx_urb_size)
 394                         usbnet_unlink_rx_urbs(dev);
 395         }
 396
 397         /* max qlen depend on hard_mtu and rx_urb_size */
 398         usbnet_update_max_qlen(dev);
 399
 400         return 0;
 401 }
 402 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
 403
 404 /* The caller must hold list->lock */
 405 static void __usbnet_queue_skb(struct sk_buff_head *list,
 406                         struct sk_buff *newsk, enum skb_state state)
 407 {
 408         struct skb_data *entry = (struct skb_data *) newsk->cb;
 409
 410         __skb_queue_tail(list, newsk);
 411         entry->state = state;
 412 }
 413
 414 /*-------------------------------------------------------------------------*/
 415
 416 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
 417  * completion callbacks.  2.5 should have fixed those bugs...
 418  */
 419
 420 static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
 421                 struct sk_buff_head *list, enum skb_state state)
 422 {
 423         unsigned long           flags;
 424         enum skb_state          old_state;
 425         struct skb_data *entry = (struct skb_data *) skb->cb;
 426
 427         spin_lock_irqsave(&list->lock, flags);
 428         old_state = entry->state;
 429         entry->state = state;
 430         __skb_unlink(skb, list);
 431         spin_unlock(&list->lock);
 432         spin_lock(&dev->done.lock);
 433         __skb_queue_tail(&dev->done, skb);
 434         if (dev->done.qlen == 1)
 435                 tasklet_schedule(&dev->bh);
 436         spin_unlock_irqrestore(&dev->done.lock, flags);
 437         return old_state;
 438 }
 439
 440 /* some work can't be done in tasklets, so we use keventd
 441  *
 442  * NOTE:  annoying asymmetry:  if it's active, schedule_work() fails,
 443  * but tasklet_schedule() doesn't.  hope the failure is rare.
 444  */
 445 void usbnet_defer_kevent (struct usbnet *dev, int work)
 446 {
 447         set_bit (work, &dev->flags);
 448         if (!schedule_work (&dev->kevent)) {
 449                 if (net_ratelimit())
 450                         netdev_err(dev->net, "kevent %d may have been dropped\n", work);
 451         } else {
 452                 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
 453         }
 454 }
 455 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
 456
 457 /*-------------------------------------------------------------------------*/
 458
 459 static void rx_complete (struct urb *urb);
 460
 461 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
 462 {
 463         struct sk_buff          *skb;
 464         struct skb_data         *entry;
 465         int                     retval = 0;
 466         unsigned long           lockflags;
 467         size_t                  size = dev->rx_urb_size;
 468
 469         /* prevent rx skb allocation when error ratio is high */
 470         if (test_bit(EVENT_RX_KILL, &dev->flags)) {
 471                 usb_free_urb(urb);
 472                 return -ENOLINK;
 473         }
 474
 475         skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
 476         if (!skb) {
 477                 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
 478                 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
 479                 usb_free_urb (urb);
 480                 return -ENOMEM;
 481         }
 482
 483         entry = (struct skb_data *) skb->cb;
 484         entry->urb = urb;
 485         entry->dev = dev;
 486         entry->length = 0;
 487
 488         usb_fill_bulk_urb (urb, dev->udev, dev->in,
 489                 skb->data, size, rx_complete, skb);
 490
 491         spin_lock_irqsave (&dev->rxq.lock, lockflags);
 492
 493         if (netif_running (dev->net) &&
 494             netif_device_present (dev->net) &&
 495             !test_bit (EVENT_RX_HALT, &dev->flags) &&
 496             !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
 497                 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
 498                 case -EPIPE:
 499                         usbnet_defer_kevent (dev, EVENT_RX_HALT);
 500                         break;
 501                 case -ENOMEM:
 502                         usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
 503                         break;
 504                 case -ENODEV:
 505                         netif_dbg(dev, ifdown, dev->net, "device gone\n");
 506                         netif_device_detach (dev->net);
 507                         break;
 508                 case -EHOSTUNREACH:
 509                         retval = -ENOLINK;
 510                         break;
 511                 default:
 512                         netif_dbg(dev, rx_err, dev->net,
 513                                   "rx submit, %d\n", retval);
 514                         tasklet_schedule (&dev->bh);
 515                         break;
 516                 case 0:
 517                         __usbnet_queue_skb(&dev->rxq, skb, rx_start);
 518                 }
 519         } else {
 520                 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
 521                 retval = -ENOLINK;
 522         }
 523         spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
 524         if (retval) {
 525                 dev_kfree_skb_any (skb);
 526                 usb_free_urb (urb);
 527         }
 528         return retval;
 529 }
 530
 531
 532 /*-------------------------------------------------------------------------*/
 533
 534 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
 535 {
 536         if (dev->driver_info->rx_fixup &&
 537             !dev->driver_info->rx_fixup (dev, skb)) {
 538                 /* With RX_ASSEMBLE, rx_fixup() must update counters */
 539                 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
 540                         dev->net->stats.rx_errors++;
 541                 goto done;
 542         }
 543         // else network stack removes extra byte if we forced a short packet
 544
 545         /* all data was already cloned from skb inside the driver */
 546         if (dev->driver_info->flags & FLAG_MULTI_PACKET)
 547                 goto done;
 548
 549         if (skb->len < ETH_HLEN) {
 550                 dev->net->stats.rx_errors++;
 551                 dev->net->stats.rx_length_errors++;
 552                 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
 553         } else {
 554                 usbnet_skb_return(dev, skb);
 555                 return;
 556         }
 557
 558 done:
 559         skb_queue_tail(&dev->done, skb);
 560 }
 561
 562 /*-------------------------------------------------------------------------*/
 563
 564 static void rx_complete (struct urb *urb)
 565 {
 566         struct sk_buff          *skb = (struct sk_buff *) urb->context;
 567         struct skb_data         *entry = (struct skb_data *) skb->cb;
 568         struct usbnet           *dev = entry->dev;
 569         int                     urb_status = urb->status;
 570         enum skb_state          state;
 571
 572         skb_put (skb, urb->actual_length);
 573         state = rx_done;
 574         entry->urb = NULL;
 575
 576         switch (urb_status) {
 577         /* success */
 578         case 0:
 579                 break;
 580
 581         /* stalls need manual reset. this is rare ... except that
 582          * when going through USB 2.0 TTs, unplug appears this way.
 583          * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
 584          * storm, recovering as needed.
 585          */
 586         case -EPIPE:
 587                 dev->net->stats.rx_errors++;
 588                 usbnet_defer_kevent (dev, EVENT_RX_HALT);
 589                 // FALLTHROUGH
 590
 591         /* software-driven interface shutdown */
 592         case -ECONNRESET:               /* async unlink */
 593         case -ESHUTDOWN:                /* hardware gone */
 594                 netif_dbg(dev, ifdown, dev->net,
 595                           "rx shutdown, code %d\n", urb_status);
 596                 goto block;
 597
 598         /* we get controller i/o faults during khubd disconnect() delays.
 599          * throttle down resubmits, to avoid log floods; just temporarily,
 600          * so we still recover when the fault isn't a khubd delay.
 601          */
 602         case -EPROTO:
 603         case -ETIME:
 604         case -EILSEQ:
 605                 dev->net->stats.rx_errors++;
 606                 if (!timer_pending (&dev->delay)) {
 607                         mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
 608                         netif_dbg(dev, link, dev->net,
 609                                   "rx throttle %d\n", urb_status);
 610                 }
 611 block:
 612                 state = rx_cleanup;
 613                 entry->urb = urb;
 614                 urb = NULL;
 615                 break;
 616
 617         /* data overrun ... flush fifo? */
 618         case -EOVERFLOW:
 619                 dev->net->stats.rx_over_errors++;
 620                 // FALLTHROUGH
 621
 622         default:
 623                 state = rx_cleanup;
 624                 dev->net->stats.rx_errors++;
 625                 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
 626                 break;
 627         }
 628
 629         /* stop rx if packet error rate is high */
 630         if (++dev->pkt_cnt > 30) {
 631                 dev->pkt_cnt = 0;
 632                 dev->pkt_err = 0;
 633         } else {
 634                 if (state == rx_cleanup)
 635                         dev->pkt_err++;
 636                 if (dev->pkt_err > 20)
 637                         set_bit(EVENT_RX_KILL, &dev->flags);
 638         }
 639
 640         state = defer_bh(dev, skb, &dev->rxq, state);
 641
 642         if (urb) {
 643                 if (netif_running (dev->net) &&
 644                     !test_bit (EVENT_RX_HALT, &dev->flags) &&
 645                     state != unlink_start) {
 646                         rx_submit (dev, urb, GFP_ATOMIC);
 647                         usb_mark_last_busy(dev->udev);
 648                         return;
 649                 }
 650                 usb_free_urb (urb);
 651         }
 652         netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
 653 }
 654
 655 /*-------------------------------------------------------------------------*/
 656 void usbnet_pause_rx(struct usbnet *dev)
 657 {
 658         set_bit(EVENT_RX_PAUSED, &dev->flags);
 659
 660         netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
 661 }
 662 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
 663
 664 void usbnet_resume_rx(struct usbnet *dev)
 665 {
 666         struct sk_buff *skb;
 667         int num = 0;
 668
 669         clear_bit(EVENT_RX_PAUSED, &dev->flags);
 670
 671         while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
 672                 usbnet_skb_return(dev, skb);
 673                 num++;
 674         }
 675
 676         tasklet_schedule(&dev->bh);
 677
 678         netif_dbg(dev, rx_status, dev->net,
 679                   "paused rx queue disabled, %d skbs requeued\n", num);
 680 }
 681 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
 682
 683 void usbnet_purge_paused_rxq(struct usbnet *dev)
 684 {
 685         skb_queue_purge(&dev->rxq_pause);
 686 }
 687 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
 688
 689 /*-------------------------------------------------------------------------*/
 690
 691 // unlink pending rx/tx; completion handlers do all other cleanup
 692
 693 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
 694 {
 695         unsigned long           flags;
 696         struct sk_buff          *skb;
 697         int                     count = 0;
 698
 699         spin_lock_irqsave (&q->lock, flags);
 700         while (!skb_queue_empty(q)) {
 701                 struct skb_data         *entry;
 702                 struct urb              *urb;
 703                 int                     retval;
 704
 705                 skb_queue_walk(q, skb) {
 706                         entry = (struct skb_data *) skb->cb;
 707                         if (entry->state != unlink_start)
 708                                 goto found;
 709                 }
 710                 break;
 711 found:
 712                 entry->state = unlink_start;
 713                 urb = entry->urb;
 714
 715                 /*
 716                  * Get reference count of the URB to avoid it to be
 717                  * freed during usb_unlink_urb, which may trigger
 718                  * use-after-free problem inside usb_unlink_urb since
 719                  * usb_unlink_urb is always racing with .complete
 720                  * handler(include defer_bh).
 721                  */
 722                 usb_get_urb(urb);
 723                 spin_unlock_irqrestore(&q->lock, flags);
 724                 // during some PM-driven resume scenarios,
 725                 // these (async) unlinks complete immediately
 726                 retval = usb_unlink_urb (urb);
 727                 if (retval != -EINPROGRESS && retval != 0)
 728                         netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
 729                 else
 730                         count++;
 731                 usb_put_urb(urb);
 732                 spin_lock_irqsave(&q->lock, flags);
 733         }
 734         spin_unlock_irqrestore (&q->lock, flags);
 735         return count;
 736 }
 737
 738 // Flush all pending rx urbs
 739 // minidrivers may need to do this when the MTU changes
 740
 741 void usbnet_unlink_rx_urbs(struct usbnet *dev)
 742 {
 743         if (netif_running(dev->net)) {
 744                 (void) unlink_urbs (dev, &dev->rxq);
 745                 tasklet_schedule(&dev->bh);
 746         }
 747 }
 748 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
 749
 750 /*-------------------------------------------------------------------------*/
 751
 752 // precondition: never called in_interrupt
 753 static void usbnet_terminate_urbs(struct usbnet *dev)
 754 {
 755         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
 756         DECLARE_WAITQUEUE(wait, current);
 757         int temp;
 758
 759         /* ensure there are no more active urbs */
 760         add_wait_queue(&unlink_wakeup, &wait);
 761         set_current_state(TASK_UNINTERRUPTIBLE);
 762         dev->wait = &unlink_wakeup;
 763         temp = unlink_urbs(dev, &dev->txq) +
 764                 unlink_urbs(dev, &dev->rxq);
 765
 766         /* maybe wait for deletions to finish. */
 767         while (!skb_queue_empty(&dev->rxq)
 768                 && !skb_queue_empty(&dev->txq)
 769                 && !skb_queue_empty(&dev->done)) {
 770                         schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
 771                         set_current_state(TASK_UNINTERRUPTIBLE);
 772                         netif_dbg(dev, ifdown, dev->net,
 773                                   "waited for %d urb completions\n", temp);
 774         }
 775         set_current_state(TASK_RUNNING);
 776         dev->wait = NULL;
 777         remove_wait_queue(&unlink_wakeup, &wait);
 778 }
 779
 780 int usbnet_stop (struct net_device *net)
 781 {
 782         struct usbnet           *dev = netdev_priv(net);
 783         struct driver_info      *info = dev->driver_info;
 784         int                     retval;
 785
 786         clear_bit(EVENT_DEV_OPEN, &dev->flags);
 787         netif_stop_queue (net);
 788
 789         netif_info(dev, ifdown, dev->net,
 790                    "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
 791                    net->stats.rx_packets, net->stats.tx_packets,
 792                    net->stats.rx_errors, net->stats.tx_errors);
 793
 794         /* allow minidriver to stop correctly (wireless devices to turn off
 795          * radio etc) */
 796         if (info->stop) {
 797                 retval = info->stop(dev);
 798                 if (retval < 0)
 799                         netif_info(dev, ifdown, dev->net,
 800                                    "stop fail (%d) usbnet usb-%s-%s, %s\n",
 801                                    retval,
 802                                    dev->udev->bus->bus_name, dev->udev->devpath,
 803                                    info->description);
 804         }
 805
 806         if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
 807                 usbnet_terminate_urbs(dev);
 808
 809         usbnet_status_stop(dev);
 810
 811         usbnet_purge_paused_rxq(dev);
 812
 813         /* deferred work (task, timer, softirq) must also stop.
 814          * can't flush_scheduled_work() until we drop rtnl (later),
 815          * else workers could deadlock; so make workers a NOP.
 816          */
 817         dev->flags = 0;
 818         del_timer_sync (&dev->delay);
 819         tasklet_kill (&dev->bh);
 820         if (info->manage_power &&
 821             !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags))
 822                 info->manage_power(dev, 0);
 823         else
 824                 usb_autopm_put_interface(dev->intf);
 825
 826         return 0;
 827 }
 828 EXPORT_SYMBOL_GPL(usbnet_stop);
 829
 830 /*-------------------------------------------------------------------------*/
 831
 832 // posts reads, and enables write queuing
 833
 834 // precondition: never called in_interrupt
 835
 836 int usbnet_open (struct net_device *net)
 837 {
 838         struct usbnet           *dev = netdev_priv(net);
 839         int                     retval;
 840         struct driver_info      *info = dev->driver_info;
 841
 842         if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
 843                 netif_info(dev, ifup, dev->net,
 844                            "resumption fail (%d) usbnet usb-%s-%s, %s\n",
 845                            retval,
 846                            dev->udev->bus->bus_name,
 847                            dev->udev->devpath,
 848                            info->description);
 849                 goto done_nopm;
 850         }
 851
 852         // put into "known safe" state
 853         if (info->reset && (retval = info->reset (dev)) < 0) {
 854                 netif_info(dev, ifup, dev->net,
 855                            "open reset fail (%d) usbnet usb-%s-%s, %s\n",
 856                            retval,
 857                            dev->udev->bus->bus_name,
 858                            dev->udev->devpath,
 859                            info->description);
 860                 goto done;
 861         }
 862
 863         /* hard_mtu or rx_urb_size may change in reset() */
 864         usbnet_update_max_qlen(dev);
 865
 866         // insist peer be connected
 867         if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
 868                 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
 869                 goto done;
 870         }
 871
 872         /* start any status interrupt transfer */
 873         if (dev->interrupt) {
 874                 retval = usbnet_status_start(dev, GFP_KERNEL);
 875                 if (retval < 0) {
 876                         netif_err(dev, ifup, dev->net,
 877                                   "intr submit %d\n", retval);
 878                         goto done;
 879                 }
 880         }
 881
 882         set_bit(EVENT_DEV_OPEN, &dev->flags);
 883         netif_start_queue (net);
 884         netif_info(dev, ifup, dev->net,
 885                    "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
 886                    (int)RX_QLEN(dev), (int)TX_QLEN(dev),
 887                    dev->net->mtu,
 888                    (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
 889                    (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
 890                    (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
 891                    (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
 892                    (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
 893                    "simple");
 894
 895         /* reset rx error state */
 896         dev->pkt_cnt = 0;
 897         dev->pkt_err = 0;
 898         clear_bit(EVENT_RX_KILL, &dev->flags);
 899
 900         // delay posting reads until we're fully open
 901         tasklet_schedule (&dev->bh);
 902         if (info->manage_power) {
 903                 retval = info->manage_power(dev, 1);
 904                 if (retval < 0) {
 905                         retval = 0;
 906                         set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
 907                 } else {
 908                         usb_autopm_put_interface(dev->intf);
 909                 }
 910         }
 911         return retval;
 912 done:
 913         usb_autopm_put_interface(dev->intf);
 914 done_nopm:
 915         return retval;
 916 }
 917 EXPORT_SYMBOL_GPL(usbnet_open);
 918
 919 /*-------------------------------------------------------------------------*/
 920
 921 /* ethtool methods; minidrivers may need to add some more, but
 922  * they'll probably want to use this base set.
 923  */
 924
 925 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
 926 {
 927         struct usbnet *dev = netdev_priv(net);
 928
 929         if (!dev->mii.mdio_read)
 930                 return -EOPNOTSUPP;
 931
 932         return mii_ethtool_gset(&dev->mii, cmd);
 933 }
 934 EXPORT_SYMBOL_GPL(usbnet_get_settings);
 935
 936 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
 937 {
 938         struct usbnet *dev = netdev_priv(net);
 939         int retval;
 940
 941         if (!dev->mii.mdio_write)
 942                 return -EOPNOTSUPP;
 943
 944         retval = mii_ethtool_sset(&dev->mii, cmd);
 945
 946         /* link speed/duplex might have changed */
 947         if (dev->driver_info->link_reset)
 948                 dev->driver_info->link_reset(dev);
 949
 950         /* hard_mtu or rx_urb_size may change in link_reset() */
 951         usbnet_update_max_qlen(dev);
 952
 953         return retval;
 954
 955 }
 956 EXPORT_SYMBOL_GPL(usbnet_set_settings);
 957
 958 u32 usbnet_get_link (struct net_device *net)
 959 {
 960         struct usbnet *dev = netdev_priv(net);
 961
 962         /* If a check_connect is defined, return its result */
 963         if (dev->driver_info->check_connect)
 964                 return dev->driver_info->check_connect (dev) == 0;
 965
 966         /* if the device has mii operations, use those */
 967         if (dev->mii.mdio_read)
 968                 return mii_link_ok(&dev->mii);
 969
 970         /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
 971         return ethtool_op_get_link(net);
 972 }
 973 EXPORT_SYMBOL_GPL(usbnet_get_link);
 974
 975 int usbnet_nway_reset(struct net_device *net)
 976 {
 977         struct usbnet *dev = netdev_priv(net);
 978
 979         if (!dev->mii.mdio_write)
 980                 return -EOPNOTSUPP;
 981
 982         return mii_nway_restart(&dev->mii);
 983 }
 984 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
 985
 986 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
 987 {
 988         struct usbnet *dev = netdev_priv(net);
 989
 990         strlcpy (info->driver, dev->driver_name, sizeof info->driver);
 991         strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
 992         strlcpy (info->fw_version, dev->driver_info->description,
 993                 sizeof info->fw_version);
 994         usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
 995 }
 996 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
 997
 998 u32 usbnet_get_msglevel (struct net_device *net)
 999 {
1000         struct usbnet *dev = netdev_priv(net);
1001
1002         return dev->msg_enable;
1003 }
1004 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1005
1006 void usbnet_set_msglevel (struct net_device *net, u32 level)
1007 {
1008         struct usbnet *dev = netdev_priv(net);
1009
1010         dev->msg_enable = level;
1011 }
1012 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1013
1014 /* drivers may override default ethtool_ops in their bind() routine */
1015 static const struct ethtool_ops usbnet_ethtool_ops = {
1016         .get_settings           = usbnet_get_settings,
1017         .set_settings           = usbnet_set_settings,
1018         .get_link               = usbnet_get_link,
1019         .nway_reset             = usbnet_nway_reset,
1020         .get_drvinfo            = usbnet_get_drvinfo,
1021         .get_msglevel           = usbnet_get_msglevel,
1022         .set_msglevel           = usbnet_set_msglevel,
1023         .get_ts_info            = ethtool_op_get_ts_info,
1024 };
1025
1026 /*-------------------------------------------------------------------------*/
1027
1028 static void __handle_link_change(struct usbnet *dev)
1029 {
1030         if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1031                 return;
1032
1033         if (!netif_carrier_ok(dev->net)) {
1034                 /* kill URBs for reading packets to save bus bandwidth */
1035                 unlink_urbs(dev, &dev->rxq);
1036
1037                 /*
1038                  * tx_timeout will unlink URBs for sending packets and
1039                  * tx queue is stopped by netcore after link becomes off
1040                  */
1041         } else {
1042                 /* submitting URBs for reading packets */
1043                 tasklet_schedule(&dev->bh);
1044         }
1045
1046         /* hard_mtu or rx_urb_size may change during link change */
1047         usbnet_update_max_qlen(dev);
1048
1049         clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1050 }
1051
1052 /* work that cannot be done in interrupt context uses keventd.
1053  *
1054  * NOTE:  with 2.5 we could do more of this using completion callbacks,
1055  * especially now that control transfers can be queued.
1056  */
1057 static void
1058 kevent (struct work_struct *work)
1059 {
1060         struct usbnet           *dev =
1061                 container_of(work, struct usbnet, kevent);
1062         int                     status;
1063
1064         /* usb_clear_halt() needs a thread context */
1065         if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1066                 unlink_urbs (dev, &dev->txq);
1067                 status = usb_autopm_get_interface(dev->intf);
1068                 if (status < 0)
1069                         goto fail_pipe;
1070                 status = usb_clear_halt (dev->udev, dev->out);
1071                 usb_autopm_put_interface(dev->intf);
1072                 if (status < 0 &&
1073                     status != -EPIPE &&
1074                     status != -ESHUTDOWN) {
1075                         if (netif_msg_tx_err (dev))
1076 fail_pipe:
1077                                 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1078                                            status);
1079                 } else {
1080                         clear_bit (EVENT_TX_HALT, &dev->flags);
1081                         if (status != -ESHUTDOWN)
1082                                 netif_wake_queue (dev->net);
1083                 }
1084         }
1085         if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1086                 unlink_urbs (dev, &dev->rxq);
1087                 status = usb_autopm_get_interface(dev->intf);
1088                 if (status < 0)
1089                         goto fail_halt;
1090                 status = usb_clear_halt (dev->udev, dev->in);
1091                 usb_autopm_put_interface(dev->intf);
1092                 if (status < 0 &&
1093                     status != -EPIPE &&
1094                     status != -ESHUTDOWN) {
1095                         if (netif_msg_rx_err (dev))
1096 fail_halt:
1097                                 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1098                                            status);
1099                 } else {
1100                         clear_bit (EVENT_RX_HALT, &dev->flags);
1101                         tasklet_schedule (&dev->bh);
1102                 }
1103         }
1104
1105         /* tasklet could resubmit itself forever if memory is tight */
1106         if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1107                 struct urb      *urb = NULL;
1108                 int resched = 1;
1109
1110                 if (netif_running (dev->net))
1111                         urb = usb_alloc_urb (0, GFP_KERNEL);
1112                 else
1113                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
1114                 if (urb != NULL) {
1115                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
1116                         status = usb_autopm_get_interface(dev->intf);
1117                         if (status < 0) {
1118                                 usb_free_urb(urb);
1119                                 goto fail_lowmem;
1120                         }
1121                         if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1122                                 resched = 0;
1123                         usb_autopm_put_interface(dev->intf);
1124 fail_lowmem:
1125                         if (resched)
1126                                 tasklet_schedule (&dev->bh);
1127                 }
1128         }
1129
1130         if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1131                 struct driver_info      *info = dev->driver_info;
1132                 int                     retval = 0;
1133
1134                 clear_bit (EVENT_LINK_RESET, &dev->flags);
1135                 status = usb_autopm_get_interface(dev->intf);
1136                 if (status < 0)
1137                         goto skip_reset;
1138                 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1139                         usb_autopm_put_interface(dev->intf);
1140 skip_reset:
1141                         netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1142                                     retval,
1143                                     dev->udev->bus->bus_name,
1144                                     dev->udev->devpath,
1145                                     info->description);
1146                 } else {
1147                         usb_autopm_put_interface(dev->intf);
1148                 }
1149
1150                 /* handle link change from link resetting */
1151                 __handle_link_change(dev);
1152         }
1153
1154         if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1155                 __handle_link_change(dev);
1156
1157         if (dev->flags)
1158                 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1159 }
1160
1161 /*-------------------------------------------------------------------------*/
1162
1163 static void tx_complete (struct urb *urb)
1164 {
1165         struct sk_buff          *skb = (struct sk_buff *) urb->context;
1166         struct skb_data         *entry = (struct skb_data *) skb->cb;
1167         struct usbnet           *dev = entry->dev;
1168
1169         if (urb->status == 0) {
1170                 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1171                         dev->net->stats.tx_packets++;
1172                 dev->net->stats.tx_bytes += entry->length;
1173         } else {
1174                 dev->net->stats.tx_errors++;
1175
1176                 switch (urb->status) {
1177                 case -EPIPE:
1178                         usbnet_defer_kevent (dev, EVENT_TX_HALT);
1179                         break;
1180
1181                 /* software-driven interface shutdown */
1182                 case -ECONNRESET:               // async unlink
1183                 case -ESHUTDOWN:                // hardware gone
1184                         break;
1185
1186                 // like rx, tx gets controller i/o faults during khubd delays
1187                 // and so it uses the same throttling mechanism.
1188                 case -EPROTO:
1189                 case -ETIME:
1190                 case -EILSEQ:
1191                         usb_mark_last_busy(dev->udev);
1192                         if (!timer_pending (&dev->delay)) {
1193                                 mod_timer (&dev->delay,
1194                                         jiffies + THROTTLE_JIFFIES);
1195                                 netif_dbg(dev, link, dev->net,
1196                                           "tx throttle %d\n", urb->status);
1197                         }
1198                         netif_stop_queue (dev->net);
1199                         break;
1200                 default:
1201                         netif_dbg(dev, tx_err, dev->net,
1202                                   "tx err %d\n", entry->urb->status);
1203                         break;
1204                 }
1205         }
1206
1207         usb_autopm_put_interface_async(dev->intf);
1208         (void) defer_bh(dev, skb, &dev->txq, tx_done);
1209 }
1210
1211 /*-------------------------------------------------------------------------*/
1212
1213 void usbnet_tx_timeout (struct net_device *net)
1214 {
1215         struct usbnet           *dev = netdev_priv(net);
1216
1217         unlink_urbs (dev, &dev->txq);
1218         tasklet_schedule (&dev->bh);
1219
1220         // FIXME: device recovery -- reset?
1221 }
1222 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1223
1224 /*-------------------------------------------------------------------------*/
1225
1226 static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1227 {
1228         unsigned num_sgs, total_len = 0;
1229         int i, s = 0;
1230
1231         num_sgs = skb_shinfo(skb)->nr_frags + 1;
1232         if (num_sgs == 1)
1233                 return 0;
1234
1235         /* reserve one for zero packet */
1236         urb->sg = kmalloc((num_sgs + 1) * sizeof(struct scatterlist),
1237                           GFP_ATOMIC);
1238         if (!urb->sg)
1239                 return -ENOMEM;
1240
1241         urb->num_sgs = num_sgs;
1242         sg_init_table(urb->sg, urb->num_sgs + 1);
1243
1244         sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1245         total_len += skb_headlen(skb);
1246
1247         for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1248                 struct skb_frag_struct *f = &skb_shinfo(skb)->frags[i];
1249
1250                 total_len += skb_frag_size(f);
1251                 sg_set_page(&urb->sg[i + s], f->page.p, f->size,
1252                                 f->page_offset);
1253         }
1254         urb->transfer_buffer_length = total_len;
1255
1256         return 1;
1257 }
1258
1259 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1260                                      struct net_device *net)
1261 {
1262         struct usbnet           *dev = netdev_priv(net);
1263         int                     length;
1264         struct urb              *urb = NULL;
1265         struct skb_data         *entry;
1266         struct driver_info      *info = dev->driver_info;
1267         unsigned long           flags;
1268         int retval;
1269
1270         if (skb)
1271                 skb_tx_timestamp(skb);
1272
1273         // some devices want funky USB-level framing, for
1274         // win32 driver (usually) and/or hardware quirks
1275         if (info->tx_fixup) {
1276                 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1277                 if (!skb) {
1278                         /* packet collected; minidriver waiting for more */
1279                         if (info->flags & FLAG_MULTI_PACKET)
1280                                 goto not_drop;
1281                         netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1282                         goto drop;
1283                 }
1284         }
1285
1286         if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1287                 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1288                 goto drop;
1289         }
1290
1291         entry = (struct skb_data *) skb->cb;
1292         entry->urb = urb;
1293         entry->dev = dev;
1294
1295         usb_fill_bulk_urb (urb, dev->udev, dev->out,
1296                         skb->data, skb->len, tx_complete, skb);
1297         if (dev->can_dma_sg) {
1298                 if (build_dma_sg(skb, urb) < 0)
1299                         goto drop;
1300         }
1301         length = urb->transfer_buffer_length;
1302
1303         /* don't assume the hardware handles USB_ZERO_PACKET
1304          * NOTE:  strictly conforming cdc-ether devices should expect
1305          * the ZLP here, but ignore the one-byte packet.
1306          * NOTE2: CDC NCM specification is different from CDC ECM when
1307          * handling ZLP/short packets, so cdc_ncm driver will make short
1308          * packet itself if needed.
1309          */
1310         if (length % dev->maxpacket == 0) {
1311                 if (!(info->flags & FLAG_SEND_ZLP)) {
1312                         if (!(info->flags & FLAG_MULTI_PACKET)) {
1313                                 length++;
1314                                 if (skb_tailroom(skb) && !urb->num_sgs) {
1315                                         skb->data[skb->len] = 0;
1316                                         __skb_put(skb, 1);
1317                                 } else if (urb->num_sgs)
1318                                         sg_set_buf(&urb->sg[urb->num_sgs++],
1319                                                         dev->padding_pkt, 1);
1320                         }
1321                 } else
1322                         urb->transfer_flags |= URB_ZERO_PACKET;
1323         }
1324         entry->length = urb->transfer_buffer_length = length;
1325
1326         spin_lock_irqsave(&dev->txq.lock, flags);
1327         retval = usb_autopm_get_interface_async(dev->intf);
1328         if (retval < 0) {
1329                 spin_unlock_irqrestore(&dev->txq.lock, flags);
1330                 goto drop;
1331         }
1332
1333 #ifdef CONFIG_PM
1334         /* if this triggers the device is still a sleep */
1335         if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1336                 /* transmission will be done in resume */
1337                 usb_anchor_urb(urb, &dev->deferred);
1338                 /* no use to process more packets */
1339                 netif_stop_queue(net);
1340                 usb_put_urb(urb);
1341                 spin_unlock_irqrestore(&dev->txq.lock, flags);
1342                 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1343                 goto deferred;
1344         }
1345 #endif
1346
1347         switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1348         case -EPIPE:
1349                 netif_stop_queue (net);
1350                 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1351                 usb_autopm_put_interface_async(dev->intf);
1352                 break;
1353         default:
1354                 usb_autopm_put_interface_async(dev->intf);
1355                 netif_dbg(dev, tx_err, dev->net,
1356                           "tx: submit urb err %d\n", retval);
1357                 break;
1358         case 0:
1359                 net->trans_start = jiffies;
1360                 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1361                 if (dev->txq.qlen >= TX_QLEN (dev))
1362                         netif_stop_queue (net);
1363         }
1364         spin_unlock_irqrestore (&dev->txq.lock, flags);
1365
1366         if (retval) {
1367                 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1368 drop:
1369                 dev->net->stats.tx_dropped++;
1370 not_drop:
1371                 if (skb)
1372                         dev_kfree_skb_any (skb);
1373                 if (urb) {
1374                         kfree(urb->sg);
1375                         usb_free_urb(urb);
1376                 }
1377         } else
1378                 netif_dbg(dev, tx_queued, dev->net,
1379                           "> tx, len %d, type 0x%x\n", length, skb->protocol);
1380 #ifdef CONFIG_PM
1381 deferred:
1382 #endif
1383         return NETDEV_TX_OK;
1384 }
1385 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1386
1387 static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1388 {
1389         struct urb      *urb;
1390         int             i;
1391         int             ret = 0;
1392
1393         /* don't refill the queue all at once */
1394         for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1395                 urb = usb_alloc_urb(0, flags);
1396                 if (urb != NULL) {
1397                         ret = rx_submit(dev, urb, flags);
1398                         if (ret)
1399                                 goto err;
1400                 } else {
1401                         ret = -ENOMEM;
1402                         goto err;
1403                 }
1404         }
1405 err:
1406         return ret;
1407 }
1408
1409 /*-------------------------------------------------------------------------*/
1410
1411 // tasklet (work deferred from completions, in_irq) or timer
1412
1413 static void usbnet_bh (unsigned long param)
1414 {
1415         struct usbnet           *dev = (struct usbnet *) param;
1416         struct sk_buff          *skb;
1417         struct skb_data         *entry;
1418
1419         while ((skb = skb_dequeue (&dev->done))) {
1420                 entry = (struct skb_data *) skb->cb;
1421                 switch (entry->state) {
1422                 case rx_done:
1423                         entry->state = rx_cleanup;
1424                         rx_process (dev, skb);
1425                         continue;
1426                 case tx_done:
1427                         kfree(entry->urb->sg);
1428                 case rx_cleanup:
1429                         usb_free_urb (entry->urb);
1430                         dev_kfree_skb (skb);
1431                         continue;
1432                 default:
1433                         netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1434                 }
1435         }
1436
1437         /* restart RX again after disabling due to high error rate */
1438         clear_bit(EVENT_RX_KILL, &dev->flags);
1439
1440         // waiting for all pending urbs to complete?
1441         if (dev->wait) {
1442                 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1443                         wake_up (dev->wait);
1444                 }
1445
1446         // or are we maybe short a few urbs?
1447         } else if (netif_running (dev->net) &&
1448                    netif_device_present (dev->net) &&
1449                    netif_carrier_ok(dev->net) &&
1450                    !timer_pending (&dev->delay) &&
1451                    !test_bit (EVENT_RX_HALT, &dev->flags)) {
1452                 int     temp = dev->rxq.qlen;
1453
1454                 if (temp < RX_QLEN(dev)) {
1455                         if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1456                                 return;
1457                         if (temp != dev->rxq.qlen)
1458                                 netif_dbg(dev, link, dev->net,
1459                                           "rxqlen %d --> %d\n",
1460                                           temp, dev->rxq.qlen);
1461                         if (dev->rxq.qlen < RX_QLEN(dev))
1462                                 tasklet_schedule (&dev->bh);
1463                 }
1464                 if (dev->txq.qlen < TX_QLEN (dev))
1465                         netif_wake_queue (dev->net);
1466         }
1467 }
1468
1469
1470 /*-------------------------------------------------------------------------
1471  *
1472  * USB Device Driver support
1473  *
1474  *-------------------------------------------------------------------------*/
1475
1476 // precondition: never called in_interrupt
1477
1478 void usbnet_disconnect (struct usb_interface *intf)
1479 {
1480         struct usbnet           *dev;
1481         struct usb_device       *xdev;
1482         struct net_device       *net;
1483
1484         dev = usb_get_intfdata(intf);
1485         usb_set_intfdata(intf, NULL);
1486         if (!dev)
1487                 return;
1488
1489         xdev = interface_to_usbdev (intf);
1490
1491         netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1492                    intf->dev.driver->name,
1493                    xdev->bus->bus_name, xdev->devpath,
1494                    dev->driver_info->description);
1495
1496         net = dev->net;
1497         unregister_netdev (net);
1498
1499         cancel_work_sync(&dev->kevent);
1500
1501         usb_scuttle_anchored_urbs(&dev->deferred);
1502
1503         if (dev->driver_info->unbind)
1504                 dev->driver_info->unbind (dev, intf);
1505
1506         usb_kill_urb(dev->interrupt);
1507         usb_free_urb(dev->interrupt);
1508         kfree(dev->padding_pkt);
1509
1510         free_netdev(net);
1511 }
1512 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1513
1514 static const struct net_device_ops usbnet_netdev_ops = {
1515         .ndo_open               = usbnet_open,
1516         .ndo_stop               = usbnet_stop,
1517         .ndo_start_xmit         = usbnet_start_xmit,
1518         .ndo_tx_timeout         = usbnet_tx_timeout,
1519         .ndo_change_mtu         = usbnet_change_mtu,
1520         .ndo_set_mac_address    = eth_mac_addr,
1521         .ndo_validate_addr      = eth_validate_addr,
1522 };
1523
1524 /*-------------------------------------------------------------------------*/
1525
1526 // precondition: never called in_interrupt
1527
1528 static struct device_type wlan_type = {
1529         .name   = "wlan",
1530 };
1531
1532 static struct device_type wwan_type = {
1533         .name   = "wwan",
1534 };
1535
1536 int
1537 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1538 {
1539         struct usbnet                   *dev;
1540         struct net_device               *net;
1541         struct usb_host_interface       *interface;
1542         struct driver_info              *info;
1543         struct usb_device               *xdev;
1544         int                             status;
1545         const char                      *name;
1546         struct usb_driver       *driver = to_usb_driver(udev->dev.driver);
1547
1548         /* usbnet already took usb runtime pm, so have to enable the feature
1549          * for usb interface, otherwise usb_autopm_get_interface may return
1550          * failure if RUNTIME_PM is enabled.
1551          */
1552         if (!driver->supports_autosuspend) {
1553                 driver->supports_autosuspend = 1;
1554                 pm_runtime_enable(&udev->dev);
1555         }
1556
1557         name = udev->dev.driver->name;
1558         info = (struct driver_info *) prod->driver_info;
1559         if (!info) {
1560                 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1561                 return -ENODEV;
1562         }
1563         xdev = interface_to_usbdev (udev);
1564         interface = udev->cur_altsetting;
1565
1566         status = -ENOMEM;
1567
1568         // set up our own records
1569         net = alloc_etherdev(sizeof(*dev));
1570         if (!net)
1571                 goto out;
1572
1573         /* netdev_printk() needs this so do it as early as possible */
1574         SET_NETDEV_DEV(net, &udev->dev);
1575
1576         dev = netdev_priv(net);
1577         dev->udev = xdev;
1578         dev->intf = udev;
1579         dev->driver_info = info;
1580         dev->driver_name = name;
1581         dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1582                                 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1583         skb_queue_head_init (&dev->rxq);
1584         skb_queue_head_init (&dev->txq);
1585         skb_queue_head_init (&dev->done);
1586         skb_queue_head_init(&dev->rxq_pause);
1587         dev->bh.func = usbnet_bh;
1588         dev->bh.data = (unsigned long) dev;
1589         INIT_WORK (&dev->kevent, kevent);
1590         init_usb_anchor(&dev->deferred);
1591         dev->delay.function = usbnet_bh;
1592         dev->delay.data = (unsigned long) dev;
1593         init_timer (&dev->delay);
1594         mutex_init (&dev->phy_mutex);
1595         mutex_init(&dev->interrupt_mutex);
1596         dev->interrupt_count = 0;
1597
1598         dev->net = net;
1599         strcpy (net->name, "usb%d");
1600         memcpy (net->dev_addr, node_id, sizeof node_id);
1601
1602         /* rx and tx sides can use different message sizes;
1603          * bind() should set rx_urb_size in that case.
1604          */
1605         dev->hard_mtu = net->mtu + net->hard_header_len;
1606 #if 0
1607 // dma_supported() is deeply broken on almost all architectures
1608         // possible with some EHCI controllers
1609         if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1610                 net->features |= NETIF_F_HIGHDMA;
1611 #endif
1612
1613         net->netdev_ops = &usbnet_netdev_ops;
1614         net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1615         net->ethtool_ops = &usbnet_ethtool_ops;
1616
1617         // allow device-specific bind/init procedures
1618         // NOTE net->name still not usable ...
1619         if (info->bind) {
1620                 status = info->bind (dev, udev);
1621                 if (status < 0)
1622                         goto out1;
1623
1624                 // heuristic:  "usb%d" for links we know are two-host,
1625                 // else "eth%d" when there's reasonable doubt.  userspace
1626                 // can rename the link if it knows better.
1627                 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1628                     ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1629                      (net->dev_addr [0] & 0x02) == 0))
1630                         strcpy (net->name, "eth%d");
1631                 /* WLAN devices should always be named "wlan%d" */
1632                 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1633                         strcpy(net->name, "wlan%d");
1634                 /* WWAN devices should always be named "wwan%d" */
1635                 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1636                         strcpy(net->name, "wwan%d");
1637
1638                 /* devices that cannot do ARP */
1639                 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1640                         net->flags |= IFF_NOARP;
1641
1642                 /* maybe the remote can't receive an Ethernet MTU */
1643                 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1644                         net->mtu = dev->hard_mtu - net->hard_header_len;
1645         } else if (!info->in || !info->out)
1646                 status = usbnet_get_endpoints (dev, udev);
1647         else {
1648                 dev->in = usb_rcvbulkpipe (xdev, info->in);
1649                 dev->out = usb_sndbulkpipe (xdev, info->out);
1650                 if (!(info->flags & FLAG_NO_SETINT))
1651                         status = usb_set_interface (xdev,
1652                                 interface->desc.bInterfaceNumber,
1653                                 interface->desc.bAlternateSetting);
1654                 else
1655                         status = 0;
1656
1657         }
1658         if (status >= 0 && dev->status)
1659                 status = init_status (dev, udev);
1660         if (status < 0)
1661                 goto out3;
1662
1663         if (!dev->rx_urb_size)
1664                 dev->rx_urb_size = dev->hard_mtu;
1665         dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1666
1667         /* let userspace know we have a random address */
1668         if (ether_addr_equal(net->dev_addr, node_id))
1669                 net->addr_assign_type = NET_ADDR_RANDOM;
1670
1671         if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1672                 SET_NETDEV_DEVTYPE(net, &wlan_type);
1673         if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1674                 SET_NETDEV_DEVTYPE(net, &wwan_type);
1675
1676         /* initialize max rx_qlen and tx_qlen */
1677         usbnet_update_max_qlen(dev);
1678
1679         if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1680                 !(info->flags & FLAG_MULTI_PACKET)) {
1681                 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1682                 if (!dev->padding_pkt) {
1683                         status = -ENOMEM;
1684                         goto out4;
1685                 }
1686         }
1687
1688         status = register_netdev (net);
1689         if (status)
1690                 goto out5;
1691         netif_info(dev, probe, dev->net,
1692                    "register '%s' at usb-%s-%s, %s, %pM\n",
1693                    udev->dev.driver->name,
1694                    xdev->bus->bus_name, xdev->devpath,
1695                    dev->driver_info->description,
1696                    net->dev_addr);
1697
1698         // ok, it's ready to go.
1699         usb_set_intfdata (udev, dev);
1700
1701         netif_device_attach (net);
1702
1703         if (dev->driver_info->flags & FLAG_LINK_INTR)
1704                 usbnet_link_change(dev, 0, 0);
1705
1706         return 0;
1707
1708 out5:
1709         kfree(dev->padding_pkt);
1710 out4:
1711         usb_free_urb(dev->interrupt);
1712 out3:
1713         if (info->unbind)
1714                 info->unbind (dev, udev);
1715 out1:
1716         free_netdev(net);
1717 out:
1718         return status;
1719 }
1720 EXPORT_SYMBOL_GPL(usbnet_probe);
1721
1722 /*-------------------------------------------------------------------------*/
1723
1724 /*
1725  * suspend the whole driver as soon as the first interface is suspended
1726  * resume only when the last interface is resumed
1727  */
1728
1729 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1730 {
1731         struct usbnet           *dev = usb_get_intfdata(intf);
1732
1733         if (!dev->suspend_count++) {
1734                 spin_lock_irq(&dev->txq.lock);
1735                 /* don't autosuspend while transmitting */
1736                 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1737                         dev->suspend_count--;
1738                         spin_unlock_irq(&dev->txq.lock);
1739                         return -EBUSY;
1740                 } else {
1741                         set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1742                         spin_unlock_irq(&dev->txq.lock);
1743                 }
1744                 /*
1745                  * accelerate emptying of the rx and queues, to avoid
1746                  * having everything error out.
1747                  */
1748                 netif_device_detach (dev->net);
1749                 usbnet_terminate_urbs(dev);
1750                 __usbnet_status_stop_force(dev);
1751
1752                 /*
1753                  * reattach so runtime management can use and
1754                  * wake the device
1755                  */
1756                 netif_device_attach (dev->net);
1757         }
1758         return 0;
1759 }
1760 EXPORT_SYMBOL_GPL(usbnet_suspend);
1761
1762 int usbnet_resume (struct usb_interface *intf)
1763 {
1764         struct usbnet           *dev = usb_get_intfdata(intf);
1765         struct sk_buff          *skb;
1766         struct urb              *res;
1767         int                     retval;
1768
1769         if (!--dev->suspend_count) {
1770                 /* resume interrupt URB if it was previously submitted */
1771                 __usbnet_status_start_force(dev, GFP_NOIO);
1772
1773                 spin_lock_irq(&dev->txq.lock);
1774                 while ((res = usb_get_from_anchor(&dev->deferred))) {
1775
1776                         skb = (struct sk_buff *)res->context;
1777                         retval = usb_submit_urb(res, GFP_ATOMIC);
1778                         if (retval < 0) {
1779                                 dev_kfree_skb_any(skb);
1780                                 kfree(res->sg);
1781                                 usb_free_urb(res);
1782                                 usb_autopm_put_interface_async(dev->intf);
1783                         } else {
1784                                 dev->net->trans_start = jiffies;
1785                                 __skb_queue_tail(&dev->txq, skb);
1786                         }
1787                 }
1788
1789                 smp_mb();
1790                 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1791                 spin_unlock_irq(&dev->txq.lock);
1792
1793                 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1794                         /* handle remote wakeup ASAP */
1795                         if (!dev->wait &&
1796                                 netif_device_present(dev->net) &&
1797                                 !timer_pending(&dev->delay) &&
1798                                 !test_bit(EVENT_RX_HALT, &dev->flags))
1799                                         rx_alloc_submit(dev, GFP_NOIO);
1800
1801                         if (!(dev->txq.qlen >= TX_QLEN(dev)))
1802                                 netif_tx_wake_all_queues(dev->net);
1803                         tasklet_schedule (&dev->bh);
1804                 }
1805         }
1806
1807         if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1808                 usb_autopm_get_interface_no_resume(intf);
1809
1810         return 0;
1811 }
1812 EXPORT_SYMBOL_GPL(usbnet_resume);
1813
1814 /*
1815  * Either a subdriver implements manage_power, then it is assumed to always
1816  * be ready to be suspended or it reports the readiness to be suspended
1817  * explicitly
1818  */
1819 void usbnet_device_suggests_idle(struct usbnet *dev)
1820 {
1821         if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1822                 dev->intf->needs_remote_wakeup = 1;
1823                 usb_autopm_put_interface_async(dev->intf);
1824         }
1825 }
1826 EXPORT_SYMBOL(usbnet_device_suggests_idle);
1827
1828 /*
1829  * For devices that can do without special commands
1830  */
1831 int usbnet_manage_power(struct usbnet *dev, int on)
1832 {
1833         dev->intf->needs_remote_wakeup = on;
1834         return 0;
1835 }
1836 EXPORT_SYMBOL(usbnet_manage_power);
1837
1838 void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1839 {
1840         /* update link after link is reseted */
1841         if (link && !need_reset)
1842                 netif_carrier_on(dev->net);
1843         else
1844                 netif_carrier_off(dev->net);
1845
1846         if (need_reset && link)
1847                 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1848         else
1849                 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1850 }
1851 EXPORT_SYMBOL(usbnet_link_change);
1852
1853 /*-------------------------------------------------------------------------*/
1854 static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1855                              u16 value, u16 index, void *data, u16 size)
1856 {
1857         void *buf = NULL;
1858         int err = -ENOMEM;
1859
1860         netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1861                    " value=0x%04x index=0x%04x size=%d\n",
1862                    cmd, reqtype, value, index, size);
1863
1864         if (data) {
1865                 buf = kmalloc(size, GFP_KERNEL);
1866                 if (!buf)
1867                         goto out;
1868         }
1869
1870         err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1871                               cmd, reqtype, value, index, buf, size,
1872                               USB_CTRL_GET_TIMEOUT);
1873         if (err > 0 && err <= size)
1874                 memcpy(data, buf, err);
1875         kfree(buf);
1876 out:
1877         return err;
1878 }
1879
1880 static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1881                               u16 value, u16 index, const void *data,
1882                               u16 size)
1883 {
1884         void *buf = NULL;
1885         int err = -ENOMEM;
1886
1887         netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1888                    " value=0x%04x index=0x%04x size=%d\n",
1889                    cmd, reqtype, value, index, size);
1890
1891         if (data) {
1892                 buf = kmemdup(data, size, GFP_KERNEL);
1893                 if (!buf)
1894                         goto out;
1895         }
1896
1897         err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1898                               cmd, reqtype, value, index, buf, size,
1899                               USB_CTRL_SET_TIMEOUT);
1900         kfree(buf);
1901
1902 out:
1903         return err;
1904 }
1905
1906 /*
1907  * The function can't be called inside suspend/resume callback,
1908  * otherwise deadlock will be caused.
1909  */
1910 int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1911                     u16 value, u16 index, void *data, u16 size)
1912 {
1913         int ret;
1914
1915         if (usb_autopm_get_interface(dev->intf) < 0)
1916                 return -ENODEV;
1917         ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1918                                 data, size);
1919         usb_autopm_put_interface(dev->intf);
1920         return ret;
1921 }
1922 EXPORT_SYMBOL_GPL(usbnet_read_cmd);
1923
1924 /*
1925  * The function can't be called inside suspend/resume callback,
1926  * otherwise deadlock will be caused.
1927  */
1928 int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1929                      u16 value, u16 index, const void *data, u16 size)
1930 {
1931         int ret;
1932
1933         if (usb_autopm_get_interface(dev->intf) < 0)
1934                 return -ENODEV;
1935         ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1936                                  data, size);
1937         usb_autopm_put_interface(dev->intf);
1938         return ret;
1939 }
1940 EXPORT_SYMBOL_GPL(usbnet_write_cmd);
1941
1942 /*
1943  * The function can be called inside suspend/resume callback safely
1944  * and should only be called by suspend/resume callback generally.
1945  */
1946 int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1947                           u16 value, u16 index, void *data, u16 size)
1948 {
1949         return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1950                                  data, size);
1951 }
1952 EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
1953
1954 /*
1955  * The function can be called inside suspend/resume callback safely
1956  * and should only be called by suspend/resume callback generally.
1957  */
1958 int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1959                           u16 value, u16 index, const void *data,
1960                           u16 size)
1961 {
1962         return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1963                                   data, size);
1964 }
1965 EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
1966
1967 static void usbnet_async_cmd_cb(struct urb *urb)
1968 {
1969         struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
1970         int status = urb->status;
1971
1972         if (status < 0)
1973                 dev_dbg(&urb->dev->dev, "%s failed with %d",
1974                         __func__, status);
1975
1976         kfree(req);
1977         usb_free_urb(urb);
1978 }
1979
1980 /*
1981  * The caller must make sure that device can't be put into suspend
1982  * state until the control URB completes.
1983  */
1984 int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
1985                            u16 value, u16 index, const void *data, u16 size)
1986 {
1987         struct usb_ctrlrequest *req = NULL;
1988         struct urb *urb;
1989         int err = -ENOMEM;
1990         void *buf = NULL;
1991
1992         netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1993                    " value=0x%04x index=0x%04x size=%d\n",
1994                    cmd, reqtype, value, index, size);
1995
1996         urb = usb_alloc_urb(0, GFP_ATOMIC);
1997         if (!urb) {
1998                 netdev_err(dev->net, "Error allocating URB in"
1999                            " %s!\n", __func__);
2000                 goto fail;
2001         }
2002
2003         if (data) {
2004                 buf = kmemdup(data, size, GFP_ATOMIC);
2005                 if (!buf) {
2006                         netdev_err(dev->net, "Error allocating buffer"
2007                                    " in %s!\n", __func__);
2008                         goto fail_free;
2009                 }
2010         }
2011
2012         req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2013         if (!req)
2014                 goto fail_free_buf;
2015
2016         req->bRequestType = reqtype;
2017         req->bRequest = cmd;
2018         req->wValue = cpu_to_le16(value);
2019         req->wIndex = cpu_to_le16(index);
2020         req->wLength = cpu_to_le16(size);
2021
2022         usb_fill_control_urb(urb, dev->udev,
2023                              usb_sndctrlpipe(dev->udev, 0),
2024                              (void *)req, buf, size,
2025                              usbnet_async_cmd_cb, req);
2026         urb->transfer_flags |= URB_FREE_BUFFER;
2027
2028         err = usb_submit_urb(urb, GFP_ATOMIC);
2029         if (err < 0) {
2030                 netdev_err(dev->net, "Error submitting the control"
2031                            " message: status=%d\n", err);
2032                 goto fail_free;
2033         }
2034         return 0;
2035
2036 fail_free_buf:
2037         kfree(buf);
2038 fail_free:
2039         kfree(req);
2040         usb_free_urb(urb);
2041 fail:
2042         return err;
2043
2044 }
2045 EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2046 /*-------------------------------------------------------------------------*/
2047
2048 static int __init usbnet_init(void)
2049 {
2050         /* Compiler should optimize this out. */
2051         BUILD_BUG_ON(
2052                 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
2053
2054         eth_random_addr(node_id);
2055         return 0;
2056 }
2057 module_init(usbnet_init);
2058
2059 static void __exit usbnet_exit(void)
2060 {
2061 }
2062 module_exit(usbnet_exit);
2063
2064 MODULE_AUTHOR("David Brownell");
2065 MODULE_DESCRIPTION("USB network driver framework");
2066 MODULE_LICENSE("GPL");