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