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 * Develop test procedures for USB net interfaces
36 * Fix bugs from previous two steps
37 * Snoop other OSs for any tricks we're not doing
38 * Reduce arbitrary timeouts
39 * Smart multicast support
40 * Temporary MAC change support
41 * Tunable SOFs parameter - ioctl()?
42 * Ethernet stats collection
43 * Code formatting improvements
46 #include <linux/module.h>
47 #include <linux/slab.h>
48 #include <linux/string.h>
49 #include <linux/init.h>
50 #include <linux/delay.h>
51 #include <linux/netdevice.h>
52 #include <linux/etherdevice.h>
53 #include <linux/usb.h>
54 #include <linux/types.h>
55 #include <linux/ethtool.h>
56 #include <linux/dma-mapping.h>
57 #include <linux/wait.h>
58 #include <linux/firmware.h>
59 #include <asm/uaccess.h>
60 #include <asm/byteorder.h>
64 #define KAWETH_MTU 1514
65 #define KAWETH_BUF_SIZE 1664
66 #define KAWETH_TX_TIMEOUT (5 * HZ)
67 #define KAWETH_SCRATCH_SIZE 32
68 #define KAWETH_FIRMWARE_BUF_SIZE 4096
69 #define KAWETH_CONTROL_TIMEOUT (30000)
71 #define KAWETH_STATUS_BROKEN 0x0000001
72 #define KAWETH_STATUS_CLOSING 0x0000002
73 #define KAWETH_STATUS_SUSPENDING 0x0000004
75 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
77 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
78 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
79 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
80 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
81 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
84 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
85 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
86 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
87 #define KAWETH_COMMAND_STATISTICS 0x03
88 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
89 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
90 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
91 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
92 #define KAWETH_COMMAND_SCAN 0xFF
94 #define KAWETH_SOFS_TO_WAIT 0x05
96 #define INTBUFFERSIZE 4
98 #define STATE_OFFSET 0
99 #define STATE_MASK 0x40
100 #define STATE_SHIFT 5
102 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
105 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>");
106 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
107 MODULE_LICENSE("GPL");
110 static const char driver_name[] = "kaweth";
112 static int kaweth_probe(
113 struct usb_interface *intf,
114 const struct usb_device_id *id /* from id_table */
116 static void kaweth_disconnect(struct usb_interface *intf);
117 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
119 struct usb_ctrlrequest *cmd, void *data,
120 int len, int timeout);
121 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
122 static int kaweth_resume(struct usb_interface *intf);
124 /****************************************************************
126 ****************************************************************/
127 static struct usb_device_id usb_klsi_table[] = {
128 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
129 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
130 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
131 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
132 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
133 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
134 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
135 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
136 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
137 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
138 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
139 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
140 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
141 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
142 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
143 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
144 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
145 { USB_DEVICE(0x07c9, 0xb010) }, /* Allied Telesyn AT-USB10 USB Ethernet Adapter */
146 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
147 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
148 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
149 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
150 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
151 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
152 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
153 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
154 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
155 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
156 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
157 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
158 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
159 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
160 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
161 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
162 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
163 {} /* Null terminator */
166 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
168 /****************************************************************
170 ****************************************************************/
171 static struct usb_driver kaweth_driver = {
173 .probe = kaweth_probe,
174 .disconnect = kaweth_disconnect,
175 .suspend = kaweth_suspend,
176 .resume = kaweth_resume,
177 .id_table = usb_klsi_table,
178 .supports_autosuspend = 1,
179 .disable_hub_initiated_lpm = 1,
182 typedef __u8 eth_addr_t[6];
184 /****************************************************************
186 ****************************************************************/
194 /****************************************************************
195 * kaweth_ethernet_configuration
197 ****************************************************************/
198 struct kaweth_ethernet_configuration
204 __u32 statistics_mask;
206 __u16 max_multicast_filters;
210 /****************************************************************
212 ****************************************************************/
215 spinlock_t device_lock;
219 int suspend_lowmem_rx;
220 int suspend_lowmem_ctrl;
223 struct delayed_work lowmem_work;
225 struct usb_device *dev;
226 struct usb_interface *intf;
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;
251 /****************************************************************
253 ****************************************************************/
254 static int kaweth_control(struct kaweth_device *kaweth,
264 struct usb_ctrlrequest *dr;
267 dbg("kaweth_control()");
270 dbg("in_interrupt()");
274 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
277 dbg("kmalloc() failed");
281 dr->bRequestType = requesttype;
282 dr->bRequest = request;
283 dr->wValue = cpu_to_le16(value);
284 dr->wIndex = cpu_to_le16(index);
285 dr->wLength = cpu_to_le16(size);
287 retval = kaweth_internal_control_msg(kaweth->dev,
298 /****************************************************************
299 * kaweth_read_configuration
300 ****************************************************************/
301 static int kaweth_read_configuration(struct kaweth_device *kaweth)
305 dbg("Reading kaweth configuration");
307 retval = kaweth_control(kaweth,
308 usb_rcvctrlpipe(kaweth->dev, 0),
309 KAWETH_COMMAND_GET_ETHERNET_DESC,
310 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
313 (void *)&kaweth->configuration,
314 sizeof(kaweth->configuration),
315 KAWETH_CONTROL_TIMEOUT);
320 /****************************************************************
321 * kaweth_set_urb_size
322 ****************************************************************/
323 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
327 dbg("Setting URB size to %d", (unsigned)urb_size);
329 retval = kaweth_control(kaweth,
330 usb_sndctrlpipe(kaweth->dev, 0),
331 KAWETH_COMMAND_SET_URB_SIZE,
332 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
335 (void *)&kaweth->scratch,
337 KAWETH_CONTROL_TIMEOUT);
342 /****************************************************************
343 * kaweth_set_sofs_wait
344 ****************************************************************/
345 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
349 dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
351 retval = kaweth_control(kaweth,
352 usb_sndctrlpipe(kaweth->dev, 0),
353 KAWETH_COMMAND_SET_SOFS_WAIT,
354 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
357 (void *)&kaweth->scratch,
359 KAWETH_CONTROL_TIMEOUT);
364 /****************************************************************
365 * kaweth_set_receive_filter
366 ****************************************************************/
367 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
368 __u16 receive_filter)
372 dbg("Set receive filter to %d", (unsigned)receive_filter);
374 retval = kaweth_control(kaweth,
375 usb_sndctrlpipe(kaweth->dev, 0),
376 KAWETH_COMMAND_SET_PACKET_FILTER,
377 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
380 (void *)&kaweth->scratch,
382 KAWETH_CONTROL_TIMEOUT);
387 /****************************************************************
388 * kaweth_download_firmware
389 ****************************************************************/
390 static int kaweth_download_firmware(struct kaweth_device *kaweth,
395 const struct firmware *fw;
399 ret = reject_firmware(&fw, fwname, &kaweth->dev->dev);
401 dev_err(&kaweth->intf->dev, "Firmware request failed\n");
405 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
406 dev_err(&kaweth->intf->dev, "Firmware too big: %zu\n",
408 release_firmware(fw);
412 memcpy(kaweth->firmware_buf, fw->data, fw->size);
414 release_firmware(fw);
416 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
417 kaweth->firmware_buf[3] = data_len >> 8;
418 kaweth->firmware_buf[4] = type;
419 kaweth->firmware_buf[5] = interrupt;
421 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
422 kaweth->firmware_buf[2]);
424 dbg("Downloading firmware at %p to kaweth device at %p",
426 dbg("Firmware length: %d", 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 dbg("Triggering firmware");
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 dbg("kaweth_reset(%p)", kaweth);
475 result = usb_reset_configuration(kaweth->dev);
478 dbg("kaweth_reset() returns %d.",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 kaweth_device *kaweth = urb->context;
596 struct net_device *net = kaweth->net;
597 int status = urb->status;
599 int count = urb->actual_length;
600 int count2 = urb->transfer_buffer_length;
602 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
606 if (unlikely(status == -EPIPE)) {
607 kaweth->stats.rx_errors++;
609 wake_up(&kaweth->term_wait);
610 dbg("Status was -EPIPE.");
613 if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
614 /* we are killed - set a flag and wake the disconnect handler */
616 wake_up(&kaweth->term_wait);
617 dbg("Status was -ECONNRESET or -ESHUTDOWN.");
620 if (unlikely(status == -EPROTO || status == -ETIME ||
621 status == -EILSEQ)) {
622 kaweth->stats.rx_errors++;
623 dbg("Status was -EPROTO, -ETIME, or -EILSEQ.");
626 if (unlikely(status == -EOVERFLOW)) {
627 kaweth->stats.rx_errors++;
628 dbg("Status was -EOVERFLOW.");
630 spin_lock(&kaweth->device_lock);
631 if (IS_BLOCKED(kaweth->status)) {
632 spin_unlock(&kaweth->device_lock);
635 spin_unlock(&kaweth->device_lock);
637 if(status && status != -EREMOTEIO && count != 1) {
638 dev_err(&kaweth->intf->dev,
639 "%s RX status: %d count: %d packet_len: %d\n",
640 net->name, status, count, (int)pkt_len);
641 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
645 if(kaweth->net && (count > 2)) {
646 if(pkt_len > (count - 2)) {
647 dev_err(&kaweth->intf->dev,
648 "Packet length too long for USB frame (pkt_len: %x, count: %x)\n",
650 dev_err(&kaweth->intf->dev, "Packet len & 2047: %x\n",
652 dev_err(&kaweth->intf->dev, "Count 2: %x\n", count2);
653 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
657 if(!(skb = dev_alloc_skb(pkt_len+2))) {
658 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
662 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
664 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
666 skb_put(skb, pkt_len);
668 skb->protocol = eth_type_trans(skb, net);
672 kaweth->stats.rx_packets++;
673 kaweth->stats.rx_bytes += pkt_len;
676 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
679 /****************************************************************
681 ****************************************************************/
682 static int kaweth_open(struct net_device *net)
684 struct kaweth_device *kaweth = netdev_priv(net);
687 dbg("Opening network device.");
689 res = usb_autopm_get_interface(kaweth->intf);
691 dev_err(&kaweth->intf->dev, "Interface cannot be resumed.\n");
694 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
701 usb_rcvintpipe(kaweth->dev, 3),
706 250); /* overriding the descriptor */
707 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
708 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
710 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
712 usb_kill_urb(kaweth->rx_urb);
717 netif_start_queue(net);
719 kaweth_async_set_rx_mode(kaweth);
723 usb_autopm_put_interface(kaweth->intf);
727 /****************************************************************
729 ****************************************************************/
730 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
732 usb_kill_urb(kaweth->irq_urb);
733 usb_kill_urb(kaweth->rx_urb);
734 usb_kill_urb(kaweth->tx_urb);
736 cancel_delayed_work_sync(&kaweth->lowmem_work);
738 /* a scheduled work may have resubmitted,
740 usb_kill_urb(kaweth->irq_urb);
741 usb_kill_urb(kaweth->rx_urb);
744 /****************************************************************
746 ****************************************************************/
747 static int kaweth_close(struct net_device *net)
749 struct kaweth_device *kaweth = netdev_priv(net);
751 netif_stop_queue(net);
754 kaweth->status |= KAWETH_STATUS_CLOSING;
756 kaweth_kill_urbs(kaweth);
758 kaweth->status &= ~KAWETH_STATUS_CLOSING;
760 usb_autopm_put_interface(kaweth->intf);
765 static u32 kaweth_get_link(struct net_device *dev)
767 struct kaweth_device *kaweth = netdev_priv(dev);
769 return kaweth->linkstate;
772 static const struct ethtool_ops ops = {
773 .get_link = kaweth_get_link
776 /****************************************************************
777 * kaweth_usb_transmit_complete
778 ****************************************************************/
779 static void kaweth_usb_transmit_complete(struct urb *urb)
781 struct kaweth_device *kaweth = urb->context;
782 struct sk_buff *skb = kaweth->tx_skb;
783 int status = urb->status;
785 if (unlikely(status != 0))
786 if (status != -ENOENT)
787 dbg("%s: TX status %d.", kaweth->net->name, status);
789 netif_wake_queue(kaweth->net);
790 dev_kfree_skb_irq(skb);
793 /****************************************************************
795 ****************************************************************/
796 static netdev_tx_t kaweth_start_xmit(struct sk_buff *skb,
797 struct net_device *net)
799 struct kaweth_device *kaweth = netdev_priv(net);
800 __le16 *private_header;
804 spin_lock_irq(&kaweth->device_lock);
806 kaweth_async_set_rx_mode(kaweth);
807 netif_stop_queue(net);
808 if (IS_BLOCKED(kaweth->status)) {
812 /* We now decide whether we can put our special header into the sk_buff */
813 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
814 /* no such luck - we make our own */
815 struct sk_buff *copied_skb;
816 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
817 dev_kfree_skb_irq(skb);
820 kaweth->stats.tx_errors++;
821 netif_start_queue(net);
822 spin_unlock_irq(&kaweth->device_lock);
827 private_header = (__le16 *)__skb_push(skb, 2);
828 *private_header = cpu_to_le16(skb->len-2);
829 kaweth->tx_skb = skb;
831 usb_fill_bulk_urb(kaweth->tx_urb,
833 usb_sndbulkpipe(kaweth->dev, 2),
836 kaweth_usb_transmit_complete,
840 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
842 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
844 kaweth->stats.tx_errors++;
846 netif_start_queue(net);
847 dev_kfree_skb_irq(skb);
851 kaweth->stats.tx_packets++;
852 kaweth->stats.tx_bytes += skb->len;
855 spin_unlock_irq(&kaweth->device_lock);
860 /****************************************************************
862 ****************************************************************/
863 static void kaweth_set_rx_mode(struct net_device *net)
865 struct kaweth_device *kaweth = netdev_priv(net);
867 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
868 KAWETH_PACKET_FILTER_BROADCAST |
869 KAWETH_PACKET_FILTER_MULTICAST;
871 dbg("Setting Rx mode to %d", packet_filter_bitmap);
873 netif_stop_queue(net);
875 if (net->flags & IFF_PROMISC) {
876 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
878 else if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI)) {
879 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
882 kaweth->packet_filter_bitmap = packet_filter_bitmap;
883 netif_wake_queue(net);
886 /****************************************************************
887 * kaweth_async_set_rx_mode
888 ****************************************************************/
889 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
892 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
894 kaweth->packet_filter_bitmap = 0;
895 if (packet_filter_bitmap == 0)
901 result = kaweth_control(kaweth,
902 usb_sndctrlpipe(kaweth->dev, 0),
903 KAWETH_COMMAND_SET_PACKET_FILTER,
904 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
905 packet_filter_bitmap,
907 (void *)&kaweth->scratch,
909 KAWETH_CONTROL_TIMEOUT);
912 dev_err(&kaweth->intf->dev, "Failed to set Rx mode: %d\n",
916 dbg("Set Rx mode to %d", packet_filter_bitmap);
920 /****************************************************************
921 * kaweth_netdev_stats
922 ****************************************************************/
923 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
925 struct kaweth_device *kaweth = netdev_priv(dev);
926 return &kaweth->stats;
929 /****************************************************************
931 ****************************************************************/
932 static void kaweth_tx_timeout(struct net_device *net)
934 struct kaweth_device *kaweth = netdev_priv(net);
936 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
937 kaweth->stats.tx_errors++;
938 net->trans_start = jiffies;
940 usb_unlink_urb(kaweth->tx_urb);
943 /****************************************************************
945 ****************************************************************/
946 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
948 struct kaweth_device *kaweth = usb_get_intfdata(intf);
951 dbg("Suspending device");
952 spin_lock_irqsave(&kaweth->device_lock, flags);
953 kaweth->status |= KAWETH_STATUS_SUSPENDING;
954 spin_unlock_irqrestore(&kaweth->device_lock, flags);
956 kaweth_kill_urbs(kaweth);
960 /****************************************************************
962 ****************************************************************/
963 static int kaweth_resume(struct usb_interface *intf)
965 struct kaweth_device *kaweth = usb_get_intfdata(intf);
968 dbg("Resuming device");
969 spin_lock_irqsave(&kaweth->device_lock, flags);
970 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
971 spin_unlock_irqrestore(&kaweth->device_lock, flags);
975 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
976 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
981 /****************************************************************
983 ****************************************************************/
986 static const struct net_device_ops kaweth_netdev_ops = {
987 .ndo_open = kaweth_open,
988 .ndo_stop = kaweth_close,
989 .ndo_start_xmit = kaweth_start_xmit,
990 .ndo_tx_timeout = kaweth_tx_timeout,
991 .ndo_set_rx_mode = kaweth_set_rx_mode,
992 .ndo_get_stats = kaweth_netdev_stats,
993 .ndo_change_mtu = eth_change_mtu,
994 .ndo_set_mac_address = eth_mac_addr,
995 .ndo_validate_addr = eth_validate_addr,
998 static int kaweth_probe(
999 struct usb_interface *intf,
1000 const struct usb_device_id *id /* from id_table */
1003 struct usb_device *dev = interface_to_usbdev(intf);
1004 struct kaweth_device *kaweth;
1005 struct net_device *netdev;
1006 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1009 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1011 le16_to_cpu(dev->descriptor.idVendor),
1012 le16_to_cpu(dev->descriptor.idProduct),
1013 le16_to_cpu(dev->descriptor.bcdDevice));
1015 dbg("Device at %p", dev);
1017 dbg("Descriptor length: %x type: %x",
1018 (int)dev->descriptor.bLength,
1019 (int)dev->descriptor.bDescriptorType);
1021 netdev = alloc_etherdev(sizeof(*kaweth));
1025 kaweth = netdev_priv(netdev);
1027 kaweth->net = netdev;
1029 spin_lock_init(&kaweth->device_lock);
1030 init_waitqueue_head(&kaweth->term_wait);
1034 kaweth_reset(kaweth);
1037 * If high byte of bcdDevice is nonzero, firmware is already
1038 * downloaded. Don't try to do it again, or we'll hang the device.
1041 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1042 dev_info(&intf->dev, "Firmware present in device.\n");
1044 /* Download the firmware */
1045 dev_info(&intf->dev, "Downloading firmware...\n");
1046 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1047 if ((result = kaweth_download_firmware(kaweth,
1051 dev_err(&intf->dev, "Error downloading firmware (%d)\n",
1056 if ((result = kaweth_download_firmware(kaweth,
1061 "Error downloading firmware fix (%d)\n",
1066 if ((result = kaweth_download_firmware(kaweth,
1071 "Error downloading trigger code (%d)\n",
1077 if ((result = kaweth_download_firmware(kaweth,
1081 dev_err(&intf->dev, "Error downloading trigger code fix (%d)\n", result);
1086 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1087 dev_err(&intf->dev, "Error triggering firmware (%d)\n",
1092 /* Device will now disappear for a moment... */
1093 dev_info(&intf->dev, "Firmware loaded. I'll be back...\n");
1095 free_page((unsigned long)kaweth->firmware_buf);
1096 free_netdev(netdev);
1100 result = kaweth_read_configuration(kaweth);
1103 dev_err(&intf->dev, "Error reading configuration (%d), no net device created\n", result);
1104 goto err_free_netdev;
1107 dev_info(&intf->dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
1108 dev_info(&intf->dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1109 dev_info(&intf->dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
1110 dev_info(&intf->dev, "Read MAC address %pM\n", kaweth->configuration.hw_addr);
1112 if(!memcmp(&kaweth->configuration.hw_addr,
1114 sizeof(bcast_addr))) {
1115 dev_err(&intf->dev, "Firmware not functioning properly, no net device created\n");
1116 goto err_free_netdev;
1119 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1120 dbg("Error setting URB size");
1121 goto err_free_netdev;
1124 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1125 dev_err(&intf->dev, "Error setting SOFS wait\n");
1126 goto err_free_netdev;
1129 result = kaweth_set_receive_filter(kaweth,
1130 KAWETH_PACKET_FILTER_DIRECTED |
1131 KAWETH_PACKET_FILTER_BROADCAST |
1132 KAWETH_PACKET_FILTER_MULTICAST);
1135 dev_err(&intf->dev, "Error setting receive filter\n");
1136 goto err_free_netdev;
1139 dbg("Initializing net device.");
1141 kaweth->intf = intf;
1143 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1144 if (!kaweth->tx_urb)
1145 goto err_free_netdev;
1146 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1147 if (!kaweth->rx_urb)
1149 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1150 if (!kaweth->irq_urb)
1153 kaweth->intbuffer = usb_alloc_coherent( kaweth->dev,
1156 &kaweth->intbufferhandle);
1157 if (!kaweth->intbuffer)
1158 goto err_tx_and_rx_and_irq;
1159 kaweth->rx_buf = usb_alloc_coherent( kaweth->dev,
1162 &kaweth->rxbufferhandle);
1163 if (!kaweth->rx_buf)
1164 goto err_all_but_rxbuf;
1166 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1167 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1168 sizeof(kaweth->configuration.hw_addr));
1170 netdev->netdev_ops = &kaweth_netdev_ops;
1171 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1172 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1173 SET_ETHTOOL_OPS(netdev, &ops);
1175 /* kaweth is zeroed as part of alloc_netdev */
1176 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1177 usb_set_intfdata(intf, kaweth);
1180 // dma_supported() is deeply broken on almost all architectures
1181 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1182 kaweth->net->features |= NETIF_F_HIGHDMA;
1185 SET_NETDEV_DEV(netdev, &intf->dev);
1186 if (register_netdev(netdev) != 0) {
1187 dev_err(&intf->dev, "Error registering netdev.\n");
1191 dev_info(&intf->dev, "kaweth interface created at %s\n",
1194 dbg("Kaweth probe returning.");
1199 usb_set_intfdata(intf, NULL);
1200 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1202 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1203 err_tx_and_rx_and_irq:
1204 usb_free_urb(kaweth->irq_urb);
1206 usb_free_urb(kaweth->rx_urb);
1208 usb_free_urb(kaweth->tx_urb);
1210 free_netdev(netdev);
1215 /****************************************************************
1217 ****************************************************************/
1218 static void kaweth_disconnect(struct usb_interface *intf)
1220 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1221 struct net_device *netdev;
1223 dev_info(&intf->dev, "Unregistering\n");
1225 usb_set_intfdata(intf, NULL);
1227 dev_warn(&intf->dev, "unregistering non-existent device\n");
1230 netdev = kaweth->net;
1232 dbg("Unregistering net device");
1233 unregister_netdev(netdev);
1235 usb_free_urb(kaweth->rx_urb);
1236 usb_free_urb(kaweth->tx_urb);
1237 usb_free_urb(kaweth->irq_urb);
1239 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1240 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1242 free_netdev(netdev);
1246 // FIXME this completion stuff is a modified clone of
1247 // an OLD version of some stuff in usb.c ...
1248 struct usb_api_data {
1249 wait_queue_head_t wqh;
1253 /*-------------------------------------------------------------------*
1254 * completion handler for compatibility wrappers (sync control/bulk) *
1255 *-------------------------------------------------------------------*/
1256 static void usb_api_blocking_completion(struct urb *urb)
1258 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1264 /*-------------------------------------------------------------------*
1265 * COMPATIBILITY STUFF *
1266 *-------------------------------------------------------------------*/
1268 // Starts urb and waits for completion or timeout
1269 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1271 struct usb_api_data awd;
1274 init_waitqueue_head(&awd.wqh);
1277 urb->context = &awd;
1278 status = usb_submit_urb(urb, GFP_NOIO);
1280 // something went wrong
1285 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1287 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1288 usb_kill_urb(urb); // remove urb safely
1289 status = -ETIMEDOUT;
1292 status = urb->status;
1295 if (actual_length) {
1296 *actual_length = urb->actual_length;
1303 /*-------------------------------------------------------------------*/
1304 // returns status (negative) or length (positive)
1305 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1307 struct usb_ctrlrequest *cmd, void *data,
1308 int len, int timeout)
1312 int length = 0; /* shut up GCC */
1314 urb = usb_alloc_urb(0, GFP_ATOMIC);
1318 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1319 len, usb_api_blocking_completion, NULL);
1321 retv = usb_start_wait_urb(urb, timeout, &length);
1330 module_usb_driver(kaweth_driver);