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, see <http://www.gnu.org/licenses/>.
30 ****************************************************************/
33 * Develop test procedures for USB net interfaces
35 * Fix bugs from previous two steps
36 * Snoop other OSs for any tricks we're not doing
37 * Reduce arbitrary timeouts
38 * Smart multicast support
39 * Temporary MAC change support
40 * Tunable SOFs parameter - ioctl()?
41 * Ethernet stats collection
42 * Code formatting improvements
45 #include <linux/module.h>
46 #include <linux/slab.h>
47 #include <linux/string.h>
48 #include <linux/delay.h>
49 #include <linux/netdevice.h>
50 #include <linux/etherdevice.h>
51 #include <linux/usb.h>
52 #include <linux/types.h>
53 #include <linux/ethtool.h>
54 #include <linux/dma-mapping.h>
55 #include <linux/wait.h>
56 #include <linux/firmware.h>
57 #include <asm/uaccess.h>
58 #include <asm/byteorder.h>
62 #define KAWETH_MTU 1514
63 #define KAWETH_BUF_SIZE 1664
64 #define KAWETH_TX_TIMEOUT (5 * HZ)
65 #define KAWETH_SCRATCH_SIZE 32
66 #define KAWETH_FIRMWARE_BUF_SIZE 4096
67 #define KAWETH_CONTROL_TIMEOUT (30000)
69 #define KAWETH_STATUS_BROKEN 0x0000001
70 #define KAWETH_STATUS_CLOSING 0x0000002
71 #define KAWETH_STATUS_SUSPENDING 0x0000004
73 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
75 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
76 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
77 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
78 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
79 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
82 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
83 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
84 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
85 #define KAWETH_COMMAND_STATISTICS 0x03
86 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
87 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
88 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
89 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
90 #define KAWETH_COMMAND_SCAN 0xFF
92 #define KAWETH_SOFS_TO_WAIT 0x05
94 #define INTBUFFERSIZE 4
96 #define STATE_OFFSET 0
97 #define STATE_MASK 0x40
100 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
103 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>");
104 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
105 MODULE_LICENSE("GPL");
106 MODULE_FIRMWARE("kaweth/new_code.bin");
107 MODULE_FIRMWARE("kaweth/new_code_fix.bin");
108 MODULE_FIRMWARE("kaweth/trigger_code.bin");
109 MODULE_FIRMWARE("kaweth/trigger_code_fix.bin");
111 static const char driver_name[] = "kaweth";
113 static int kaweth_probe(
114 struct usb_interface *intf,
115 const struct usb_device_id *id /* from id_table */
117 static void kaweth_disconnect(struct usb_interface *intf);
118 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
120 struct usb_ctrlrequest *cmd, void *data,
121 int len, int timeout);
122 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
123 static int kaweth_resume(struct usb_interface *intf);
125 /****************************************************************
127 ****************************************************************/
128 static struct usb_device_id usb_klsi_table[] = {
129 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
130 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
131 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
132 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
133 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
134 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
135 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
136 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
137 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
138 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
139 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
140 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
141 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
142 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
143 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
144 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
145 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
146 { USB_DEVICE(0x07c9, 0xb010) }, /* Allied Telesyn AT-USB10 USB Ethernet Adapter */
147 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
148 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
149 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
150 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
151 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
152 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
153 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
154 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
155 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
156 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
157 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
158 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
159 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
160 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
161 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
162 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
163 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
164 {} /* Null terminator */
167 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
169 /****************************************************************
171 ****************************************************************/
172 static struct usb_driver kaweth_driver = {
174 .probe = kaweth_probe,
175 .disconnect = kaweth_disconnect,
176 .suspend = kaweth_suspend,
177 .resume = kaweth_resume,
178 .id_table = usb_klsi_table,
179 .supports_autosuspend = 1,
180 .disable_hub_initiated_lpm = 1,
183 typedef __u8 eth_addr_t[6];
185 /****************************************************************
187 ****************************************************************/
195 /****************************************************************
196 * kaweth_ethernet_configuration
198 ****************************************************************/
199 struct kaweth_ethernet_configuration
205 __u32 statistics_mask;
207 __u16 max_multicast_filters;
211 /****************************************************************
213 ****************************************************************/
216 spinlock_t device_lock;
220 int suspend_lowmem_rx;
221 int suspend_lowmem_ctrl;
224 struct delayed_work lowmem_work;
226 struct usb_device *dev;
227 struct usb_interface *intf;
228 struct net_device *net;
229 wait_queue_head_t term_wait;
235 dma_addr_t intbufferhandle;
237 dma_addr_t rxbufferhandle;
241 struct sk_buff *tx_skb;
244 __u8 scratch[KAWETH_SCRATCH_SIZE];
245 __u16 packet_filter_bitmap;
247 struct kaweth_ethernet_configuration configuration;
249 struct net_device_stats stats;
252 /****************************************************************
254 ****************************************************************/
255 static int kaweth_control(struct kaweth_device *kaweth,
265 struct usb_ctrlrequest *dr;
268 netdev_dbg(kaweth->net, "kaweth_control()\n");
271 netdev_dbg(kaweth->net, "in_interrupt()\n");
275 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
279 dr->bRequestType = requesttype;
280 dr->bRequest = request;
281 dr->wValue = cpu_to_le16(value);
282 dr->wIndex = cpu_to_le16(index);
283 dr->wLength = cpu_to_le16(size);
285 retval = kaweth_internal_control_msg(kaweth->dev,
296 /****************************************************************
297 * kaweth_read_configuration
298 ****************************************************************/
299 static int kaweth_read_configuration(struct kaweth_device *kaweth)
303 netdev_dbg(kaweth->net, "Reading kaweth configuration\n");
305 retval = kaweth_control(kaweth,
306 usb_rcvctrlpipe(kaweth->dev, 0),
307 KAWETH_COMMAND_GET_ETHERNET_DESC,
308 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
311 (void *)&kaweth->configuration,
312 sizeof(kaweth->configuration),
313 KAWETH_CONTROL_TIMEOUT);
318 /****************************************************************
319 * kaweth_set_urb_size
320 ****************************************************************/
321 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
325 netdev_dbg(kaweth->net, "Setting URB size to %d\n", (unsigned)urb_size);
327 retval = kaweth_control(kaweth,
328 usb_sndctrlpipe(kaweth->dev, 0),
329 KAWETH_COMMAND_SET_URB_SIZE,
330 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
333 (void *)&kaweth->scratch,
335 KAWETH_CONTROL_TIMEOUT);
340 /****************************************************************
341 * kaweth_set_sofs_wait
342 ****************************************************************/
343 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
347 netdev_dbg(kaweth->net, "Set SOFS wait to %d\n", (unsigned)sofs_wait);
349 retval = kaweth_control(kaweth,
350 usb_sndctrlpipe(kaweth->dev, 0),
351 KAWETH_COMMAND_SET_SOFS_WAIT,
352 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
355 (void *)&kaweth->scratch,
357 KAWETH_CONTROL_TIMEOUT);
362 /****************************************************************
363 * kaweth_set_receive_filter
364 ****************************************************************/
365 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
366 __u16 receive_filter)
370 netdev_dbg(kaweth->net, "Set receive filter to %d\n",
371 (unsigned)receive_filter);
373 retval = kaweth_control(kaweth,
374 usb_sndctrlpipe(kaweth->dev, 0),
375 KAWETH_COMMAND_SET_PACKET_FILTER,
376 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
379 (void *)&kaweth->scratch,
381 KAWETH_CONTROL_TIMEOUT);
386 /****************************************************************
387 * kaweth_download_firmware
388 ****************************************************************/
389 static int kaweth_download_firmware(struct kaweth_device *kaweth,
394 const struct firmware *fw;
398 ret = request_firmware(&fw, fwname, &kaweth->dev->dev);
400 dev_err(&kaweth->intf->dev, "Firmware request failed\n");
404 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
405 dev_err(&kaweth->intf->dev, "Firmware too big: %zu\n",
407 release_firmware(fw);
411 memcpy(kaweth->firmware_buf, fw->data, fw->size);
413 release_firmware(fw);
415 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
416 kaweth->firmware_buf[3] = data_len >> 8;
417 kaweth->firmware_buf[4] = type;
418 kaweth->firmware_buf[5] = interrupt;
420 netdev_dbg(kaweth->net, "High: %i, Low:%i\n", kaweth->firmware_buf[3],
421 kaweth->firmware_buf[2]);
423 netdev_dbg(kaweth->net,
424 "Downloading firmware at %p to kaweth device at %p\n",
425 kaweth->firmware_buf, kaweth);
426 netdev_dbg(kaweth->net, "Firmware length: %d\n", data_len);
428 return kaweth_control(kaweth,
429 usb_sndctrlpipe(kaweth->dev, 0),
431 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
434 (void *)kaweth->firmware_buf,
436 KAWETH_CONTROL_TIMEOUT);
439 /****************************************************************
440 * kaweth_trigger_firmware
441 ****************************************************************/
442 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
445 kaweth->firmware_buf[0] = 0xB6;
446 kaweth->firmware_buf[1] = 0xC3;
447 kaweth->firmware_buf[2] = 0x01;
448 kaweth->firmware_buf[3] = 0x00;
449 kaweth->firmware_buf[4] = 0x06;
450 kaweth->firmware_buf[5] = interrupt;
451 kaweth->firmware_buf[6] = 0x00;
452 kaweth->firmware_buf[7] = 0x00;
454 netdev_dbg(kaweth->net, "Triggering firmware\n");
456 return kaweth_control(kaweth,
457 usb_sndctrlpipe(kaweth->dev, 0),
459 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
462 (void *)kaweth->firmware_buf,
464 KAWETH_CONTROL_TIMEOUT);
467 /****************************************************************
469 ****************************************************************/
470 static int kaweth_reset(struct kaweth_device *kaweth)
474 netdev_dbg(kaweth->net, "kaweth_reset(%p)\n", kaweth);
475 result = usb_reset_configuration(kaweth->dev);
478 netdev_dbg(kaweth->net, "kaweth_reset() returns %d.\n", result);
483 static void kaweth_usb_receive(struct urb *);
484 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
486 /****************************************************************
488 *****************************************************************/
490 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
494 status = usb_submit_urb (kaweth->irq_urb, mf);
495 if (unlikely(status == -ENOMEM)) {
496 kaweth->suspend_lowmem_ctrl = 1;
497 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
499 kaweth->suspend_lowmem_ctrl = 0;
503 dev_err(&kaweth->intf->dev,
504 "can't resubmit intr, %s-%s, status %d\n",
505 kaweth->dev->bus->bus_name,
506 kaweth->dev->devpath, status);
509 static void int_callback(struct urb *u)
511 struct kaweth_device *kaweth = u->context;
513 int status = u->status;
516 case 0: /* success */
518 case -ECONNRESET: /* unlink */
522 /* -EPIPE: should clear the halt */
527 /* we check the link state to report changes */
528 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
530 netif_carrier_on(kaweth->net);
532 netif_carrier_off(kaweth->net);
534 kaweth->linkstate = act_state;
537 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
540 static void kaweth_resubmit_tl(struct work_struct *work)
542 struct kaweth_device *kaweth =
543 container_of(work, struct kaweth_device, lowmem_work.work);
545 if (IS_BLOCKED(kaweth->status))
548 if (kaweth->suspend_lowmem_rx)
549 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
551 if (kaweth->suspend_lowmem_ctrl)
552 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
556 /****************************************************************
557 * kaweth_resubmit_rx_urb
558 ****************************************************************/
559 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
564 usb_fill_bulk_urb(kaweth->rx_urb,
566 usb_rcvbulkpipe(kaweth->dev, 1),
571 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
572 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
574 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
575 if (result == -ENOMEM) {
576 kaweth->suspend_lowmem_rx = 1;
577 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
579 dev_err(&kaweth->intf->dev, "resubmitting rx_urb %d failed\n",
582 kaweth->suspend_lowmem_rx = 0;
588 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
590 /****************************************************************
592 ****************************************************************/
593 static void kaweth_usb_receive(struct urb *urb)
595 struct device *dev = &urb->dev->dev;
596 struct kaweth_device *kaweth = urb->context;
597 struct net_device *net = kaweth->net;
598 int status = urb->status;
600 int count = urb->actual_length;
601 int count2 = urb->transfer_buffer_length;
603 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
607 if (unlikely(status == -EPIPE)) {
608 kaweth->stats.rx_errors++;
610 wake_up(&kaweth->term_wait);
611 dev_dbg(dev, "Status was -EPIPE.\n");
614 if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
615 /* we are killed - set a flag and wake the disconnect handler */
617 wake_up(&kaweth->term_wait);
618 dev_dbg(dev, "Status was -ECONNRESET or -ESHUTDOWN.\n");
621 if (unlikely(status == -EPROTO || status == -ETIME ||
622 status == -EILSEQ)) {
623 kaweth->stats.rx_errors++;
624 dev_dbg(dev, "Status was -EPROTO, -ETIME, or -EILSEQ.\n");
627 if (unlikely(status == -EOVERFLOW)) {
628 kaweth->stats.rx_errors++;
629 dev_dbg(dev, "Status was -EOVERFLOW.\n");
631 spin_lock(&kaweth->device_lock);
632 if (IS_BLOCKED(kaweth->status)) {
633 spin_unlock(&kaweth->device_lock);
636 spin_unlock(&kaweth->device_lock);
638 if(status && status != -EREMOTEIO && count != 1) {
639 dev_err(&kaweth->intf->dev,
640 "%s RX status: %d count: %d packet_len: %d\n",
641 net->name, status, count, (int)pkt_len);
642 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
646 if(kaweth->net && (count > 2)) {
647 if(pkt_len > (count - 2)) {
648 dev_err(&kaweth->intf->dev,
649 "Packet length too long for USB frame (pkt_len: %x, count: %x)\n",
651 dev_err(&kaweth->intf->dev, "Packet len & 2047: %x\n",
653 dev_err(&kaweth->intf->dev, "Count 2: %x\n", count2);
654 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
658 if(!(skb = dev_alloc_skb(pkt_len+2))) {
659 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
663 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
665 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
667 skb_put(skb, pkt_len);
669 skb->protocol = eth_type_trans(skb, net);
673 kaweth->stats.rx_packets++;
674 kaweth->stats.rx_bytes += pkt_len;
677 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
680 /****************************************************************
682 ****************************************************************/
683 static int kaweth_open(struct net_device *net)
685 struct kaweth_device *kaweth = netdev_priv(net);
688 netdev_dbg(kaweth->net, "Opening network device.\n");
690 res = usb_autopm_get_interface(kaweth->intf);
692 dev_err(&kaweth->intf->dev, "Interface cannot be resumed.\n");
695 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
702 usb_rcvintpipe(kaweth->dev, 3),
707 250); /* overriding the descriptor */
708 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
709 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
711 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
713 usb_kill_urb(kaweth->rx_urb);
718 netif_start_queue(net);
720 kaweth_async_set_rx_mode(kaweth);
724 usb_autopm_put_interface(kaweth->intf);
728 /****************************************************************
730 ****************************************************************/
731 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
733 usb_kill_urb(kaweth->irq_urb);
734 usb_kill_urb(kaweth->rx_urb);
735 usb_kill_urb(kaweth->tx_urb);
737 cancel_delayed_work_sync(&kaweth->lowmem_work);
739 /* a scheduled work may have resubmitted,
741 usb_kill_urb(kaweth->irq_urb);
742 usb_kill_urb(kaweth->rx_urb);
745 /****************************************************************
747 ****************************************************************/
748 static int kaweth_close(struct net_device *net)
750 struct kaweth_device *kaweth = netdev_priv(net);
752 netif_stop_queue(net);
755 kaweth->status |= KAWETH_STATUS_CLOSING;
757 kaweth_kill_urbs(kaweth);
759 kaweth->status &= ~KAWETH_STATUS_CLOSING;
761 usb_autopm_put_interface(kaweth->intf);
766 static u32 kaweth_get_link(struct net_device *dev)
768 struct kaweth_device *kaweth = netdev_priv(dev);
770 return kaweth->linkstate;
773 static const struct ethtool_ops ops = {
774 .get_link = kaweth_get_link
777 /****************************************************************
778 * kaweth_usb_transmit_complete
779 ****************************************************************/
780 static void kaweth_usb_transmit_complete(struct urb *urb)
782 struct kaweth_device *kaweth = urb->context;
783 struct sk_buff *skb = kaweth->tx_skb;
784 int status = urb->status;
786 if (unlikely(status != 0))
787 if (status != -ENOENT)
788 dev_dbg(&urb->dev->dev, "%s: TX status %d.\n",
789 kaweth->net->name, status);
791 netif_wake_queue(kaweth->net);
792 dev_kfree_skb_irq(skb);
795 /****************************************************************
797 ****************************************************************/
798 static netdev_tx_t kaweth_start_xmit(struct sk_buff *skb,
799 struct net_device *net)
801 struct kaweth_device *kaweth = netdev_priv(net);
802 __le16 *private_header;
806 spin_lock_irq(&kaweth->device_lock);
808 kaweth_async_set_rx_mode(kaweth);
809 netif_stop_queue(net);
810 if (IS_BLOCKED(kaweth->status)) {
814 /* We now decide whether we can put our special header into the sk_buff */
815 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
816 /* no such luck - we make our own */
817 struct sk_buff *copied_skb;
818 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
819 dev_kfree_skb_irq(skb);
822 kaweth->stats.tx_errors++;
823 netif_start_queue(net);
824 spin_unlock_irq(&kaweth->device_lock);
829 private_header = (__le16 *)__skb_push(skb, 2);
830 *private_header = cpu_to_le16(skb->len-2);
831 kaweth->tx_skb = skb;
833 usb_fill_bulk_urb(kaweth->tx_urb,
835 usb_sndbulkpipe(kaweth->dev, 2),
838 kaweth_usb_transmit_complete,
842 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
844 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
846 kaweth->stats.tx_errors++;
848 netif_start_queue(net);
849 dev_kfree_skb_irq(skb);
853 kaweth->stats.tx_packets++;
854 kaweth->stats.tx_bytes += skb->len;
857 spin_unlock_irq(&kaweth->device_lock);
862 /****************************************************************
864 ****************************************************************/
865 static void kaweth_set_rx_mode(struct net_device *net)
867 struct kaweth_device *kaweth = netdev_priv(net);
869 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
870 KAWETH_PACKET_FILTER_BROADCAST |
871 KAWETH_PACKET_FILTER_MULTICAST;
873 netdev_dbg(net, "Setting Rx mode to %d\n", packet_filter_bitmap);
875 netif_stop_queue(net);
877 if (net->flags & IFF_PROMISC) {
878 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
880 else if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI)) {
881 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
884 kaweth->packet_filter_bitmap = packet_filter_bitmap;
885 netif_wake_queue(net);
888 /****************************************************************
889 * kaweth_async_set_rx_mode
890 ****************************************************************/
891 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
894 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
896 kaweth->packet_filter_bitmap = 0;
897 if (packet_filter_bitmap == 0)
903 result = kaweth_control(kaweth,
904 usb_sndctrlpipe(kaweth->dev, 0),
905 KAWETH_COMMAND_SET_PACKET_FILTER,
906 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
907 packet_filter_bitmap,
909 (void *)&kaweth->scratch,
911 KAWETH_CONTROL_TIMEOUT);
914 dev_err(&kaweth->intf->dev, "Failed to set Rx mode: %d\n",
918 netdev_dbg(kaweth->net, "Set Rx mode to %d\n",
919 packet_filter_bitmap);
923 /****************************************************************
924 * kaweth_netdev_stats
925 ****************************************************************/
926 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
928 struct kaweth_device *kaweth = netdev_priv(dev);
929 return &kaweth->stats;
932 /****************************************************************
934 ****************************************************************/
935 static void kaweth_tx_timeout(struct net_device *net)
937 struct kaweth_device *kaweth = netdev_priv(net);
939 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
940 kaweth->stats.tx_errors++;
941 netif_trans_update(net);
943 usb_unlink_urb(kaweth->tx_urb);
946 /****************************************************************
948 ****************************************************************/
949 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
951 struct kaweth_device *kaweth = usb_get_intfdata(intf);
954 dev_dbg(&intf->dev, "Suspending device\n");
955 spin_lock_irqsave(&kaweth->device_lock, flags);
956 kaweth->status |= KAWETH_STATUS_SUSPENDING;
957 spin_unlock_irqrestore(&kaweth->device_lock, flags);
959 kaweth_kill_urbs(kaweth);
963 /****************************************************************
965 ****************************************************************/
966 static int kaweth_resume(struct usb_interface *intf)
968 struct kaweth_device *kaweth = usb_get_intfdata(intf);
971 dev_dbg(&intf->dev, "Resuming device\n");
972 spin_lock_irqsave(&kaweth->device_lock, flags);
973 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
974 spin_unlock_irqrestore(&kaweth->device_lock, flags);
978 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
979 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
984 /****************************************************************
986 ****************************************************************/
989 static const struct net_device_ops kaweth_netdev_ops = {
990 .ndo_open = kaweth_open,
991 .ndo_stop = kaweth_close,
992 .ndo_start_xmit = kaweth_start_xmit,
993 .ndo_tx_timeout = kaweth_tx_timeout,
994 .ndo_set_rx_mode = kaweth_set_rx_mode,
995 .ndo_get_stats = kaweth_netdev_stats,
996 .ndo_change_mtu = eth_change_mtu,
997 .ndo_set_mac_address = eth_mac_addr,
998 .ndo_validate_addr = eth_validate_addr,
1001 static int kaweth_probe(
1002 struct usb_interface *intf,
1003 const struct usb_device_id *id /* from id_table */
1006 struct device *dev = &intf->dev;
1007 struct usb_device *udev = interface_to_usbdev(intf);
1008 struct kaweth_device *kaweth;
1009 struct net_device *netdev;
1010 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1014 "Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x\n",
1015 udev->devnum, le16_to_cpu(udev->descriptor.idVendor),
1016 le16_to_cpu(udev->descriptor.idProduct),
1017 le16_to_cpu(udev->descriptor.bcdDevice));
1019 dev_dbg(dev, "Device at %p\n", udev);
1021 dev_dbg(dev, "Descriptor length: %x type: %x\n",
1022 (int)udev->descriptor.bLength,
1023 (int)udev->descriptor.bDescriptorType);
1025 netdev = alloc_etherdev(sizeof(*kaweth));
1029 kaweth = netdev_priv(netdev);
1031 kaweth->net = netdev;
1033 spin_lock_init(&kaweth->device_lock);
1034 init_waitqueue_head(&kaweth->term_wait);
1036 dev_dbg(dev, "Resetting.\n");
1038 kaweth_reset(kaweth);
1041 * If high byte of bcdDevice is nonzero, firmware is already
1042 * downloaded. Don't try to do it again, or we'll hang the device.
1045 if (le16_to_cpu(udev->descriptor.bcdDevice) >> 8) {
1046 dev_info(dev, "Firmware present in device.\n");
1048 /* Download the firmware */
1049 dev_info(dev, "Downloading firmware...\n");
1050 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1051 if ((result = kaweth_download_firmware(kaweth,
1052 "kaweth/new_code.bin",
1055 dev_err(dev, "Error downloading firmware (%d)\n",
1060 if ((result = kaweth_download_firmware(kaweth,
1061 "kaweth/new_code_fix.bin",
1064 dev_err(dev, "Error downloading firmware fix (%d)\n",
1069 if ((result = kaweth_download_firmware(kaweth,
1070 "kaweth/trigger_code.bin",
1073 dev_err(dev, "Error downloading trigger code (%d)\n",
1079 if ((result = kaweth_download_firmware(kaweth,
1080 "kaweth/trigger_code_fix.bin",
1083 dev_err(dev, "Error downloading trigger code fix (%d)\n", result);
1088 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1089 dev_err(dev, "Error triggering firmware (%d)\n", result);
1093 /* Device will now disappear for a moment... */
1094 dev_info(dev, "Firmware loaded. I'll be back...\n");
1096 free_page((unsigned long)kaweth->firmware_buf);
1097 free_netdev(netdev);
1101 result = kaweth_read_configuration(kaweth);
1104 dev_err(dev, "Error reading configuration (%d), no net device created\n", result);
1105 goto err_free_netdev;
1108 dev_info(dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
1109 dev_info(dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1110 dev_info(dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
1111 dev_info(dev, "Read MAC address %pM\n", kaweth->configuration.hw_addr);
1113 if(!memcmp(&kaweth->configuration.hw_addr,
1115 sizeof(bcast_addr))) {
1116 dev_err(dev, "Firmware not functioning properly, no net device created\n");
1117 goto err_free_netdev;
1120 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1121 dev_dbg(dev, "Error setting URB size\n");
1122 goto err_free_netdev;
1125 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1126 dev_err(dev, "Error setting SOFS wait\n");
1127 goto err_free_netdev;
1130 result = kaweth_set_receive_filter(kaweth,
1131 KAWETH_PACKET_FILTER_DIRECTED |
1132 KAWETH_PACKET_FILTER_BROADCAST |
1133 KAWETH_PACKET_FILTER_MULTICAST);
1136 dev_err(dev, "Error setting receive filter\n");
1137 goto err_free_netdev;
1140 dev_dbg(dev, "Initializing net device.\n");
1142 kaweth->intf = intf;
1144 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1145 if (!kaweth->tx_urb)
1146 goto err_free_netdev;
1147 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1148 if (!kaweth->rx_urb)
1150 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1151 if (!kaweth->irq_urb)
1154 kaweth->intbuffer = usb_alloc_coherent( kaweth->dev,
1157 &kaweth->intbufferhandle);
1158 if (!kaweth->intbuffer)
1159 goto err_tx_and_rx_and_irq;
1160 kaweth->rx_buf = usb_alloc_coherent( kaweth->dev,
1163 &kaweth->rxbufferhandle);
1164 if (!kaweth->rx_buf)
1165 goto err_all_but_rxbuf;
1167 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1168 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1169 sizeof(kaweth->configuration.hw_addr));
1171 netdev->netdev_ops = &kaweth_netdev_ops;
1172 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1173 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1174 netdev->ethtool_ops = &ops;
1176 /* kaweth is zeroed as part of alloc_netdev */
1177 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1178 usb_set_intfdata(intf, kaweth);
1180 SET_NETDEV_DEV(netdev, dev);
1181 if (register_netdev(netdev) != 0) {
1182 dev_err(dev, "Error registering netdev.\n");
1186 dev_info(dev, "kaweth interface created at %s\n",
1189 dev_dbg(dev, "Kaweth probe returning.\n");
1194 usb_set_intfdata(intf, NULL);
1195 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1197 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1198 err_tx_and_rx_and_irq:
1199 usb_free_urb(kaweth->irq_urb);
1201 usb_free_urb(kaweth->rx_urb);
1203 usb_free_urb(kaweth->tx_urb);
1205 free_netdev(netdev);
1210 /****************************************************************
1212 ****************************************************************/
1213 static void kaweth_disconnect(struct usb_interface *intf)
1215 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1216 struct net_device *netdev;
1218 dev_info(&intf->dev, "Unregistering\n");
1220 usb_set_intfdata(intf, NULL);
1222 dev_warn(&intf->dev, "unregistering non-existent device\n");
1225 netdev = kaweth->net;
1227 netdev_dbg(kaweth->net, "Unregistering net device\n");
1228 unregister_netdev(netdev);
1230 usb_free_urb(kaweth->rx_urb);
1231 usb_free_urb(kaweth->tx_urb);
1232 usb_free_urb(kaweth->irq_urb);
1234 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1235 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1237 free_netdev(netdev);
1241 // FIXME this completion stuff is a modified clone of
1242 // an OLD version of some stuff in usb.c ...
1243 struct usb_api_data {
1244 wait_queue_head_t wqh;
1248 /*-------------------------------------------------------------------*
1249 * completion handler for compatibility wrappers (sync control/bulk) *
1250 *-------------------------------------------------------------------*/
1251 static void usb_api_blocking_completion(struct urb *urb)
1253 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1259 /*-------------------------------------------------------------------*
1260 * COMPATIBILITY STUFF *
1261 *-------------------------------------------------------------------*/
1263 // Starts urb and waits for completion or timeout
1264 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1266 struct usb_api_data awd;
1269 init_waitqueue_head(&awd.wqh);
1272 urb->context = &awd;
1273 status = usb_submit_urb(urb, GFP_ATOMIC);
1275 // something went wrong
1280 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1282 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1283 usb_kill_urb(urb); // remove urb safely
1284 status = -ETIMEDOUT;
1287 status = urb->status;
1290 if (actual_length) {
1291 *actual_length = urb->actual_length;
1298 /*-------------------------------------------------------------------*/
1299 // returns status (negative) or length (positive)
1300 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1302 struct usb_ctrlrequest *cmd, void *data,
1303 int len, int timeout)
1307 int length = 0; /* shut up GCC */
1309 urb = usb_alloc_urb(0, GFP_ATOMIC);
1313 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1314 len, usb_api_blocking_completion, NULL);
1316 retv = usb_start_wait_urb(urb, timeout, &length);
1325 module_usb_driver(kaweth_driver);