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");
108 MODULE_FIRMWARE("kaweth/new_code.bin");
109 MODULE_FIRMWARE("kaweth/new_code_fix.bin");
110 MODULE_FIRMWARE("kaweth/trigger_code.bin");
111 MODULE_FIRMWARE("kaweth/trigger_code_fix.bin");
113 static const char driver_name[] = "kaweth";
115 static int kaweth_probe(
116 struct usb_interface *intf,
117 const struct usb_device_id *id /* from id_table */
119 static void kaweth_disconnect(struct usb_interface *intf);
120 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
122 struct usb_ctrlrequest *cmd, void *data,
123 int len, int timeout);
124 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
125 static int kaweth_resume(struct usb_interface *intf);
127 /****************************************************************
129 ****************************************************************/
130 static struct usb_device_id usb_klsi_table[] = {
131 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
132 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
133 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
134 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
135 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
136 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
137 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
138 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
139 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
140 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
141 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
142 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
143 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
144 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
145 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
146 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
147 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
148 { USB_DEVICE(0x07c9, 0xb010) }, /* Allied Telesyn AT-USB10 USB Ethernet Adapter */
149 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
150 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
151 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
152 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
153 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
154 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
155 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
156 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
157 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
158 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
159 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
160 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
161 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
162 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
163 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
164 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
165 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
166 {} /* Null terminator */
169 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
171 /****************************************************************
173 ****************************************************************/
174 static struct usb_driver kaweth_driver = {
176 .probe = kaweth_probe,
177 .disconnect = kaweth_disconnect,
178 .suspend = kaweth_suspend,
179 .resume = kaweth_resume,
180 .id_table = usb_klsi_table,
181 .supports_autosuspend = 1,
184 typedef __u8 eth_addr_t[6];
186 /****************************************************************
188 ****************************************************************/
196 /****************************************************************
197 * kaweth_ethernet_configuration
199 ****************************************************************/
200 struct kaweth_ethernet_configuration
206 __u32 statistics_mask;
208 __u16 max_multicast_filters;
210 } __attribute__ ((packed));
212 /****************************************************************
214 ****************************************************************/
217 spinlock_t device_lock;
221 int suspend_lowmem_rx;
222 int suspend_lowmem_ctrl;
225 struct delayed_work lowmem_work;
227 struct usb_device *dev;
228 struct usb_interface *intf;
229 struct net_device *net;
230 wait_queue_head_t term_wait;
236 dma_addr_t intbufferhandle;
238 dma_addr_t rxbufferhandle;
242 struct sk_buff *tx_skb;
245 __u8 scratch[KAWETH_SCRATCH_SIZE];
246 __u16 packet_filter_bitmap;
248 struct kaweth_ethernet_configuration configuration;
250 struct net_device_stats stats;
253 /****************************************************************
255 ****************************************************************/
256 static int kaweth_control(struct kaweth_device *kaweth,
266 struct usb_ctrlrequest *dr;
269 dbg("kaweth_control()");
272 dbg("in_interrupt()");
276 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
279 dbg("kmalloc() failed");
283 dr->bRequestType = requesttype;
284 dr->bRequest = request;
285 dr->wValue = cpu_to_le16(value);
286 dr->wIndex = cpu_to_le16(index);
287 dr->wLength = cpu_to_le16(size);
289 retval = kaweth_internal_control_msg(kaweth->dev,
300 /****************************************************************
301 * kaweth_read_configuration
302 ****************************************************************/
303 static int kaweth_read_configuration(struct kaweth_device *kaweth)
307 dbg("Reading kaweth configuration");
309 retval = kaweth_control(kaweth,
310 usb_rcvctrlpipe(kaweth->dev, 0),
311 KAWETH_COMMAND_GET_ETHERNET_DESC,
312 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
315 (void *)&kaweth->configuration,
316 sizeof(kaweth->configuration),
317 KAWETH_CONTROL_TIMEOUT);
322 /****************************************************************
323 * kaweth_set_urb_size
324 ****************************************************************/
325 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
329 dbg("Setting URB size to %d", (unsigned)urb_size);
331 retval = kaweth_control(kaweth,
332 usb_sndctrlpipe(kaweth->dev, 0),
333 KAWETH_COMMAND_SET_URB_SIZE,
334 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
337 (void *)&kaweth->scratch,
339 KAWETH_CONTROL_TIMEOUT);
344 /****************************************************************
345 * kaweth_set_sofs_wait
346 ****************************************************************/
347 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
351 dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
353 retval = kaweth_control(kaweth,
354 usb_sndctrlpipe(kaweth->dev, 0),
355 KAWETH_COMMAND_SET_SOFS_WAIT,
356 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
359 (void *)&kaweth->scratch,
361 KAWETH_CONTROL_TIMEOUT);
366 /****************************************************************
367 * kaweth_set_receive_filter
368 ****************************************************************/
369 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
370 __u16 receive_filter)
374 dbg("Set receive filter to %d", (unsigned)receive_filter);
376 retval = kaweth_control(kaweth,
377 usb_sndctrlpipe(kaweth->dev, 0),
378 KAWETH_COMMAND_SET_PACKET_FILTER,
379 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
382 (void *)&kaweth->scratch,
384 KAWETH_CONTROL_TIMEOUT);
389 /****************************************************************
390 * kaweth_download_firmware
391 ****************************************************************/
392 static int kaweth_download_firmware(struct kaweth_device *kaweth,
397 const struct firmware *fw;
401 ret = request_firmware(&fw, fwname, &kaweth->dev->dev);
403 err("Firmware request failed\n");
407 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
408 err("Firmware too big: %zu", fw->size);
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 err ("can't resubmit intr, %s-%s, status %d",
504 kaweth->dev->bus->bus_name,
505 kaweth->dev->devpath, status);
508 static void int_callback(struct urb *u)
510 struct kaweth_device *kaweth = u->context;
512 int status = u->status;
515 case 0: /* success */
517 case -ECONNRESET: /* unlink */
521 /* -EPIPE: should clear the halt */
526 /* we check the link state to report changes */
527 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
529 netif_carrier_on(kaweth->net);
531 netif_carrier_off(kaweth->net);
533 kaweth->linkstate = act_state;
536 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
539 static void kaweth_resubmit_tl(struct work_struct *work)
541 struct kaweth_device *kaweth =
542 container_of(work, struct kaweth_device, lowmem_work.work);
544 if (IS_BLOCKED(kaweth->status))
547 if (kaweth->suspend_lowmem_rx)
548 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
550 if (kaweth->suspend_lowmem_ctrl)
551 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
555 /****************************************************************
556 * kaweth_resubmit_rx_urb
557 ****************************************************************/
558 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
563 usb_fill_bulk_urb(kaweth->rx_urb,
565 usb_rcvbulkpipe(kaweth->dev, 1),
570 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
571 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
573 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
574 if (result == -ENOMEM) {
575 kaweth->suspend_lowmem_rx = 1;
576 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
578 err("resubmitting rx_urb %d failed", result);
580 kaweth->suspend_lowmem_rx = 0;
586 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
588 /****************************************************************
590 ****************************************************************/
591 static void kaweth_usb_receive(struct urb *urb)
593 struct kaweth_device *kaweth = urb->context;
594 struct net_device *net = kaweth->net;
595 int status = urb->status;
597 int count = urb->actual_length;
598 int count2 = urb->transfer_buffer_length;
600 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
604 if (unlikely(status == -EPIPE)) {
605 kaweth->stats.rx_errors++;
607 wake_up(&kaweth->term_wait);
608 dbg("Status was -EPIPE.");
611 if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
612 /* we are killed - set a flag and wake the disconnect handler */
614 wake_up(&kaweth->term_wait);
615 dbg("Status was -ECONNRESET or -ESHUTDOWN.");
618 if (unlikely(status == -EPROTO || status == -ETIME ||
619 status == -EILSEQ)) {
620 kaweth->stats.rx_errors++;
621 dbg("Status was -EPROTO, -ETIME, or -EILSEQ.");
624 if (unlikely(status == -EOVERFLOW)) {
625 kaweth->stats.rx_errors++;
626 dbg("Status was -EOVERFLOW.");
628 spin_lock(&kaweth->device_lock);
629 if (IS_BLOCKED(kaweth->status)) {
630 spin_unlock(&kaweth->device_lock);
633 spin_unlock(&kaweth->device_lock);
635 if(status && status != -EREMOTEIO && count != 1) {
636 err("%s RX status: %d count: %d packet_len: %d",
641 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
645 if(kaweth->net && (count > 2)) {
646 if(pkt_len > (count - 2)) {
647 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
648 err("Packet len & 2047: %x", pkt_len & 2047);
649 err("Count 2: %x", count2);
650 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
654 if(!(skb = dev_alloc_skb(pkt_len+2))) {
655 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
659 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
661 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
663 skb_put(skb, pkt_len);
665 skb->protocol = eth_type_trans(skb, net);
669 kaweth->stats.rx_packets++;
670 kaweth->stats.rx_bytes += pkt_len;
673 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
676 /****************************************************************
678 ****************************************************************/
679 static int kaweth_open(struct net_device *net)
681 struct kaweth_device *kaweth = netdev_priv(net);
684 dbg("Opening network device.");
686 res = usb_autopm_get_interface(kaweth->intf);
688 err("Interface cannot be resumed.");
691 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
698 usb_rcvintpipe(kaweth->dev, 3),
703 250); /* overriding the descriptor */
704 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
705 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
707 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
709 usb_kill_urb(kaweth->rx_urb);
714 netif_start_queue(net);
716 kaweth_async_set_rx_mode(kaweth);
720 usb_autopm_put_interface(kaweth->intf);
724 /****************************************************************
726 ****************************************************************/
727 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
729 usb_kill_urb(kaweth->irq_urb);
730 usb_kill_urb(kaweth->rx_urb);
731 usb_kill_urb(kaweth->tx_urb);
733 cancel_delayed_work_sync(&kaweth->lowmem_work);
735 /* a scheduled work may have resubmitted,
737 usb_kill_urb(kaweth->irq_urb);
738 usb_kill_urb(kaweth->rx_urb);
741 /****************************************************************
743 ****************************************************************/
744 static int kaweth_close(struct net_device *net)
746 struct kaweth_device *kaweth = netdev_priv(net);
748 netif_stop_queue(net);
751 kaweth->status |= KAWETH_STATUS_CLOSING;
753 kaweth_kill_urbs(kaweth);
755 kaweth->status &= ~KAWETH_STATUS_CLOSING;
757 usb_autopm_put_interface(kaweth->intf);
762 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
764 struct kaweth_device *kaweth = netdev_priv(dev);
766 strlcpy(info->driver, driver_name, sizeof(info->driver));
767 usb_make_path(kaweth->dev, info->bus_info, sizeof (info->bus_info));
770 static u32 kaweth_get_link(struct net_device *dev)
772 struct kaweth_device *kaweth = netdev_priv(dev);
774 return kaweth->linkstate;
777 static const struct ethtool_ops ops = {
778 .get_drvinfo = kaweth_get_drvinfo,
779 .get_link = kaweth_get_link
782 /****************************************************************
783 * kaweth_usb_transmit_complete
784 ****************************************************************/
785 static void kaweth_usb_transmit_complete(struct urb *urb)
787 struct kaweth_device *kaweth = urb->context;
788 struct sk_buff *skb = kaweth->tx_skb;
789 int status = urb->status;
791 if (unlikely(status != 0))
792 if (status != -ENOENT)
793 dbg("%s: TX status %d.", kaweth->net->name, status);
795 netif_wake_queue(kaweth->net);
796 dev_kfree_skb_irq(skb);
799 /****************************************************************
801 ****************************************************************/
802 static netdev_tx_t kaweth_start_xmit(struct sk_buff *skb,
803 struct net_device *net)
805 struct kaweth_device *kaweth = netdev_priv(net);
806 __le16 *private_header;
810 spin_lock_irq(&kaweth->device_lock);
812 kaweth_async_set_rx_mode(kaweth);
813 netif_stop_queue(net);
814 if (IS_BLOCKED(kaweth->status)) {
818 /* We now decide whether we can put our special header into the sk_buff */
819 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
820 /* no such luck - we make our own */
821 struct sk_buff *copied_skb;
822 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
823 dev_kfree_skb_irq(skb);
826 kaweth->stats.tx_errors++;
827 netif_start_queue(net);
828 spin_unlock_irq(&kaweth->device_lock);
833 private_header = (__le16 *)__skb_push(skb, 2);
834 *private_header = cpu_to_le16(skb->len-2);
835 kaweth->tx_skb = skb;
837 usb_fill_bulk_urb(kaweth->tx_urb,
839 usb_sndbulkpipe(kaweth->dev, 2),
842 kaweth_usb_transmit_complete,
846 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
848 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
850 kaweth->stats.tx_errors++;
852 netif_start_queue(net);
853 dev_kfree_skb_irq(skb);
857 kaweth->stats.tx_packets++;
858 kaweth->stats.tx_bytes += skb->len;
859 net->trans_start = jiffies;
862 spin_unlock_irq(&kaweth->device_lock);
867 /****************************************************************
869 ****************************************************************/
870 static void kaweth_set_rx_mode(struct net_device *net)
872 struct kaweth_device *kaweth = netdev_priv(net);
874 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
875 KAWETH_PACKET_FILTER_BROADCAST |
876 KAWETH_PACKET_FILTER_MULTICAST;
878 dbg("Setting Rx mode to %d", packet_filter_bitmap);
880 netif_stop_queue(net);
882 if (net->flags & IFF_PROMISC) {
883 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
885 else if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI)) {
886 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
889 kaweth->packet_filter_bitmap = packet_filter_bitmap;
890 netif_wake_queue(net);
893 /****************************************************************
894 * kaweth_async_set_rx_mode
895 ****************************************************************/
896 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
899 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
901 kaweth->packet_filter_bitmap = 0;
902 if (packet_filter_bitmap == 0)
908 result = kaweth_control(kaweth,
909 usb_sndctrlpipe(kaweth->dev, 0),
910 KAWETH_COMMAND_SET_PACKET_FILTER,
911 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
912 packet_filter_bitmap,
914 (void *)&kaweth->scratch,
916 KAWETH_CONTROL_TIMEOUT);
919 err("Failed to set Rx mode: %d", result);
922 dbg("Set Rx mode to %d", packet_filter_bitmap);
926 /****************************************************************
927 * kaweth_netdev_stats
928 ****************************************************************/
929 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
931 struct kaweth_device *kaweth = netdev_priv(dev);
932 return &kaweth->stats;
935 /****************************************************************
937 ****************************************************************/
938 static void kaweth_tx_timeout(struct net_device *net)
940 struct kaweth_device *kaweth = netdev_priv(net);
942 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
943 kaweth->stats.tx_errors++;
944 net->trans_start = jiffies;
946 usb_unlink_urb(kaweth->tx_urb);
949 /****************************************************************
951 ****************************************************************/
952 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
954 struct kaweth_device *kaweth = usb_get_intfdata(intf);
957 dbg("Suspending device");
958 spin_lock_irqsave(&kaweth->device_lock, flags);
959 kaweth->status |= KAWETH_STATUS_SUSPENDING;
960 spin_unlock_irqrestore(&kaweth->device_lock, flags);
962 kaweth_kill_urbs(kaweth);
966 /****************************************************************
968 ****************************************************************/
969 static int kaweth_resume(struct usb_interface *intf)
971 struct kaweth_device *kaweth = usb_get_intfdata(intf);
974 dbg("Resuming device");
975 spin_lock_irqsave(&kaweth->device_lock, flags);
976 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
977 spin_unlock_irqrestore(&kaweth->device_lock, flags);
981 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
982 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
987 /****************************************************************
989 ****************************************************************/
992 static const struct net_device_ops kaweth_netdev_ops = {
993 .ndo_open = kaweth_open,
994 .ndo_stop = kaweth_close,
995 .ndo_start_xmit = kaweth_start_xmit,
996 .ndo_tx_timeout = kaweth_tx_timeout,
997 .ndo_set_multicast_list = kaweth_set_rx_mode,
998 .ndo_get_stats = kaweth_netdev_stats,
999 .ndo_change_mtu = eth_change_mtu,
1000 .ndo_set_mac_address = eth_mac_addr,
1001 .ndo_validate_addr = eth_validate_addr,
1004 static int kaweth_probe(
1005 struct usb_interface *intf,
1006 const struct usb_device_id *id /* from id_table */
1009 struct usb_device *dev = interface_to_usbdev(intf);
1010 struct kaweth_device *kaweth;
1011 struct net_device *netdev;
1012 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1015 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1017 le16_to_cpu(dev->descriptor.idVendor),
1018 le16_to_cpu(dev->descriptor.idProduct),
1019 le16_to_cpu(dev->descriptor.bcdDevice));
1021 dbg("Device at %p", dev);
1023 dbg("Descriptor length: %x type: %x",
1024 (int)dev->descriptor.bLength,
1025 (int)dev->descriptor.bDescriptorType);
1027 netdev = alloc_etherdev(sizeof(*kaweth));
1031 kaweth = netdev_priv(netdev);
1033 kaweth->net = netdev;
1035 spin_lock_init(&kaweth->device_lock);
1036 init_waitqueue_head(&kaweth->term_wait);
1040 kaweth_reset(kaweth);
1043 * If high byte of bcdDevice is nonzero, firmware is already
1044 * downloaded. Don't try to do it again, or we'll hang the device.
1047 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1048 dev_info(&intf->dev, "Firmware present in device.\n");
1050 /* Download the firmware */
1051 dev_info(&intf->dev, "Downloading firmware...\n");
1052 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1053 if ((result = kaweth_download_firmware(kaweth,
1054 "kaweth/new_code.bin",
1057 err("Error downloading firmware (%d)", result);
1061 if ((result = kaweth_download_firmware(kaweth,
1062 "kaweth/new_code_fix.bin",
1065 err("Error downloading firmware fix (%d)", result);
1069 if ((result = kaweth_download_firmware(kaweth,
1070 "kaweth/trigger_code.bin",
1073 err("Error downloading trigger code (%d)", result);
1078 if ((result = kaweth_download_firmware(kaweth,
1079 "kaweth/trigger_code_fix.bin",
1082 err("Error downloading trigger code fix (%d)", result);
1087 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1088 err("Error triggering firmware (%d)", result);
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 err("Error reading configuration (%d), no net device created", 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 %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1111 (int)kaweth->configuration.hw_addr[0],
1112 (int)kaweth->configuration.hw_addr[1],
1113 (int)kaweth->configuration.hw_addr[2],
1114 (int)kaweth->configuration.hw_addr[3],
1115 (int)kaweth->configuration.hw_addr[4],
1116 (int)kaweth->configuration.hw_addr[5]);
1118 if(!memcmp(&kaweth->configuration.hw_addr,
1120 sizeof(bcast_addr))) {
1121 err("Firmware not functioning properly, no net device created");
1122 goto err_free_netdev;
1125 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1126 dbg("Error setting URB size");
1127 goto err_free_netdev;
1130 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1131 err("Error setting SOFS wait");
1132 goto err_free_netdev;
1135 result = kaweth_set_receive_filter(kaweth,
1136 KAWETH_PACKET_FILTER_DIRECTED |
1137 KAWETH_PACKET_FILTER_BROADCAST |
1138 KAWETH_PACKET_FILTER_MULTICAST);
1141 err("Error setting receive filter");
1142 goto err_free_netdev;
1145 dbg("Initializing net device.");
1147 kaweth->intf = intf;
1149 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1150 if (!kaweth->tx_urb)
1151 goto err_free_netdev;
1152 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1153 if (!kaweth->rx_urb)
1155 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1156 if (!kaweth->irq_urb)
1159 kaweth->intbuffer = usb_alloc_coherent( kaweth->dev,
1162 &kaweth->intbufferhandle);
1163 if (!kaweth->intbuffer)
1164 goto err_tx_and_rx_and_irq;
1165 kaweth->rx_buf = usb_alloc_coherent( kaweth->dev,
1168 &kaweth->rxbufferhandle);
1169 if (!kaweth->rx_buf)
1170 goto err_all_but_rxbuf;
1172 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1173 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1174 sizeof(kaweth->configuration.hw_addr));
1176 netdev->netdev_ops = &kaweth_netdev_ops;
1177 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1178 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1179 SET_ETHTOOL_OPS(netdev, &ops);
1181 /* kaweth is zeroed as part of alloc_netdev */
1182 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1183 usb_set_intfdata(intf, kaweth);
1186 // dma_supported() is deeply broken on almost all architectures
1187 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1188 kaweth->net->features |= NETIF_F_HIGHDMA;
1191 SET_NETDEV_DEV(netdev, &intf->dev);
1192 if (register_netdev(netdev) != 0) {
1193 err("Error registering netdev.");
1197 dev_info(&intf->dev, "kaweth interface created at %s\n",
1200 dbg("Kaweth probe returning.");
1205 usb_set_intfdata(intf, NULL);
1206 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1208 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1209 err_tx_and_rx_and_irq:
1210 usb_free_urb(kaweth->irq_urb);
1212 usb_free_urb(kaweth->rx_urb);
1214 usb_free_urb(kaweth->tx_urb);
1216 free_netdev(netdev);
1221 /****************************************************************
1223 ****************************************************************/
1224 static void kaweth_disconnect(struct usb_interface *intf)
1226 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1227 struct net_device *netdev;
1229 dev_info(&intf->dev, "Unregistering\n");
1231 usb_set_intfdata(intf, NULL);
1233 dev_warn(&intf->dev, "unregistering non-existant device\n");
1236 netdev = kaweth->net;
1238 dbg("Unregistering net device");
1239 unregister_netdev(netdev);
1241 usb_free_urb(kaweth->rx_urb);
1242 usb_free_urb(kaweth->tx_urb);
1243 usb_free_urb(kaweth->irq_urb);
1245 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1246 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1248 free_netdev(netdev);
1252 // FIXME this completion stuff is a modified clone of
1253 // an OLD version of some stuff in usb.c ...
1254 struct usb_api_data {
1255 wait_queue_head_t wqh;
1259 /*-------------------------------------------------------------------*
1260 * completion handler for compatibility wrappers (sync control/bulk) *
1261 *-------------------------------------------------------------------*/
1262 static void usb_api_blocking_completion(struct urb *urb)
1264 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1270 /*-------------------------------------------------------------------*
1271 * COMPATIBILITY STUFF *
1272 *-------------------------------------------------------------------*/
1274 // Starts urb and waits for completion or timeout
1275 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1277 struct usb_api_data awd;
1280 init_waitqueue_head(&awd.wqh);
1283 urb->context = &awd;
1284 status = usb_submit_urb(urb, GFP_NOIO);
1286 // something went wrong
1291 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1293 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1294 usb_kill_urb(urb); // remove urb safely
1295 status = -ETIMEDOUT;
1298 status = urb->status;
1301 if (actual_length) {
1302 *actual_length = urb->actual_length;
1309 /*-------------------------------------------------------------------*/
1310 // returns status (negative) or length (positive)
1311 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1313 struct usb_ctrlrequest *cmd, void *data,
1314 int len, int timeout)
1318 int length = 0; /* shut up GCC */
1320 urb = usb_alloc_urb(0, GFP_NOIO);
1324 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1325 len, usb_api_blocking_completion, NULL);
1327 retv = usb_start_wait_urb(urb, timeout, &length);
1337 /****************************************************************
1339 ****************************************************************/
1340 static int __init kaweth_init(void)
1342 dbg("Driver loading");
1343 return usb_register(&kaweth_driver);
1346 /****************************************************************
1348 ****************************************************************/
1349 static void __exit kaweth_exit(void)
1351 usb_deregister(&kaweth_driver);
1354 module_init(kaweth_init);
1355 module_exit(kaweth_exit);