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