drivers/net/usb/kaweth.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /****************************************************************
   3  *
   4  *     kaweth.c - driver for KL5KUSB101 based USB->Ethernet
   5  *
   6  *     (c) 2000 Interlan Communications
   7  *     (c) 2000 Stephane Alnet
   8  *     (C) 2001 Brad Hards
   9  *     (C) 2002 Oliver Neukum
  10  *
  11  *     Original author: The Zapman <zapman@interlan.net>
  12  *     Inspired by, and much credit goes to Michael Rothwell
  13  *     <rothwell@interlan.net> for the test equipment, help, and patience
  14  *     Based off of (and with thanks to) Petko Manolov's pegaus.c driver.
  15  *     Also many thanks to Joel Silverman and Ed Surprenant at Kawasaki
  16  *     for providing the firmware and driver resources.
  17  *
  18  ****************************************************************/
  19
  20 /* TODO:
  21  * Develop test procedures for USB net interfaces
  22  * Run test procedures
  23  * Fix bugs from previous two steps
  24  * Snoop other OSs for any tricks we're not doing
  25  * Reduce arbitrary timeouts
  26  * Smart multicast support
  27  * Temporary MAC change support
  28  * Tunable SOFs parameter - ioctl()?
  29  * Ethernet stats collection
  30  * Code formatting improvements
  31  */
  32
  33 #include <linux/module.h>
  34 #include <linux/slab.h>
  35 #include <linux/string.h>
  36 #include <linux/delay.h>
  37 #include <linux/netdevice.h>
  38 #include <linux/etherdevice.h>
  39 #include <linux/usb.h>
  40 #include <linux/types.h>
  41 #include <linux/ethtool.h>
  42 #include <linux/dma-mapping.h>
  43 #include <linux/wait.h>
  44 #include <linux/firmware.h>
  45 #include <linux/uaccess.h>
  46 #include <asm/byteorder.h>
  47
  48 #undef DEBUG
  49
  50 #define KAWETH_MTU                      1514
  51 #define KAWETH_BUF_SIZE                 1664
  52 #define KAWETH_TX_TIMEOUT               (5 * HZ)
  53 #define KAWETH_SCRATCH_SIZE             32
  54 #define KAWETH_FIRMWARE_BUF_SIZE        4096
  55 #define KAWETH_CONTROL_TIMEOUT          (30000)
  56
  57 #define KAWETH_STATUS_BROKEN            0x0000001
  58 #define KAWETH_STATUS_CLOSING           0x0000002
  59 #define KAWETH_STATUS_SUSPENDING        0x0000004
  60
  61 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
  62
  63 #define KAWETH_PACKET_FILTER_PROMISCUOUS        0x01
  64 #define KAWETH_PACKET_FILTER_ALL_MULTICAST      0x02
  65 #define KAWETH_PACKET_FILTER_DIRECTED           0x04
  66 #define KAWETH_PACKET_FILTER_BROADCAST          0x08
  67 #define KAWETH_PACKET_FILTER_MULTICAST          0x10
  68
  69 /* Table 7 */
  70 #define KAWETH_COMMAND_GET_ETHERNET_DESC        0x00
  71 #define KAWETH_COMMAND_MULTICAST_FILTERS        0x01
  72 #define KAWETH_COMMAND_SET_PACKET_FILTER        0x02
  73 #define KAWETH_COMMAND_STATISTICS               0x03
  74 #define KAWETH_COMMAND_SET_TEMP_MAC             0x06
  75 #define KAWETH_COMMAND_GET_TEMP_MAC             0x07
  76 #define KAWETH_COMMAND_SET_URB_SIZE             0x08
  77 #define KAWETH_COMMAND_SET_SOFS_WAIT            0x09
  78 #define KAWETH_COMMAND_SCAN                     0xFF
  79
  80 #define KAWETH_SOFS_TO_WAIT                     0x05
  81
  82 #define INTBUFFERSIZE                           4
  83
  84 #define STATE_OFFSET                            0
  85 #define STATE_MASK                              0x40
  86 #define STATE_SHIFT                             5
  87
  88 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
  89
  90
  91 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>");
  92 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
  93 MODULE_LICENSE("GPL");
  94 /*(DEBLOBBED)*/
  95
  96 static const char driver_name[] = "kaweth";
  97
  98 static int kaweth_probe(
  99                 struct usb_interface *intf,
 100                 const struct usb_device_id *id  /* from id_table */
 101         );
 102 static void kaweth_disconnect(struct usb_interface *intf);
 103 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
 104 static int kaweth_resume(struct usb_interface *intf);
 105
 106 /****************************************************************
 107  *     usb_device_id
 108  ****************************************************************/
 109 static const struct usb_device_id usb_klsi_table[] = {
 110         { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
 111         { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
 112         { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
 113         { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
 114         { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
 115         { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
 116         { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
 117         { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
 118         { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
 119         { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
 120         { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
 121         { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
 122         { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
 123         { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
 124         { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
 125         { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
 126         { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
 127         { USB_DEVICE(0x07c9, 0xb010) }, /* Allied Telesyn AT-USB10 USB Ethernet Adapter */
 128         { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
 129         { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
 130         { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
 131         { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
 132         { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
 133         { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
 134         { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
 135         { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
 136         { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
 137         { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
 138         { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
 139         { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
 140         { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
 141         { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
 142         { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
 143         { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
 144         { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
 145         {} /* Null terminator */
 146 };
 147
 148 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
 149
 150 /****************************************************************
 151  *     kaweth_driver
 152  ****************************************************************/
 153 static struct usb_driver kaweth_driver = {
 154         .name =         driver_name,
 155         .probe =        kaweth_probe,
 156         .disconnect =   kaweth_disconnect,
 157         .suspend =      kaweth_suspend,
 158         .resume =       kaweth_resume,
 159         .id_table =     usb_klsi_table,
 160         .supports_autosuspend = 1,
 161         .disable_hub_initiated_lpm = 1,
 162 };
 163
 164 typedef __u8 eth_addr_t[6];
 165
 166 /****************************************************************
 167  *     usb_eth_dev
 168  ****************************************************************/
 169 struct usb_eth_dev {
 170         char *name;
 171         __u16 vendor;
 172         __u16 device;
 173         void *pdata;
 174 };
 175
 176 /****************************************************************
 177  *     kaweth_ethernet_configuration
 178  *     Refer Table 8
 179  ****************************************************************/
 180 struct kaweth_ethernet_configuration
 181 {
 182         __u8 size;
 183         __u8 reserved1;
 184         __u8 reserved2;
 185         eth_addr_t hw_addr;
 186         __u32 statistics_mask;
 187         __le16 segment_size;
 188         __u16 max_multicast_filters;
 189         __u8 reserved3;
 190 } __packed;
 191
 192 /****************************************************************
 193  *     kaweth_device
 194  ****************************************************************/
 195 struct kaweth_device
 196 {
 197         spinlock_t device_lock;
 198
 199         __u32 status;
 200         int end;
 201         int suspend_lowmem_rx;
 202         int suspend_lowmem_ctrl;
 203         int linkstate;
 204         int opened;
 205         struct delayed_work lowmem_work;
 206
 207         struct usb_device *dev;
 208         struct usb_interface *intf;
 209         struct net_device *net;
 210         wait_queue_head_t term_wait;
 211
 212         struct urb *rx_urb;
 213         struct urb *tx_urb;
 214         struct urb *irq_urb;
 215
 216         dma_addr_t intbufferhandle;
 217         __u8 *intbuffer;
 218         dma_addr_t rxbufferhandle;
 219         __u8 *rx_buf;
 220
 221
 222         struct sk_buff *tx_skb;
 223
 224         __u8 *firmware_buf;
 225         __u8 scratch[KAWETH_SCRATCH_SIZE];
 226         __u16 packet_filter_bitmap;
 227
 228         struct kaweth_ethernet_configuration configuration;
 229 };
 230
 231 /****************************************************************
 232  *     kaweth_read_configuration
 233  ****************************************************************/
 234 static int kaweth_read_configuration(struct kaweth_device *kaweth)
 235 {
 236         return usb_control_msg(kaweth->dev, usb_rcvctrlpipe(kaweth->dev, 0),
 237                                 KAWETH_COMMAND_GET_ETHERNET_DESC,
 238                                 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
 239                                 0, 0,
 240                                 &kaweth->configuration,
 241                                 sizeof(kaweth->configuration),
 242                                 KAWETH_CONTROL_TIMEOUT);
 243 }
 244
 245 /****************************************************************
 246  *     kaweth_set_urb_size
 247  ****************************************************************/
 248 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
 249 {
 250         netdev_dbg(kaweth->net, "Setting URB size to %d\n", (unsigned)urb_size);
 251
 252         return usb_control_msg(kaweth->dev, usb_sndctrlpipe(kaweth->dev, 0),
 253                                KAWETH_COMMAND_SET_URB_SIZE,
 254                                USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 255                                urb_size, 0,
 256                                &kaweth->scratch, 0,
 257                                KAWETH_CONTROL_TIMEOUT);
 258 }
 259
 260 /****************************************************************
 261  *     kaweth_set_sofs_wait
 262  ****************************************************************/
 263 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
 264 {
 265         netdev_dbg(kaweth->net, "Set SOFS wait to %d\n", (unsigned)sofs_wait);
 266
 267         return usb_control_msg(kaweth->dev, usb_sndctrlpipe(kaweth->dev, 0),
 268                                KAWETH_COMMAND_SET_SOFS_WAIT,
 269                                USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 270                                sofs_wait, 0,
 271                                &kaweth->scratch, 0,
 272                                KAWETH_CONTROL_TIMEOUT);
 273 }
 274
 275 /****************************************************************
 276  *     kaweth_set_receive_filter
 277  ****************************************************************/
 278 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
 279                                      __u16 receive_filter)
 280 {
 281         netdev_dbg(kaweth->net, "Set receive filter to %d\n",
 282                    (unsigned)receive_filter);
 283
 284         return usb_control_msg(kaweth->dev, usb_sndctrlpipe(kaweth->dev, 0),
 285                                KAWETH_COMMAND_SET_PACKET_FILTER,
 286                                USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 287                                receive_filter, 0,
 288                                &kaweth->scratch, 0,
 289                                KAWETH_CONTROL_TIMEOUT);
 290 }
 291
 292 /****************************************************************
 293  *     kaweth_download_firmware
 294  ****************************************************************/
 295 static int kaweth_download_firmware(struct kaweth_device *kaweth,
 296                                     const char *fwname,
 297                                     __u8 interrupt,
 298                                     __u8 type)
 299 {
 300         const struct firmware *fw;
 301         int data_len;
 302         int ret;
 303
 304         ret = reject_firmware(&fw, fwname, &kaweth->dev->dev);
 305         if (ret) {
 306                 dev_err(&kaweth->intf->dev, "Firmware request failed\n");
 307                 return ret;
 308         }
 309
 310         if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
 311                 dev_err(&kaweth->intf->dev, "Firmware too big: %zu\n",
 312                         fw->size);
 313                 release_firmware(fw);
 314                 return -ENOSPC;
 315         }
 316         data_len = fw->size;
 317         memcpy(kaweth->firmware_buf, fw->data, fw->size);
 318
 319         release_firmware(fw);
 320
 321         kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
 322         kaweth->firmware_buf[3] = data_len >> 8;
 323         kaweth->firmware_buf[4] = type;
 324         kaweth->firmware_buf[5] = interrupt;
 325
 326         netdev_dbg(kaweth->net, "High: %i, Low:%i\n", kaweth->firmware_buf[3],
 327                    kaweth->firmware_buf[2]);
 328
 329         netdev_dbg(kaweth->net,
 330                    "Downloading firmware at %p to kaweth device at %p\n",
 331                    kaweth->firmware_buf, kaweth);
 332         netdev_dbg(kaweth->net, "Firmware length: %d\n", data_len);
 333
 334         return usb_control_msg(kaweth->dev, usb_sndctrlpipe(kaweth->dev, 0),
 335                               KAWETH_COMMAND_SCAN,
 336                               USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 337                               0, 0,
 338                               kaweth->firmware_buf, data_len,
 339                               KAWETH_CONTROL_TIMEOUT);
 340 }
 341
 342 /****************************************************************
 343  *     kaweth_trigger_firmware
 344  ****************************************************************/
 345 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
 346                                    __u8 interrupt)
 347 {
 348         kaweth->firmware_buf[0] = 0xB6;
 349         kaweth->firmware_buf[1] = 0xC3;
 350         kaweth->firmware_buf[2] = 0x01;
 351         kaweth->firmware_buf[3] = 0x00;
 352         kaweth->firmware_buf[4] = 0x06;
 353         kaweth->firmware_buf[5] = interrupt;
 354         kaweth->firmware_buf[6] = 0x00;
 355         kaweth->firmware_buf[7] = 0x00;
 356
 357         return usb_control_msg(kaweth->dev, usb_sndctrlpipe(kaweth->dev, 0),
 358                                KAWETH_COMMAND_SCAN,
 359                                USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 360                                0, 0,
 361                                (void *)kaweth->firmware_buf, 8,
 362                                KAWETH_CONTROL_TIMEOUT);
 363 }
 364
 365 /****************************************************************
 366  *     kaweth_reset
 367  ****************************************************************/
 368 static int kaweth_reset(struct kaweth_device *kaweth)
 369 {
 370         int result;
 371
 372         result = usb_reset_configuration(kaweth->dev);
 373         mdelay(10);
 374
 375         netdev_dbg(kaweth->net, "kaweth_reset() returns %d.\n", result);
 376
 377         return result;
 378 }
 379
 380 static void kaweth_usb_receive(struct urb *);
 381 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
 382
 383 /****************************************************************
 384         int_callback
 385 *****************************************************************/
 386
 387 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
 388 {
 389         int status;
 390
 391         status = usb_submit_urb (kaweth->irq_urb, mf);
 392         if (unlikely(status == -ENOMEM)) {
 393                 kaweth->suspend_lowmem_ctrl = 1;
 394                 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
 395         } else {
 396                 kaweth->suspend_lowmem_ctrl = 0;
 397         }
 398
 399         if (status)
 400                 dev_err(&kaweth->intf->dev,
 401                         "can't resubmit intr, %s-%s, status %d\n",
 402                         kaweth->dev->bus->bus_name,
 403                         kaweth->dev->devpath, status);
 404 }
 405
 406 static void int_callback(struct urb *u)
 407 {
 408         struct kaweth_device *kaweth = u->context;
 409         int act_state;
 410         int status = u->status;
 411
 412         switch (status) {
 413         case 0:                 /* success */
 414                 break;
 415         case -ECONNRESET:       /* unlink */
 416         case -ENOENT:
 417         case -ESHUTDOWN:
 418                 return;
 419         /* -EPIPE:  should clear the halt */
 420         default:                /* error */
 421                 goto resubmit;
 422         }
 423
 424         /* we check the link state to report changes */
 425         if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
 426                 if (act_state)
 427                         netif_carrier_on(kaweth->net);
 428                 else
 429                         netif_carrier_off(kaweth->net);
 430
 431                 kaweth->linkstate = act_state;
 432         }
 433 resubmit:
 434         kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
 435 }
 436
 437 static void kaweth_resubmit_tl(struct work_struct *work)
 438 {
 439         struct kaweth_device *kaweth =
 440                 container_of(work, struct kaweth_device, lowmem_work.work);
 441
 442         if (IS_BLOCKED(kaweth->status))
 443                 return;
 444
 445         if (kaweth->suspend_lowmem_rx)
 446                 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
 447
 448         if (kaweth->suspend_lowmem_ctrl)
 449                 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
 450 }
 451
 452
 453 /****************************************************************
 454  *     kaweth_resubmit_rx_urb
 455  ****************************************************************/
 456 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
 457                                                 gfp_t mem_flags)
 458 {
 459         int result;
 460
 461         usb_fill_bulk_urb(kaweth->rx_urb,
 462                       kaweth->dev,
 463                       usb_rcvbulkpipe(kaweth->dev, 1),
 464                       kaweth->rx_buf,
 465                       KAWETH_BUF_SIZE,
 466                       kaweth_usb_receive,
 467                       kaweth);
 468         kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 469         kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
 470
 471         if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
 472                 if (result == -ENOMEM) {
 473                         kaweth->suspend_lowmem_rx = 1;
 474                         schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
 475                 }
 476                 dev_err(&kaweth->intf->dev, "resubmitting rx_urb %d failed\n",
 477                         result);
 478         } else {
 479                 kaweth->suspend_lowmem_rx = 0;
 480         }
 481
 482         return result;
 483 }
 484
 485 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth,
 486                                      bool may_sleep);
 487
 488 /****************************************************************
 489  *     kaweth_usb_receive
 490  ****************************************************************/
 491 static void kaweth_usb_receive(struct urb *urb)
 492 {
 493         struct device *dev = &urb->dev->dev;
 494         struct kaweth_device *kaweth = urb->context;
 495         struct net_device *net = kaweth->net;
 496         int status = urb->status;
 497         unsigned long flags;
 498         int count = urb->actual_length;
 499         int count2 = urb->transfer_buffer_length;
 500
 501         __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
 502
 503         struct sk_buff *skb;
 504
 505         if (unlikely(status == -EPIPE)) {
 506                 net->stats.rx_errors++;
 507                 kaweth->end = 1;
 508                 wake_up(&kaweth->term_wait);
 509                 dev_dbg(dev, "Status was -EPIPE.\n");
 510                 return;
 511         }
 512         if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
 513                 /* we are killed - set a flag and wake the disconnect handler */
 514                 kaweth->end = 1;
 515                 wake_up(&kaweth->term_wait);
 516                 dev_dbg(dev, "Status was -ECONNRESET or -ESHUTDOWN.\n");
 517                 return;
 518         }
 519         if (unlikely(status == -EPROTO || status == -ETIME ||
 520                      status == -EILSEQ)) {
 521                 net->stats.rx_errors++;
 522                 dev_dbg(dev, "Status was -EPROTO, -ETIME, or -EILSEQ.\n");
 523                 return;
 524         }
 525         if (unlikely(status == -EOVERFLOW)) {
 526                 net->stats.rx_errors++;
 527                 dev_dbg(dev, "Status was -EOVERFLOW.\n");
 528         }
 529         spin_lock_irqsave(&kaweth->device_lock, flags);
 530         if (IS_BLOCKED(kaweth->status)) {
 531                 spin_unlock_irqrestore(&kaweth->device_lock, flags);
 532                 return;
 533         }
 534         spin_unlock_irqrestore(&kaweth->device_lock, flags);
 535
 536         if(status && status != -EREMOTEIO && count != 1) {
 537                 dev_err(&kaweth->intf->dev,
 538                         "%s RX status: %d count: %d packet_len: %d\n",
 539                         net->name, status, count, (int)pkt_len);
 540                 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 541                 return;
 542         }
 543
 544         if(kaweth->net && (count > 2)) {
 545                 if(pkt_len > (count - 2)) {
 546                         dev_err(&kaweth->intf->dev,
 547                                 "Packet length too long for USB frame (pkt_len: %x, count: %x)\n",
 548                                 pkt_len, count);
 549                         dev_err(&kaweth->intf->dev, "Packet len & 2047: %x\n",
 550                                 pkt_len & 2047);
 551                         dev_err(&kaweth->intf->dev, "Count 2: %x\n", count2);
 552                         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 553                         return;
 554                 }
 555
 556                 if(!(skb = dev_alloc_skb(pkt_len+2))) {
 557                         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 558                         return;
 559                 }
 560
 561                 skb_reserve(skb, 2);    /* Align IP on 16 byte boundaries */
 562
 563                 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
 564
 565                 skb_put(skb, pkt_len);
 566
 567                 skb->protocol = eth_type_trans(skb, net);
 568
 569                 netif_rx(skb);
 570
 571                 net->stats.rx_packets++;
 572                 net->stats.rx_bytes += pkt_len;
 573         }
 574
 575         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
 576 }
 577
 578 /****************************************************************
 579  *     kaweth_open
 580  ****************************************************************/
 581 static int kaweth_open(struct net_device *net)
 582 {
 583         struct kaweth_device *kaweth = netdev_priv(net);
 584         int res;
 585
 586         res = usb_autopm_get_interface(kaweth->intf);
 587         if (res) {
 588                 dev_err(&kaweth->intf->dev, "Interface cannot be resumed.\n");
 589                 return -EIO;
 590         }
 591         res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
 592         if (res)
 593                 goto err_out;
 594
 595         usb_fill_int_urb(
 596                 kaweth->irq_urb,
 597                 kaweth->dev,
 598                 usb_rcvintpipe(kaweth->dev, 3),
 599                 kaweth->intbuffer,
 600                 INTBUFFERSIZE,
 601                 int_callback,
 602                 kaweth,
 603                 250); /* overriding the descriptor */
 604         kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
 605         kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 606
 607         res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
 608         if (res) {
 609                 usb_kill_urb(kaweth->rx_urb);
 610                 goto err_out;
 611         }
 612         kaweth->opened = 1;
 613
 614         netif_start_queue(net);
 615
 616         kaweth_async_set_rx_mode(kaweth, true);
 617         return 0;
 618
 619 err_out:
 620         usb_autopm_put_interface(kaweth->intf);
 621         return -EIO;
 622 }
 623
 624 /****************************************************************
 625  *     kaweth_kill_urbs
 626  ****************************************************************/
 627 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
 628 {
 629         usb_kill_urb(kaweth->irq_urb);
 630         usb_kill_urb(kaweth->rx_urb);
 631         usb_kill_urb(kaweth->tx_urb);
 632
 633         cancel_delayed_work_sync(&kaweth->lowmem_work);
 634
 635         /* a scheduled work may have resubmitted,
 636            we hit them again */
 637         usb_kill_urb(kaweth->irq_urb);
 638         usb_kill_urb(kaweth->rx_urb);
 639 }
 640
 641 /****************************************************************
 642  *     kaweth_close
 643  ****************************************************************/
 644 static int kaweth_close(struct net_device *net)
 645 {
 646         struct kaweth_device *kaweth = netdev_priv(net);
 647
 648         netif_stop_queue(net);
 649         kaweth->opened = 0;
 650
 651         kaweth->status |= KAWETH_STATUS_CLOSING;
 652
 653         kaweth_kill_urbs(kaweth);
 654
 655         kaweth->status &= ~KAWETH_STATUS_CLOSING;
 656
 657         usb_autopm_put_interface(kaweth->intf);
 658
 659         return 0;
 660 }
 661
 662 static u32 kaweth_get_link(struct net_device *dev)
 663 {
 664         struct kaweth_device *kaweth = netdev_priv(dev);
 665
 666         return kaweth->linkstate;
 667 }
 668
 669 static const struct ethtool_ops ops = {
 670         .get_link       = kaweth_get_link
 671 };
 672
 673 /****************************************************************
 674  *     kaweth_usb_transmit_complete
 675  ****************************************************************/
 676 static void kaweth_usb_transmit_complete(struct urb *urb)
 677 {
 678         struct kaweth_device *kaweth = urb->context;
 679         struct sk_buff *skb = kaweth->tx_skb;
 680         int status = urb->status;
 681
 682         if (unlikely(status != 0))
 683                 if (status != -ENOENT)
 684                         dev_dbg(&urb->dev->dev, "%s: TX status %d.\n",
 685                                 kaweth->net->name, status);
 686
 687         netif_wake_queue(kaweth->net);
 688         dev_kfree_skb_irq(skb);
 689 }
 690
 691 /****************************************************************
 692  *     kaweth_start_xmit
 693  ****************************************************************/
 694 static netdev_tx_t kaweth_start_xmit(struct sk_buff *skb,
 695                                            struct net_device *net)
 696 {
 697         struct kaweth_device *kaweth = netdev_priv(net);
 698         __le16 *private_header;
 699
 700         int res;
 701
 702         spin_lock_irq(&kaweth->device_lock);
 703
 704         kaweth_async_set_rx_mode(kaweth, false);
 705         netif_stop_queue(net);
 706         if (IS_BLOCKED(kaweth->status)) {
 707                 goto skip;
 708         }
 709
 710         /* We now decide whether we can put our special header into the sk_buff */
 711         if (skb_cow_head(skb, 2)) {
 712                 net->stats.tx_errors++;
 713                 netif_start_queue(net);
 714                 spin_unlock_irq(&kaweth->device_lock);
 715                 dev_kfree_skb_any(skb);
 716                 return NETDEV_TX_OK;
 717         }
 718
 719         private_header = __skb_push(skb, 2);
 720         *private_header = cpu_to_le16(skb->len-2);
 721         kaweth->tx_skb = skb;
 722
 723         usb_fill_bulk_urb(kaweth->tx_urb,
 724                       kaweth->dev,
 725                       usb_sndbulkpipe(kaweth->dev, 2),
 726                       private_header,
 727                       skb->len,
 728                       kaweth_usb_transmit_complete,
 729                       kaweth);
 730         kaweth->end = 0;
 731
 732         if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
 733         {
 734                 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
 735 skip:
 736                 net->stats.tx_errors++;
 737
 738                 netif_start_queue(net);
 739                 dev_kfree_skb_irq(skb);
 740         }
 741         else
 742         {
 743                 net->stats.tx_packets++;
 744                 net->stats.tx_bytes += skb->len;
 745         }
 746
 747         spin_unlock_irq(&kaweth->device_lock);
 748
 749         return NETDEV_TX_OK;
 750 }
 751
 752 /****************************************************************
 753  *     kaweth_set_rx_mode
 754  ****************************************************************/
 755 static void kaweth_set_rx_mode(struct net_device *net)
 756 {
 757         struct kaweth_device *kaweth = netdev_priv(net);
 758
 759         __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
 760                                      KAWETH_PACKET_FILTER_BROADCAST |
 761                                      KAWETH_PACKET_FILTER_MULTICAST;
 762
 763         netdev_dbg(net, "Setting Rx mode to %d\n", packet_filter_bitmap);
 764
 765         netif_stop_queue(net);
 766
 767         if (net->flags & IFF_PROMISC) {
 768                 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
 769         }
 770         else if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI)) {
 771                 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
 772         }
 773
 774         kaweth->packet_filter_bitmap = packet_filter_bitmap;
 775         netif_wake_queue(net);
 776 }
 777
 778 /****************************************************************
 779  *     kaweth_async_set_rx_mode
 780  ****************************************************************/
 781 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth,
 782                                      bool may_sleep)
 783 {
 784         int ret;
 785         __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
 786
 787         kaweth->packet_filter_bitmap = 0;
 788         if (packet_filter_bitmap == 0)
 789                 return;
 790
 791         if (!may_sleep)
 792                 return;
 793
 794         ret = usb_control_msg(kaweth->dev, usb_sndctrlpipe(kaweth->dev, 0),
 795                               KAWETH_COMMAND_SET_PACKET_FILTER,
 796                               USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
 797                               packet_filter_bitmap, 0,
 798                               &kaweth->scratch, 0,
 799                               KAWETH_CONTROL_TIMEOUT);
 800         if (ret < 0)
 801                 dev_err(&kaweth->intf->dev, "Failed to set Rx mode: %d\n",
 802                         ret);
 803         else
 804                 netdev_dbg(kaweth->net, "Set Rx mode to %d\n",
 805                            packet_filter_bitmap);
 806 }
 807
 808 /****************************************************************
 809  *     kaweth_tx_timeout
 810  ****************************************************************/
 811 static void kaweth_tx_timeout(struct net_device *net, unsigned int txqueue)
 812 {
 813         struct kaweth_device *kaweth = netdev_priv(net);
 814
 815         dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
 816         net->stats.tx_errors++;
 817         netif_trans_update(net);
 818
 819         usb_unlink_urb(kaweth->tx_urb);
 820 }
 821
 822 /****************************************************************
 823  *     kaweth_suspend
 824  ****************************************************************/
 825 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
 826 {
 827         struct kaweth_device *kaweth = usb_get_intfdata(intf);
 828         unsigned long flags;
 829
 830         spin_lock_irqsave(&kaweth->device_lock, flags);
 831         kaweth->status |= KAWETH_STATUS_SUSPENDING;
 832         spin_unlock_irqrestore(&kaweth->device_lock, flags);
 833
 834         kaweth_kill_urbs(kaweth);
 835         return 0;
 836 }
 837
 838 /****************************************************************
 839  *     kaweth_resume
 840  ****************************************************************/
 841 static int kaweth_resume(struct usb_interface *intf)
 842 {
 843         struct kaweth_device *kaweth = usb_get_intfdata(intf);
 844         unsigned long flags;
 845
 846         spin_lock_irqsave(&kaweth->device_lock, flags);
 847         kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
 848         spin_unlock_irqrestore(&kaweth->device_lock, flags);
 849
 850         if (!kaweth->opened)
 851                 return 0;
 852         kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
 853         kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
 854
 855         return 0;
 856 }
 857
 858 /****************************************************************
 859  *     kaweth_probe
 860  ****************************************************************/
 861
 862
 863 static const struct net_device_ops kaweth_netdev_ops = {
 864         .ndo_open =                     kaweth_open,
 865         .ndo_stop =                     kaweth_close,
 866         .ndo_start_xmit =               kaweth_start_xmit,
 867         .ndo_tx_timeout =               kaweth_tx_timeout,
 868         .ndo_set_rx_mode =              kaweth_set_rx_mode,
 869         .ndo_set_mac_address =          eth_mac_addr,
 870         .ndo_validate_addr =            eth_validate_addr,
 871 };
 872
 873 static int kaweth_probe(
 874                 struct usb_interface *intf,
 875                 const struct usb_device_id *id      /* from id_table */
 876         )
 877 {
 878         struct device *dev = &intf->dev;
 879         struct usb_device *udev = interface_to_usbdev(intf);
 880         struct kaweth_device *kaweth;
 881         struct net_device *netdev;
 882         const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
 883         int result = 0;
 884         int rv = -EIO;
 885
 886         dev_dbg(dev,
 887                 "Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x\n",
 888                 udev->devnum, le16_to_cpu(udev->descriptor.idVendor),
 889                 le16_to_cpu(udev->descriptor.idProduct),
 890                 le16_to_cpu(udev->descriptor.bcdDevice));
 891
 892         dev_dbg(dev, "Device at %p\n", udev);
 893
 894         dev_dbg(dev, "Descriptor length: %x type: %x\n",
 895                 (int)udev->descriptor.bLength,
 896                 (int)udev->descriptor.bDescriptorType);
 897
 898         netdev = alloc_etherdev(sizeof(*kaweth));
 899         if (!netdev)
 900                 return -ENOMEM;
 901
 902         kaweth = netdev_priv(netdev);
 903         kaweth->dev = udev;
 904         kaweth->net = netdev;
 905         kaweth->intf = intf;
 906
 907         spin_lock_init(&kaweth->device_lock);
 908         init_waitqueue_head(&kaweth->term_wait);
 909
 910         dev_dbg(dev, "Resetting.\n");
 911
 912         kaweth_reset(kaweth);
 913
 914         /*
 915          * If high byte of bcdDevice is nonzero, firmware is already
 916          * downloaded. Don't try to do it again, or we'll hang the device.
 917          */
 918
 919         if (le16_to_cpu(udev->descriptor.bcdDevice) >> 8) {
 920                 dev_info(dev, "Firmware present in device.\n");
 921         } else {
 922                 /* Download the firmware */
 923                 dev_info(dev, "Downloading firmware...\n");
 924                 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
 925                 if (!kaweth->firmware_buf) {
 926                         rv = -ENOMEM;
 927                         goto err_free_netdev;
 928                 }
 929                 if ((result = kaweth_download_firmware(kaweth,
 930                                                       "/*(DEBLOBBED)*/",
 931                                                       100,
 932                                                       2)) < 0) {
 933                         dev_err(dev, "Error downloading firmware (%d)\n",
 934                                 result);
 935                         goto err_fw;
 936                 }
 937
 938                 if ((result = kaweth_download_firmware(kaweth,
 939                                                       "/*(DEBLOBBED)*/",
 940                                                       100,
 941                                                       3)) < 0) {
 942                         dev_err(dev, "Error downloading firmware fix (%d)\n",
 943                                 result);
 944                         goto err_fw;
 945                 }
 946
 947                 if ((result = kaweth_download_firmware(kaweth,
 948                                                       "/*(DEBLOBBED)*/",
 949                                                       126,
 950                                                       2)) < 0) {
 951                         dev_err(dev, "Error downloading trigger code (%d)\n",
 952                                 result);
 953                         goto err_fw;
 954
 955                 }
 956
 957                 if ((result = kaweth_download_firmware(kaweth,
 958                                                       "/*(DEBLOBBED)*/",
 959                                                       126,
 960                                                       3)) < 0) {
 961                         dev_err(dev, "Error downloading trigger code fix (%d)\n", result);
 962                         goto err_fw;
 963                 }
 964
 965
 966                 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
 967                         dev_err(dev, "Error triggering firmware (%d)\n", result);
 968                         goto err_fw;
 969                 }
 970
 971                 /* Device will now disappear for a moment...  */
 972                 dev_info(dev, "Firmware loaded.  I'll be back...\n");
 973 err_fw:
 974                 free_page((unsigned long)kaweth->firmware_buf);
 975                 free_netdev(netdev);
 976                 return -EIO;
 977         }
 978
 979         result = kaweth_read_configuration(kaweth);
 980
 981         if(result < 0) {
 982                 dev_err(dev, "Error reading configuration (%d), no net device created\n", result);
 983                 goto err_free_netdev;
 984         }
 985
 986         dev_info(dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
 987         dev_info(dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
 988         dev_info(dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
 989         dev_info(dev, "Read MAC address %pM\n", kaweth->configuration.hw_addr);
 990
 991         if(!memcmp(&kaweth->configuration.hw_addr,
 992                    &bcast_addr,
 993                    sizeof(bcast_addr))) {
 994                 dev_err(dev, "Firmware not functioning properly, no net device created\n");
 995                 goto err_free_netdev;
 996         }
 997
 998         if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
 999                 dev_dbg(dev, "Error setting URB size\n");
1000                 goto err_free_netdev;
1001         }
1002
1003         if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1004                 dev_err(dev, "Error setting SOFS wait\n");
1005                 goto err_free_netdev;
1006         }
1007
1008         result = kaweth_set_receive_filter(kaweth,
1009                                            KAWETH_PACKET_FILTER_DIRECTED |
1010                                            KAWETH_PACKET_FILTER_BROADCAST |
1011                                            KAWETH_PACKET_FILTER_MULTICAST);
1012
1013         if(result < 0) {
1014                 dev_err(dev, "Error setting receive filter\n");
1015                 goto err_free_netdev;
1016         }
1017
1018         dev_dbg(dev, "Initializing net device.\n");
1019
1020         kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1021         if (!kaweth->tx_urb)
1022                 goto err_free_netdev;
1023         kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1024         if (!kaweth->rx_urb)
1025                 goto err_only_tx;
1026         kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1027         if (!kaweth->irq_urb)
1028                 goto err_tx_and_rx;
1029
1030         kaweth->intbuffer = usb_alloc_coherent( kaweth->dev,
1031                                                 INTBUFFERSIZE,
1032                                                 GFP_KERNEL,
1033                                                 &kaweth->intbufferhandle);
1034         if (!kaweth->intbuffer)
1035                 goto err_tx_and_rx_and_irq;
1036         kaweth->rx_buf = usb_alloc_coherent(    kaweth->dev,
1037                                                 KAWETH_BUF_SIZE,
1038                                                 GFP_KERNEL,
1039                                                 &kaweth->rxbufferhandle);
1040         if (!kaweth->rx_buf)
1041                 goto err_all_but_rxbuf;
1042
1043         memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1044         memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1045                sizeof(kaweth->configuration.hw_addr));
1046
1047         netdev->netdev_ops = &kaweth_netdev_ops;
1048         netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1049         netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1050         netdev->ethtool_ops = &ops;
1051
1052         /* kaweth is zeroed as part of alloc_netdev */
1053         INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1054         usb_set_intfdata(intf, kaweth);
1055
1056         SET_NETDEV_DEV(netdev, dev);
1057         if (register_netdev(netdev) != 0) {
1058                 dev_err(dev, "Error registering netdev.\n");
1059                 goto err_intfdata;
1060         }
1061
1062         dev_info(dev, "kaweth interface created at %s\n",
1063                  kaweth->net->name);
1064
1065         return 0;
1066
1067 err_intfdata:
1068         usb_set_intfdata(intf, NULL);
1069         usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1070 err_all_but_rxbuf:
1071         usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1072 err_tx_and_rx_and_irq:
1073         usb_free_urb(kaweth->irq_urb);
1074 err_tx_and_rx:
1075         usb_free_urb(kaweth->rx_urb);
1076 err_only_tx:
1077         usb_free_urb(kaweth->tx_urb);
1078 err_free_netdev:
1079         free_netdev(netdev);
1080
1081         return rv;
1082 }
1083
1084 /****************************************************************
1085  *     kaweth_disconnect
1086  ****************************************************************/
1087 static void kaweth_disconnect(struct usb_interface *intf)
1088 {
1089         struct kaweth_device *kaweth = usb_get_intfdata(intf);
1090         struct net_device *netdev;
1091
1092         usb_set_intfdata(intf, NULL);
1093         if (!kaweth) {
1094                 dev_warn(&intf->dev, "unregistering non-existent device\n");
1095                 return;
1096         }
1097         netdev = kaweth->net;
1098
1099         netdev_dbg(kaweth->net, "Unregistering net device\n");
1100         unregister_netdev(netdev);
1101
1102         usb_free_urb(kaweth->rx_urb);
1103         usb_free_urb(kaweth->tx_urb);
1104         usb_free_urb(kaweth->irq_urb);
1105
1106         usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1107         usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1108
1109         free_netdev(netdev);
1110 }
1111
1112
1113 module_usb_driver(kaweth_driver);