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