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/slab.h>
50 #include <linux/string.h>
51 #include <linux/init.h>
52 #include <linux/delay.h>
53 #include <linux/netdevice.h>
54 #include <linux/etherdevice.h>
55 #include <linux/usb.h>
56 #include <linux/types.h>
57 #include <linux/ethtool.h>
58 #include <linux/pci.h>
59 #include <linux/dma-mapping.h>
60 #include <linux/wait.h>
61 #include <asm/uaccess.h>
62 #include <asm/semaphore.h>
63 #include <asm/byteorder.h>
69 #define KAWETH_MTU 1514
70 #define KAWETH_BUF_SIZE 1664
71 #define KAWETH_TX_TIMEOUT (5 * HZ)
72 #define KAWETH_SCRATCH_SIZE 32
73 #define KAWETH_FIRMWARE_BUF_SIZE 4096
74 #define KAWETH_CONTROL_TIMEOUT (30 * HZ)
76 #define KAWETH_STATUS_BROKEN 0x0000001
77 #define KAWETH_STATUS_CLOSING 0x0000002
78 #define KAWETH_STATUS_SUSPENDING 0x0000004
80 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
82 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
83 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
84 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
85 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
86 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
89 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
90 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
91 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
92 #define KAWETH_COMMAND_STATISTICS 0x03
93 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
94 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
95 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
96 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
97 #define KAWETH_COMMAND_SCAN 0xFF
99 #define KAWETH_SOFS_TO_WAIT 0x05
101 #define INTBUFFERSIZE 4
103 #define STATE_OFFSET 0
104 #define STATE_MASK 0x40
105 #define STATE_SHIFT 5
107 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
110 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>");
111 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
112 MODULE_LICENSE("GPL");
114 static const char driver_name[] = "kaweth";
116 static int kaweth_probe(
117 struct usb_interface *intf,
118 const struct usb_device_id *id /* from id_table */
120 static void kaweth_disconnect(struct usb_interface *intf);
121 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
123 struct usb_ctrlrequest *cmd, void *data,
124 int len, int timeout);
125 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
126 static int kaweth_resume(struct usb_interface *intf);
128 /****************************************************************
130 ****************************************************************/
131 static struct usb_device_id usb_klsi_table[] = {
132 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
133 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
134 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
135 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
136 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
137 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
138 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
139 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
140 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
141 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
142 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
143 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
144 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
145 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
146 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
147 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
148 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
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;
254 /****************************************************************
256 ****************************************************************/
257 static int kaweth_control(struct kaweth_device *kaweth,
267 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_le16p(&value);
286 dr->wIndex = cpu_to_le16p(&index);
287 dr->wLength = cpu_to_le16p(&size);
289 return kaweth_internal_control_msg(kaweth->dev,
297 /****************************************************************
298 * kaweth_read_configuration
299 ****************************************************************/
300 static int kaweth_read_configuration(struct kaweth_device *kaweth)
304 dbg("Reading kaweth configuration");
306 retval = kaweth_control(kaweth,
307 usb_rcvctrlpipe(kaweth->dev, 0),
308 KAWETH_COMMAND_GET_ETHERNET_DESC,
309 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
312 (void *)&kaweth->configuration,
313 sizeof(kaweth->configuration),
314 KAWETH_CONTROL_TIMEOUT);
319 /****************************************************************
320 * kaweth_set_urb_size
321 ****************************************************************/
322 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
326 dbg("Setting URB size to %d", (unsigned)urb_size);
328 retval = kaweth_control(kaweth,
329 usb_sndctrlpipe(kaweth->dev, 0),
330 KAWETH_COMMAND_SET_URB_SIZE,
331 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
334 (void *)&kaweth->scratch,
336 KAWETH_CONTROL_TIMEOUT);
341 /****************************************************************
342 * kaweth_set_sofs_wait
343 ****************************************************************/
344 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
348 dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
350 retval = kaweth_control(kaweth,
351 usb_sndctrlpipe(kaweth->dev, 0),
352 KAWETH_COMMAND_SET_SOFS_WAIT,
353 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
356 (void *)&kaweth->scratch,
358 KAWETH_CONTROL_TIMEOUT);
363 /****************************************************************
364 * kaweth_set_receive_filter
365 ****************************************************************/
366 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
367 __u16 receive_filter)
371 dbg("Set receive filter to %d", (unsigned)receive_filter);
373 retval = kaweth_control(kaweth,
374 usb_sndctrlpipe(kaweth->dev, 0),
375 KAWETH_COMMAND_SET_PACKET_FILTER,
376 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
379 (void *)&kaweth->scratch,
381 KAWETH_CONTROL_TIMEOUT);
386 /****************************************************************
387 * kaweth_download_firmware
388 ****************************************************************/
389 static int kaweth_download_firmware(struct kaweth_device *kaweth,
395 if(data_len > KAWETH_FIRMWARE_BUF_SIZE) {
396 err("Firmware too big: %d", data_len);
400 memcpy(kaweth->firmware_buf, data, data_len);
402 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
403 kaweth->firmware_buf[3] = data_len >> 8;
404 kaweth->firmware_buf[4] = type;
405 kaweth->firmware_buf[5] = interrupt;
407 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
408 kaweth->firmware_buf[2]);
410 dbg("Downloading firmware at %p to kaweth device at %p",
413 dbg("Firmware length: %d", data_len);
415 return kaweth_control(kaweth,
416 usb_sndctrlpipe(kaweth->dev, 0),
418 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
421 (void *)kaweth->firmware_buf,
423 KAWETH_CONTROL_TIMEOUT);
426 /****************************************************************
427 * kaweth_trigger_firmware
428 ****************************************************************/
429 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
432 kaweth->firmware_buf[0] = 0xB6;
433 kaweth->firmware_buf[1] = 0xC3;
434 kaweth->firmware_buf[2] = 0x01;
435 kaweth->firmware_buf[3] = 0x00;
436 kaweth->firmware_buf[4] = 0x06;
437 kaweth->firmware_buf[5] = interrupt;
438 kaweth->firmware_buf[6] = 0x00;
439 kaweth->firmware_buf[7] = 0x00;
441 dbg("Triggering firmware");
443 return kaweth_control(kaweth,
444 usb_sndctrlpipe(kaweth->dev, 0),
446 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
449 (void *)kaweth->firmware_buf,
451 KAWETH_CONTROL_TIMEOUT);
454 /****************************************************************
456 ****************************************************************/
457 static int kaweth_reset(struct kaweth_device *kaweth)
461 dbg("kaweth_reset(%p)", kaweth);
462 result = kaweth_control(kaweth,
463 usb_sndctrlpipe(kaweth->dev, 0),
464 USB_REQ_SET_CONFIGURATION,
466 kaweth->dev->config[0].desc.bConfigurationValue,
470 KAWETH_CONTROL_TIMEOUT);
474 dbg("kaweth_reset() returns %d.",result);
479 static void kaweth_usb_receive(struct urb *);
480 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
482 /****************************************************************
484 *****************************************************************/
486 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
490 status = usb_submit_urb (kaweth->irq_urb, mf);
491 if (unlikely(status == -ENOMEM)) {
492 kaweth->suspend_lowmem_ctrl = 1;
493 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
495 kaweth->suspend_lowmem_ctrl = 0;
499 err ("can't resubmit intr, %s-%s, status %d",
500 kaweth->dev->bus->bus_name,
501 kaweth->dev->devpath, status);
504 static void int_callback(struct urb *u)
506 struct kaweth_device *kaweth = u->context;
510 case 0: /* success */
512 case -ECONNRESET: /* unlink */
516 /* -EPIPE: should clear the halt */
521 /* we check the link state to report changes */
522 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
524 netif_carrier_on(kaweth->net);
526 netif_carrier_off(kaweth->net);
528 kaweth->linkstate = act_state;
531 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
534 static void kaweth_resubmit_tl(struct work_struct *work)
536 struct kaweth_device *kaweth =
537 container_of(work, struct kaweth_device, lowmem_work.work);
539 if (IS_BLOCKED(kaweth->status))
542 if (kaweth->suspend_lowmem_rx)
543 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
545 if (kaweth->suspend_lowmem_ctrl)
546 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
550 /****************************************************************
551 * kaweth_resubmit_rx_urb
552 ****************************************************************/
553 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
558 usb_fill_bulk_urb(kaweth->rx_urb,
560 usb_rcvbulkpipe(kaweth->dev, 1),
565 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
566 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
568 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
569 if (result == -ENOMEM) {
570 kaweth->suspend_lowmem_rx = 1;
571 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
573 err("resubmitting rx_urb %d failed", result);
575 kaweth->suspend_lowmem_rx = 0;
581 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
583 /****************************************************************
585 ****************************************************************/
586 static void kaweth_usb_receive(struct urb *urb)
588 struct kaweth_device *kaweth = urb->context;
589 struct net_device *net = kaweth->net;
591 int count = urb->actual_length;
592 int count2 = urb->transfer_buffer_length;
594 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
598 if(unlikely(urb->status == -ECONNRESET || urb->status == -ESHUTDOWN))
599 /* we are killed - set a flag and wake the disconnect handler */
602 wake_up(&kaweth->term_wait);
606 spin_lock(&kaweth->device_lock);
607 if (IS_BLOCKED(kaweth->status)) {
608 spin_unlock(&kaweth->device_lock);
611 spin_unlock(&kaweth->device_lock);
613 if(urb->status && urb->status != -EREMOTEIO && count != 1) {
614 err("%s RX status: %d count: %d packet_len: %d",
619 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
623 if(kaweth->net && (count > 2)) {
624 if(pkt_len > (count - 2)) {
625 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
626 err("Packet len & 2047: %x", pkt_len & 2047);
627 err("Count 2: %x", count2);
628 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
632 if(!(skb = dev_alloc_skb(pkt_len+2))) {
633 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
637 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
641 eth_copy_and_sum(skb, kaweth->rx_buf + 2, pkt_len, 0);
643 skb_put(skb, pkt_len);
645 skb->protocol = eth_type_trans(skb, net);
649 kaweth->stats.rx_packets++;
650 kaweth->stats.rx_bytes += pkt_len;
653 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
656 /****************************************************************
658 ****************************************************************/
659 static int kaweth_open(struct net_device *net)
661 struct kaweth_device *kaweth = netdev_priv(net);
664 dbg("Opening network device.");
666 res = usb_autopm_get_interface(kaweth->intf);
668 err("Interface cannot be resumed.");
671 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
678 usb_rcvintpipe(kaweth->dev, 3),
683 250); /* overriding the descriptor */
684 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
685 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
687 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
689 usb_kill_urb(kaweth->rx_urb);
694 netif_start_queue(net);
696 kaweth_async_set_rx_mode(kaweth);
700 usb_autopm_enable(kaweth->intf);
704 /****************************************************************
706 ****************************************************************/
707 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
709 usb_kill_urb(kaweth->irq_urb);
710 usb_kill_urb(kaweth->rx_urb);
711 usb_kill_urb(kaweth->tx_urb);
713 flush_scheduled_work();
715 /* a scheduled work may have resubmitted,
717 usb_kill_urb(kaweth->irq_urb);
718 usb_kill_urb(kaweth->rx_urb);
721 /****************************************************************
723 ****************************************************************/
724 static int kaweth_close(struct net_device *net)
726 struct kaweth_device *kaweth = netdev_priv(net);
728 netif_stop_queue(net);
731 kaweth->status |= KAWETH_STATUS_CLOSING;
733 kaweth_kill_urbs(kaweth);
735 kaweth->status &= ~KAWETH_STATUS_CLOSING;
737 usb_autopm_enable(kaweth->intf);
742 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
744 struct kaweth_device *kaweth = netdev_priv(dev);
746 strlcpy(info->driver, driver_name, sizeof(info->driver));
747 usb_make_path(kaweth->dev, info->bus_info, sizeof (info->bus_info));
750 static u32 kaweth_get_link(struct net_device *dev)
752 struct kaweth_device *kaweth = netdev_priv(dev);
754 return kaweth->linkstate;
757 static struct ethtool_ops ops = {
758 .get_drvinfo = kaweth_get_drvinfo,
759 .get_link = kaweth_get_link
762 /****************************************************************
763 * kaweth_usb_transmit_complete
764 ****************************************************************/
765 static void kaweth_usb_transmit_complete(struct urb *urb)
767 struct kaweth_device *kaweth = urb->context;
768 struct sk_buff *skb = kaweth->tx_skb;
770 if (unlikely(urb->status != 0))
771 if (urb->status != -ENOENT)
772 dbg("%s: TX status %d.", kaweth->net->name, urb->status);
774 netif_wake_queue(kaweth->net);
775 dev_kfree_skb_irq(skb);
778 /****************************************************************
780 ****************************************************************/
781 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
783 struct kaweth_device *kaweth = netdev_priv(net);
784 __le16 *private_header;
788 spin_lock(&kaweth->device_lock);
790 kaweth_async_set_rx_mode(kaweth);
791 netif_stop_queue(net);
792 if (IS_BLOCKED(kaweth->status)) {
796 /* We now decide whether we can put our special header into the sk_buff */
797 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
798 /* no such luck - we make our own */
799 struct sk_buff *copied_skb;
800 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
801 dev_kfree_skb_irq(skb);
804 kaweth->stats.tx_errors++;
805 netif_start_queue(net);
806 spin_unlock(&kaweth->device_lock);
811 private_header = (__le16 *)__skb_push(skb, 2);
812 *private_header = cpu_to_le16(skb->len-2);
813 kaweth->tx_skb = skb;
815 usb_fill_bulk_urb(kaweth->tx_urb,
817 usb_sndbulkpipe(kaweth->dev, 2),
820 kaweth_usb_transmit_complete,
824 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
826 warn("kaweth failed tx_urb %d", res);
828 kaweth->stats.tx_errors++;
830 netif_start_queue(net);
831 dev_kfree_skb_irq(skb);
835 kaweth->stats.tx_packets++;
836 kaweth->stats.tx_bytes += skb->len;
837 net->trans_start = jiffies;
840 spin_unlock(&kaweth->device_lock);
845 /****************************************************************
847 ****************************************************************/
848 static void kaweth_set_rx_mode(struct net_device *net)
850 struct kaweth_device *kaweth = netdev_priv(net);
852 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
853 KAWETH_PACKET_FILTER_BROADCAST |
854 KAWETH_PACKET_FILTER_MULTICAST;
856 dbg("Setting Rx mode to %d", packet_filter_bitmap);
858 netif_stop_queue(net);
860 if (net->flags & IFF_PROMISC) {
861 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
863 else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
864 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
867 kaweth->packet_filter_bitmap = packet_filter_bitmap;
868 netif_wake_queue(net);
871 /****************************************************************
872 * kaweth_async_set_rx_mode
873 ****************************************************************/
874 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
876 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
877 kaweth->packet_filter_bitmap = 0;
878 if (packet_filter_bitmap == 0)
883 result = kaweth_control(kaweth,
884 usb_sndctrlpipe(kaweth->dev, 0),
885 KAWETH_COMMAND_SET_PACKET_FILTER,
886 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
887 packet_filter_bitmap,
889 (void *)&kaweth->scratch,
891 KAWETH_CONTROL_TIMEOUT);
894 err("Failed to set Rx mode: %d", result);
897 dbg("Set Rx mode to %d", packet_filter_bitmap);
902 /****************************************************************
903 * kaweth_netdev_stats
904 ****************************************************************/
905 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
907 struct kaweth_device *kaweth = netdev_priv(dev);
908 return &kaweth->stats;
911 /****************************************************************
913 ****************************************************************/
914 static void kaweth_tx_timeout(struct net_device *net)
916 struct kaweth_device *kaweth = netdev_priv(net);
918 warn("%s: Tx timed out. Resetting.", net->name);
919 kaweth->stats.tx_errors++;
920 net->trans_start = jiffies;
922 usb_unlink_urb(kaweth->tx_urb);
925 /****************************************************************
927 ****************************************************************/
928 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
930 struct kaweth_device *kaweth = usb_get_intfdata(intf);
933 dbg("Suspending device");
934 spin_lock_irqsave(&kaweth->device_lock, flags);
935 kaweth->status |= KAWETH_STATUS_SUSPENDING;
936 spin_unlock_irqrestore(&kaweth->device_lock, flags);
938 kaweth_kill_urbs(kaweth);
942 /****************************************************************
944 ****************************************************************/
945 static int kaweth_resume(struct usb_interface *intf)
947 struct kaweth_device *kaweth = usb_get_intfdata(intf);
950 dbg("Resuming device");
951 spin_lock_irqsave(&kaweth->device_lock, flags);
952 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
953 spin_unlock_irqrestore(&kaweth->device_lock, flags);
957 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
958 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
963 /****************************************************************
965 ****************************************************************/
966 static int kaweth_probe(
967 struct usb_interface *intf,
968 const struct usb_device_id *id /* from id_table */
971 struct usb_device *dev = interface_to_usbdev(intf);
972 struct kaweth_device *kaweth;
973 struct net_device *netdev;
974 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
977 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
979 le16_to_cpu(dev->descriptor.idVendor),
980 le16_to_cpu(dev->descriptor.idProduct),
981 le16_to_cpu(dev->descriptor.bcdDevice));
983 dbg("Device at %p", dev);
985 dbg("Descriptor length: %x type: %x",
986 (int)dev->descriptor.bLength,
987 (int)dev->descriptor.bDescriptorType);
989 netdev = alloc_etherdev(sizeof(*kaweth));
993 kaweth = netdev_priv(netdev);
995 kaweth->net = netdev;
997 spin_lock_init(&kaweth->device_lock);
998 init_waitqueue_head(&kaweth->term_wait);
1002 kaweth_reset(kaweth);
1005 * If high byte of bcdDevice is nonzero, firmware is already
1006 * downloaded. Don't try to do it again, or we'll hang the device.
1009 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1010 info("Firmware present in device.");
1012 /* Download the firmware */
1013 info("Downloading firmware...");
1014 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1015 if ((result = kaweth_download_firmware(kaweth,
1017 len_kaweth_new_code,
1020 err("Error downloading firmware (%d)", result);
1024 if ((result = kaweth_download_firmware(kaweth,
1025 kaweth_new_code_fix,
1026 len_kaweth_new_code_fix,
1029 err("Error downloading firmware fix (%d)", result);
1033 if ((result = kaweth_download_firmware(kaweth,
1034 kaweth_trigger_code,
1035 len_kaweth_trigger_code,
1038 err("Error downloading trigger code (%d)", result);
1043 if ((result = kaweth_download_firmware(kaweth,
1044 kaweth_trigger_code_fix,
1045 len_kaweth_trigger_code_fix,
1048 err("Error downloading trigger code fix (%d)", result);
1053 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1054 err("Error triggering firmware (%d)", result);
1058 /* Device will now disappear for a moment... */
1059 info("Firmware loaded. I'll be back...");
1061 free_page((unsigned long)kaweth->firmware_buf);
1062 free_netdev(netdev);
1066 result = kaweth_read_configuration(kaweth);
1069 err("Error reading configuration (%d), no net device created", result);
1070 goto err_free_netdev;
1073 info("Statistics collection: %x", kaweth->configuration.statistics_mask);
1074 info("Multicast filter limit: %x", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1075 info("MTU: %d", le16_to_cpu(kaweth->configuration.segment_size));
1076 info("Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
1077 (int)kaweth->configuration.hw_addr[0],
1078 (int)kaweth->configuration.hw_addr[1],
1079 (int)kaweth->configuration.hw_addr[2],
1080 (int)kaweth->configuration.hw_addr[3],
1081 (int)kaweth->configuration.hw_addr[4],
1082 (int)kaweth->configuration.hw_addr[5]);
1084 if(!memcmp(&kaweth->configuration.hw_addr,
1086 sizeof(bcast_addr))) {
1087 err("Firmware not functioning properly, no net device created");
1088 goto err_free_netdev;
1091 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1092 dbg("Error setting URB size");
1093 goto err_free_netdev;
1096 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1097 err("Error setting SOFS wait");
1098 goto err_free_netdev;
1101 result = kaweth_set_receive_filter(kaweth,
1102 KAWETH_PACKET_FILTER_DIRECTED |
1103 KAWETH_PACKET_FILTER_BROADCAST |
1104 KAWETH_PACKET_FILTER_MULTICAST);
1107 err("Error setting receive filter");
1108 goto err_free_netdev;
1111 dbg("Initializing net device.");
1113 kaweth->intf = intf;
1115 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1116 if (!kaweth->tx_urb)
1117 goto err_free_netdev;
1118 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1119 if (!kaweth->rx_urb)
1121 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1122 if (!kaweth->irq_urb)
1125 kaweth->intbuffer = usb_buffer_alloc( kaweth->dev,
1128 &kaweth->intbufferhandle);
1129 if (!kaweth->intbuffer)
1130 goto err_tx_and_rx_and_irq;
1131 kaweth->rx_buf = usb_buffer_alloc( kaweth->dev,
1134 &kaweth->rxbufferhandle);
1135 if (!kaweth->rx_buf)
1136 goto err_all_but_rxbuf;
1138 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1139 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1140 sizeof(kaweth->configuration.hw_addr));
1142 netdev->open = kaweth_open;
1143 netdev->stop = kaweth_close;
1145 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1146 netdev->tx_timeout = kaweth_tx_timeout;
1148 netdev->hard_start_xmit = kaweth_start_xmit;
1149 netdev->set_multicast_list = kaweth_set_rx_mode;
1150 netdev->get_stats = kaweth_netdev_stats;
1151 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1152 SET_ETHTOOL_OPS(netdev, &ops);
1154 /* kaweth is zeroed as part of alloc_netdev */
1156 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1158 SET_MODULE_OWNER(netdev);
1160 usb_set_intfdata(intf, kaweth);
1163 // dma_supported() is deeply broken on almost all architectures
1164 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1165 kaweth->net->features |= NETIF_F_HIGHDMA;
1168 SET_NETDEV_DEV(netdev, &intf->dev);
1169 if (register_netdev(netdev) != 0) {
1170 err("Error registering netdev.");
1174 info("kaweth interface created at %s", kaweth->net->name);
1176 dbg("Kaweth probe returning.");
1181 usb_set_intfdata(intf, NULL);
1182 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1184 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1185 err_tx_and_rx_and_irq:
1186 usb_free_urb(kaweth->irq_urb);
1188 usb_free_urb(kaweth->rx_urb);
1190 usb_free_urb(kaweth->tx_urb);
1192 free_netdev(netdev);
1197 /****************************************************************
1199 ****************************************************************/
1200 static void kaweth_disconnect(struct usb_interface *intf)
1202 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1203 struct net_device *netdev;
1205 info("Unregistering");
1207 usb_set_intfdata(intf, NULL);
1209 warn("unregistering non-existant device");
1212 netdev = kaweth->net;
1214 dbg("Unregistering net device");
1215 unregister_netdev(netdev);
1217 usb_free_urb(kaweth->rx_urb);
1218 usb_free_urb(kaweth->tx_urb);
1219 usb_free_urb(kaweth->irq_urb);
1221 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1222 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1224 free_netdev(netdev);
1228 // FIXME this completion stuff is a modified clone of
1229 // an OLD version of some stuff in usb.c ...
1230 struct usb_api_data {
1231 wait_queue_head_t wqh;
1235 /*-------------------------------------------------------------------*
1236 * completion handler for compatibility wrappers (sync control/bulk) *
1237 *-------------------------------------------------------------------*/
1238 static void usb_api_blocking_completion(struct urb *urb)
1240 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1246 /*-------------------------------------------------------------------*
1247 * COMPATIBILITY STUFF *
1248 *-------------------------------------------------------------------*/
1250 // Starts urb and waits for completion or timeout
1251 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1253 struct usb_api_data awd;
1256 init_waitqueue_head(&awd.wqh);
1259 urb->context = &awd;
1260 status = usb_submit_urb(urb, GFP_NOIO);
1262 // something went wrong
1267 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1269 warn("usb_control/bulk_msg: timeout");
1270 usb_kill_urb(urb); // remove urb safely
1271 status = -ETIMEDOUT;
1274 status = urb->status;
1277 if (actual_length) {
1278 *actual_length = urb->actual_length;
1285 /*-------------------------------------------------------------------*/
1286 // returns status (negative) or length (positive)
1287 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1289 struct usb_ctrlrequest *cmd, void *data,
1290 int len, int timeout)
1294 int length = 0; /* shut up GCC */
1296 urb = usb_alloc_urb(0, GFP_NOIO);
1300 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1301 len, usb_api_blocking_completion, NULL);
1303 retv = usb_start_wait_urb(urb, timeout, &length);
1313 /****************************************************************
1315 ****************************************************************/
1316 static int __init kaweth_init(void)
1318 dbg("Driver loading");
1319 return usb_register(&kaweth_driver);
1322 /****************************************************************
1324 ****************************************************************/
1325 static void __exit kaweth_exit(void)
1327 usb_deregister(&kaweth_driver);
1330 module_init(kaweth_init);
1331 module_exit(kaweth_exit);