drivers/usb/net/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/sched.h>
  38 #include <linux/init.h>
  39 #include <linux/netdevice.h>
  40 #include <linux/etherdevice.h>
  41 #include <linux/ethtool.h>
  42 #include <linux/workqueue.h>
  43 #include <linux/mii.h>
  44 #include <linux/usb.h>
  45
  46 #include "usbnet.h"
  47
  48 #define DRIVER_VERSION          "22-Aug-2005"
  49
  50
  51 /*-------------------------------------------------------------------------*/
  52
  53 /*
  54  * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
  55  * Several dozen bytes of IPv4 data can fit in two such transactions.
  56  * One maximum size Ethernet packet takes twenty four of them.
  57  * For high speed, each frame comfortably fits almost 36 max size
  58  * Ethernet packets (so queues should be bigger).
  59  *
  60  * REVISIT qlens should be members of 'struct usbnet'; the goal is to
  61  * let the USB host controller be busy for 5msec or more before an irq
  62  * is required, under load.  Jumbograms change the equation.
  63  */
  64 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
  65 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
  66                         (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
  67 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
  68                         (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
  69
  70 // reawaken network queue this soon after stopping; else watchdog barks
  71 #define TX_TIMEOUT_JIFFIES      (5*HZ)
  72
  73 // throttle rx/tx briefly after some faults, so khubd might disconnect()
  74 // us (it polls at HZ/4 usually) before we report too many false errors.
  75 #define THROTTLE_JIFFIES        (HZ/8)
  76
  77 // between wakeups
  78 #define UNLINK_TIMEOUT_MS       3
  79
  80 /*-------------------------------------------------------------------------*/
  81
  82 // randomly generated ethernet address
  83 static u8       node_id [ETH_ALEN];
  84
  85 static const char driver_name [] = "usbnet";
  86
  87 /* use ethtool to change the level for any given device */
  88 static int msg_level = -1;
  89 module_param (msg_level, int, 0);
  90 MODULE_PARM_DESC (msg_level, "Override default message level");
  91
  92 /*-------------------------------------------------------------------------*/
  93
  94 /* handles CDC Ethernet and many other network "bulk data" interfaces */
  95 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
  96 {
  97         int                             tmp;
  98         struct usb_host_interface       *alt = NULL;
  99         struct usb_host_endpoint        *in = NULL, *out = NULL;
 100         struct usb_host_endpoint        *status = NULL;
 101
 102         for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
 103                 unsigned        ep;
 104
 105                 in = out = status = NULL;
 106                 alt = intf->altsetting + tmp;
 107
 108                 /* take the first altsetting with in-bulk + out-bulk;
 109                  * remember any status endpoint, just in case;
 110                  * ignore other endpoints and altsetttings.
 111                  */
 112                 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
 113                         struct usb_host_endpoint        *e;
 114                         int                             intr = 0;
 115
 116                         e = alt->endpoint + ep;
 117                         switch (e->desc.bmAttributes) {
 118                         case USB_ENDPOINT_XFER_INT:
 119                                 if (!(e->desc.bEndpointAddress & USB_DIR_IN))
 120                                         continue;
 121                                 intr = 1;
 122                                 /* FALLTHROUGH */
 123                         case USB_ENDPOINT_XFER_BULK:
 124                                 break;
 125                         default:
 126                                 continue;
 127                         }
 128                         if (e->desc.bEndpointAddress & USB_DIR_IN) {
 129                                 if (!intr && !in)
 130                                         in = e;
 131                                 else if (intr && !status)
 132                                         status = e;
 133                         } else {
 134                                 if (!out)
 135                                         out = e;
 136                         }
 137                 }
 138                 if (in && out)
 139                         break;
 140         }
 141         if (!alt || !in || !out)
 142                 return -EINVAL;
 143
 144         if (alt->desc.bAlternateSetting != 0
 145                         || !(dev->driver_info->flags & FLAG_NO_SETINT)) {
 146                 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
 147                                 alt->desc.bAlternateSetting);
 148                 if (tmp < 0)
 149                         return tmp;
 150         }
 151
 152         dev->in = usb_rcvbulkpipe (dev->udev,
 153                         in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 154         dev->out = usb_sndbulkpipe (dev->udev,
 155                         out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 156         dev->status = status;
 157         return 0;
 158 }
 159 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
 160
 161 static void intr_complete (struct urb *urb);
 162
 163 static int init_status (struct usbnet *dev, struct usb_interface *intf)
 164 {
 165         char            *buf = NULL;
 166         unsigned        pipe = 0;
 167         unsigned        maxp;
 168         unsigned        period;
 169
 170         if (!dev->driver_info->status)
 171                 return 0;
 172
 173         pipe = usb_rcvintpipe (dev->udev,
 174                         dev->status->desc.bEndpointAddress
 175                                 & USB_ENDPOINT_NUMBER_MASK);
 176         maxp = usb_maxpacket (dev->udev, pipe, 0);
 177
 178         /* avoid 1 msec chatter:  min 8 msec poll rate */
 179         period = max ((int) dev->status->desc.bInterval,
 180                 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
 181
 182         buf = kmalloc (maxp, SLAB_KERNEL);
 183         if (buf) {
 184                 dev->interrupt = usb_alloc_urb (0, SLAB_KERNEL);
 185                 if (!dev->interrupt) {
 186                         kfree (buf);
 187                         return -ENOMEM;
 188                 } else {
 189                         usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
 190                                 buf, maxp, intr_complete, dev, period);
 191                         dev_dbg(&intf->dev,
 192                                 "status ep%din, %d bytes period %d\n",
 193                                 usb_pipeendpoint(pipe), maxp, period);
 194                 }
 195         }
 196         return  0;
 197 }
 198
 199 /* Passes this packet up the stack, updating its accounting.
 200  * Some link protocols batch packets, so their rx_fixup paths
 201  * can return clones as well as just modify the original skb.
 202  */
 203 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
 204 {
 205         int     status;
 206
 207         skb->dev = dev->net;
 208         skb->protocol = eth_type_trans (skb, dev->net);
 209         dev->stats.rx_packets++;
 210         dev->stats.rx_bytes += skb->len;
 211
 212         if (netif_msg_rx_status (dev))
 213                 devdbg (dev, "< rx, len %zu, type 0x%x",
 214                         skb->len + sizeof (struct ethhdr), skb->protocol);
 215         memset (skb->cb, 0, sizeof (struct skb_data));
 216         status = netif_rx (skb);
 217         if (status != NET_RX_SUCCESS && netif_msg_rx_err (dev))
 218                 devdbg (dev, "netif_rx status %d", status);
 219 }
 220 EXPORT_SYMBOL_GPL(usbnet_skb_return);
 221
 222 \f
 223 /*-------------------------------------------------------------------------
 224  *
 225  * Network Device Driver (peer link to "Host Device", from USB host)
 226  *
 227  *-------------------------------------------------------------------------*/
 228
 229 static int usbnet_change_mtu (struct net_device *net, int new_mtu)
 230 {
 231         struct usbnet   *dev = netdev_priv(net);
 232         int             ll_mtu = new_mtu + net->hard_header_len;
 233         int             old_hard_mtu = dev->hard_mtu;
 234         int             old_rx_urb_size = dev->rx_urb_size;
 235
 236         if (new_mtu <= 0)
 237                 return -EINVAL;
 238         // no second zero-length packet read wanted after mtu-sized packets
 239         if ((ll_mtu % dev->maxpacket) == 0)
 240                 return -EDOM;
 241         net->mtu = new_mtu;
 242
 243         dev->hard_mtu = net->mtu + net->hard_header_len;
 244         if (dev->rx_urb_size == old_hard_mtu) {
 245                 dev->rx_urb_size = dev->hard_mtu;
 246                 if (dev->rx_urb_size > old_rx_urb_size)
 247                         usbnet_unlink_rx_urbs(dev);
 248         }
 249
 250         return 0;
 251 }
 252
 253 /*-------------------------------------------------------------------------*/
 254
 255 static struct net_device_stats *usbnet_get_stats (struct net_device *net)
 256 {
 257         struct usbnet   *dev = netdev_priv(net);
 258         return &dev->stats;
 259 }
 260
 261 /*-------------------------------------------------------------------------*/
 262
 263 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
 264  * completion callbacks.  2.5 should have fixed those bugs...
 265  */
 266
 267 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
 268 {
 269         unsigned long           flags;
 270
 271         spin_lock_irqsave(&list->lock, flags);
 272         __skb_unlink(skb, list);
 273         spin_unlock(&list->lock);
 274         spin_lock(&dev->done.lock);
 275         __skb_queue_tail(&dev->done, skb);
 276         if (dev->done.qlen == 1)
 277                 tasklet_schedule(&dev->bh);
 278         spin_unlock_irqrestore(&dev->done.lock, flags);
 279 }
 280
 281 /* some work can't be done in tasklets, so we use keventd
 282  *
 283  * NOTE:  annoying asymmetry:  if it's active, schedule_work() fails,
 284  * but tasklet_schedule() doesn't.  hope the failure is rare.
 285  */
 286 void usbnet_defer_kevent (struct usbnet *dev, int work)
 287 {
 288         set_bit (work, &dev->flags);
 289         if (!schedule_work (&dev->kevent))
 290                 deverr (dev, "kevent %d may have been dropped", work);
 291         else
 292                 devdbg (dev, "kevent %d scheduled", work);
 293 }
 294 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
 295
 296 /*-------------------------------------------------------------------------*/
 297
 298 static void rx_complete (struct urb *urb);
 299
 300 static void rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
 301 {
 302         struct sk_buff          *skb;
 303         struct skb_data         *entry;
 304         int                     retval = 0;
 305         unsigned long           lockflags;
 306         size_t                  size = dev->rx_urb_size;
 307
 308         if ((skb = alloc_skb (size + NET_IP_ALIGN, flags)) == NULL) {
 309                 if (netif_msg_rx_err (dev))
 310                         devdbg (dev, "no rx skb");
 311                 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
 312                 usb_free_urb (urb);
 313                 return;
 314         }
 315         skb_reserve (skb, NET_IP_ALIGN);
 316
 317         entry = (struct skb_data *) skb->cb;
 318         entry->urb = urb;
 319         entry->dev = dev;
 320         entry->state = rx_start;
 321         entry->length = 0;
 322
 323         usb_fill_bulk_urb (urb, dev->udev, dev->in,
 324                 skb->data, size, rx_complete, skb);
 325
 326         spin_lock_irqsave (&dev->rxq.lock, lockflags);
 327
 328         if (netif_running (dev->net)
 329                         && netif_device_present (dev->net)
 330                         && !test_bit (EVENT_RX_HALT, &dev->flags)) {
 331                 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)){
 332                 case -EPIPE:
 333                         usbnet_defer_kevent (dev, EVENT_RX_HALT);
 334                         break;
 335                 case -ENOMEM:
 336                         usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
 337                         break;
 338                 case -ENODEV:
 339                         if (netif_msg_ifdown (dev))
 340                                 devdbg (dev, "device gone");
 341                         netif_device_detach (dev->net);
 342                         break;
 343                 default:
 344                         if (netif_msg_rx_err (dev))
 345                                 devdbg (dev, "rx submit, %d", retval);
 346                         tasklet_schedule (&dev->bh);
 347                         break;
 348                 case 0:
 349                         __skb_queue_tail (&dev->rxq, skb);
 350                 }
 351         } else {
 352                 if (netif_msg_ifdown (dev))
 353                         devdbg (dev, "rx: stopped");
 354                 retval = -ENOLINK;
 355         }
 356         spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
 357         if (retval) {
 358                 dev_kfree_skb_any (skb);
 359                 usb_free_urb (urb);
 360         }
 361 }
 362
 363
 364 /*-------------------------------------------------------------------------*/
 365
 366 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
 367 {
 368         if (dev->driver_info->rx_fixup
 369                         && !dev->driver_info->rx_fixup (dev, skb))
 370                 goto error;
 371         // else network stack removes extra byte if we forced a short packet
 372
 373         if (skb->len)
 374                 usbnet_skb_return (dev, skb);
 375         else {
 376                 if (netif_msg_rx_err (dev))
 377                         devdbg (dev, "drop");
 378 error:
 379                 dev->stats.rx_errors++;
 380                 skb_queue_tail (&dev->done, skb);
 381         }
 382 }
 383
 384 /*-------------------------------------------------------------------------*/
 385
 386 static void rx_complete (struct urb *urb)
 387 {
 388         struct sk_buff          *skb = (struct sk_buff *) urb->context;
 389         struct skb_data         *entry = (struct skb_data *) skb->cb;
 390         struct usbnet           *dev = entry->dev;
 391         int                     urb_status = urb->status;
 392
 393         skb_put (skb, urb->actual_length);
 394         entry->state = rx_done;
 395         entry->urb = NULL;
 396
 397         switch (urb_status) {
 398             // success
 399             case 0:
 400                 if (skb->len < dev->net->hard_header_len) {
 401                         entry->state = rx_cleanup;
 402                         dev->stats.rx_errors++;
 403                         dev->stats.rx_length_errors++;
 404                         if (netif_msg_rx_err (dev))
 405                                 devdbg (dev, "rx length %d", skb->len);
 406                 }
 407                 break;
 408
 409             // stalls need manual reset. this is rare ... except that
 410             // when going through USB 2.0 TTs, unplug appears this way.
 411             // we avoid the highspeed version of the ETIMEOUT/EILSEQ
 412             // storm, recovering as needed.
 413             case -EPIPE:
 414                 dev->stats.rx_errors++;
 415                 usbnet_defer_kevent (dev, EVENT_RX_HALT);
 416                 // FALLTHROUGH
 417
 418             // software-driven interface shutdown
 419             case -ECONNRESET:           // async unlink
 420             case -ESHUTDOWN:            // hardware gone
 421                 if (netif_msg_ifdown (dev))
 422                         devdbg (dev, "rx shutdown, code %d", urb_status);
 423                 goto block;
 424
 425             // we get controller i/o faults during khubd disconnect() delays.
 426             // throttle down resubmits, to avoid log floods; just temporarily,
 427             // so we still recover when the fault isn't a khubd delay.
 428             case -EPROTO:
 429             case -ETIME:
 430             case -EILSEQ:
 431                 dev->stats.rx_errors++;
 432                 if (!timer_pending (&dev->delay)) {
 433                         mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
 434                         if (netif_msg_link (dev))
 435                                 devdbg (dev, "rx throttle %d", urb_status);
 436                 }
 437 block:
 438                 entry->state = rx_cleanup;
 439                 entry->urb = urb;
 440                 urb = NULL;
 441                 break;
 442
 443             // data overrun ... flush fifo?
 444             case -EOVERFLOW:
 445                 dev->stats.rx_over_errors++;
 446                 // FALLTHROUGH
 447
 448             default:
 449                 entry->state = rx_cleanup;
 450                 dev->stats.rx_errors++;
 451                 if (netif_msg_rx_err (dev))
 452                         devdbg (dev, "rx status %d", urb_status);
 453                 break;
 454         }
 455
 456         defer_bh(dev, skb, &dev->rxq);
 457
 458         if (urb) {
 459                 if (netif_running (dev->net)
 460                                 && !test_bit (EVENT_RX_HALT, &dev->flags)) {
 461                         rx_submit (dev, urb, GFP_ATOMIC);
 462                         return;
 463                 }
 464                 usb_free_urb (urb);
 465         }
 466         if (netif_msg_rx_err (dev))
 467                 devdbg (dev, "no read resubmitted");
 468 }
 469
 470 static void intr_complete (struct urb *urb)
 471 {
 472         struct usbnet   *dev = urb->context;
 473         int             status = urb->status;
 474
 475         switch (status) {
 476             /* success */
 477             case 0:
 478                 dev->driver_info->status(dev, urb);
 479                 break;
 480
 481             /* software-driven interface shutdown */
 482             case -ENOENT:               // urb killed
 483             case -ESHUTDOWN:            // hardware gone
 484                 if (netif_msg_ifdown (dev))
 485                         devdbg (dev, "intr shutdown, code %d", status);
 486                 return;
 487
 488             /* NOTE:  not throttling like RX/TX, since this endpoint
 489              * already polls infrequently
 490              */
 491             default:
 492                 devdbg (dev, "intr status %d", status);
 493                 break;
 494         }
 495
 496         if (!netif_running (dev->net))
 497                 return;
 498
 499         memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
 500         status = usb_submit_urb (urb, GFP_ATOMIC);
 501         if (status != 0 && netif_msg_timer (dev))
 502                 deverr(dev, "intr resubmit --> %d", status);
 503 }
 504
 505 /*-------------------------------------------------------------------------*/
 506
 507 // unlink pending rx/tx; completion handlers do all other cleanup
 508
 509 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
 510 {
 511         unsigned long           flags;
 512         struct sk_buff          *skb, *skbnext;
 513         int                     count = 0;
 514
 515         spin_lock_irqsave (&q->lock, flags);
 516         for (skb = q->next; skb != (struct sk_buff *) q; skb = skbnext) {
 517                 struct skb_data         *entry;
 518                 struct urb              *urb;
 519                 int                     retval;
 520
 521                 entry = (struct skb_data *) skb->cb;
 522                 urb = entry->urb;
 523                 skbnext = skb->next;
 524
 525                 // during some PM-driven resume scenarios,
 526                 // these (async) unlinks complete immediately
 527                 retval = usb_unlink_urb (urb);
 528                 if (retval != -EINPROGRESS && retval != 0)
 529                         devdbg (dev, "unlink urb err, %d", retval);
 530                 else
 531                         count++;
 532         }
 533         spin_unlock_irqrestore (&q->lock, flags);
 534         return count;
 535 }
 536
 537 // Flush all pending rx urbs
 538 // minidrivers may need to do this when the MTU changes
 539
 540 void usbnet_unlink_rx_urbs(struct usbnet *dev)
 541 {
 542         if (netif_running(dev->net)) {
 543                 (void) unlink_urbs (dev, &dev->rxq);
 544                 tasklet_schedule(&dev->bh);
 545         }
 546 }
 547 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
 548
 549 /*-------------------------------------------------------------------------*/
 550
 551 // precondition: never called in_interrupt
 552
 553 static int usbnet_stop (struct net_device *net)
 554 {
 555         struct usbnet           *dev = netdev_priv(net);
 556         int                     temp;
 557         DECLARE_WAIT_QUEUE_HEAD (unlink_wakeup);
 558         DECLARE_WAITQUEUE (wait, current);
 559
 560         netif_stop_queue (net);
 561
 562         if (netif_msg_ifdown (dev))
 563                 devinfo (dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld",
 564                         dev->stats.rx_packets, dev->stats.tx_packets,
 565                         dev->stats.rx_errors, dev->stats.tx_errors
 566                         );
 567
 568         // ensure there are no more active urbs
 569         add_wait_queue (&unlink_wakeup, &wait);
 570         dev->wait = &unlink_wakeup;
 571         temp = unlink_urbs (dev, &dev->txq) + unlink_urbs (dev, &dev->rxq);
 572
 573         // maybe wait for deletions to finish.
 574         while (!skb_queue_empty(&dev->rxq) &&
 575                !skb_queue_empty(&dev->txq) &&
 576                !skb_queue_empty(&dev->done)) {
 577                 msleep(UNLINK_TIMEOUT_MS);
 578                 if (netif_msg_ifdown (dev))
 579                         devdbg (dev, "waited for %d urb completions", temp);
 580         }
 581         dev->wait = NULL;
 582         remove_wait_queue (&unlink_wakeup, &wait);
 583
 584         usb_kill_urb(dev->interrupt);
 585
 586         /* deferred work (task, timer, softirq) must also stop.
 587          * can't flush_scheduled_work() until we drop rtnl (later),
 588          * else workers could deadlock; so make workers a NOP.
 589          */
 590         dev->flags = 0;
 591         del_timer_sync (&dev->delay);
 592         tasklet_kill (&dev->bh);
 593
 594         return 0;
 595 }
 596
 597 /*-------------------------------------------------------------------------*/
 598
 599 // posts reads, and enables write queuing
 600
 601 // precondition: never called in_interrupt
 602
 603 static int usbnet_open (struct net_device *net)
 604 {
 605         struct usbnet           *dev = netdev_priv(net);
 606         int                     retval = 0;
 607         struct driver_info      *info = dev->driver_info;
 608
 609         // put into "known safe" state
 610         if (info->reset && (retval = info->reset (dev)) < 0) {
 611                 if (netif_msg_ifup (dev))
 612                         devinfo (dev,
 613                                 "open reset fail (%d) usbnet usb-%s-%s, %s",
 614                                 retval,
 615                                 dev->udev->bus->bus_name, dev->udev->devpath,
 616                         info->description);
 617                 goto done;
 618         }
 619
 620         // insist peer be connected
 621         if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
 622                 if (netif_msg_ifup (dev))
 623                         devdbg (dev, "can't open; %d", retval);
 624                 goto done;
 625         }
 626
 627         /* start any status interrupt transfer */
 628         if (dev->interrupt) {
 629                 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
 630                 if (retval < 0) {
 631                         if (netif_msg_ifup (dev))
 632                                 deverr (dev, "intr submit %d", retval);
 633                         goto done;
 634                 }
 635         }
 636
 637         netif_start_queue (net);
 638         if (netif_msg_ifup (dev)) {
 639                 char    *framing;
 640
 641                 if (dev->driver_info->flags & FLAG_FRAMING_NC)
 642                         framing = "NetChip";
 643                 else if (dev->driver_info->flags & FLAG_FRAMING_GL)
 644                         framing = "GeneSys";
 645                 else if (dev->driver_info->flags & FLAG_FRAMING_Z)
 646                         framing = "Zaurus";
 647                 else if (dev->driver_info->flags & FLAG_FRAMING_RN)
 648                         framing = "RNDIS";
 649                 else if (dev->driver_info->flags & FLAG_FRAMING_AX)
 650                         framing = "ASIX";
 651                 else
 652                         framing = "simple";
 653
 654                 devinfo (dev, "open: enable queueing "
 655                                 "(rx %d, tx %d) mtu %d %s framing",
 656                         (int)RX_QLEN (dev), (int)TX_QLEN (dev), dev->net->mtu,
 657                         framing);
 658         }
 659
 660         // delay posting reads until we're fully open
 661         tasklet_schedule (&dev->bh);
 662 done:
 663         return retval;
 664 }
 665
 666 /*-------------------------------------------------------------------------*/
 667
 668 /* ethtool methods; minidrivers may need to add some more, but
 669  * they'll probably want to use this base set.
 670  */
 671
 672 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
 673 {
 674         struct usbnet *dev = netdev_priv(net);
 675
 676         /* REVISIT don't always return "usbnet" */
 677         strncpy (info->driver, driver_name, sizeof info->driver);
 678         strncpy (info->version, DRIVER_VERSION, sizeof info->version);
 679         strncpy (info->fw_version, dev->driver_info->description,
 680                 sizeof info->fw_version);
 681         usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
 682 }
 683 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
 684
 685 static u32 usbnet_get_link (struct net_device *net)
 686 {
 687         struct usbnet *dev = netdev_priv(net);
 688
 689         /* If a check_connect is defined, return its result */
 690         if (dev->driver_info->check_connect)
 691                 return dev->driver_info->check_connect (dev) == 0;
 692
 693         /* Otherwise, say we're up (to avoid breaking scripts) */
 694         return 1;
 695 }
 696
 697 u32 usbnet_get_msglevel (struct net_device *net)
 698 {
 699         struct usbnet *dev = netdev_priv(net);
 700
 701         return dev->msg_enable;
 702 }
 703 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
 704
 705 void usbnet_set_msglevel (struct net_device *net, u32 level)
 706 {
 707         struct usbnet *dev = netdev_priv(net);
 708
 709         dev->msg_enable = level;
 710 }
 711 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
 712
 713 /* drivers may override default ethtool_ops in their bind() routine */
 714 static struct ethtool_ops usbnet_ethtool_ops = {
 715         .get_drvinfo            = usbnet_get_drvinfo,
 716         .get_link               = usbnet_get_link,
 717         .get_msglevel           = usbnet_get_msglevel,
 718         .set_msglevel           = usbnet_set_msglevel,
 719 };
 720
 721 /*-------------------------------------------------------------------------*/
 722
 723 /* work that cannot be done in interrupt context uses keventd.
 724  *
 725  * NOTE:  with 2.5 we could do more of this using completion callbacks,
 726  * especially now that control transfers can be queued.
 727  */
 728 static void
 729 kevent (void *data)
 730 {
 731         struct usbnet           *dev = data;
 732         int                     status;
 733
 734         /* usb_clear_halt() needs a thread context */
 735         if (test_bit (EVENT_TX_HALT, &dev->flags)) {
 736                 unlink_urbs (dev, &dev->txq);
 737                 status = usb_clear_halt (dev->udev, dev->out);
 738                 if (status < 0
 739                                 && status != -EPIPE
 740                                 && status != -ESHUTDOWN) {
 741                         if (netif_msg_tx_err (dev))
 742                                 deverr (dev, "can't clear tx halt, status %d",
 743                                         status);
 744                 } else {
 745                         clear_bit (EVENT_TX_HALT, &dev->flags);
 746                         if (status != -ESHUTDOWN)
 747                                 netif_wake_queue (dev->net);
 748                 }
 749         }
 750         if (test_bit (EVENT_RX_HALT, &dev->flags)) {
 751                 unlink_urbs (dev, &dev->rxq);
 752                 status = usb_clear_halt (dev->udev, dev->in);
 753                 if (status < 0
 754                                 && status != -EPIPE
 755                                 && status != -ESHUTDOWN) {
 756                         if (netif_msg_rx_err (dev))
 757                                 deverr (dev, "can't clear rx halt, status %d",
 758                                         status);
 759                 } else {
 760                         clear_bit (EVENT_RX_HALT, &dev->flags);
 761                         tasklet_schedule (&dev->bh);
 762                 }
 763         }
 764
 765         /* tasklet could resubmit itself forever if memory is tight */
 766         if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
 767                 struct urb      *urb = NULL;
 768
 769                 if (netif_running (dev->net))
 770                         urb = usb_alloc_urb (0, GFP_KERNEL);
 771                 else
 772                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
 773                 if (urb != NULL) {
 774                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
 775                         rx_submit (dev, urb, GFP_KERNEL);
 776                         tasklet_schedule (&dev->bh);
 777                 }
 778         }
 779
 780         if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
 781                 struct driver_info      *info = dev->driver_info;
 782                 int                     retval = 0;
 783
 784                 clear_bit (EVENT_LINK_RESET, &dev->flags);
 785                 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
 786                         devinfo(dev, "link reset failed (%d) usbnet usb-%s-%s, %s",
 787                                 retval,
 788                                 dev->udev->bus->bus_name, dev->udev->devpath,
 789                                 info->description);
 790                 }
 791         }
 792
 793         if (dev->flags)
 794                 devdbg (dev, "kevent done, flags = 0x%lx",
 795                         dev->flags);
 796 }
 797
 798 /*-------------------------------------------------------------------------*/
 799
 800 static void tx_complete (struct urb *urb)
 801 {
 802         struct sk_buff          *skb = (struct sk_buff *) urb->context;
 803         struct skb_data         *entry = (struct skb_data *) skb->cb;
 804         struct usbnet           *dev = entry->dev;
 805
 806         if (urb->status == 0) {
 807                 dev->stats.tx_packets++;
 808                 dev->stats.tx_bytes += entry->length;
 809         } else {
 810                 dev->stats.tx_errors++;
 811
 812                 switch (urb->status) {
 813                 case -EPIPE:
 814                         usbnet_defer_kevent (dev, EVENT_TX_HALT);
 815                         break;
 816
 817                 /* software-driven interface shutdown */
 818                 case -ECONNRESET:               // async unlink
 819                 case -ESHUTDOWN:                // hardware gone
 820                         break;
 821
 822                 // like rx, tx gets controller i/o faults during khubd delays
 823                 // and so it uses the same throttling mechanism.
 824                 case -EPROTO:
 825                 case -ETIME:
 826                 case -EILSEQ:
 827                         if (!timer_pending (&dev->delay)) {
 828                                 mod_timer (&dev->delay,
 829                                         jiffies + THROTTLE_JIFFIES);
 830                                 if (netif_msg_link (dev))
 831                                         devdbg (dev, "tx throttle %d",
 832                                                         urb->status);
 833                         }
 834                         netif_stop_queue (dev->net);
 835                         break;
 836                 default:
 837                         if (netif_msg_tx_err (dev))
 838                                 devdbg (dev, "tx err %d", entry->urb->status);
 839                         break;
 840                 }
 841         }
 842
 843         urb->dev = NULL;
 844         entry->state = tx_done;
 845         defer_bh(dev, skb, &dev->txq);
 846 }
 847
 848 /*-------------------------------------------------------------------------*/
 849
 850 static void usbnet_tx_timeout (struct net_device *net)
 851 {
 852         struct usbnet           *dev = netdev_priv(net);
 853
 854         unlink_urbs (dev, &dev->txq);
 855         tasklet_schedule (&dev->bh);
 856
 857         // FIXME: device recovery -- reset?
 858 }
 859
 860 /*-------------------------------------------------------------------------*/
 861
 862 static int usbnet_start_xmit (struct sk_buff *skb, struct net_device *net)
 863 {
 864         struct usbnet           *dev = netdev_priv(net);
 865         int                     length;
 866         int                     retval = NET_XMIT_SUCCESS;
 867         struct urb              *urb = NULL;
 868         struct skb_data         *entry;
 869         struct driver_info      *info = dev->driver_info;
 870         unsigned long           flags;
 871
 872         // some devices want funky USB-level framing, for
 873         // win32 driver (usually) and/or hardware quirks
 874         if (info->tx_fixup) {
 875                 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
 876                 if (!skb) {
 877                         if (netif_msg_tx_err (dev))
 878                                 devdbg (dev, "can't tx_fixup skb");
 879                         goto drop;
 880                 }
 881         }
 882         length = skb->len;
 883
 884         if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
 885                 if (netif_msg_tx_err (dev))
 886                         devdbg (dev, "no urb");
 887                 goto drop;
 888         }
 889
 890         entry = (struct skb_data *) skb->cb;
 891         entry->urb = urb;
 892         entry->dev = dev;
 893         entry->state = tx_start;
 894         entry->length = length;
 895
 896         usb_fill_bulk_urb (urb, dev->udev, dev->out,
 897                         skb->data, skb->len, tx_complete, skb);
 898
 899         /* don't assume the hardware handles USB_ZERO_PACKET
 900          * NOTE:  strictly conforming cdc-ether devices should expect
 901          * the ZLP here, but ignore the one-byte packet.
 902          *
 903          * FIXME zero that byte, if it doesn't require a new skb.
 904          */
 905         if ((length % dev->maxpacket) == 0)
 906                 urb->transfer_buffer_length++;
 907
 908         spin_lock_irqsave (&dev->txq.lock, flags);
 909
 910         switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
 911         case -EPIPE:
 912                 netif_stop_queue (net);
 913                 usbnet_defer_kevent (dev, EVENT_TX_HALT);
 914                 break;
 915         default:
 916                 if (netif_msg_tx_err (dev))
 917                         devdbg (dev, "tx: submit urb err %d", retval);
 918                 break;
 919         case 0:
 920                 net->trans_start = jiffies;
 921                 __skb_queue_tail (&dev->txq, skb);
 922                 if (dev->txq.qlen >= TX_QLEN (dev))
 923                         netif_stop_queue (net);
 924         }
 925         spin_unlock_irqrestore (&dev->txq.lock, flags);
 926
 927         if (retval) {
 928                 if (netif_msg_tx_err (dev))
 929                         devdbg (dev, "drop, code %d", retval);
 930 drop:
 931                 retval = NET_XMIT_SUCCESS;
 932                 dev->stats.tx_dropped++;
 933                 if (skb)
 934                         dev_kfree_skb_any (skb);
 935                 usb_free_urb (urb);
 936         } else if (netif_msg_tx_queued (dev)) {
 937                 devdbg (dev, "> tx, len %d, type 0x%x",
 938                         length, skb->protocol);
 939         }
 940         return retval;
 941 }
 942
 943
 944 /*-------------------------------------------------------------------------*/
 945
 946 // tasklet (work deferred from completions, in_irq) or timer
 947
 948 static void usbnet_bh (unsigned long param)
 949 {
 950         struct usbnet           *dev = (struct usbnet *) param;
 951         struct sk_buff          *skb;
 952         struct skb_data         *entry;
 953
 954         while ((skb = skb_dequeue (&dev->done))) {
 955                 entry = (struct skb_data *) skb->cb;
 956                 switch (entry->state) {
 957                     case rx_done:
 958                         entry->state = rx_cleanup;
 959                         rx_process (dev, skb);
 960                         continue;
 961                     case tx_done:
 962                     case rx_cleanup:
 963                         usb_free_urb (entry->urb);
 964                         dev_kfree_skb (skb);
 965                         continue;
 966                     default:
 967                         devdbg (dev, "bogus skb state %d", entry->state);
 968                 }
 969         }
 970
 971         // waiting for all pending urbs to complete?
 972         if (dev->wait) {
 973                 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
 974                         wake_up (dev->wait);
 975                 }
 976
 977         // or are we maybe short a few urbs?
 978         } else if (netif_running (dev->net)
 979                         && netif_device_present (dev->net)
 980                         && !timer_pending (&dev->delay)
 981                         && !test_bit (EVENT_RX_HALT, &dev->flags)) {
 982                 int     temp = dev->rxq.qlen;
 983                 int     qlen = RX_QLEN (dev);
 984
 985                 if (temp < qlen) {
 986                         struct urb      *urb;
 987                         int             i;
 988
 989                         // don't refill the queue all at once
 990                         for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
 991                                 urb = usb_alloc_urb (0, GFP_ATOMIC);
 992                                 if (urb != NULL)
 993                                         rx_submit (dev, urb, GFP_ATOMIC);
 994                         }
 995                         if (temp != dev->rxq.qlen && netif_msg_link (dev))
 996                                 devdbg (dev, "rxqlen %d --> %d",
 997                                                 temp, dev->rxq.qlen);
 998                         if (dev->rxq.qlen < qlen)
 999                                 tasklet_schedule (&dev->bh);
1000                 }
1001                 if (dev->txq.qlen < TX_QLEN (dev))
1002                         netif_wake_queue (dev->net);
1003         }
1004 }
1005
1006
1007 \f
1008 /*-------------------------------------------------------------------------
1009  *
1010  * USB Device Driver support
1011  *
1012  *-------------------------------------------------------------------------*/
1013
1014 // precondition: never called in_interrupt
1015
1016 void usbnet_disconnect (struct usb_interface *intf)
1017 {
1018         struct usbnet           *dev;
1019         struct usb_device       *xdev;
1020         struct net_device       *net;
1021
1022         dev = usb_get_intfdata(intf);
1023         usb_set_intfdata(intf, NULL);
1024         if (!dev)
1025                 return;
1026
1027         xdev = interface_to_usbdev (intf);
1028
1029         if (netif_msg_probe (dev))
1030                 devinfo (dev, "unregister '%s' usb-%s-%s, %s",
1031                         intf->dev.driver->name,
1032                         xdev->bus->bus_name, xdev->devpath,
1033                         dev->driver_info->description);
1034
1035         net = dev->net;
1036         unregister_netdev (net);
1037
1038         /* we don't hold rtnl here ... */
1039         flush_scheduled_work ();
1040
1041         if (dev->driver_info->unbind)
1042                 dev->driver_info->unbind (dev, intf);
1043
1044         free_netdev(net);
1045         usb_put_dev (xdev);
1046 }
1047 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1048
1049
1050 /*-------------------------------------------------------------------------*/
1051
1052 // precondition: never called in_interrupt
1053
1054 int
1055 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1056 {
1057         struct usbnet                   *dev;
1058         struct net_device               *net;
1059         struct usb_host_interface       *interface;
1060         struct driver_info              *info;
1061         struct usb_device               *xdev;
1062         int                             status;
1063
1064         info = (struct driver_info *) prod->driver_info;
1065         if (!info) {
1066                 dev_dbg (&udev->dev, "blacklisted by %s\n", driver_name);
1067                 return -ENODEV;
1068         }
1069         xdev = interface_to_usbdev (udev);
1070         interface = udev->cur_altsetting;
1071
1072         usb_get_dev (xdev);
1073
1074         status = -ENOMEM;
1075
1076         // set up our own records
1077         net = alloc_etherdev(sizeof(*dev));
1078         if (!net) {
1079                 dbg ("can't kmalloc dev");
1080                 goto out;
1081         }
1082
1083         dev = netdev_priv(net);
1084         dev->udev = xdev;
1085         dev->driver_info = info;
1086         dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1087                                 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1088         skb_queue_head_init (&dev->rxq);
1089         skb_queue_head_init (&dev->txq);
1090         skb_queue_head_init (&dev->done);
1091         dev->bh.func = usbnet_bh;
1092         dev->bh.data = (unsigned long) dev;
1093         INIT_WORK (&dev->kevent, kevent, dev);
1094         dev->delay.function = usbnet_bh;
1095         dev->delay.data = (unsigned long) dev;
1096         init_timer (&dev->delay);
1097
1098         SET_MODULE_OWNER (net);
1099         dev->net = net;
1100         strcpy (net->name, "usb%d");
1101         memcpy (net->dev_addr, node_id, sizeof node_id);
1102
1103         /* rx and tx sides can use different message sizes;
1104          * bind() should set rx_urb_size in that case.
1105          */
1106         dev->hard_mtu = net->mtu + net->hard_header_len;
1107 #if 0
1108 // dma_supported() is deeply broken on almost all architectures
1109         // possible with some EHCI controllers
1110         if (dma_supported (&udev->dev, DMA_64BIT_MASK))
1111                 net->features |= NETIF_F_HIGHDMA;
1112 #endif
1113
1114         net->change_mtu = usbnet_change_mtu;
1115         net->get_stats = usbnet_get_stats;
1116         net->hard_start_xmit = usbnet_start_xmit;
1117         net->open = usbnet_open;
1118         net->stop = usbnet_stop;
1119         net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1120         net->tx_timeout = usbnet_tx_timeout;
1121         net->ethtool_ops = &usbnet_ethtool_ops;
1122
1123         // allow device-specific bind/init procedures
1124         // NOTE net->name still not usable ...
1125         if (info->bind) {
1126                 status = info->bind (dev, udev);
1127                 // heuristic:  "usb%d" for links we know are two-host,
1128                 // else "eth%d" when there's reasonable doubt.  userspace
1129                 // can rename the link if it knows better.
1130                 if ((dev->driver_info->flags & FLAG_ETHER) != 0
1131                                 && (net->dev_addr [0] & 0x02) == 0)
1132                         strcpy (net->name, "eth%d");
1133
1134                 /* maybe the remote can't receive an Ethernet MTU */
1135                 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1136                         net->mtu = dev->hard_mtu - net->hard_header_len;
1137         } else if (!info->in || !info->out)
1138                 status = usbnet_get_endpoints (dev, udev);
1139         else {
1140                 dev->in = usb_rcvbulkpipe (xdev, info->in);
1141                 dev->out = usb_sndbulkpipe (xdev, info->out);
1142                 if (!(info->flags & FLAG_NO_SETINT))
1143                         status = usb_set_interface (xdev,
1144                                 interface->desc.bInterfaceNumber,
1145                                 interface->desc.bAlternateSetting);
1146                 else
1147                         status = 0;
1148
1149         }
1150         if (status == 0 && dev->status)
1151                 status = init_status (dev, udev);
1152         if (status < 0)
1153                 goto out1;
1154
1155         if (!dev->rx_urb_size)
1156                 dev->rx_urb_size = dev->hard_mtu;
1157         dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1158
1159         SET_NETDEV_DEV(net, &udev->dev);
1160         status = register_netdev (net);
1161         if (status)
1162                 goto out3;
1163         if (netif_msg_probe (dev))
1164                 devinfo (dev, "register '%s' at usb-%s-%s, %s, "
1165                                 "%02x:%02x:%02x:%02x:%02x:%02x",
1166                         udev->dev.driver->name,
1167                         xdev->bus->bus_name, xdev->devpath,
1168                         dev->driver_info->description,
1169                         net->dev_addr [0], net->dev_addr [1],
1170                         net->dev_addr [2], net->dev_addr [3],
1171                         net->dev_addr [4], net->dev_addr [5]);
1172
1173         // ok, it's ready to go.
1174         usb_set_intfdata (udev, dev);
1175
1176         // start as if the link is up
1177         netif_device_attach (net);
1178
1179         return 0;
1180
1181 out3:
1182         if (info->unbind)
1183                 info->unbind (dev, udev);
1184 out1:
1185         free_netdev(net);
1186 out:
1187         usb_put_dev(xdev);
1188         return status;
1189 }
1190 EXPORT_SYMBOL_GPL(usbnet_probe);
1191
1192 /*-------------------------------------------------------------------------*/
1193
1194 /* FIXME these suspend/resume methods assume non-CDC style
1195  * devices, with only one interface.
1196  */
1197
1198 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1199 {
1200         struct usbnet           *dev = usb_get_intfdata(intf);
1201
1202         /* accelerate emptying of the rx and queues, to avoid
1203          * having everything error out.
1204          */
1205         netif_device_detach (dev->net);
1206         (void) unlink_urbs (dev, &dev->rxq);
1207         (void) unlink_urbs (dev, &dev->txq);
1208         return 0;
1209 }
1210 EXPORT_SYMBOL_GPL(usbnet_suspend);
1211
1212 int usbnet_resume (struct usb_interface *intf)
1213 {
1214         struct usbnet           *dev = usb_get_intfdata(intf);
1215
1216         netif_device_attach (dev->net);
1217         tasklet_schedule (&dev->bh);
1218         return 0;
1219 }
1220 EXPORT_SYMBOL_GPL(usbnet_resume);
1221
1222
1223 /*-------------------------------------------------------------------------*/
1224
1225 static int __init usbnet_init(void)
1226 {
1227         /* compiler should optimize this out */
1228         BUG_ON (sizeof (((struct sk_buff *)0)->cb)
1229                         < sizeof (struct skb_data));
1230
1231         random_ether_addr(node_id);
1232         return 0;
1233 }
1234 module_init(usbnet_init);
1235
1236 static void __exit usbnet_exit(void)
1237 {
1238 }
1239 module_exit(usbnet_exit);
1240
1241 MODULE_AUTHOR("David Brownell");
1242 MODULE_DESCRIPTION("USB network driver framework");
1243 MODULE_LICENSE("GPL");