1 /****************************************************************
3 * kaweth.c - driver for KL5KUSB101 based USB->Ethernet
5 * (c) 2000 Interlan Communications
6 * (c) 2000 Stephane Alnet
8 * (C) 2002 Oliver Neukum
10 * Original author: The Zapman <zapman@interlan.net>
11 * Inspired by, and much credit goes to Michael Rothwell
12 * <rothwell@interlan.net> for the test equipment, help, and patience
13 * Based off of (and with thanks to) Petko Manolov's pegaus.c driver.
14 * Also many thanks to Joel Silverman and Ed Surprenant at Kawasaki
15 * for providing the firmware and driver resources.
17 * This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU General Public License as
19 * published by the Free Software Foundation; either version 2, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software Foundation,
29 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
31 ****************************************************************/
34 * Fix in_interrupt() problem
35 * Develop test procedures for USB net interfaces
37 * Fix bugs from previous two steps
38 * Snoop other OSs for any tricks we're not doing
40 * Reduce arbitrary timeouts
41 * Smart multicast support
42 * Temporary MAC change support
43 * Tunable SOFs parameter - ioctl()?
44 * Ethernet stats collection
45 * Code formatting improvements
48 #include <linux/module.h>
49 #include <linux/sched.h>
50 #include <linux/slab.h>
51 #include <linux/string.h>
52 #include <linux/init.h>
53 #include <linux/delay.h>
54 #include <linux/netdevice.h>
55 #include <linux/etherdevice.h>
56 #include <linux/usb.h>
57 #include <linux/types.h>
58 #include <linux/ethtool.h>
59 #include <linux/pci.h>
60 #include <linux/dma-mapping.h>
61 #include <linux/wait.h>
62 #include <asm/uaccess.h>
63 #include <asm/semaphore.h>
64 #include <asm/byteorder.h>
70 #define KAWETH_MTU 1514
71 #define KAWETH_BUF_SIZE 1664
72 #define KAWETH_TX_TIMEOUT (5 * HZ)
73 #define KAWETH_SCRATCH_SIZE 32
74 #define KAWETH_FIRMWARE_BUF_SIZE 4096
75 #define KAWETH_CONTROL_TIMEOUT (30 * HZ)
77 #define KAWETH_STATUS_BROKEN 0x0000001
78 #define KAWETH_STATUS_CLOSING 0x0000002
79 #define KAWETH_STATUS_SUSPENDING 0x0000004
81 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
83 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
84 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
85 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
86 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
87 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
90 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
91 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
92 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
93 #define KAWETH_COMMAND_STATISTICS 0x03
94 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
95 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
96 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
97 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
98 #define KAWETH_COMMAND_SCAN 0xFF
100 #define KAWETH_SOFS_TO_WAIT 0x05
102 #define INTBUFFERSIZE 4
104 #define STATE_OFFSET 0
105 #define STATE_MASK 0x40
106 #define STATE_SHIFT 5
108 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
111 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>");
112 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
113 MODULE_LICENSE("GPL");
115 static const char driver_name[] = "kaweth";
117 static int kaweth_probe(
118 struct usb_interface *intf,
119 const struct usb_device_id *id /* from id_table */
121 static void kaweth_disconnect(struct usb_interface *intf);
122 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
124 struct usb_ctrlrequest *cmd, void *data,
125 int len, int timeout);
126 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
127 static int kaweth_resume(struct usb_interface *intf);
129 /****************************************************************
131 ****************************************************************/
132 static struct usb_device_id usb_klsi_table[] = {
133 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
134 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
135 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
136 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
137 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
138 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
139 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
140 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
141 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
142 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
143 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
144 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
145 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
146 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
147 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
148 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
149 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
150 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
151 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
152 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
153 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
154 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
155 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
156 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
157 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
158 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
159 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
160 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
161 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
162 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
163 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
164 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
165 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
166 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
167 {} /* Null terminator */
170 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
172 /****************************************************************
174 ****************************************************************/
175 static struct usb_driver kaweth_driver = {
177 .probe = kaweth_probe,
178 .disconnect = kaweth_disconnect,
179 .suspend = kaweth_suspend,
180 .resume = kaweth_resume,
181 .id_table = usb_klsi_table,
184 typedef __u8 eth_addr_t[6];
186 /****************************************************************
188 ****************************************************************/
196 /****************************************************************
197 * kaweth_ethernet_configuration
199 ****************************************************************/
200 struct kaweth_ethernet_configuration
206 __u32 statistics_mask;
208 __u16 max_multicast_filters;
210 } __attribute__ ((packed));
212 /****************************************************************
214 ****************************************************************/
217 spinlock_t device_lock;
221 int suspend_lowmem_rx;
222 int suspend_lowmem_ctrl;
225 struct work_struct lowmem_work;
227 struct usb_device *dev;
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;
253 /****************************************************************
255 ****************************************************************/
256 static int kaweth_control(struct kaweth_device *kaweth,
266 struct usb_ctrlrequest *dr;
268 dbg("kaweth_control()");
271 dbg("in_interrupt()");
275 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
278 dbg("kmalloc() failed");
282 dr->bRequestType= requesttype;
283 dr->bRequest = request;
284 dr->wValue = cpu_to_le16p(&value);
285 dr->wIndex = cpu_to_le16p(&index);
286 dr->wLength = cpu_to_le16p(&size);
288 return kaweth_internal_control_msg(kaweth->dev,
296 /****************************************************************
297 * kaweth_read_configuration
298 ****************************************************************/
299 static int kaweth_read_configuration(struct kaweth_device *kaweth)
303 dbg("Reading kaweth configuration");
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 dbg("Setting URB size to %d", (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 dbg("Set SOFS wait to %d", (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 dbg("Set receive filter to %d", (unsigned)receive_filter);
372 retval = kaweth_control(kaweth,
373 usb_sndctrlpipe(kaweth->dev, 0),
374 KAWETH_COMMAND_SET_PACKET_FILTER,
375 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
378 (void *)&kaweth->scratch,
380 KAWETH_CONTROL_TIMEOUT);
385 /****************************************************************
386 * kaweth_download_firmware
387 ****************************************************************/
388 static int kaweth_download_firmware(struct kaweth_device *kaweth,
394 if(data_len > KAWETH_FIRMWARE_BUF_SIZE) {
395 err("Firmware too big: %d", data_len);
399 memcpy(kaweth->firmware_buf, data, data_len);
401 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
402 kaweth->firmware_buf[3] = data_len >> 8;
403 kaweth->firmware_buf[4] = type;
404 kaweth->firmware_buf[5] = interrupt;
406 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
407 kaweth->firmware_buf[2]);
409 dbg("Downloading firmware at %p to kaweth device at %p",
412 dbg("Firmware length: %d", data_len);
414 return kaweth_control(kaweth,
415 usb_sndctrlpipe(kaweth->dev, 0),
417 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
420 (void *)kaweth->firmware_buf,
422 KAWETH_CONTROL_TIMEOUT);
425 /****************************************************************
426 * kaweth_trigger_firmware
427 ****************************************************************/
428 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
431 kaweth->firmware_buf[0] = 0xB6;
432 kaweth->firmware_buf[1] = 0xC3;
433 kaweth->firmware_buf[2] = 0x01;
434 kaweth->firmware_buf[3] = 0x00;
435 kaweth->firmware_buf[4] = 0x06;
436 kaweth->firmware_buf[5] = interrupt;
437 kaweth->firmware_buf[6] = 0x00;
438 kaweth->firmware_buf[7] = 0x00;
440 dbg("Triggering firmware");
442 return kaweth_control(kaweth,
443 usb_sndctrlpipe(kaweth->dev, 0),
445 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
448 (void *)kaweth->firmware_buf,
450 KAWETH_CONTROL_TIMEOUT);
453 /****************************************************************
455 ****************************************************************/
456 static int kaweth_reset(struct kaweth_device *kaweth)
460 dbg("kaweth_reset(%p)", kaweth);
461 result = kaweth_control(kaweth,
462 usb_sndctrlpipe(kaweth->dev, 0),
463 USB_REQ_SET_CONFIGURATION,
465 kaweth->dev->config[0].desc.bConfigurationValue,
469 KAWETH_CONTROL_TIMEOUT);
473 dbg("kaweth_reset() returns %d.",result);
478 static void kaweth_usb_receive(struct urb *);
479 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
481 /****************************************************************
483 *****************************************************************/
485 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
489 status = usb_submit_urb (kaweth->irq_urb, mf);
490 if (unlikely(status == -ENOMEM)) {
491 kaweth->suspend_lowmem_ctrl = 1;
492 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
494 kaweth->suspend_lowmem_ctrl = 0;
498 err ("can't resubmit intr, %s-%s, status %d",
499 kaweth->dev->bus->bus_name,
500 kaweth->dev->devpath, status);
503 static void int_callback(struct urb *u)
505 struct kaweth_device *kaweth = u->context;
509 case 0: /* success */
511 case -ECONNRESET: /* unlink */
515 /* -EPIPE: should clear the halt */
520 /* we check the link state to report changes */
521 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
523 netif_carrier_on(kaweth->net);
525 netif_carrier_off(kaweth->net);
527 kaweth->linkstate = act_state;
530 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
533 static void kaweth_resubmit_tl(void *d)
535 struct kaweth_device *kaweth = (struct kaweth_device *)d;
537 if (IS_BLOCKED(kaweth->status))
540 if (kaweth->suspend_lowmem_rx)
541 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
543 if (kaweth->suspend_lowmem_ctrl)
544 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
548 /****************************************************************
549 * kaweth_resubmit_rx_urb
550 ****************************************************************/
551 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
556 usb_fill_bulk_urb(kaweth->rx_urb,
558 usb_rcvbulkpipe(kaweth->dev, 1),
563 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
564 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
566 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
567 if (result == -ENOMEM) {
568 kaweth->suspend_lowmem_rx = 1;
569 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
571 err("resubmitting rx_urb %d failed", result);
573 kaweth->suspend_lowmem_rx = 0;
579 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
581 /****************************************************************
583 ****************************************************************/
584 static void kaweth_usb_receive(struct urb *urb)
586 struct kaweth_device *kaweth = urb->context;
587 struct net_device *net = kaweth->net;
589 int count = urb->actual_length;
590 int count2 = urb->transfer_buffer_length;
592 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
596 if(unlikely(urb->status == -ECONNRESET || urb->status == -ESHUTDOWN))
597 /* we are killed - set a flag and wake the disconnect handler */
600 wake_up(&kaweth->term_wait);
604 spin_lock(&kaweth->device_lock);
605 if (IS_BLOCKED(kaweth->status)) {
606 spin_unlock(&kaweth->device_lock);
609 spin_unlock(&kaweth->device_lock);
611 if(urb->status && urb->status != -EREMOTEIO && count != 1) {
612 err("%s RX status: %d count: %d packet_len: %d",
617 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
621 if(kaweth->net && (count > 2)) {
622 if(pkt_len > (count - 2)) {
623 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
624 err("Packet len & 2047: %x", pkt_len & 2047);
625 err("Count 2: %x", count2);
626 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
630 if(!(skb = dev_alloc_skb(pkt_len+2))) {
631 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
635 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
639 eth_copy_and_sum(skb, kaweth->rx_buf + 2, pkt_len, 0);
641 skb_put(skb, pkt_len);
643 skb->protocol = eth_type_trans(skb, net);
647 kaweth->stats.rx_packets++;
648 kaweth->stats.rx_bytes += pkt_len;
651 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
654 /****************************************************************
656 ****************************************************************/
657 static int kaweth_open(struct net_device *net)
659 struct kaweth_device *kaweth = netdev_priv(net);
662 dbg("Opening network device.");
664 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
671 usb_rcvintpipe(kaweth->dev, 3),
676 250); /* overriding the descriptor */
677 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
678 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
680 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
682 usb_kill_urb(kaweth->rx_urb);
687 netif_start_queue(net);
689 kaweth_async_set_rx_mode(kaweth);
693 /****************************************************************
695 ****************************************************************/
696 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
698 usb_kill_urb(kaweth->irq_urb);
699 usb_kill_urb(kaweth->rx_urb);
700 usb_kill_urb(kaweth->tx_urb);
702 flush_scheduled_work();
704 /* a scheduled work may have resubmitted,
706 usb_kill_urb(kaweth->irq_urb);
707 usb_kill_urb(kaweth->rx_urb);
710 /****************************************************************
712 ****************************************************************/
713 static int kaweth_close(struct net_device *net)
715 struct kaweth_device *kaweth = netdev_priv(net);
717 netif_stop_queue(net);
720 kaweth->status |= KAWETH_STATUS_CLOSING;
722 kaweth_kill_urbs(kaweth);
724 kaweth->status &= ~KAWETH_STATUS_CLOSING;
729 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
732 strlcpy(info->driver, driver_name, sizeof(info->driver));
735 static struct ethtool_ops ops = {
736 .get_drvinfo = kaweth_get_drvinfo
739 /****************************************************************
740 * kaweth_usb_transmit_complete
741 ****************************************************************/
742 static void kaweth_usb_transmit_complete(struct urb *urb)
744 struct kaweth_device *kaweth = urb->context;
745 struct sk_buff *skb = kaweth->tx_skb;
747 if (unlikely(urb->status != 0))
748 if (urb->status != -ENOENT)
749 dbg("%s: TX status %d.", kaweth->net->name, urb->status);
751 netif_wake_queue(kaweth->net);
752 dev_kfree_skb_irq(skb);
755 /****************************************************************
757 ****************************************************************/
758 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
760 struct kaweth_device *kaweth = netdev_priv(net);
761 __le16 *private_header;
765 spin_lock(&kaweth->device_lock);
767 kaweth_async_set_rx_mode(kaweth);
768 netif_stop_queue(net);
769 if (IS_BLOCKED(kaweth->status)) {
773 /* We now decide whether we can put our special header into the sk_buff */
774 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
775 /* no such luck - we make our own */
776 struct sk_buff *copied_skb;
777 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
778 dev_kfree_skb_irq(skb);
781 kaweth->stats.tx_errors++;
782 netif_start_queue(net);
783 spin_unlock(&kaweth->device_lock);
788 private_header = (__le16 *)__skb_push(skb, 2);
789 *private_header = cpu_to_le16(skb->len-2);
790 kaweth->tx_skb = skb;
792 usb_fill_bulk_urb(kaweth->tx_urb,
794 usb_sndbulkpipe(kaweth->dev, 2),
797 kaweth_usb_transmit_complete,
801 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
803 warn("kaweth failed tx_urb %d", res);
805 kaweth->stats.tx_errors++;
807 netif_start_queue(net);
808 dev_kfree_skb_irq(skb);
812 kaweth->stats.tx_packets++;
813 kaweth->stats.tx_bytes += skb->len;
814 net->trans_start = jiffies;
817 spin_unlock(&kaweth->device_lock);
822 /****************************************************************
824 ****************************************************************/
825 static void kaweth_set_rx_mode(struct net_device *net)
827 struct kaweth_device *kaweth = netdev_priv(net);
829 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
830 KAWETH_PACKET_FILTER_BROADCAST |
831 KAWETH_PACKET_FILTER_MULTICAST;
833 dbg("Setting Rx mode to %d", packet_filter_bitmap);
835 netif_stop_queue(net);
837 if (net->flags & IFF_PROMISC) {
838 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
840 else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
841 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
844 kaweth->packet_filter_bitmap = packet_filter_bitmap;
845 netif_wake_queue(net);
848 /****************************************************************
849 * kaweth_async_set_rx_mode
850 ****************************************************************/
851 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
853 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
854 kaweth->packet_filter_bitmap = 0;
855 if (packet_filter_bitmap == 0)
860 result = kaweth_control(kaweth,
861 usb_sndctrlpipe(kaweth->dev, 0),
862 KAWETH_COMMAND_SET_PACKET_FILTER,
863 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
864 packet_filter_bitmap,
866 (void *)&kaweth->scratch,
868 KAWETH_CONTROL_TIMEOUT);
871 err("Failed to set Rx mode: %d", result);
874 dbg("Set Rx mode to %d", packet_filter_bitmap);
879 /****************************************************************
880 * kaweth_netdev_stats
881 ****************************************************************/
882 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
884 struct kaweth_device *kaweth = netdev_priv(dev);
885 return &kaweth->stats;
888 /****************************************************************
890 ****************************************************************/
891 static void kaweth_tx_timeout(struct net_device *net)
893 struct kaweth_device *kaweth = netdev_priv(net);
895 warn("%s: Tx timed out. Resetting.", net->name);
896 kaweth->stats.tx_errors++;
897 net->trans_start = jiffies;
899 usb_unlink_urb(kaweth->tx_urb);
902 /****************************************************************
904 ****************************************************************/
905 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
907 struct kaweth_device *kaweth = usb_get_intfdata(intf);
910 spin_lock_irqsave(&kaweth->device_lock, flags);
911 kaweth->status |= KAWETH_STATUS_SUSPENDING;
912 spin_unlock_irqrestore(&kaweth->device_lock, flags);
914 kaweth_kill_urbs(kaweth);
918 /****************************************************************
920 ****************************************************************/
921 static int kaweth_resume(struct usb_interface *intf)
923 struct kaweth_device *kaweth = usb_get_intfdata(intf);
926 spin_lock_irqsave(&kaweth->device_lock, flags);
927 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
928 spin_unlock_irqrestore(&kaweth->device_lock, flags);
932 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
933 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
938 /****************************************************************
940 ****************************************************************/
941 static int kaweth_probe(
942 struct usb_interface *intf,
943 const struct usb_device_id *id /* from id_table */
946 struct usb_device *dev = interface_to_usbdev(intf);
947 struct kaweth_device *kaweth;
948 struct net_device *netdev;
949 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
952 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
954 le16_to_cpu(dev->descriptor.idVendor),
955 le16_to_cpu(dev->descriptor.idProduct),
956 le16_to_cpu(dev->descriptor.bcdDevice));
958 dbg("Device at %p", dev);
960 dbg("Descriptor length: %x type: %x",
961 (int)dev->descriptor.bLength,
962 (int)dev->descriptor.bDescriptorType);
964 netdev = alloc_etherdev(sizeof(*kaweth));
968 kaweth = netdev_priv(netdev);
970 kaweth->net = netdev;
972 spin_lock_init(&kaweth->device_lock);
973 init_waitqueue_head(&kaweth->term_wait);
977 kaweth_reset(kaweth);
980 * If high byte of bcdDevice is nonzero, firmware is already
981 * downloaded. Don't try to do it again, or we'll hang the device.
984 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
985 info("Firmware present in device.");
987 /* Download the firmware */
988 info("Downloading firmware...");
989 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
990 if ((result = kaweth_download_firmware(kaweth,
995 err("Error downloading firmware (%d)", result);
999 if ((result = kaweth_download_firmware(kaweth,
1000 kaweth_new_code_fix,
1001 len_kaweth_new_code_fix,
1004 err("Error downloading firmware fix (%d)", result);
1008 if ((result = kaweth_download_firmware(kaweth,
1009 kaweth_trigger_code,
1010 len_kaweth_trigger_code,
1013 err("Error downloading trigger code (%d)", result);
1018 if ((result = kaweth_download_firmware(kaweth,
1019 kaweth_trigger_code_fix,
1020 len_kaweth_trigger_code_fix,
1023 err("Error downloading trigger code fix (%d)", result);
1028 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1029 err("Error triggering firmware (%d)", result);
1033 /* Device will now disappear for a moment... */
1034 info("Firmware loaded. I'll be back...");
1036 free_page((unsigned long)kaweth->firmware_buf);
1037 free_netdev(netdev);
1041 result = kaweth_read_configuration(kaweth);
1044 err("Error reading configuration (%d), no net device created", result);
1045 goto err_free_netdev;
1048 info("Statistics collection: %x", kaweth->configuration.statistics_mask);
1049 info("Multicast filter limit: %x", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1050 info("MTU: %d", le16_to_cpu(kaweth->configuration.segment_size));
1051 info("Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
1052 (int)kaweth->configuration.hw_addr[0],
1053 (int)kaweth->configuration.hw_addr[1],
1054 (int)kaweth->configuration.hw_addr[2],
1055 (int)kaweth->configuration.hw_addr[3],
1056 (int)kaweth->configuration.hw_addr[4],
1057 (int)kaweth->configuration.hw_addr[5]);
1059 if(!memcmp(&kaweth->configuration.hw_addr,
1061 sizeof(bcast_addr))) {
1062 err("Firmware not functioning properly, no net device created");
1063 goto err_free_netdev;
1066 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1067 dbg("Error setting URB size");
1068 goto err_free_netdev;
1071 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1072 err("Error setting SOFS wait");
1073 goto err_free_netdev;
1076 result = kaweth_set_receive_filter(kaweth,
1077 KAWETH_PACKET_FILTER_DIRECTED |
1078 KAWETH_PACKET_FILTER_BROADCAST |
1079 KAWETH_PACKET_FILTER_MULTICAST);
1082 err("Error setting receive filter");
1083 goto err_free_netdev;
1086 dbg("Initializing net device.");
1088 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1089 if (!kaweth->tx_urb)
1090 goto err_free_netdev;
1091 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1092 if (!kaweth->rx_urb)
1094 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1095 if (!kaweth->irq_urb)
1098 kaweth->intbuffer = usb_buffer_alloc( kaweth->dev,
1101 &kaweth->intbufferhandle);
1102 if (!kaweth->intbuffer)
1103 goto err_tx_and_rx_and_irq;
1104 kaweth->rx_buf = usb_buffer_alloc( kaweth->dev,
1107 &kaweth->rxbufferhandle);
1108 if (!kaweth->rx_buf)
1109 goto err_all_but_rxbuf;
1111 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1112 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1113 sizeof(kaweth->configuration.hw_addr));
1115 netdev->open = kaweth_open;
1116 netdev->stop = kaweth_close;
1118 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1119 netdev->tx_timeout = kaweth_tx_timeout;
1121 netdev->hard_start_xmit = kaweth_start_xmit;
1122 netdev->set_multicast_list = kaweth_set_rx_mode;
1123 netdev->get_stats = kaweth_netdev_stats;
1124 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1125 SET_ETHTOOL_OPS(netdev, &ops);
1127 /* kaweth is zeroed as part of alloc_netdev */
1129 INIT_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl, (void *)kaweth);
1131 SET_MODULE_OWNER(netdev);
1133 usb_set_intfdata(intf, kaweth);
1136 // dma_supported() is deeply broken on almost all architectures
1137 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1138 kaweth->net->features |= NETIF_F_HIGHDMA;
1141 SET_NETDEV_DEV(netdev, &intf->dev);
1142 if (register_netdev(netdev) != 0) {
1143 err("Error registering netdev.");
1147 info("kaweth interface created at %s", kaweth->net->name);
1149 dbg("Kaweth probe returning.");
1154 usb_set_intfdata(intf, NULL);
1155 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1157 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1158 err_tx_and_rx_and_irq:
1159 usb_free_urb(kaweth->irq_urb);
1161 usb_free_urb(kaweth->rx_urb);
1163 usb_free_urb(kaweth->tx_urb);
1165 free_netdev(netdev);
1170 /****************************************************************
1172 ****************************************************************/
1173 static void kaweth_disconnect(struct usb_interface *intf)
1175 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1176 struct net_device *netdev;
1178 info("Unregistering");
1180 usb_set_intfdata(intf, NULL);
1182 warn("unregistering non-existant device");
1185 netdev = kaweth->net;
1187 dbg("Unregistering net device");
1188 unregister_netdev(netdev);
1190 usb_free_urb(kaweth->rx_urb);
1191 usb_free_urb(kaweth->tx_urb);
1192 usb_free_urb(kaweth->irq_urb);
1194 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1195 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1197 free_netdev(netdev);
1201 // FIXME this completion stuff is a modified clone of
1202 // an OLD version of some stuff in usb.c ...
1203 struct usb_api_data {
1204 wait_queue_head_t wqh;
1208 /*-------------------------------------------------------------------*
1209 * completion handler for compatibility wrappers (sync control/bulk) *
1210 *-------------------------------------------------------------------*/
1211 static void usb_api_blocking_completion(struct urb *urb)
1213 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1219 /*-------------------------------------------------------------------*
1220 * COMPATIBILITY STUFF *
1221 *-------------------------------------------------------------------*/
1223 // Starts urb and waits for completion or timeout
1224 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1226 struct usb_api_data awd;
1229 init_waitqueue_head(&awd.wqh);
1232 urb->context = &awd;
1233 status = usb_submit_urb(urb, GFP_NOIO);
1235 // something went wrong
1240 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1242 warn("usb_control/bulk_msg: timeout");
1243 usb_kill_urb(urb); // remove urb safely
1244 status = -ETIMEDOUT;
1247 status = urb->status;
1250 if (actual_length) {
1251 *actual_length = urb->actual_length;
1258 /*-------------------------------------------------------------------*/
1259 // returns status (negative) or length (positive)
1260 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1262 struct usb_ctrlrequest *cmd, void *data,
1263 int len, int timeout)
1269 urb = usb_alloc_urb(0, GFP_NOIO);
1273 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1274 len, usb_api_blocking_completion, NULL);
1276 retv = usb_start_wait_urb(urb, timeout, &length);
1286 /****************************************************************
1288 ****************************************************************/
1289 static int __init kaweth_init(void)
1291 dbg("Driver loading");
1292 return usb_register(&kaweth_driver);
1295 /****************************************************************
1297 ****************************************************************/
1298 static void __exit kaweth_exit(void)
1300 usb_deregister(&kaweth_driver);
1303 module_init(kaweth_init);
1304 module_exit(kaweth_exit);