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, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 /*
  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.
  25  *
  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.
  31  */
  32
  33 // #define      DEBUG                   // error path messages, extra info
  34 // #define      VERBOSE                 // more; success messages
  35
  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>
  49
  50 #define DRIVER_VERSION          "22-Aug-2005"
  51
  52
  53 /*-------------------------------------------------------------------------*/
  54
  55 /*
  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).
  61  *
  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.
  65  */
  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)
  71
  72 // reawaken network queue this soon after stopping; else watchdog barks
  73 #define TX_TIMEOUT_JIFFIES      (5*HZ)
  74
  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)
  78
  79 // between wakeups
  80 #define UNLINK_TIMEOUT_MS       3
  81
  82 /*-------------------------------------------------------------------------*/
  83
  84 // randomly generated ethernet address
  85 static u8       node_id [ETH_ALEN];
  86
  87 static const char driver_name [] = "usbnet";
  88
  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");
  93
  94 /*-------------------------------------------------------------------------*/
  95
  96 /* handles CDC Ethernet and many other network "bulk data" interfaces */
  97 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
  98 {
  99         int                             tmp;
 100         struct usb_host_interface       *alt = NULL;
 101         struct usb_host_endpoint        *in = NULL, *out = NULL;
 102         struct usb_host_endpoint        *status = NULL;
 103
 104         for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
 105                 unsigned        ep;
 106
 107                 in = out = status = NULL;
 108                 alt = intf->altsetting + tmp;
 109
 110                 /* take the first altsetting with in-bulk + out-bulk;
 111                  * remember any status endpoint, just in case;
 112                  * ignore other endpoints and altsettings.
 113                  */
 114                 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
 115                         struct usb_host_endpoint        *e;
 116                         int                             intr = 0;
 117
 118                         e = alt->endpoint + ep;
 119                         switch (e->desc.bmAttributes) {
 120                         case USB_ENDPOINT_XFER_INT:
 121                                 if (!usb_endpoint_dir_in(&e->desc))
 122                                         continue;
 123                                 intr = 1;
 124                                 /* FALLTHROUGH */
 125                         case USB_ENDPOINT_XFER_BULK:
 126                                 break;
 127                         default:
 128                                 continue;
 129                         }
 130                         if (usb_endpoint_dir_in(&e->desc)) {
 131                                 if (!intr && !in)
 132                                         in = e;
 133                                 else if (intr && !status)
 134                                         status = e;
 135                         } else {
 136                                 if (!out)
 137                                         out = e;
 138                         }
 139                 }
 140                 if (in && out)
 141                         break;
 142         }
 143         if (!alt || !in || !out)
 144                 return -EINVAL;
 145
 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);
 150                 if (tmp < 0)
 151                         return tmp;
 152         }
 153
 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;
 159         return 0;
 160 }
 161 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
 162
 163 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
 164 {
 165         int             tmp, i;
 166         unsigned char   buf [13];
 167
 168         tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
 169         if (tmp != 12) {
 170                 dev_dbg(&dev->udev->dev,
 171                         "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
 172                 if (tmp >= 0)
 173                         tmp = -EINVAL;
 174                 return tmp;
 175         }
 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]);
 179         return 0;
 180 }
 181 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
 182
 183 static void intr_complete (struct urb *urb);
 184
 185 static int init_status (struct usbnet *dev, struct usb_interface *intf)
 186 {
 187         char            *buf = NULL;
 188         unsigned        pipe = 0;
 189         unsigned        maxp;
 190         unsigned        period;
 191
 192         if (!dev->driver_info->status)
 193                 return 0;
 194
 195         pipe = usb_rcvintpipe (dev->udev,
 196                         dev->status->desc.bEndpointAddress
 197                                 & USB_ENDPOINT_NUMBER_MASK);
 198         maxp = usb_maxpacket (dev->udev, pipe, 0);
 199
 200         /* avoid 1 msec chatter:  min 8 msec poll rate */
 201         period = max ((int) dev->status->desc.bInterval,
 202                 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
 203
 204         buf = kmalloc (maxp, GFP_KERNEL);
 205         if (buf) {
 206                 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
 207                 if (!dev->interrupt) {
 208                         kfree (buf);
 209                         return -ENOMEM;
 210                 } else {
 211                         usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
 212                                 buf, maxp, intr_complete, dev, period);
 213                         dev_dbg(&intf->dev,
 214                                 "status ep%din, %d bytes period %d\n",
 215                                 usb_pipeendpoint(pipe), maxp, period);
 216                 }
 217         }
 218         return 0;
 219 }
 220
 221 /* Passes this packet up the stack, updating its accounting.
 222  * Some link protocols batch packets, so their rx_fixup paths
 223  * can return clones as well as just modify the original skb.
 224  */
 225 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
 226 {
 227         int     status;
 228
 229         if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
 230                 skb_queue_tail(&dev->rxq_pause, skb);
 231                 return;
 232         }
 233
 234         skb->protocol = eth_type_trans (skb, dev->net);
 235         dev->net->stats.rx_packets++;
 236         dev->net->stats.rx_bytes += skb->len;
 237
 238         netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
 239                   skb->len + sizeof (struct ethhdr), skb->protocol);
 240         memset (skb->cb, 0, sizeof (struct skb_data));
 241
 242         if (skb_defer_rx_timestamp(skb))
 243                 return;
 244
 245         status = netif_rx (skb);
 246         if (status != NET_RX_SUCCESS)
 247                 netif_dbg(dev, rx_err, dev->net,
 248                           "netif_rx status %d\n", status);
 249 }
 250 EXPORT_SYMBOL_GPL(usbnet_skb_return);
 251
 252 \f
 253 /*-------------------------------------------------------------------------
 254  *
 255  * Network Device Driver (peer link to "Host Device", from USB host)
 256  *
 257  *-------------------------------------------------------------------------*/
 258
 259 int usbnet_change_mtu (struct net_device *net, int new_mtu)
 260 {
 261         struct usbnet   *dev = netdev_priv(net);
 262         int             ll_mtu = new_mtu + net->hard_header_len;
 263         int             old_hard_mtu = dev->hard_mtu;
 264         int             old_rx_urb_size = dev->rx_urb_size;
 265
 266         if (new_mtu <= 0)
 267                 return -EINVAL;
 268         // no second zero-length packet read wanted after mtu-sized packets
 269         if ((ll_mtu % dev->maxpacket) == 0)
 270                 return -EDOM;
 271         net->mtu = new_mtu;
 272
 273         dev->hard_mtu = net->mtu + net->hard_header_len;
 274         if (dev->rx_urb_size == old_hard_mtu) {
 275                 dev->rx_urb_size = dev->hard_mtu;
 276                 if (dev->rx_urb_size > old_rx_urb_size)
 277                         usbnet_unlink_rx_urbs(dev);
 278         }
 279
 280         return 0;
 281 }
 282 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
 283
 284 /*-------------------------------------------------------------------------*/
 285
 286 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
 287  * completion callbacks.  2.5 should have fixed those bugs...
 288  */
 289
 290 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
 291 {
 292         unsigned long           flags;
 293
 294         spin_lock_irqsave(&list->lock, flags);
 295         __skb_unlink(skb, list);
 296         spin_unlock(&list->lock);
 297         spin_lock(&dev->done.lock);
 298         __skb_queue_tail(&dev->done, skb);
 299         if (dev->done.qlen == 1)
 300                 tasklet_schedule(&dev->bh);
 301         spin_unlock_irqrestore(&dev->done.lock, flags);
 302 }
 303
 304 /* some work can't be done in tasklets, so we use keventd
 305  *
 306  * NOTE:  annoying asymmetry:  if it's active, schedule_work() fails,
 307  * but tasklet_schedule() doesn't.  hope the failure is rare.
 308  */
 309 void usbnet_defer_kevent (struct usbnet *dev, int work)
 310 {
 311         set_bit (work, &dev->flags);
 312         if (!schedule_work (&dev->kevent))
 313                 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
 314         else
 315                 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
 316 }
 317 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
 318
 319 /*-------------------------------------------------------------------------*/
 320
 321 static void rx_complete (struct urb *urb);
 322
 323 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
 324 {
 325         struct sk_buff          *skb;
 326         struct skb_data         *entry;
 327         int                     retval = 0;
 328         unsigned long           lockflags;
 329         size_t                  size = dev->rx_urb_size;
 330
 331         skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
 332         if (!skb) {
 333                 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
 334                 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
 335                 usb_free_urb (urb);
 336                 return -ENOMEM;
 337         }
 338
 339         entry = (struct skb_data *) skb->cb;
 340         entry->urb = urb;
 341         entry->dev = dev;
 342         entry->state = rx_start;
 343         entry->length = 0;
 344
 345         usb_fill_bulk_urb (urb, dev->udev, dev->in,
 346                 skb->data, size, rx_complete, skb);
 347
 348         spin_lock_irqsave (&dev->rxq.lock, lockflags);
 349
 350         if (netif_running (dev->net) &&
 351             netif_device_present (dev->net) &&
 352             !test_bit (EVENT_RX_HALT, &dev->flags) &&
 353             !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
 354                 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
 355                 case -EPIPE:
 356                         usbnet_defer_kevent (dev, EVENT_RX_HALT);
 357                         break;
 358                 case -ENOMEM:
 359                         usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
 360                         break;
 361                 case -ENODEV:
 362                         netif_dbg(dev, ifdown, dev->net, "device gone\n");
 363                         netif_device_detach (dev->net);
 364                         break;
 365                 case -EHOSTUNREACH:
 366                         retval = -ENOLINK;
 367                         break;
 368                 default:
 369                         netif_dbg(dev, rx_err, dev->net,
 370                                   "rx submit, %d\n", retval);
 371                         tasklet_schedule (&dev->bh);
 372                         break;
 373                 case 0:
 374                         __skb_queue_tail (&dev->rxq, skb);
 375                 }
 376         } else {
 377                 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
 378                 retval = -ENOLINK;
 379         }
 380         spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
 381         if (retval) {
 382                 dev_kfree_skb_any (skb);
 383                 usb_free_urb (urb);
 384         }
 385         return retval;
 386 }
 387
 388
 389 /*-------------------------------------------------------------------------*/
 390
 391 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
 392 {
 393         if (dev->driver_info->rx_fixup &&
 394             !dev->driver_info->rx_fixup (dev, skb)) {
 395                 /* With RX_ASSEMBLE, rx_fixup() must update counters */
 396                 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
 397                         dev->net->stats.rx_errors++;
 398                 goto done;
 399         }
 400         // else network stack removes extra byte if we forced a short packet
 401
 402         if (skb->len) {
 403                 /* all data was already cloned from skb inside the driver */
 404                 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
 405                         dev_kfree_skb_any(skb);
 406                 else
 407                         usbnet_skb_return(dev, skb);
 408                 return;
 409         }
 410
 411         netif_dbg(dev, rx_err, dev->net, "drop\n");
 412         dev->net->stats.rx_errors++;
 413 done:
 414         skb_queue_tail(&dev->done, skb);
 415 }
 416
 417 /*-------------------------------------------------------------------------*/
 418
 419 static void rx_complete (struct urb *urb)
 420 {
 421         struct sk_buff          *skb = (struct sk_buff *) urb->context;
 422         struct skb_data         *entry = (struct skb_data *) skb->cb;
 423         struct usbnet           *dev = entry->dev;
 424         int                     urb_status = urb->status;
 425
 426         skb_put (skb, urb->actual_length);
 427         entry->state = rx_done;
 428         entry->urb = NULL;
 429
 430         switch (urb_status) {
 431         /* success */
 432         case 0:
 433                 if (skb->len < dev->net->hard_header_len) {
 434                         entry->state = rx_cleanup;
 435                         dev->net->stats.rx_errors++;
 436                         dev->net->stats.rx_length_errors++;
 437                         netif_dbg(dev, rx_err, dev->net,
 438                                   "rx length %d\n", skb->len);
 439                 }
 440                 break;
 441
 442         /* stalls need manual reset. this is rare ... except that
 443          * when going through USB 2.0 TTs, unplug appears this way.
 444          * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
 445          * storm, recovering as needed.
 446          */
 447         case -EPIPE:
 448                 dev->net->stats.rx_errors++;
 449                 usbnet_defer_kevent (dev, EVENT_RX_HALT);
 450                 // FALLTHROUGH
 451
 452         /* software-driven interface shutdown */
 453         case -ECONNRESET:               /* async unlink */
 454         case -ESHUTDOWN:                /* hardware gone */
 455                 netif_dbg(dev, ifdown, dev->net,
 456                           "rx shutdown, code %d\n", urb_status);
 457                 goto block;
 458
 459         /* we get controller i/o faults during khubd disconnect() delays.
 460          * throttle down resubmits, to avoid log floods; just temporarily,
 461          * so we still recover when the fault isn't a khubd delay.
 462          */
 463         case -EPROTO:
 464         case -ETIME:
 465         case -EILSEQ:
 466                 dev->net->stats.rx_errors++;
 467                 if (!timer_pending (&dev->delay)) {
 468                         mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
 469                         netif_dbg(dev, link, dev->net,
 470                                   "rx throttle %d\n", urb_status);
 471                 }
 472 block:
 473                 entry->state = rx_cleanup;
 474                 entry->urb = urb;
 475                 urb = NULL;
 476                 break;
 477
 478         /* data overrun ... flush fifo? */
 479         case -EOVERFLOW:
 480                 dev->net->stats.rx_over_errors++;
 481                 // FALLTHROUGH
 482
 483         default:
 484                 entry->state = rx_cleanup;
 485                 dev->net->stats.rx_errors++;
 486                 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
 487                 break;
 488         }
 489
 490         defer_bh(dev, skb, &dev->rxq);
 491
 492         if (urb) {
 493                 if (netif_running (dev->net) &&
 494                     !test_bit (EVENT_RX_HALT, &dev->flags)) {
 495                         rx_submit (dev, urb, GFP_ATOMIC);
 496                         usb_mark_last_busy(dev->udev);
 497                         return;
 498                 }
 499                 usb_free_urb (urb);
 500         }
 501         netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
 502 }
 503
 504 static void intr_complete (struct urb *urb)
 505 {
 506         struct usbnet   *dev = urb->context;
 507         int             status = urb->status;
 508
 509         switch (status) {
 510         /* success */
 511         case 0:
 512                 dev->driver_info->status(dev, urb);
 513                 break;
 514
 515         /* software-driven interface shutdown */
 516         case -ENOENT:           /* urb killed */
 517         case -ESHUTDOWN:        /* hardware gone */
 518                 netif_dbg(dev, ifdown, dev->net,
 519                           "intr shutdown, code %d\n", status);
 520                 return;
 521
 522         /* NOTE:  not throttling like RX/TX, since this endpoint
 523          * already polls infrequently
 524          */
 525         default:
 526                 netdev_dbg(dev->net, "intr status %d\n", status);
 527                 break;
 528         }
 529
 530         if (!netif_running (dev->net))
 531                 return;
 532
 533         memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
 534         status = usb_submit_urb (urb, GFP_ATOMIC);
 535         if (status != 0)
 536                 netif_err(dev, timer, dev->net,
 537                           "intr resubmit --> %d\n", status);
 538 }
 539
 540 /*-------------------------------------------------------------------------*/
 541 void usbnet_pause_rx(struct usbnet *dev)
 542 {
 543         set_bit(EVENT_RX_PAUSED, &dev->flags);
 544
 545         netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
 546 }
 547 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
 548
 549 void usbnet_resume_rx(struct usbnet *dev)
 550 {
 551         struct sk_buff *skb;
 552         int num = 0;
 553
 554         clear_bit(EVENT_RX_PAUSED, &dev->flags);
 555
 556         while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
 557                 usbnet_skb_return(dev, skb);
 558                 num++;
 559         }
 560
 561         tasklet_schedule(&dev->bh);
 562
 563         netif_dbg(dev, rx_status, dev->net,
 564                   "paused rx queue disabled, %d skbs requeued\n", num);
 565 }
 566 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
 567
 568 void usbnet_purge_paused_rxq(struct usbnet *dev)
 569 {
 570         skb_queue_purge(&dev->rxq_pause);
 571 }
 572 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
 573
 574 /*-------------------------------------------------------------------------*/
 575
 576 // unlink pending rx/tx; completion handlers do all other cleanup
 577
 578 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
 579 {
 580         unsigned long           flags;
 581         struct sk_buff          *skb, *skbnext;
 582         int                     count = 0;
 583
 584         spin_lock_irqsave (&q->lock, flags);
 585         skb_queue_walk_safe(q, skb, skbnext) {
 586                 struct skb_data         *entry;
 587                 struct urb              *urb;
 588                 int                     retval;
 589
 590                 entry = (struct skb_data *) skb->cb;
 591                 urb = entry->urb;
 592
 593                 /*
 594                  * Get reference count of the URB to avoid it to be
 595                  * freed during usb_unlink_urb, which may trigger
 596                  * use-after-free problem inside usb_unlink_urb since
 597                  * usb_unlink_urb is always racing with .complete
 598                  * handler(include defer_bh).
 599                  */
 600                 usb_get_urb(urb);
 601                 spin_unlock_irqrestore(&q->lock, flags);
 602                 // during some PM-driven resume scenarios,
 603                 // these (async) unlinks complete immediately
 604                 retval = usb_unlink_urb (urb);
 605                 if (retval != -EINPROGRESS && retval != 0)
 606                         netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
 607                 else
 608                         count++;
 609                 usb_put_urb(urb);
 610                 spin_lock_irqsave(&q->lock, flags);
 611         }
 612         spin_unlock_irqrestore (&q->lock, flags);
 613         return count;
 614 }
 615
 616 // Flush all pending rx urbs
 617 // minidrivers may need to do this when the MTU changes
 618
 619 void usbnet_unlink_rx_urbs(struct usbnet *dev)
 620 {
 621         if (netif_running(dev->net)) {
 622                 (void) unlink_urbs (dev, &dev->rxq);
 623                 tasklet_schedule(&dev->bh);
 624         }
 625 }
 626 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
 627
 628 /*-------------------------------------------------------------------------*/
 629
 630 // precondition: never called in_interrupt
 631 static void usbnet_terminate_urbs(struct usbnet *dev)
 632 {
 633         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
 634         DECLARE_WAITQUEUE(wait, current);
 635         int temp;
 636
 637         /* ensure there are no more active urbs */
 638         add_wait_queue(&unlink_wakeup, &wait);
 639         set_current_state(TASK_UNINTERRUPTIBLE);
 640         dev->wait = &unlink_wakeup;
 641         temp = unlink_urbs(dev, &dev->txq) +
 642                 unlink_urbs(dev, &dev->rxq);
 643
 644         /* maybe wait for deletions to finish. */
 645         while (!skb_queue_empty(&dev->rxq)
 646                 && !skb_queue_empty(&dev->txq)
 647                 && !skb_queue_empty(&dev->done)) {
 648                         schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
 649                         set_current_state(TASK_UNINTERRUPTIBLE);
 650                         netif_dbg(dev, ifdown, dev->net,
 651                                   "waited for %d urb completions\n", temp);
 652         }
 653         set_current_state(TASK_RUNNING);
 654         dev->wait = NULL;
 655         remove_wait_queue(&unlink_wakeup, &wait);
 656 }
 657
 658 int usbnet_stop (struct net_device *net)
 659 {
 660         struct usbnet           *dev = netdev_priv(net);
 661         struct driver_info      *info = dev->driver_info;
 662         int                     retval;
 663
 664         clear_bit(EVENT_DEV_OPEN, &dev->flags);
 665         netif_stop_queue (net);
 666
 667         netif_info(dev, ifdown, dev->net,
 668                    "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
 669                    net->stats.rx_packets, net->stats.tx_packets,
 670                    net->stats.rx_errors, net->stats.tx_errors);
 671
 672         /* allow minidriver to stop correctly (wireless devices to turn off
 673          * radio etc) */
 674         if (info->stop) {
 675                 retval = info->stop(dev);
 676                 if (retval < 0)
 677                         netif_info(dev, ifdown, dev->net,
 678                                    "stop fail (%d) usbnet usb-%s-%s, %s\n",
 679                                    retval,
 680                                    dev->udev->bus->bus_name, dev->udev->devpath,
 681                                    info->description);
 682         }
 683
 684         if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
 685                 usbnet_terminate_urbs(dev);
 686
 687         usb_kill_urb(dev->interrupt);
 688
 689         usbnet_purge_paused_rxq(dev);
 690
 691         /* deferred work (task, timer, softirq) must also stop.
 692          * can't flush_scheduled_work() until we drop rtnl (later),
 693          * else workers could deadlock; so make workers a NOP.
 694          */
 695         dev->flags = 0;
 696         del_timer_sync (&dev->delay);
 697         tasklet_kill (&dev->bh);
 698         if (info->manage_power)
 699                 info->manage_power(dev, 0);
 700         else
 701                 usb_autopm_put_interface(dev->intf);
 702
 703         return 0;
 704 }
 705 EXPORT_SYMBOL_GPL(usbnet_stop);
 706
 707 /*-------------------------------------------------------------------------*/
 708
 709 // posts reads, and enables write queuing
 710
 711 // precondition: never called in_interrupt
 712
 713 int usbnet_open (struct net_device *net)
 714 {
 715         struct usbnet           *dev = netdev_priv(net);
 716         int                     retval;
 717         struct driver_info      *info = dev->driver_info;
 718
 719         if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
 720                 netif_info(dev, ifup, dev->net,
 721                            "resumption fail (%d) usbnet usb-%s-%s, %s\n",
 722                            retval,
 723                            dev->udev->bus->bus_name,
 724                            dev->udev->devpath,
 725                            info->description);
 726                 goto done_nopm;
 727         }
 728
 729         // put into "known safe" state
 730         if (info->reset && (retval = info->reset (dev)) < 0) {
 731                 netif_info(dev, ifup, dev->net,
 732                            "open reset fail (%d) usbnet usb-%s-%s, %s\n",
 733                            retval,
 734                            dev->udev->bus->bus_name,
 735                            dev->udev->devpath,
 736                            info->description);
 737                 goto done;
 738         }
 739
 740         // insist peer be connected
 741         if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
 742                 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
 743                 goto done;
 744         }
 745
 746         /* start any status interrupt transfer */
 747         if (dev->interrupt) {
 748                 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
 749                 if (retval < 0) {
 750                         netif_err(dev, ifup, dev->net,
 751                                   "intr submit %d\n", retval);
 752                         goto done;
 753                 }
 754         }
 755
 756         set_bit(EVENT_DEV_OPEN, &dev->flags);
 757         netif_start_queue (net);
 758         netif_info(dev, ifup, dev->net,
 759                    "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
 760                    (int)RX_QLEN(dev), (int)TX_QLEN(dev),
 761                    dev->net->mtu,
 762                    (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
 763                    (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
 764                    (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
 765                    (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
 766                    (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
 767                    "simple");
 768
 769         // delay posting reads until we're fully open
 770         tasklet_schedule (&dev->bh);
 771         if (info->manage_power) {
 772                 retval = info->manage_power(dev, 1);
 773                 if (retval < 0)
 774                         goto done;
 775                 usb_autopm_put_interface(dev->intf);
 776         }
 777         return retval;
 778
 779 done:
 780         usb_autopm_put_interface(dev->intf);
 781 done_nopm:
 782         return retval;
 783 }
 784 EXPORT_SYMBOL_GPL(usbnet_open);
 785
 786 /*-------------------------------------------------------------------------*/
 787
 788 /* ethtool methods; minidrivers may need to add some more, but
 789  * they'll probably want to use this base set.
 790  */
 791
 792 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
 793 {
 794         struct usbnet *dev = netdev_priv(net);
 795
 796         if (!dev->mii.mdio_read)
 797                 return -EOPNOTSUPP;
 798
 799         return mii_ethtool_gset(&dev->mii, cmd);
 800 }
 801 EXPORT_SYMBOL_GPL(usbnet_get_settings);
 802
 803 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
 804 {
 805         struct usbnet *dev = netdev_priv(net);
 806         int retval;
 807
 808         if (!dev->mii.mdio_write)
 809                 return -EOPNOTSUPP;
 810
 811         retval = mii_ethtool_sset(&dev->mii, cmd);
 812
 813         /* link speed/duplex might have changed */
 814         if (dev->driver_info->link_reset)
 815                 dev->driver_info->link_reset(dev);
 816
 817         return retval;
 818
 819 }
 820 EXPORT_SYMBOL_GPL(usbnet_set_settings);
 821
 822 u32 usbnet_get_link (struct net_device *net)
 823 {
 824         struct usbnet *dev = netdev_priv(net);
 825
 826         /* If a check_connect is defined, return its result */
 827         if (dev->driver_info->check_connect)
 828                 return dev->driver_info->check_connect (dev) == 0;
 829
 830         /* if the device has mii operations, use those */
 831         if (dev->mii.mdio_read)
 832                 return mii_link_ok(&dev->mii);
 833
 834         /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
 835         return ethtool_op_get_link(net);
 836 }
 837 EXPORT_SYMBOL_GPL(usbnet_get_link);
 838
 839 int usbnet_nway_reset(struct net_device *net)
 840 {
 841         struct usbnet *dev = netdev_priv(net);
 842
 843         if (!dev->mii.mdio_write)
 844                 return -EOPNOTSUPP;
 845
 846         return mii_nway_restart(&dev->mii);
 847 }
 848 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
 849
 850 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
 851 {
 852         struct usbnet *dev = netdev_priv(net);
 853
 854         strncpy (info->driver, dev->driver_name, sizeof info->driver);
 855         strncpy (info->version, DRIVER_VERSION, sizeof info->version);
 856         strncpy (info->fw_version, dev->driver_info->description,
 857                 sizeof info->fw_version);
 858         usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
 859 }
 860 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
 861
 862 u32 usbnet_get_msglevel (struct net_device *net)
 863 {
 864         struct usbnet *dev = netdev_priv(net);
 865
 866         return dev->msg_enable;
 867 }
 868 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
 869
 870 void usbnet_set_msglevel (struct net_device *net, u32 level)
 871 {
 872         struct usbnet *dev = netdev_priv(net);
 873
 874         dev->msg_enable = level;
 875 }
 876 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
 877
 878 /* drivers may override default ethtool_ops in their bind() routine */
 879 static const struct ethtool_ops usbnet_ethtool_ops = {
 880         .get_settings           = usbnet_get_settings,
 881         .set_settings           = usbnet_set_settings,
 882         .get_link               = usbnet_get_link,
 883         .nway_reset             = usbnet_nway_reset,
 884         .get_drvinfo            = usbnet_get_drvinfo,
 885         .get_msglevel           = usbnet_get_msglevel,
 886         .set_msglevel           = usbnet_set_msglevel,
 887 };
 888
 889 /*-------------------------------------------------------------------------*/
 890
 891 /* work that cannot be done in interrupt context uses keventd.
 892  *
 893  * NOTE:  with 2.5 we could do more of this using completion callbacks,
 894  * especially now that control transfers can be queued.
 895  */
 896 static void
 897 kevent (struct work_struct *work)
 898 {
 899         struct usbnet           *dev =
 900                 container_of(work, struct usbnet, kevent);
 901         int                     status;
 902
 903         /* usb_clear_halt() needs a thread context */
 904         if (test_bit (EVENT_TX_HALT, &dev->flags)) {
 905                 unlink_urbs (dev, &dev->txq);
 906                 status = usb_autopm_get_interface(dev->intf);
 907                 if (status < 0)
 908                         goto fail_pipe;
 909                 status = usb_clear_halt (dev->udev, dev->out);
 910                 usb_autopm_put_interface(dev->intf);
 911                 if (status < 0 &&
 912                     status != -EPIPE &&
 913                     status != -ESHUTDOWN) {
 914                         if (netif_msg_tx_err (dev))
 915 fail_pipe:
 916                                 netdev_err(dev->net, "can't clear tx halt, status %d\n",
 917                                            status);
 918                 } else {
 919                         clear_bit (EVENT_TX_HALT, &dev->flags);
 920                         if (status != -ESHUTDOWN)
 921                                 netif_wake_queue (dev->net);
 922                 }
 923         }
 924         if (test_bit (EVENT_RX_HALT, &dev->flags)) {
 925                 unlink_urbs (dev, &dev->rxq);
 926                 status = usb_autopm_get_interface(dev->intf);
 927                 if (status < 0)
 928                         goto fail_halt;
 929                 status = usb_clear_halt (dev->udev, dev->in);
 930                 usb_autopm_put_interface(dev->intf);
 931                 if (status < 0 &&
 932                     status != -EPIPE &&
 933                     status != -ESHUTDOWN) {
 934                         if (netif_msg_rx_err (dev))
 935 fail_halt:
 936                                 netdev_err(dev->net, "can't clear rx halt, status %d\n",
 937                                            status);
 938                 } else {
 939                         clear_bit (EVENT_RX_HALT, &dev->flags);
 940                         tasklet_schedule (&dev->bh);
 941                 }
 942         }
 943
 944         /* tasklet could resubmit itself forever if memory is tight */
 945         if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
 946                 struct urb      *urb = NULL;
 947                 int resched = 1;
 948
 949                 if (netif_running (dev->net))
 950                         urb = usb_alloc_urb (0, GFP_KERNEL);
 951                 else
 952                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
 953                 if (urb != NULL) {
 954                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
 955                         status = usb_autopm_get_interface(dev->intf);
 956                         if (status < 0) {
 957                                 usb_free_urb(urb);
 958                                 goto fail_lowmem;
 959                         }
 960                         if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
 961                                 resched = 0;
 962                         usb_autopm_put_interface(dev->intf);
 963 fail_lowmem:
 964                         if (resched)
 965                                 tasklet_schedule (&dev->bh);
 966                 }
 967         }
 968
 969         if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
 970                 struct driver_info      *info = dev->driver_info;
 971                 int                     retval = 0;
 972
 973                 clear_bit (EVENT_LINK_RESET, &dev->flags);
 974                 status = usb_autopm_get_interface(dev->intf);
 975                 if (status < 0)
 976                         goto skip_reset;
 977                 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
 978                         usb_autopm_put_interface(dev->intf);
 979 skip_reset:
 980                         netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
 981                                     retval,
 982                                     dev->udev->bus->bus_name,
 983                                     dev->udev->devpath,
 984                                     info->description);
 985                 } else {
 986                         usb_autopm_put_interface(dev->intf);
 987                 }
 988         }
 989
 990         if (dev->flags)
 991                 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
 992 }
 993
 994 /*-------------------------------------------------------------------------*/
 995
 996 static void tx_complete (struct urb *urb)
 997 {
 998         struct sk_buff          *skb = (struct sk_buff *) urb->context;
 999         struct skb_data         *entry = (struct skb_data *) skb->cb;
1000         struct usbnet           *dev = entry->dev;
1001
1002         if (urb->status == 0) {
1003                 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1004                         dev->net->stats.tx_packets++;
1005                 dev->net->stats.tx_bytes += entry->length;
1006         } else {
1007                 dev->net->stats.tx_errors++;
1008
1009                 switch (urb->status) {
1010                 case -EPIPE:
1011                         usbnet_defer_kevent (dev, EVENT_TX_HALT);
1012                         break;
1013
1014                 /* software-driven interface shutdown */
1015                 case -ECONNRESET:               // async unlink
1016                 case -ESHUTDOWN:                // hardware gone
1017                         break;
1018
1019                 // like rx, tx gets controller i/o faults during khubd delays
1020                 // and so it uses the same throttling mechanism.
1021                 case -EPROTO:
1022                 case -ETIME:
1023                 case -EILSEQ:
1024                         usb_mark_last_busy(dev->udev);
1025                         if (!timer_pending (&dev->delay)) {
1026                                 mod_timer (&dev->delay,
1027                                         jiffies + THROTTLE_JIFFIES);
1028                                 netif_dbg(dev, link, dev->net,
1029                                           "tx throttle %d\n", urb->status);
1030                         }
1031                         netif_stop_queue (dev->net);
1032                         break;
1033                 default:
1034                         netif_dbg(dev, tx_err, dev->net,
1035                                   "tx err %d\n", entry->urb->status);
1036                         break;
1037                 }
1038         }
1039
1040         usb_autopm_put_interface_async(dev->intf);
1041         entry->state = tx_done;
1042         defer_bh(dev, skb, &dev->txq);
1043 }
1044
1045 /*-------------------------------------------------------------------------*/
1046
1047 void usbnet_tx_timeout (struct net_device *net)
1048 {
1049         struct usbnet           *dev = netdev_priv(net);
1050
1051         unlink_urbs (dev, &dev->txq);
1052         tasklet_schedule (&dev->bh);
1053
1054         // FIXME: device recovery -- reset?
1055 }
1056 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1057
1058 /*-------------------------------------------------------------------------*/
1059
1060 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1061                                      struct net_device *net)
1062 {
1063         struct usbnet           *dev = netdev_priv(net);
1064         int                     length;
1065         struct urb              *urb = NULL;
1066         struct skb_data         *entry;
1067         struct driver_info      *info = dev->driver_info;
1068         unsigned long           flags;
1069         int retval;
1070
1071         if (skb)
1072                 skb_tx_timestamp(skb);
1073
1074         // some devices want funky USB-level framing, for
1075         // win32 driver (usually) and/or hardware quirks
1076         if (info->tx_fixup) {
1077                 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1078                 if (!skb) {
1079                         if (netif_msg_tx_err(dev)) {
1080                                 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1081                                 goto drop;
1082                         } else {
1083                                 /* cdc_ncm collected packet; waits for more */
1084                                 goto not_drop;
1085                         }
1086                 }
1087         }
1088         length = skb->len;
1089
1090         if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1091                 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1092                 goto drop;
1093         }
1094
1095         entry = (struct skb_data *) skb->cb;
1096         entry->urb = urb;
1097         entry->dev = dev;
1098         entry->state = tx_start;
1099         entry->length = length;
1100
1101         usb_fill_bulk_urb (urb, dev->udev, dev->out,
1102                         skb->data, skb->len, tx_complete, skb);
1103
1104         /* don't assume the hardware handles USB_ZERO_PACKET
1105          * NOTE:  strictly conforming cdc-ether devices should expect
1106          * the ZLP here, but ignore the one-byte packet.
1107          * NOTE2: CDC NCM specification is different from CDC ECM when
1108          * handling ZLP/short packets, so cdc_ncm driver will make short
1109          * packet itself if needed.
1110          */
1111         if (length % dev->maxpacket == 0) {
1112                 if (!(info->flags & FLAG_SEND_ZLP)) {
1113                         if (!(info->flags & FLAG_MULTI_PACKET)) {
1114                                 urb->transfer_buffer_length++;
1115                                 if (skb_tailroom(skb)) {
1116                                         skb->data[skb->len] = 0;
1117                                         __skb_put(skb, 1);
1118                                 }
1119                         }
1120                 } else
1121                         urb->transfer_flags |= URB_ZERO_PACKET;
1122         }
1123
1124         spin_lock_irqsave(&dev->txq.lock, flags);
1125         retval = usb_autopm_get_interface_async(dev->intf);
1126         if (retval < 0) {
1127                 spin_unlock_irqrestore(&dev->txq.lock, flags);
1128                 goto drop;
1129         }
1130
1131 #ifdef CONFIG_PM
1132         /* if this triggers the device is still a sleep */
1133         if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1134                 /* transmission will be done in resume */
1135                 usb_anchor_urb(urb, &dev->deferred);
1136                 /* no use to process more packets */
1137                 netif_stop_queue(net);
1138                 spin_unlock_irqrestore(&dev->txq.lock, flags);
1139                 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1140                 goto deferred;
1141         }
1142 #endif
1143
1144         switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1145         case -EPIPE:
1146                 netif_stop_queue (net);
1147                 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1148                 usb_autopm_put_interface_async(dev->intf);
1149                 break;
1150         default:
1151                 usb_autopm_put_interface_async(dev->intf);
1152                 netif_dbg(dev, tx_err, dev->net,
1153                           "tx: submit urb err %d\n", retval);
1154                 break;
1155         case 0:
1156                 net->trans_start = jiffies;
1157                 __skb_queue_tail (&dev->txq, skb);
1158                 if (dev->txq.qlen >= TX_QLEN (dev))
1159                         netif_stop_queue (net);
1160         }
1161         spin_unlock_irqrestore (&dev->txq.lock, flags);
1162
1163         if (retval) {
1164                 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1165 drop:
1166                 dev->net->stats.tx_dropped++;
1167 not_drop:
1168                 if (skb)
1169                         dev_kfree_skb_any (skb);
1170                 usb_free_urb (urb);
1171         } else
1172                 netif_dbg(dev, tx_queued, dev->net,
1173                           "> tx, len %d, type 0x%x\n", length, skb->protocol);
1174 #ifdef CONFIG_PM
1175 deferred:
1176 #endif
1177         return NETDEV_TX_OK;
1178 }
1179 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1180
1181 /*-------------------------------------------------------------------------*/
1182
1183 // tasklet (work deferred from completions, in_irq) or timer
1184
1185 static void usbnet_bh (unsigned long param)
1186 {
1187         struct usbnet           *dev = (struct usbnet *) param;
1188         struct sk_buff          *skb;
1189         struct skb_data         *entry;
1190
1191         while ((skb = skb_dequeue (&dev->done))) {
1192                 entry = (struct skb_data *) skb->cb;
1193                 switch (entry->state) {
1194                 case rx_done:
1195                         entry->state = rx_cleanup;
1196                         rx_process (dev, skb);
1197                         continue;
1198                 case tx_done:
1199                 case rx_cleanup:
1200                         usb_free_urb (entry->urb);
1201                         dev_kfree_skb (skb);
1202                         continue;
1203                 default:
1204                         netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1205                 }
1206         }
1207
1208         // waiting for all pending urbs to complete?
1209         if (dev->wait) {
1210                 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1211                         wake_up (dev->wait);
1212                 }
1213
1214         // or are we maybe short a few urbs?
1215         } else if (netif_running (dev->net) &&
1216                    netif_device_present (dev->net) &&
1217                    !timer_pending (&dev->delay) &&
1218                    !test_bit (EVENT_RX_HALT, &dev->flags)) {
1219                 int     temp = dev->rxq.qlen;
1220                 int     qlen = RX_QLEN (dev);
1221
1222                 if (temp < qlen) {
1223                         struct urb      *urb;
1224                         int             i;
1225
1226                         // don't refill the queue all at once
1227                         for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1228                                 urb = usb_alloc_urb (0, GFP_ATOMIC);
1229                                 if (urb != NULL) {
1230                                         if (rx_submit (dev, urb, GFP_ATOMIC) ==
1231                                             -ENOLINK)
1232                                                 return;
1233                                 }
1234                         }
1235                         if (temp != dev->rxq.qlen)
1236                                 netif_dbg(dev, link, dev->net,
1237                                           "rxqlen %d --> %d\n",
1238                                           temp, dev->rxq.qlen);
1239                         if (dev->rxq.qlen < qlen)
1240                                 tasklet_schedule (&dev->bh);
1241                 }
1242                 if (dev->txq.qlen < TX_QLEN (dev))
1243                         netif_wake_queue (dev->net);
1244         }
1245 }
1246
1247
1248 /*-------------------------------------------------------------------------
1249  *
1250  * USB Device Driver support
1251  *
1252  *-------------------------------------------------------------------------*/
1253
1254 // precondition: never called in_interrupt
1255
1256 void usbnet_disconnect (struct usb_interface *intf)
1257 {
1258         struct usbnet           *dev;
1259         struct usb_device       *xdev;
1260         struct net_device       *net;
1261
1262         dev = usb_get_intfdata(intf);
1263         usb_set_intfdata(intf, NULL);
1264         if (!dev)
1265                 return;
1266
1267         xdev = interface_to_usbdev (intf);
1268
1269         netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1270                    intf->dev.driver->name,
1271                    xdev->bus->bus_name, xdev->devpath,
1272                    dev->driver_info->description);
1273
1274         net = dev->net;
1275         unregister_netdev (net);
1276
1277         cancel_work_sync(&dev->kevent);
1278
1279         if (dev->driver_info->unbind)
1280                 dev->driver_info->unbind (dev, intf);
1281
1282         usb_kill_urb(dev->interrupt);
1283         usb_free_urb(dev->interrupt);
1284
1285         free_netdev(net);
1286         usb_put_dev (xdev);
1287 }
1288 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1289
1290 static const struct net_device_ops usbnet_netdev_ops = {
1291         .ndo_open               = usbnet_open,
1292         .ndo_stop               = usbnet_stop,
1293         .ndo_start_xmit         = usbnet_start_xmit,
1294         .ndo_tx_timeout         = usbnet_tx_timeout,
1295         .ndo_change_mtu         = usbnet_change_mtu,
1296         .ndo_set_mac_address    = eth_mac_addr,
1297         .ndo_validate_addr      = eth_validate_addr,
1298 };
1299
1300 /*-------------------------------------------------------------------------*/
1301
1302 // precondition: never called in_interrupt
1303
1304 static struct device_type wlan_type = {
1305         .name   = "wlan",
1306 };
1307
1308 static struct device_type wwan_type = {
1309         .name   = "wwan",
1310 };
1311
1312 int
1313 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1314 {
1315         struct usbnet                   *dev;
1316         struct net_device               *net;
1317         struct usb_host_interface       *interface;
1318         struct driver_info              *info;
1319         struct usb_device               *xdev;
1320         int                             status;
1321         const char                      *name;
1322         struct usb_driver       *driver = to_usb_driver(udev->dev.driver);
1323
1324         /* usbnet already took usb runtime pm, so have to enable the feature
1325          * for usb interface, otherwise usb_autopm_get_interface may return
1326          * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1327          */
1328         if (!driver->supports_autosuspend) {
1329                 driver->supports_autosuspend = 1;
1330                 pm_runtime_enable(&udev->dev);
1331         }
1332
1333         name = udev->dev.driver->name;
1334         info = (struct driver_info *) prod->driver_info;
1335         if (!info) {
1336                 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1337                 return -ENODEV;
1338         }
1339         xdev = interface_to_usbdev (udev);
1340         interface = udev->cur_altsetting;
1341
1342         usb_get_dev (xdev);
1343
1344         status = -ENOMEM;
1345
1346         // set up our own records
1347         net = alloc_etherdev(sizeof(*dev));
1348         if (!net)
1349                 goto out;
1350
1351         /* netdev_printk() needs this so do it as early as possible */
1352         SET_NETDEV_DEV(net, &udev->dev);
1353
1354         dev = netdev_priv(net);
1355         dev->udev = xdev;
1356         dev->intf = udev;
1357         dev->driver_info = info;
1358         dev->driver_name = name;
1359         dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1360                                 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1361         skb_queue_head_init (&dev->rxq);
1362         skb_queue_head_init (&dev->txq);
1363         skb_queue_head_init (&dev->done);
1364         skb_queue_head_init(&dev->rxq_pause);
1365         dev->bh.func = usbnet_bh;
1366         dev->bh.data = (unsigned long) dev;
1367         INIT_WORK (&dev->kevent, kevent);
1368         init_usb_anchor(&dev->deferred);
1369         dev->delay.function = usbnet_bh;
1370         dev->delay.data = (unsigned long) dev;
1371         init_timer (&dev->delay);
1372         mutex_init (&dev->phy_mutex);
1373
1374         dev->net = net;
1375         strcpy (net->name, "usb%d");
1376         memcpy (net->dev_addr, node_id, sizeof node_id);
1377
1378         /* rx and tx sides can use different message sizes;
1379          * bind() should set rx_urb_size in that case.
1380          */
1381         dev->hard_mtu = net->mtu + net->hard_header_len;
1382 #if 0
1383 // dma_supported() is deeply broken on almost all architectures
1384         // possible with some EHCI controllers
1385         if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1386                 net->features |= NETIF_F_HIGHDMA;
1387 #endif
1388
1389         net->netdev_ops = &usbnet_netdev_ops;
1390         net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1391         net->ethtool_ops = &usbnet_ethtool_ops;
1392
1393         // allow device-specific bind/init procedures
1394         // NOTE net->name still not usable ...
1395         if (info->bind) {
1396                 status = info->bind (dev, udev);
1397                 if (status < 0)
1398                         goto out1;
1399
1400                 // heuristic:  "usb%d" for links we know are two-host,
1401                 // else "eth%d" when there's reasonable doubt.  userspace
1402                 // can rename the link if it knows better.
1403                 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1404                     ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1405                      (net->dev_addr [0] & 0x02) == 0))
1406                         strcpy (net->name, "eth%d");
1407                 /* WLAN devices should always be named "wlan%d" */
1408                 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1409                         strcpy(net->name, "wlan%d");
1410                 /* WWAN devices should always be named "wwan%d" */
1411                 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1412                         strcpy(net->name, "wwan%d");
1413
1414                 /* maybe the remote can't receive an Ethernet MTU */
1415                 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1416                         net->mtu = dev->hard_mtu - net->hard_header_len;
1417         } else if (!info->in || !info->out)
1418                 status = usbnet_get_endpoints (dev, udev);
1419         else {
1420                 dev->in = usb_rcvbulkpipe (xdev, info->in);
1421                 dev->out = usb_sndbulkpipe (xdev, info->out);
1422                 if (!(info->flags & FLAG_NO_SETINT))
1423                         status = usb_set_interface (xdev,
1424                                 interface->desc.bInterfaceNumber,
1425                                 interface->desc.bAlternateSetting);
1426                 else
1427                         status = 0;
1428
1429         }
1430         if (status >= 0 && dev->status)
1431                 status = init_status (dev, udev);
1432         if (status < 0)
1433                 goto out3;
1434
1435         if (!dev->rx_urb_size)
1436                 dev->rx_urb_size = dev->hard_mtu;
1437         dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1438
1439         if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1440                 SET_NETDEV_DEVTYPE(net, &wlan_type);
1441         if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1442                 SET_NETDEV_DEVTYPE(net, &wwan_type);
1443
1444         status = register_netdev (net);
1445         if (status)
1446                 goto out3;
1447         netif_info(dev, probe, dev->net,
1448                    "register '%s' at usb-%s-%s, %s, %pM\n",
1449                    udev->dev.driver->name,
1450                    xdev->bus->bus_name, xdev->devpath,
1451                    dev->driver_info->description,
1452                    net->dev_addr);
1453
1454         // ok, it's ready to go.
1455         usb_set_intfdata (udev, dev);
1456
1457         netif_device_attach (net);
1458
1459         if (dev->driver_info->flags & FLAG_LINK_INTR)
1460                 netif_carrier_off(net);
1461
1462         return 0;
1463
1464 out3:
1465         if (info->unbind)
1466                 info->unbind (dev, udev);
1467 out1:
1468         free_netdev(net);
1469 out:
1470         usb_put_dev(xdev);
1471         return status;
1472 }
1473 EXPORT_SYMBOL_GPL(usbnet_probe);
1474
1475 /*-------------------------------------------------------------------------*/
1476
1477 /*
1478  * suspend the whole driver as soon as the first interface is suspended
1479  * resume only when the last interface is resumed
1480  */
1481
1482 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1483 {
1484         struct usbnet           *dev = usb_get_intfdata(intf);
1485
1486         if (!dev->suspend_count++) {
1487                 spin_lock_irq(&dev->txq.lock);
1488                 /* don't autosuspend while transmitting */
1489                 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1490                         spin_unlock_irq(&dev->txq.lock);
1491                         return -EBUSY;
1492                 } else {
1493                         set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1494                         spin_unlock_irq(&dev->txq.lock);
1495                 }
1496                 /*
1497                  * accelerate emptying of the rx and queues, to avoid
1498                  * having everything error out.
1499                  */
1500                 netif_device_detach (dev->net);
1501                 usbnet_terminate_urbs(dev);
1502                 usb_kill_urb(dev->interrupt);
1503
1504                 /*
1505                  * reattach so runtime management can use and
1506                  * wake the device
1507                  */
1508                 netif_device_attach (dev->net);
1509         }
1510         return 0;
1511 }
1512 EXPORT_SYMBOL_GPL(usbnet_suspend);
1513
1514 int usbnet_resume (struct usb_interface *intf)
1515 {
1516         struct usbnet           *dev = usb_get_intfdata(intf);
1517         struct sk_buff          *skb;
1518         struct urb              *res;
1519         int                     retval;
1520
1521         if (!--dev->suspend_count) {
1522                 /* resume interrupt URBs */
1523                 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1524                         usb_submit_urb(dev->interrupt, GFP_NOIO);
1525
1526                 spin_lock_irq(&dev->txq.lock);
1527                 while ((res = usb_get_from_anchor(&dev->deferred))) {
1528
1529                         skb = (struct sk_buff *)res->context;
1530                         retval = usb_submit_urb(res, GFP_ATOMIC);
1531                         if (retval < 0) {
1532                                 dev_kfree_skb_any(skb);
1533                                 usb_free_urb(res);
1534                                 usb_autopm_put_interface_async(dev->intf);
1535                         } else {
1536                                 dev->net->trans_start = jiffies;
1537                                 __skb_queue_tail(&dev->txq, skb);
1538                         }
1539                 }
1540
1541                 smp_mb();
1542                 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1543                 spin_unlock_irq(&dev->txq.lock);
1544
1545                 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1546                         if (!(dev->txq.qlen >= TX_QLEN(dev)))
1547                                 netif_tx_wake_all_queues(dev->net);
1548                         tasklet_schedule (&dev->bh);
1549                 }
1550         }
1551         return 0;
1552 }
1553 EXPORT_SYMBOL_GPL(usbnet_resume);
1554
1555
1556 /*-------------------------------------------------------------------------*/
1557
1558 static int __init usbnet_init(void)
1559 {
1560         /* Compiler should optimize this out. */
1561         BUILD_BUG_ON(
1562                 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1563
1564         random_ether_addr(node_id);
1565         return 0;
1566 }
1567 module_init(usbnet_init);
1568
1569 static void __exit usbnet_exit(void)
1570 {
1571 }
1572 module_exit(usbnet_exit);
1573
1574 MODULE_AUTHOR("David Brownell");
1575 MODULE_DESCRIPTION("USB network driver framework");
1576 MODULE_LICENSE("GPL");