1 /****************************************************************
 
   3  *     kaweth.c - driver for KL5KUSB101 based USB->Ethernet
 
   5  *     (c) 2000 Interlan Communications
 
   6  *     (c) 2000 Stephane Alnet
 
   8  *     (C) 2002 Oliver Neukum
 
  10  *     Original author: The Zapman <zapman@interlan.net>
 
  11  *     Inspired by, and much credit goes to Michael Rothwell
 
  12  *     <rothwell@interlan.net> for the test equipment, help, and patience
 
  13  *     Based off of (and with thanks to) Petko Manolov's pegaus.c driver.
 
  14  *     Also many thanks to Joel Silverman and Ed Surprenant at Kawasaki
 
  15  *     for providing the firmware and driver resources.
 
  17  *     This program is free software; you can redistribute it and/or
 
  18  *     modify it under the terms of the GNU General Public License as
 
  19  *     published by the Free Software Foundation; either version 2, or
 
  20  *     (at your option) any later version.
 
  22  *     This program is distributed in the hope that it will be useful,
 
  23  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  24  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
  25  *     GNU General Public License for more details.
 
  27  *     You should have received a copy of the GNU General Public License
 
  28  *     along with this program; if not, write to the Free Software Foundation,
 
  29  *     Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
  31  ****************************************************************/
 
  34  * Fix in_interrupt() problem
 
  35  * Develop test procedures for USB net interfaces
 
  37  * Fix bugs from previous two steps
 
  38  * Snoop other OSs for any tricks we're not doing
 
  40  * Reduce arbitrary timeouts
 
  41  * Smart multicast support
 
  42  * Temporary MAC change support
 
  43  * Tunable SOFs parameter - ioctl()?
 
  44  * Ethernet stats collection
 
  45  * Code formatting improvements
 
  48 #include <linux/module.h>
 
  49 #include <linux/sched.h>
 
  50 #include <linux/slab.h>
 
  51 #include <linux/string.h>
 
  52 #include <linux/init.h>
 
  53 #include <linux/delay.h>
 
  54 #include <linux/netdevice.h>
 
  55 #include <linux/etherdevice.h>
 
  56 #include <linux/usb.h>
 
  57 #include <linux/types.h>
 
  58 #include <linux/ethtool.h>
 
  59 #include <linux/pci.h>
 
  60 #include <linux/dma-mapping.h>
 
  61 #include <linux/wait.h>
 
  62 #include <asm/uaccess.h>
 
  63 #include <asm/semaphore.h>
 
  64 #include <asm/byteorder.h>
 
  69 #define kaweth_dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format "\n" ,##arg)
 
  71 #define kaweth_dbg(format, arg...) do {} while (0)
 
  73 #define kaweth_err(format, arg...) printk(KERN_ERR __FILE__ ": " format "\n" ,##arg)
 
  74 #define kaweth_info(format, arg...) printk(KERN_INFO __FILE__ ": " format "\n" , ##arg)
 
  75 #define kaweth_warn(format, arg...) printk(KERN_WARNING __FILE__ ": " format "\n" , ##arg)
 
  80 #define KAWETH_MTU                      1514
 
  81 #define KAWETH_BUF_SIZE                 1664
 
  82 #define KAWETH_TX_TIMEOUT               (5 * HZ)
 
  83 #define KAWETH_SCRATCH_SIZE             32
 
  84 #define KAWETH_FIRMWARE_BUF_SIZE        4096
 
  85 #define KAWETH_CONTROL_TIMEOUT          (30 * HZ)
 
  87 #define KAWETH_STATUS_BROKEN            0x0000001
 
  88 #define KAWETH_STATUS_CLOSING           0x0000002
 
  90 #define KAWETH_PACKET_FILTER_PROMISCUOUS        0x01
 
  91 #define KAWETH_PACKET_FILTER_ALL_MULTICAST      0x02
 
  92 #define KAWETH_PACKET_FILTER_DIRECTED           0x04
 
  93 #define KAWETH_PACKET_FILTER_BROADCAST          0x08
 
  94 #define KAWETH_PACKET_FILTER_MULTICAST          0x10
 
  97 #define KAWETH_COMMAND_GET_ETHERNET_DESC        0x00
 
  98 #define KAWETH_COMMAND_MULTICAST_FILTERS        0x01
 
  99 #define KAWETH_COMMAND_SET_PACKET_FILTER        0x02
 
 100 #define KAWETH_COMMAND_STATISTICS               0x03
 
 101 #define KAWETH_COMMAND_SET_TEMP_MAC             0x06
 
 102 #define KAWETH_COMMAND_GET_TEMP_MAC             0x07
 
 103 #define KAWETH_COMMAND_SET_URB_SIZE             0x08
 
 104 #define KAWETH_COMMAND_SET_SOFS_WAIT            0x09
 
 105 #define KAWETH_COMMAND_SCAN                     0xFF
 
 107 #define KAWETH_SOFS_TO_WAIT                     0x05
 
 109 #define INTBUFFERSIZE                           4
 
 111 #define STATE_OFFSET                            0
 
 112 #define STATE_MASK                              0x40
 
 113 #define STATE_SHIFT                             5
 
 116 MODULE_AUTHOR("Michael Zappe <zapman@interlan.net>, Stephane Alnet <stephane@u-picardie.fr>, Brad Hards <bhards@bigpond.net.au> and Oliver Neukum <oliver@neukum.org>");
 
 117 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
 
 118 MODULE_LICENSE("GPL");
 
 120 static const char driver_name[] = "kaweth";
 
 122 static int kaweth_probe(
 
 123                 struct usb_interface *intf,
 
 124                 const struct usb_device_id *id  /* from id_table */
 
 126 static void kaweth_disconnect(struct usb_interface *intf);
 
 127 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
 
 129                                        struct usb_ctrlrequest *cmd, void *data,
 
 130                                        int len, int timeout);
 
 132 /****************************************************************
 
 134  ****************************************************************/
 
 135 static struct usb_device_id usb_klsi_table[] = {
 
 136         { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
 
 137         { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
 
 138         { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
 
 139         { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
 
 140         { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
 
 141         { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
 
 142         { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
 
 143         { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
 
 144         { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
 
 145         { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
 
 146         { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
 
 147         { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
 
 148         { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
 
 149         { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
 
 150         { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
 
 151         { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
 
 152         { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
 
 153         { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
 
 154         { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
 
 155         { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
 
 156         { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
 
 157         { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
 
 158         { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
 
 159         { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
 
 160         { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
 
 161         { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
 
 162         { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
 
 163         { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
 
 164         { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
 
 165         { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
 
 166         { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
 
 167         { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
 
 168         { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
 
 169         {} /* Null terminator */
 
 172 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
 
 174 /****************************************************************
 
 176  ****************************************************************/
 
 177 static struct usb_driver kaweth_driver = {
 
 179         .probe =        kaweth_probe,
 
 180         .disconnect =   kaweth_disconnect,
 
 181         .id_table =     usb_klsi_table,
 
 184 typedef __u8 eth_addr_t[6];
 
 186 /****************************************************************
 
 188  ****************************************************************/
 
 196 /****************************************************************
 
 197  *     kaweth_ethernet_configuration
 
 199  ****************************************************************/
 
 200 struct kaweth_ethernet_configuration
 
 206         __u32 statistics_mask;
 
 208         __u16 max_multicast_filters;
 
 210 } __attribute__ ((packed));
 
 212 /****************************************************************
 
 214  ****************************************************************/
 
 217         spinlock_t device_lock;
 
 221         int suspend_lowmem_rx;
 
 222         int suspend_lowmem_ctrl;
 
 224         struct work_struct lowmem_work;
 
 226         struct usb_device *dev;
 
 227         struct net_device *net;
 
 228         wait_queue_head_t term_wait;
 
 234         dma_addr_t intbufferhandle;
 
 236         dma_addr_t rxbufferhandle;
 
 240         struct sk_buff *tx_skb;
 
 243         __u8 scratch[KAWETH_SCRATCH_SIZE];
 
 244         __u16 packet_filter_bitmap;
 
 246         struct kaweth_ethernet_configuration configuration;
 
 248         struct net_device_stats stats;
 
 252 /****************************************************************
 
 254  ****************************************************************/
 
 255 static int kaweth_control(struct kaweth_device *kaweth,
 
 265         struct usb_ctrlrequest *dr;
 
 267         kaweth_dbg("kaweth_control()");
 
 270                 kaweth_dbg("in_interrupt()");
 
 274         dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
 
 277                 kaweth_dbg("kmalloc() failed");
 
 281         dr->bRequestType= requesttype;
 
 282         dr->bRequest = request;
 
 283         dr->wValue = cpu_to_le16p(&value);
 
 284         dr->wIndex = cpu_to_le16p(&index);
 
 285         dr->wLength = cpu_to_le16p(&size);
 
 287         return kaweth_internal_control_msg(kaweth->dev,
 
 295 /****************************************************************
 
 296  *     kaweth_read_configuration
 
 297  ****************************************************************/
 
 298 static int kaweth_read_configuration(struct kaweth_device *kaweth)
 
 302         kaweth_dbg("Reading kaweth configuration");
 
 304         retval = kaweth_control(kaweth,
 
 305                                 usb_rcvctrlpipe(kaweth->dev, 0),
 
 306                                 KAWETH_COMMAND_GET_ETHERNET_DESC,
 
 307                                 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
 
 310                                 (void *)&kaweth->configuration,
 
 311                                 sizeof(kaweth->configuration),
 
 312                                 KAWETH_CONTROL_TIMEOUT);
 
 317 /****************************************************************
 
 318  *     kaweth_set_urb_size
 
 319  ****************************************************************/
 
 320 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
 
 324         kaweth_dbg("Setting URB size to %d", (unsigned)urb_size);
 
 326         retval = kaweth_control(kaweth,
 
 327                                 usb_sndctrlpipe(kaweth->dev, 0),
 
 328                                 KAWETH_COMMAND_SET_URB_SIZE,
 
 329                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 
 332                                 (void *)&kaweth->scratch,
 
 334                                 KAWETH_CONTROL_TIMEOUT);
 
 339 /****************************************************************
 
 340  *     kaweth_set_sofs_wait
 
 341  ****************************************************************/
 
 342 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
 
 346         kaweth_dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
 
 348         retval = kaweth_control(kaweth,
 
 349                                 usb_sndctrlpipe(kaweth->dev, 0),
 
 350                                 KAWETH_COMMAND_SET_SOFS_WAIT,
 
 351                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 
 354                                 (void *)&kaweth->scratch,
 
 356                                 KAWETH_CONTROL_TIMEOUT);
 
 361 /****************************************************************
 
 362  *     kaweth_set_receive_filter
 
 363  ****************************************************************/
 
 364 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
 
 365                                      __u16 receive_filter)
 
 369         kaweth_dbg("Set receive filter to %d", (unsigned)receive_filter);
 
 371         retval = kaweth_control(kaweth,
 
 372                                 usb_sndctrlpipe(kaweth->dev, 0),
 
 373                                 KAWETH_COMMAND_SET_PACKET_FILTER,
 
 374                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 
 377                                 (void *)&kaweth->scratch,
 
 379                                 KAWETH_CONTROL_TIMEOUT);
 
 384 /****************************************************************
 
 385  *     kaweth_download_firmware
 
 386  ****************************************************************/
 
 387 static int kaweth_download_firmware(struct kaweth_device *kaweth,
 
 393         if(data_len > KAWETH_FIRMWARE_BUF_SIZE) {
 
 394                 kaweth_err("Firmware too big: %d", data_len);
 
 398         memcpy(kaweth->firmware_buf, data, data_len);
 
 400         kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
 
 401         kaweth->firmware_buf[3] = data_len >> 8;
 
 402         kaweth->firmware_buf[4] = type;
 
 403         kaweth->firmware_buf[5] = interrupt;
 
 405         kaweth_dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
 
 406                    kaweth->firmware_buf[2]);
 
 408         kaweth_dbg("Downloading firmware at %p to kaweth device at %p",
 
 411         kaweth_dbg("Firmware length: %d", data_len);
 
 413         return kaweth_control(kaweth,
 
 414                               usb_sndctrlpipe(kaweth->dev, 0),
 
 416                               USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 
 419                               (void *)kaweth->firmware_buf,
 
 421                               KAWETH_CONTROL_TIMEOUT);
 
 424 /****************************************************************
 
 425  *     kaweth_trigger_firmware
 
 426  ****************************************************************/
 
 427 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
 
 430         kaweth->firmware_buf[0] = 0xB6;
 
 431         kaweth->firmware_buf[1] = 0xC3;
 
 432         kaweth->firmware_buf[2] = 0x01;
 
 433         kaweth->firmware_buf[3] = 0x00;
 
 434         kaweth->firmware_buf[4] = 0x06;
 
 435         kaweth->firmware_buf[5] = interrupt;
 
 436         kaweth->firmware_buf[6] = 0x00;
 
 437         kaweth->firmware_buf[7] = 0x00;
 
 439         kaweth_dbg("Triggering firmware");
 
 441         return kaweth_control(kaweth,
 
 442                               usb_sndctrlpipe(kaweth->dev, 0),
 
 444                               USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 
 447                               (void *)kaweth->firmware_buf,
 
 449                               KAWETH_CONTROL_TIMEOUT);
 
 452 /****************************************************************
 
 454  ****************************************************************/
 
 455 static int kaweth_reset(struct kaweth_device *kaweth)
 
 459         kaweth_dbg("kaweth_reset(%p)", kaweth);
 
 460         result = kaweth_control(kaweth,
 
 461                                 usb_sndctrlpipe(kaweth->dev, 0),
 
 462                                 USB_REQ_SET_CONFIGURATION,
 
 464                                 kaweth->dev->config[0].desc.bConfigurationValue,
 
 468                                 KAWETH_CONTROL_TIMEOUT);
 
 472         kaweth_dbg("kaweth_reset() returns %d.",result);
 
 477 static void kaweth_usb_receive(struct urb *, struct pt_regs *regs);
 
 478 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
 
 480 /****************************************************************
 
 482 *****************************************************************/
 
 484 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
 
 488         status = usb_submit_urb (kaweth->irq_urb, mf);
 
 489         if (unlikely(status == -ENOMEM)) {
 
 490                 kaweth->suspend_lowmem_ctrl = 1;
 
 491                 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
 
 493                 kaweth->suspend_lowmem_ctrl = 0;
 
 497                 err ("can't resubmit intr, %s-%s, status %d",
 
 498                                 kaweth->dev->bus->bus_name,
 
 499                                 kaweth->dev->devpath, status);
 
 502 static void int_callback(struct urb *u, struct pt_regs *regs)
 
 504         struct kaweth_device *kaweth = u->context;
 
 508         case 0:                 /* success */
 
 510         case -ECONNRESET:       /* unlink */
 
 514         /* -EPIPE:  should clear the halt */
 
 519         /* we check the link state to report changes */
 
 520         if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
 
 522                         netif_carrier_on(kaweth->net);
 
 524                         netif_carrier_off(kaweth->net);
 
 526                 kaweth->linkstate = act_state;
 
 529         kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
 
 532 static void kaweth_resubmit_tl(void *d)
 
 534         struct kaweth_device *kaweth = (struct kaweth_device *)d;
 
 536         if (kaweth->status | KAWETH_STATUS_CLOSING)
 
 539         if (kaweth->suspend_lowmem_rx)
 
 540                 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
 
 542         if (kaweth->suspend_lowmem_ctrl)
 
 543                 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
 
 547 /****************************************************************
 
 548  *     kaweth_resubmit_rx_urb
 
 549  ****************************************************************/
 
 550 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
 
 555         usb_fill_bulk_urb(kaweth->rx_urb,
 
 557                       usb_rcvbulkpipe(kaweth->dev, 1),
 
 562         kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 
 563         kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
 
 565         if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
 
 566                 if (result == -ENOMEM) {
 
 567                         kaweth->suspend_lowmem_rx = 1;
 
 568                         schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
 
 570                 kaweth_err("resubmitting rx_urb %d failed", result);
 
 572                 kaweth->suspend_lowmem_rx = 0;
 
 578 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
 
 580 /****************************************************************
 
 582  ****************************************************************/
 
 583 static void kaweth_usb_receive(struct urb *urb, struct pt_regs *regs)
 
 585         struct kaweth_device *kaweth = urb->context;
 
 586         struct net_device *net = kaweth->net;
 
 588         int count = urb->actual_length;
 
 589         int count2 = urb->transfer_buffer_length;
 
 591         __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
 
 595         if(unlikely(urb->status == -ECONNRESET || urb->status == -ESHUTDOWN))
 
 596         /* we are killed - set a flag and wake the disconnect handler */
 
 599                 wake_up(&kaweth->term_wait);
 
 603         if (kaweth->status & KAWETH_STATUS_CLOSING)
 
 606         if(urb->status && urb->status != -EREMOTEIO && count != 1) {
 
 607                 kaweth_err("%s RX status: %d count: %d packet_len: %d",
 
 612                 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 
 616         if(kaweth->net && (count > 2)) {
 
 617                 if(pkt_len > (count - 2)) {
 
 618                         kaweth_err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
 
 619                         kaweth_err("Packet len & 2047: %x", pkt_len & 2047);
 
 620                         kaweth_err("Count 2: %x", count2);
 
 621                         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 
 625                 if(!(skb = dev_alloc_skb(pkt_len+2))) {
 
 626                         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 
 630                 skb_reserve(skb, 2);    /* Align IP on 16 byte boundaries */
 
 634                 eth_copy_and_sum(skb, kaweth->rx_buf + 2, pkt_len, 0);
 
 636                 skb_put(skb, pkt_len);
 
 638                 skb->protocol = eth_type_trans(skb, net);
 
 642                 kaweth->stats.rx_packets++;
 
 643                 kaweth->stats.rx_bytes += pkt_len;
 
 646         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 
 649 /****************************************************************
 
 651  ****************************************************************/
 
 652 static int kaweth_open(struct net_device *net)
 
 654         struct kaweth_device *kaweth = netdev_priv(net);
 
 657         kaweth_dbg("Opening network device.");
 
 659         res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
 
 666                 usb_rcvintpipe(kaweth->dev, 3),
 
 671                 250); /* overriding the descriptor */
 
 672         kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
 
 673         kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 
 675         res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
 
 677                 usb_kill_urb(kaweth->rx_urb);
 
 681         netif_start_queue(net);
 
 683         kaweth_async_set_rx_mode(kaweth);
 
 687 /****************************************************************
 
 689  ****************************************************************/
 
 690 static int kaweth_close(struct net_device *net)
 
 692         struct kaweth_device *kaweth = netdev_priv(net);
 
 694         netif_stop_queue(net);
 
 696         kaweth->status |= KAWETH_STATUS_CLOSING;
 
 698         usb_kill_urb(kaweth->irq_urb);
 
 699         usb_kill_urb(kaweth->rx_urb);
 
 700         usb_kill_urb(kaweth->tx_urb);
 
 702         flush_scheduled_work();
 
 704         /* a scheduled work may have resubmitted,
 
 706         usb_kill_urb(kaweth->irq_urb);
 
 707         usb_kill_urb(kaweth->rx_urb);
 
 709         kaweth->status &= ~KAWETH_STATUS_CLOSING;
 
 714 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
 
 717         strlcpy(info->driver, driver_name, sizeof(info->driver));
 
 720 static struct ethtool_ops ops = {
 
 721         .get_drvinfo = kaweth_get_drvinfo
 
 724 /****************************************************************
 
 725  *     kaweth_usb_transmit_complete
 
 726  ****************************************************************/
 
 727 static void kaweth_usb_transmit_complete(struct urb *urb, struct pt_regs *regs)
 
 729         struct kaweth_device *kaweth = urb->context;
 
 730         struct sk_buff *skb = kaweth->tx_skb;
 
 732         if (unlikely(urb->status != 0))
 
 733                 if (urb->status != -ENOENT)
 
 734                         kaweth_dbg("%s: TX status %d.", kaweth->net->name, urb->status);
 
 736         netif_wake_queue(kaweth->net);
 
 737         dev_kfree_skb_irq(skb);
 
 740 /****************************************************************
 
 742  ****************************************************************/
 
 743 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
 
 745         struct kaweth_device *kaweth = netdev_priv(net);
 
 746         __le16 *private_header;
 
 750         spin_lock(&kaweth->device_lock);
 
 752         kaweth_async_set_rx_mode(kaweth);
 
 753         netif_stop_queue(net);
 
 755         /* We now decide whether we can put our special header into the sk_buff */
 
 756         if (skb_cloned(skb) || skb_headroom(skb) < 2) {
 
 757                 /* no such luck - we make our own */
 
 758                 struct sk_buff *copied_skb;
 
 759                 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
 
 760                 dev_kfree_skb_irq(skb);
 
 763                         kaweth->stats.tx_errors++;
 
 764                         netif_start_queue(net);
 
 765                         spin_unlock(&kaweth->device_lock);
 
 770         private_header = (__le16 *)__skb_push(skb, 2);
 
 771         *private_header = cpu_to_le16(skb->len-2);
 
 772         kaweth->tx_skb = skb;
 
 774         usb_fill_bulk_urb(kaweth->tx_urb,
 
 776                       usb_sndbulkpipe(kaweth->dev, 2),
 
 779                       kaweth_usb_transmit_complete,
 
 783         if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
 
 785                 kaweth_warn("kaweth failed tx_urb %d", res);
 
 786                 kaweth->stats.tx_errors++;
 
 788                 netif_start_queue(net);
 
 789                 dev_kfree_skb_irq(skb);
 
 793                 kaweth->stats.tx_packets++;
 
 794                 kaweth->stats.tx_bytes += skb->len;
 
 795                 net->trans_start = jiffies;
 
 798         spin_unlock(&kaweth->device_lock);
 
 803 /****************************************************************
 
 805  ****************************************************************/
 
 806 static void kaweth_set_rx_mode(struct net_device *net)
 
 808         struct kaweth_device *kaweth = netdev_priv(net);
 
 810         __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
 
 811                                      KAWETH_PACKET_FILTER_BROADCAST |
 
 812                                      KAWETH_PACKET_FILTER_MULTICAST;
 
 814         kaweth_dbg("Setting Rx mode to %d", packet_filter_bitmap);
 
 816         netif_stop_queue(net);
 
 818         if (net->flags & IFF_PROMISC) {
 
 819                 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
 
 821         else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
 
 822                 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
 
 825         kaweth->packet_filter_bitmap = packet_filter_bitmap;
 
 826         netif_wake_queue(net);
 
 829 /****************************************************************
 
 830  *     kaweth_async_set_rx_mode
 
 831  ****************************************************************/
 
 832 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
 
 834         __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
 
 835         kaweth->packet_filter_bitmap = 0;
 
 836         if (packet_filter_bitmap == 0)
 
 841         result = kaweth_control(kaweth,
 
 842                                 usb_sndctrlpipe(kaweth->dev, 0),
 
 843                                 KAWETH_COMMAND_SET_PACKET_FILTER,
 
 844                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 
 845                                 packet_filter_bitmap,
 
 847                                 (void *)&kaweth->scratch,
 
 849                                 KAWETH_CONTROL_TIMEOUT);
 
 852                 kaweth_err("Failed to set Rx mode: %d", result);
 
 855                 kaweth_dbg("Set Rx mode to %d", packet_filter_bitmap);
 
 860 /****************************************************************
 
 861  *     kaweth_netdev_stats
 
 862  ****************************************************************/
 
 863 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
 
 865         struct kaweth_device *kaweth = netdev_priv(dev);
 
 866         return &kaweth->stats;
 
 869 /****************************************************************
 
 871  ****************************************************************/
 
 872 static void kaweth_tx_timeout(struct net_device *net)
 
 874         struct kaweth_device *kaweth = netdev_priv(net);
 
 876         kaweth_warn("%s: Tx timed out. Resetting.", net->name);
 
 877         kaweth->stats.tx_errors++;
 
 878         net->trans_start = jiffies;
 
 880         usb_unlink_urb(kaweth->tx_urb);
 
 883 /****************************************************************
 
 885  ****************************************************************/
 
 886 static int kaweth_probe(
 
 887                 struct usb_interface *intf,
 
 888                 const struct usb_device_id *id      /* from id_table */
 
 891         struct usb_device *dev = interface_to_usbdev(intf);
 
 892         struct kaweth_device *kaweth;
 
 893         struct net_device *netdev;
 
 894         const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
 
 897         kaweth_dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
 
 899                  le16_to_cpu(dev->descriptor.idVendor),
 
 900                  le16_to_cpu(dev->descriptor.idProduct),
 
 901                  le16_to_cpu(dev->descriptor.bcdDevice));
 
 903         kaweth_dbg("Device at %p", dev);
 
 905         kaweth_dbg("Descriptor length: %x type: %x",
 
 906                  (int)dev->descriptor.bLength,
 
 907                  (int)dev->descriptor.bDescriptorType);
 
 909         netdev = alloc_etherdev(sizeof(*kaweth));
 
 913         kaweth = netdev_priv(netdev);
 
 915         kaweth->net = netdev;
 
 917         spin_lock_init(&kaweth->device_lock);
 
 918         init_waitqueue_head(&kaweth->term_wait);
 
 920         kaweth_dbg("Resetting.");
 
 922         kaweth_reset(kaweth);
 
 925          * If high byte of bcdDevice is nonzero, firmware is already
 
 926          * downloaded. Don't try to do it again, or we'll hang the device.
 
 929         if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
 
 930                 kaweth_info("Firmware present in device.");
 
 932                 /* Download the firmware */
 
 933                 kaweth_info("Downloading firmware...");
 
 934                 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
 
 935                 if ((result = kaweth_download_firmware(kaweth,
 
 940                         kaweth_err("Error downloading firmware (%d)", result);
 
 944                 if ((result = kaweth_download_firmware(kaweth,
 
 946                                                       len_kaweth_new_code_fix,
 
 949                         kaweth_err("Error downloading firmware fix (%d)", result);
 
 953                 if ((result = kaweth_download_firmware(kaweth,
 
 955                                                       len_kaweth_trigger_code,
 
 958                         kaweth_err("Error downloading trigger code (%d)", result);
 
 963                 if ((result = kaweth_download_firmware(kaweth,
 
 964                                                       kaweth_trigger_code_fix,
 
 965                                                       len_kaweth_trigger_code_fix,
 
 968                         kaweth_err("Error downloading trigger code fix (%d)", result);
 
 973                 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
 
 974                         kaweth_err("Error triggering firmware (%d)", result);
 
 978                 /* Device will now disappear for a moment...  */
 
 979                 kaweth_info("Firmware loaded.  I'll be back...");
 
 981                 free_page((unsigned long)kaweth->firmware_buf);
 
 986         result = kaweth_read_configuration(kaweth);
 
 989                 kaweth_err("Error reading configuration (%d), no net device created", result);
 
 990                 goto err_free_netdev;
 
 993         kaweth_info("Statistics collection: %x", kaweth->configuration.statistics_mask);
 
 994         kaweth_info("Multicast filter limit: %x", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
 
 995         kaweth_info("MTU: %d", le16_to_cpu(kaweth->configuration.segment_size));
 
 996         kaweth_info("Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
 
 997                  (int)kaweth->configuration.hw_addr[0],
 
 998                  (int)kaweth->configuration.hw_addr[1],
 
 999                  (int)kaweth->configuration.hw_addr[2],
 
1000                  (int)kaweth->configuration.hw_addr[3],
 
1001                  (int)kaweth->configuration.hw_addr[4],
 
1002                  (int)kaweth->configuration.hw_addr[5]);
 
1004         if(!memcmp(&kaweth->configuration.hw_addr,
 
1006                    sizeof(bcast_addr))) {
 
1007                 kaweth_err("Firmware not functioning properly, no net device created");
 
1008                 goto err_free_netdev;
 
1011         if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
 
1012                 kaweth_dbg("Error setting URB size");
 
1013                 goto err_free_netdev;
 
1016         if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
 
1017                 kaweth_err("Error setting SOFS wait");
 
1018                 goto err_free_netdev;
 
1021         result = kaweth_set_receive_filter(kaweth,
 
1022                                            KAWETH_PACKET_FILTER_DIRECTED |
 
1023                                            KAWETH_PACKET_FILTER_BROADCAST |
 
1024                                            KAWETH_PACKET_FILTER_MULTICAST);
 
1027                 kaweth_err("Error setting receive filter");
 
1028                 goto err_free_netdev;
 
1031         kaweth_dbg("Initializing net device.");
 
1033         kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
 
1034         if (!kaweth->tx_urb)
 
1035                 goto err_free_netdev;
 
1036         kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
 
1037         if (!kaweth->rx_urb)
 
1039         kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
 
1040         if (!kaweth->irq_urb)
 
1043         kaweth->intbuffer = usb_buffer_alloc(   kaweth->dev,
 
1046                                                 &kaweth->intbufferhandle);
 
1047         if (!kaweth->intbuffer)
 
1048                 goto err_tx_and_rx_and_irq;
 
1049         kaweth->rx_buf = usb_buffer_alloc(      kaweth->dev,
 
1052                                                 &kaweth->rxbufferhandle);
 
1053         if (!kaweth->rx_buf)
 
1054                 goto err_all_but_rxbuf;
 
1056         memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
 
1057         memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
 
1058                sizeof(kaweth->configuration.hw_addr));
 
1060         netdev->open = kaweth_open;
 
1061         netdev->stop = kaweth_close;
 
1063         netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
 
1064         netdev->tx_timeout = kaweth_tx_timeout;
 
1066         netdev->hard_start_xmit = kaweth_start_xmit;
 
1067         netdev->set_multicast_list = kaweth_set_rx_mode;
 
1068         netdev->get_stats = kaweth_netdev_stats;
 
1069         netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
 
1070         SET_ETHTOOL_OPS(netdev, &ops);
 
1072         /* kaweth is zeroed as part of alloc_netdev */
 
1074         INIT_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl, (void *)kaweth);
 
1076         SET_MODULE_OWNER(netdev);
 
1078         usb_set_intfdata(intf, kaweth);
 
1081 // dma_supported() is deeply broken on almost all architectures
 
1082         if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
 
1083                 kaweth->net->features |= NETIF_F_HIGHDMA;
 
1086         SET_NETDEV_DEV(netdev, &intf->dev);
 
1087         if (register_netdev(netdev) != 0) {
 
1088                 kaweth_err("Error registering netdev.");
 
1092         kaweth_info("kaweth interface created at %s", kaweth->net->name);
 
1094         kaweth_dbg("Kaweth probe returning.");
 
1099         usb_set_intfdata(intf, NULL);
 
1100         usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
 
1102         usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
 
1103 err_tx_and_rx_and_irq:
 
1104         usb_free_urb(kaweth->irq_urb);
 
1106         usb_free_urb(kaweth->rx_urb);
 
1108         usb_free_urb(kaweth->tx_urb);
 
1110         free_netdev(netdev);
 
1115 /****************************************************************
 
1117  ****************************************************************/
 
1118 static void kaweth_disconnect(struct usb_interface *intf)
 
1120         struct kaweth_device *kaweth = usb_get_intfdata(intf);
 
1121         struct net_device *netdev;
 
1123         kaweth_info("Unregistering");
 
1125         usb_set_intfdata(intf, NULL);
 
1127                 kaweth_warn("unregistering non-existant device");
 
1130         netdev = kaweth->net;
 
1132         kaweth_dbg("Unregistering net device");
 
1133         unregister_netdev(netdev);
 
1135         usb_free_urb(kaweth->rx_urb);
 
1136         usb_free_urb(kaweth->tx_urb);
 
1137         usb_free_urb(kaweth->irq_urb);
 
1139         usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
 
1140         usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
 
1142         free_netdev(netdev);
 
1146 // FIXME this completion stuff is a modified clone of
 
1147 // an OLD version of some stuff in usb.c ...
 
1148 struct usb_api_data {
 
1149         wait_queue_head_t wqh;
 
1153 /*-------------------------------------------------------------------*
 
1154  * completion handler for compatibility wrappers (sync control/bulk) *
 
1155  *-------------------------------------------------------------------*/
 
1156 static void usb_api_blocking_completion(struct urb *urb, struct pt_regs *regs)
 
1158         struct usb_api_data *awd = (struct usb_api_data *)urb->context;
 
1164 /*-------------------------------------------------------------------*
 
1165  *                         COMPATIBILITY STUFF                       *
 
1166  *-------------------------------------------------------------------*/
 
1168 // Starts urb and waits for completion or timeout
 
1169 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
 
1171         struct usb_api_data awd;
 
1174         init_waitqueue_head(&awd.wqh);
 
1177         urb->context = &awd;
 
1178         status = usb_submit_urb(urb, GFP_NOIO);
 
1180                 // something went wrong
 
1185         if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
 
1187                 kaweth_warn("usb_control/bulk_msg: timeout");
 
1188                 usb_kill_urb(urb);  // remove urb safely
 
1189                 status = -ETIMEDOUT;
 
1192                 status = urb->status;
 
1195         if (actual_length) {
 
1196                 *actual_length = urb->actual_length;
 
1203 /*-------------------------------------------------------------------*/
 
1204 // returns status (negative) or length (positive)
 
1205 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
 
1207                                        struct usb_ctrlrequest *cmd, void *data,
 
1208                                        int len, int timeout)
 
1214         urb = usb_alloc_urb(0, GFP_NOIO);
 
1218         usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
 
1219                          len, usb_api_blocking_completion, NULL);
 
1221         retv = usb_start_wait_urb(urb, timeout, &length);
 
1231 /****************************************************************
 
1233  ****************************************************************/
 
1234 static int __init kaweth_init(void)
 
1236         kaweth_dbg("Driver loading");
 
1237         return usb_register(&kaweth_driver);
 
1240 /****************************************************************
 
1242  ****************************************************************/
 
1243 static void __exit kaweth_exit(void)
 
1245         usb_deregister(&kaweth_driver);
 
1248 module_init(kaweth_init);
 
1249 module_exit(kaweth_exit);