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 <asm/uaccess.h>
62 #include <asm/semaphore.h>
63 #include <asm/byteorder.h>
68 #define kaweth_dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format "\n" ,##arg)
70 #define kaweth_dbg(format, arg...) do {} while (0)
72 #define kaweth_err(format, arg...) printk(KERN_ERR __FILE__ ": " format "\n" ,##arg)
73 #define kaweth_info(format, arg...) printk(KERN_INFO __FILE__ ": " format "\n" , ##arg)
74 #define kaweth_warn(format, arg...) printk(KERN_WARNING __FILE__ ": " format "\n" , ##arg)
79 #define KAWETH_MTU 1514
80 #define KAWETH_BUF_SIZE 1664
81 #define KAWETH_TX_TIMEOUT (5 * HZ)
82 #define KAWETH_SCRATCH_SIZE 32
83 #define KAWETH_FIRMWARE_BUF_SIZE 4096
84 #define KAWETH_CONTROL_TIMEOUT (30 * HZ)
86 #define KAWETH_STATUS_BROKEN 0x0000001
87 #define KAWETH_STATUS_CLOSING 0x0000002
89 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
90 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
91 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
92 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
93 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
96 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
97 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
98 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
99 #define KAWETH_COMMAND_STATISTICS 0x03
100 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
101 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
102 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
103 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
104 #define KAWETH_COMMAND_SCAN 0xFF
106 #define KAWETH_SOFS_TO_WAIT 0x05
108 #define INTBUFFERSIZE 4
110 #define STATE_OFFSET 0
111 #define STATE_MASK 0x40
112 #define STATE_SHIFT 5
115 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>");
116 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
117 MODULE_LICENSE("GPL");
119 static const char driver_name[] = "kaweth";
121 static int kaweth_probe(
122 struct usb_interface *intf,
123 const struct usb_device_id *id /* from id_table */
125 static void kaweth_disconnect(struct usb_interface *intf);
126 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
128 struct usb_ctrlrequest *cmd, void *data,
129 int len, int timeout);
131 /****************************************************************
133 ****************************************************************/
134 static struct usb_device_id usb_klsi_table[] = {
135 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
136 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
137 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
138 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
139 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
140 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
141 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
142 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
143 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
144 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
145 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
146 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
147 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
148 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
149 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
150 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
151 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
152 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
153 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
154 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
155 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
156 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
157 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
158 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
159 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
160 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
161 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
162 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
163 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
164 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
165 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
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 = {
176 .owner = THIS_MODULE,
178 .probe = kaweth_probe,
179 .disconnect = kaweth_disconnect,
180 .id_table = usb_klsi_table,
183 typedef __u8 eth_addr_t[6];
185 /****************************************************************
187 ****************************************************************/
195 /****************************************************************
196 * kaweth_ethernet_configuration
198 ****************************************************************/
199 struct kaweth_ethernet_configuration
205 __u32 statistics_mask;
207 __u16 max_multicast_filters;
209 } __attribute__ ((packed));
211 /****************************************************************
213 ****************************************************************/
216 spinlock_t device_lock;
221 int suspend_lowmem_rx;
222 int suspend_lowmem_ctrl;
224 struct work_struct lowmem_work;
226 struct usb_device *dev;
227 struct net_device *net;
228 wait_queue_head_t term_wait;
234 dma_addr_t intbufferhandle;
236 dma_addr_t rxbufferhandle;
240 struct sk_buff *tx_skb;
243 __u8 scratch[KAWETH_SCRATCH_SIZE];
244 __u16 packet_filter_bitmap;
246 struct kaweth_ethernet_configuration configuration;
248 struct net_device_stats stats;
249 } __attribute__ ((packed));
252 /****************************************************************
254 ****************************************************************/
255 static int kaweth_control(struct kaweth_device *kaweth,
265 struct usb_ctrlrequest *dr;
267 kaweth_dbg("kaweth_control()");
270 kaweth_dbg("in_interrupt()");
274 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
277 kaweth_dbg("kmalloc() failed");
281 dr->bRequestType= requesttype;
282 dr->bRequest = request;
283 dr->wValue = cpu_to_le16p(&value);
284 dr->wIndex = cpu_to_le16p(&index);
285 dr->wLength = cpu_to_le16p(&size);
287 return kaweth_internal_control_msg(kaweth->dev,
295 /****************************************************************
296 * kaweth_read_configuration
297 ****************************************************************/
298 static int kaweth_read_configuration(struct kaweth_device *kaweth)
302 kaweth_dbg("Reading kaweth configuration");
304 retval = kaweth_control(kaweth,
305 usb_rcvctrlpipe(kaweth->dev, 0),
306 KAWETH_COMMAND_GET_ETHERNET_DESC,
307 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
310 (void *)&kaweth->configuration,
311 sizeof(kaweth->configuration),
312 KAWETH_CONTROL_TIMEOUT);
317 /****************************************************************
318 * kaweth_set_urb_size
319 ****************************************************************/
320 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
324 kaweth_dbg("Setting URB size to %d", (unsigned)urb_size);
326 retval = kaweth_control(kaweth,
327 usb_sndctrlpipe(kaweth->dev, 0),
328 KAWETH_COMMAND_SET_URB_SIZE,
329 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
332 (void *)&kaweth->scratch,
334 KAWETH_CONTROL_TIMEOUT);
339 /****************************************************************
340 * kaweth_set_sofs_wait
341 ****************************************************************/
342 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
346 kaweth_dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
348 retval = kaweth_control(kaweth,
349 usb_sndctrlpipe(kaweth->dev, 0),
350 KAWETH_COMMAND_SET_SOFS_WAIT,
351 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
354 (void *)&kaweth->scratch,
356 KAWETH_CONTROL_TIMEOUT);
361 /****************************************************************
362 * kaweth_set_receive_filter
363 ****************************************************************/
364 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
365 __u16 receive_filter)
369 kaweth_dbg("Set receive filter to %d", (unsigned)receive_filter);
371 retval = kaweth_control(kaweth,
372 usb_sndctrlpipe(kaweth->dev, 0),
373 KAWETH_COMMAND_SET_PACKET_FILTER,
374 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
377 (void *)&kaweth->scratch,
379 KAWETH_CONTROL_TIMEOUT);
384 /****************************************************************
385 * kaweth_download_firmware
386 ****************************************************************/
387 static int kaweth_download_firmware(struct kaweth_device *kaweth,
393 if(data_len > KAWETH_FIRMWARE_BUF_SIZE) {
394 kaweth_err("Firmware too big: %d", data_len);
398 memcpy(kaweth->firmware_buf, data, data_len);
400 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
401 kaweth->firmware_buf[3] = data_len >> 8;
402 kaweth->firmware_buf[4] = type;
403 kaweth->firmware_buf[5] = interrupt;
405 kaweth_dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
406 kaweth->firmware_buf[2]);
408 kaweth_dbg("Downloading firmware at %p to kaweth device at %p",
411 kaweth_dbg("Firmware length: %d", data_len);
413 return kaweth_control(kaweth,
414 usb_sndctrlpipe(kaweth->dev, 0),
416 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
419 (void *)kaweth->firmware_buf,
421 KAWETH_CONTROL_TIMEOUT);
424 /****************************************************************
425 * kaweth_trigger_firmware
426 ****************************************************************/
427 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
430 kaweth->firmware_buf[0] = 0xB6;
431 kaweth->firmware_buf[1] = 0xC3;
432 kaweth->firmware_buf[2] = 0x01;
433 kaweth->firmware_buf[3] = 0x00;
434 kaweth->firmware_buf[4] = 0x06;
435 kaweth->firmware_buf[5] = interrupt;
436 kaweth->firmware_buf[6] = 0x00;
437 kaweth->firmware_buf[7] = 0x00;
439 kaweth_dbg("Triggering firmware");
441 return kaweth_control(kaweth,
442 usb_sndctrlpipe(kaweth->dev, 0),
444 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
447 (void *)kaweth->firmware_buf,
449 KAWETH_CONTROL_TIMEOUT);
452 /****************************************************************
454 ****************************************************************/
455 static int kaweth_reset(struct kaweth_device *kaweth)
459 kaweth_dbg("kaweth_reset(%p)", kaweth);
460 result = kaweth_control(kaweth,
461 usb_sndctrlpipe(kaweth->dev, 0),
462 USB_REQ_SET_CONFIGURATION,
464 kaweth->dev->config[0].desc.bConfigurationValue,
468 KAWETH_CONTROL_TIMEOUT);
472 kaweth_dbg("kaweth_reset() returns %d.",result);
477 static void kaweth_usb_receive(struct urb *, struct pt_regs *regs);
478 static int kaweth_resubmit_rx_urb(struct kaweth_device *, int);
480 /****************************************************************
482 *****************************************************************/
484 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, int mf)
488 status = usb_submit_urb (kaweth->irq_urb, mf);
489 if (unlikely(status == -ENOMEM)) {
490 kaweth->suspend_lowmem_ctrl = 1;
491 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
493 kaweth->suspend_lowmem_ctrl = 0;
497 err ("can't resubmit intr, %s-%s, status %d",
498 kaweth->dev->bus->bus_name,
499 kaweth->dev->devpath, status);
502 static void int_callback(struct urb *u, struct pt_regs *regs)
504 struct kaweth_device *kaweth = u->context;
508 case 0: /* success */
510 case -ECONNRESET: /* unlink */
514 /* -EPIPE: should clear the halt */
519 /* we check the link state to report changes */
520 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
522 netif_carrier_on(kaweth->net);
524 netif_carrier_off(kaweth->net);
526 kaweth->linkstate = act_state;
529 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
532 static void kaweth_resubmit_tl(void *d)
534 struct kaweth_device *kaweth = (struct kaweth_device *)d;
536 if (kaweth->status | KAWETH_STATUS_CLOSING)
539 if (kaweth->suspend_lowmem_rx)
540 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
542 if (kaweth->suspend_lowmem_ctrl)
543 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
547 /****************************************************************
548 * kaweth_resubmit_rx_urb
549 ****************************************************************/
550 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
555 usb_fill_bulk_urb(kaweth->rx_urb,
557 usb_rcvbulkpipe(kaweth->dev, 1),
562 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
563 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
565 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
566 if (result == -ENOMEM) {
567 kaweth->suspend_lowmem_rx = 1;
568 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
570 kaweth_err("resubmitting rx_urb %d failed", result);
572 kaweth->suspend_lowmem_rx = 0;
578 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
580 /****************************************************************
582 ****************************************************************/
583 static void kaweth_usb_receive(struct urb *urb, struct pt_regs *regs)
585 struct kaweth_device *kaweth = urb->context;
586 struct net_device *net = kaweth->net;
588 int count = urb->actual_length;
589 int count2 = urb->transfer_buffer_length;
591 __u16 pkt_len = le16_to_cpup((u16 *)kaweth->rx_buf);
595 if(unlikely(urb->status == -ECONNRESET || urb->status == -ECONNABORTED || urb->status == -ESHUTDOWN))
596 /* we are killed - set a flag and wake the disconnect handler */
599 wake_up(&kaweth->term_wait);
603 if (kaweth->status & KAWETH_STATUS_CLOSING)
606 if(urb->status && urb->status != -EREMOTEIO && count != 1) {
607 kaweth_err("%s RX status: %d count: %d packet_len: %d",
612 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
616 if(kaweth->net && (count > 2)) {
617 if(pkt_len > (count - 2)) {
618 kaweth_err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
619 kaweth_err("Packet len & 2047: %x", pkt_len & 2047);
620 kaweth_err("Count 2: %x", count2);
621 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
625 if(!(skb = dev_alloc_skb(pkt_len+2))) {
626 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
630 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
634 eth_copy_and_sum(skb, kaweth->rx_buf + 2, pkt_len, 0);
636 skb_put(skb, pkt_len);
638 skb->protocol = eth_type_trans(skb, net);
642 kaweth->stats.rx_packets++;
643 kaweth->stats.rx_bytes += pkt_len;
646 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
649 /****************************************************************
651 ****************************************************************/
652 static int kaweth_open(struct net_device *net)
654 struct kaweth_device *kaweth = (struct kaweth_device *)net->priv;
657 kaweth_dbg("Opening network device.");
659 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
666 usb_rcvintpipe(kaweth->dev, 3),
672 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
673 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
675 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
677 usb_unlink_urb(kaweth->rx_urb);
681 netif_start_queue(net);
683 kaweth_async_set_rx_mode(kaweth);
687 /****************************************************************
689 ****************************************************************/
690 static int kaweth_close(struct net_device *net)
692 struct kaweth_device *kaweth = net->priv;
694 netif_stop_queue(net);
696 kaweth->status |= KAWETH_STATUS_CLOSING;
698 usb_unlink_urb(kaweth->irq_urb);
699 usb_unlink_urb(kaweth->rx_urb);
701 flush_scheduled_work();
703 /* a scheduled work may have resubmitted,
705 usb_unlink_urb(kaweth->irq_urb);
706 usb_unlink_urb(kaweth->rx_urb);
708 kaweth->status &= ~KAWETH_STATUS_CLOSING;
713 static int netdev_ethtool_ioctl(struct net_device *dev, void __user *useraddr)
717 if (copy_from_user(ðcmd, useraddr, sizeof(ethcmd)))
721 case ETHTOOL_GDRVINFO: {
722 struct ethtool_drvinfo info = {ETHTOOL_GDRVINFO};
723 strlcpy(info.driver, driver_name, sizeof(info.driver));
724 if (copy_to_user(useraddr, &info, sizeof(info)))
733 /****************************************************************
735 ****************************************************************/
736 static int kaweth_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
740 return netdev_ethtool_ioctl(net, rq->ifr_data);
745 /****************************************************************
746 * kaweth_usb_transmit_complete
747 ****************************************************************/
748 static void kaweth_usb_transmit_complete(struct urb *urb, struct pt_regs *regs)
750 struct kaweth_device *kaweth = urb->context;
751 struct sk_buff *skb = kaweth->tx_skb;
753 if (unlikely(urb->status != 0))
754 kaweth_dbg("%s: TX status %d.", kaweth->net->name, urb->status);
756 netif_wake_queue(kaweth->net);
757 dev_kfree_skb_irq(skb);
760 /****************************************************************
762 ****************************************************************/
763 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
765 struct kaweth_device *kaweth = net->priv;
770 spin_lock(&kaweth->device_lock);
772 if (kaweth->removed) {
773 /* our device is undergoing disconnection - we bail out */
774 spin_unlock(&kaweth->device_lock);
775 dev_kfree_skb_irq(skb);
779 kaweth_async_set_rx_mode(kaweth);
780 netif_stop_queue(net);
782 /* We now decide whether we can put our special header into the sk_buff */
783 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
784 /* no such luck - we make our own */
785 struct sk_buff *copied_skb;
786 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
787 dev_kfree_skb_irq(skb);
790 kaweth->stats.tx_errors++;
791 netif_start_queue(net);
792 spin_unlock(&kaweth->device_lock);
797 private_header = (u16 *)__skb_push(skb, 2);
798 *private_header = cpu_to_le16(skb->len-2);
799 kaweth->tx_skb = skb;
801 usb_fill_bulk_urb(kaweth->tx_urb,
803 usb_sndbulkpipe(kaweth->dev, 2),
806 kaweth_usb_transmit_complete,
809 kaweth->tx_urb->transfer_flags |= URB_ASYNC_UNLINK;
811 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
813 kaweth_warn("kaweth failed tx_urb %d", res);
814 kaweth->stats.tx_errors++;
816 netif_start_queue(net);
817 dev_kfree_skb_irq(skb);
821 kaweth->stats.tx_packets++;
822 kaweth->stats.tx_bytes += skb->len;
823 net->trans_start = jiffies;
826 spin_unlock(&kaweth->device_lock);
831 /****************************************************************
833 ****************************************************************/
834 static void kaweth_set_rx_mode(struct net_device *net)
836 struct kaweth_device *kaweth = net->priv;
838 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
839 KAWETH_PACKET_FILTER_BROADCAST |
840 KAWETH_PACKET_FILTER_MULTICAST;
842 kaweth_dbg("Setting Rx mode to %d", packet_filter_bitmap);
844 netif_stop_queue(net);
846 if (net->flags & IFF_PROMISC) {
847 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
849 else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
850 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
853 kaweth->packet_filter_bitmap = packet_filter_bitmap;
854 netif_wake_queue(net);
857 /****************************************************************
858 * kaweth_async_set_rx_mode
859 ****************************************************************/
860 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
862 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
863 kaweth->packet_filter_bitmap = 0;
864 if (packet_filter_bitmap == 0)
869 result = kaweth_control(kaweth,
870 usb_sndctrlpipe(kaweth->dev, 0),
871 KAWETH_COMMAND_SET_PACKET_FILTER,
872 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
873 packet_filter_bitmap,
875 (void *)&kaweth->scratch,
877 KAWETH_CONTROL_TIMEOUT);
880 kaweth_err("Failed to set Rx mode: %d", result);
883 kaweth_dbg("Set Rx mode to %d", packet_filter_bitmap);
888 /****************************************************************
889 * kaweth_netdev_stats
890 ****************************************************************/
891 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
893 return &((struct kaweth_device *)dev->priv)->stats;
896 /****************************************************************
898 ****************************************************************/
899 static void kaweth_tx_timeout(struct net_device *net)
901 struct kaweth_device *kaweth = net->priv;
903 kaweth_warn("%s: Tx timed out. Resetting.", net->name);
904 kaweth->stats.tx_errors++;
905 net->trans_start = jiffies;
907 usb_unlink_urb(kaweth->tx_urb);
910 /****************************************************************
912 ****************************************************************/
913 static int kaweth_probe(
914 struct usb_interface *intf,
915 const struct usb_device_id *id /* from id_table */
918 struct usb_device *dev = interface_to_usbdev(intf);
919 struct kaweth_device *kaweth;
920 struct net_device *netdev;
921 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
924 kaweth_dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
926 (int)dev->descriptor.idVendor,
927 (int)dev->descriptor.idProduct,
928 (int)dev->descriptor.bcdDevice);
930 kaweth_dbg("Device at %p", dev);
932 kaweth_dbg("Descriptor length: %x type: %x",
933 (int)dev->descriptor.bLength,
934 (int)dev->descriptor.bDescriptorType);
936 if(!(kaweth = kmalloc(sizeof(struct kaweth_device), GFP_KERNEL)))
939 memset(kaweth, 0, sizeof(struct kaweth_device));
942 spin_lock_init(&kaweth->device_lock);
943 init_waitqueue_head(&kaweth->term_wait);
945 kaweth_dbg("Resetting.");
947 kaweth_reset(kaweth);
950 * If high byte of bcdDevice is nonzero, firmware is already
951 * downloaded. Don't try to do it again, or we'll hang the device.
954 if (dev->descriptor.bcdDevice >> 8) {
955 kaweth_info("Firmware present in device.");
957 /* Download the firmware */
958 kaweth_info("Downloading firmware...");
959 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
960 if ((result = kaweth_download_firmware(kaweth,
965 kaweth_err("Error downloading firmware (%d)", result);
966 free_page((unsigned long)kaweth->firmware_buf);
971 if ((result = kaweth_download_firmware(kaweth,
973 len_kaweth_new_code_fix,
976 kaweth_err("Error downloading firmware fix (%d)", result);
977 free_page((unsigned long)kaweth->firmware_buf);
982 if ((result = kaweth_download_firmware(kaweth,
984 len_kaweth_trigger_code,
987 kaweth_err("Error downloading trigger code (%d)", result);
988 free_page((unsigned long)kaweth->firmware_buf);
993 if ((result = kaweth_download_firmware(kaweth,
994 kaweth_trigger_code_fix,
995 len_kaweth_trigger_code_fix,
998 kaweth_err("Error downloading trigger code fix (%d)", result);
999 free_page((unsigned long)kaweth->firmware_buf);
1005 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1006 kaweth_err("Error triggering firmware (%d)", result);
1007 free_page((unsigned long)kaweth->firmware_buf);
1012 /* Device will now disappear for a moment... */
1013 kaweth_info("Firmware loaded. I'll be back...");
1014 free_page((unsigned long)kaweth->firmware_buf);
1019 result = kaweth_read_configuration(kaweth);
1022 kaweth_err("Error reading configuration (%d), no net device created", result);
1027 kaweth_info("Statistics collection: %x", kaweth->configuration.statistics_mask);
1028 kaweth_info("Multicast filter limit: %x", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1029 kaweth_info("MTU: %d", le16_to_cpu(kaweth->configuration.segment_size));
1030 kaweth_info("Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
1031 (int)kaweth->configuration.hw_addr[0],
1032 (int)kaweth->configuration.hw_addr[1],
1033 (int)kaweth->configuration.hw_addr[2],
1034 (int)kaweth->configuration.hw_addr[3],
1035 (int)kaweth->configuration.hw_addr[4],
1036 (int)kaweth->configuration.hw_addr[5]);
1038 if(!memcmp(&kaweth->configuration.hw_addr,
1040 sizeof(bcast_addr))) {
1041 kaweth_err("Firmware not functioning properly, no net device created");
1046 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1047 kaweth_dbg("Error setting URB size");
1051 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1052 kaweth_err("Error setting SOFS wait");
1056 result = kaweth_set_receive_filter(kaweth,
1057 KAWETH_PACKET_FILTER_DIRECTED |
1058 KAWETH_PACKET_FILTER_BROADCAST |
1059 KAWETH_PACKET_FILTER_MULTICAST);
1062 kaweth_err("Error setting receive filter");
1067 kaweth_dbg("Initializing net device.");
1069 if (!(netdev = alloc_etherdev(0))) {
1074 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1075 if (!kaweth->tx_urb)
1077 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1078 if (!kaweth->rx_urb)
1080 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1081 if (!kaweth->irq_urb)
1084 kaweth->intbuffer = usb_buffer_alloc( kaweth->dev,
1087 &kaweth->intbufferhandle);
1088 if (!kaweth->intbuffer)
1089 goto err_tx_and_rx_and_irq;
1090 kaweth->rx_buf = usb_buffer_alloc( kaweth->dev,
1093 &kaweth->rxbufferhandle);
1094 if (!kaweth->rx_buf)
1095 goto err_all_but_rxbuf;
1097 kaweth->net = netdev;
1098 memcpy(kaweth->net->broadcast, &bcast_addr, sizeof(bcast_addr));
1099 memcpy(kaweth->net->dev_addr,
1100 &kaweth->configuration.hw_addr,
1101 sizeof(kaweth->configuration.hw_addr));
1103 kaweth->net->priv = kaweth;
1104 kaweth->net->open = kaweth_open;
1105 kaweth->net->stop = kaweth_close;
1107 kaweth->net->watchdog_timeo = KAWETH_TX_TIMEOUT;
1108 kaweth->net->tx_timeout = kaweth_tx_timeout;
1110 kaweth->net->do_ioctl = kaweth_ioctl;
1111 kaweth->net->hard_start_xmit = kaweth_start_xmit;
1112 kaweth->net->set_multicast_list = kaweth_set_rx_mode;
1113 kaweth->net->get_stats = kaweth_netdev_stats;
1114 kaweth->net->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1116 memset(&kaweth->stats, 0, sizeof(kaweth->stats));
1118 INIT_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl, (void *)kaweth);
1120 SET_MODULE_OWNER(netdev);
1122 usb_set_intfdata(intf, kaweth);
1125 // dma_supported() is deeply broken on almost all architectures
1126 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1127 kaweth->net->features |= NETIF_F_HIGHDMA;
1130 SET_NETDEV_DEV(netdev, &intf->dev);
1131 if (register_netdev(netdev) != 0) {
1132 kaweth_err("Error registering netdev.");
1136 kaweth_info("kaweth interface created at %s", kaweth->net->name);
1138 kaweth_dbg("Kaweth probe returning.");
1143 usb_set_intfdata(intf, NULL);
1144 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1146 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1147 err_tx_and_rx_and_irq:
1148 usb_free_urb(kaweth->irq_urb);
1150 usb_free_urb(kaweth->rx_urb);
1152 usb_free_urb(kaweth->tx_urb);
1154 free_netdev(netdev);
1160 /****************************************************************
1162 ****************************************************************/
1163 static void kaweth_disconnect(struct usb_interface *intf)
1165 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1167 kaweth_info("Unregistering");
1169 usb_set_intfdata(intf, NULL);
1171 kaweth_warn("unregistering non-existant device");
1175 kaweth->removed = 1;
1176 usb_unlink_urb(kaweth->irq_urb);
1177 usb_unlink_urb(kaweth->rx_urb);
1179 /* we need to wait for the urb to be cancelled, if it is active */
1180 spin_lock(&kaweth->device_lock);
1181 if (usb_unlink_urb(kaweth->tx_urb) == -EINPROGRESS) {
1182 spin_unlock(&kaweth->device_lock);
1183 wait_event(kaweth->term_wait, kaweth->end);
1185 spin_unlock(&kaweth->device_lock);
1189 if(kaweth->net->flags & IFF_UP) {
1190 kaweth_dbg("Closing net device");
1191 dev_close(kaweth->net);
1194 kaweth_dbg("Unregistering net device");
1195 unregister_netdev(kaweth->net);
1196 free_netdev(kaweth->net);
1199 usb_free_urb(kaweth->rx_urb);
1200 usb_free_urb(kaweth->tx_urb);
1201 usb_free_urb(kaweth->irq_urb);
1204 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1205 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1211 // FIXME this completion stuff is a modified clone of
1212 // an OLD version of some stuff in usb.c ...
1213 struct usb_api_data {
1214 wait_queue_head_t wqh;
1218 /*-------------------------------------------------------------------*
1219 * completion handler for compatibility wrappers (sync control/bulk) *
1220 *-------------------------------------------------------------------*/
1221 static void usb_api_blocking_completion(struct urb *urb, struct pt_regs *regs)
1223 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1229 /*-------------------------------------------------------------------*
1230 * COMPATIBILITY STUFF *
1231 *-------------------------------------------------------------------*/
1233 // Starts urb and waits for completion or timeout
1234 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1236 DECLARE_WAITQUEUE(wait, current);
1237 struct usb_api_data awd;
1240 init_waitqueue_head(&awd.wqh);
1243 add_wait_queue(&awd.wqh, &wait);
1244 urb->context = &awd;
1245 status = usb_submit_urb(urb, GFP_NOIO);
1247 // something went wrong
1249 remove_wait_queue(&awd.wqh, &wait);
1253 set_current_state(TASK_UNINTERRUPTIBLE);
1254 while (timeout && !awd.done) {
1255 timeout = schedule_timeout(timeout);
1256 set_current_state(TASK_UNINTERRUPTIBLE);
1259 set_current_state(TASK_RUNNING);
1260 remove_wait_queue(&awd.wqh, &wait);
1264 kaweth_warn("usb_control/bulk_msg: timeout");
1265 usb_unlink_urb(urb); // remove urb safely
1266 status = -ETIMEDOUT;
1269 status = urb->status;
1272 if (actual_length) {
1273 *actual_length = urb->actual_length;
1280 /*-------------------------------------------------------------------*/
1281 // returns status (negative) or length (positive)
1282 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1284 struct usb_ctrlrequest *cmd, void *data,
1285 int len, int timeout)
1291 urb = usb_alloc_urb(0, GFP_NOIO);
1295 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1296 len, usb_api_blocking_completion, NULL);
1298 retv = usb_start_wait_urb(urb, timeout, &length);
1308 /****************************************************************
1310 ****************************************************************/
1311 static int __init kaweth_init(void)
1313 kaweth_dbg("Driver loading");
1314 return usb_register(&kaweth_driver);
1317 /****************************************************************
1319 ****************************************************************/
1320 static void __exit kaweth_exit(void)
1322 usb_deregister(&kaweth_driver);
1325 module_init(kaweth_init);
1326 module_exit(kaweth_exit);