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, see <http://www.gnu.org/licenses/>.
30 ****************************************************************/
33 * Develop test procedures for USB net interfaces
35 * Fix bugs from previous two steps
36 * Snoop other OSs for any tricks we're not doing
37 * Reduce arbitrary timeouts
38 * Smart multicast support
39 * Temporary MAC change support
40 * Tunable SOFs parameter - ioctl()?
41 * Ethernet stats collection
42 * Code formatting improvements
45 #include <linux/module.h>
46 #include <linux/slab.h>
47 #include <linux/string.h>
48 #include <linux/delay.h>
49 #include <linux/netdevice.h>
50 #include <linux/etherdevice.h>
51 #include <linux/usb.h>
52 #include <linux/types.h>
53 #include <linux/ethtool.h>
54 #include <linux/dma-mapping.h>
55 #include <linux/wait.h>
56 #include <linux/firmware.h>
57 #include <linux/uaccess.h>
58 #include <asm/byteorder.h>
62 #define KAWETH_MTU 1514
63 #define KAWETH_BUF_SIZE 1664
64 #define KAWETH_TX_TIMEOUT (5 * HZ)
65 #define KAWETH_SCRATCH_SIZE 32
66 #define KAWETH_FIRMWARE_BUF_SIZE 4096
67 #define KAWETH_CONTROL_TIMEOUT (30000)
69 #define KAWETH_STATUS_BROKEN 0x0000001
70 #define KAWETH_STATUS_CLOSING 0x0000002
71 #define KAWETH_STATUS_SUSPENDING 0x0000004
73 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
75 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
76 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
77 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
78 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
79 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
82 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
83 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
84 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
85 #define KAWETH_COMMAND_STATISTICS 0x03
86 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
87 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
88 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
89 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
90 #define KAWETH_COMMAND_SCAN 0xFF
92 #define KAWETH_SOFS_TO_WAIT 0x05
94 #define INTBUFFERSIZE 4
96 #define STATE_OFFSET 0
97 #define STATE_MASK 0x40
100 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
103 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>");
104 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
105 MODULE_LICENSE("GPL");
106 MODULE_FIRMWARE("kaweth/new_code.bin");
107 MODULE_FIRMWARE("kaweth/new_code_fix.bin");
108 MODULE_FIRMWARE("kaweth/trigger_code.bin");
109 MODULE_FIRMWARE("kaweth/trigger_code_fix.bin");
111 static const char driver_name[] = "kaweth";
113 static int kaweth_probe(
114 struct usb_interface *intf,
115 const struct usb_device_id *id /* from id_table */
117 static void kaweth_disconnect(struct usb_interface *intf);
118 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
120 struct usb_ctrlrequest *cmd, void *data,
121 int len, int timeout);
122 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
123 static int kaweth_resume(struct usb_interface *intf);
125 /****************************************************************
127 ****************************************************************/
128 static struct usb_device_id usb_klsi_table[] = {
129 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
130 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
131 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
132 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
133 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
134 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
135 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
136 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
137 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
138 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
139 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
140 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
141 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
142 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
143 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
144 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
145 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
146 { USB_DEVICE(0x07c9, 0xb010) }, /* Allied Telesyn AT-USB10 USB Ethernet Adapter */
147 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
148 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
149 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
150 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
151 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
152 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
153 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
154 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
155 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
156 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
157 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
158 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
159 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
160 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
161 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
162 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
163 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
164 {} /* Null terminator */
167 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
169 /****************************************************************
171 ****************************************************************/
172 static struct usb_driver kaweth_driver = {
174 .probe = kaweth_probe,
175 .disconnect = kaweth_disconnect,
176 .suspend = kaweth_suspend,
177 .resume = kaweth_resume,
178 .id_table = usb_klsi_table,
179 .supports_autosuspend = 1,
180 .disable_hub_initiated_lpm = 1,
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;
211 /****************************************************************
213 ****************************************************************/
216 spinlock_t device_lock;
220 int suspend_lowmem_rx;
221 int suspend_lowmem_ctrl;
224 struct delayed_work lowmem_work;
226 struct usb_device *dev;
227 struct usb_interface *intf;
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;
252 /****************************************************************
254 ****************************************************************/
255 static int kaweth_control(struct kaweth_device *kaweth,
265 struct usb_ctrlrequest *dr;
269 netdev_dbg(kaweth->net, "in_interrupt()\n");
273 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
277 dr->bRequestType = requesttype;
278 dr->bRequest = request;
279 dr->wValue = cpu_to_le16(value);
280 dr->wIndex = cpu_to_le16(index);
281 dr->wLength = cpu_to_le16(size);
283 retval = kaweth_internal_control_msg(kaweth->dev,
294 /****************************************************************
295 * kaweth_read_configuration
296 ****************************************************************/
297 static int kaweth_read_configuration(struct kaweth_device *kaweth)
301 retval = kaweth_control(kaweth,
302 usb_rcvctrlpipe(kaweth->dev, 0),
303 KAWETH_COMMAND_GET_ETHERNET_DESC,
304 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
307 (void *)&kaweth->configuration,
308 sizeof(kaweth->configuration),
309 KAWETH_CONTROL_TIMEOUT);
314 /****************************************************************
315 * kaweth_set_urb_size
316 ****************************************************************/
317 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
321 netdev_dbg(kaweth->net, "Setting URB size to %d\n", (unsigned)urb_size);
323 retval = kaweth_control(kaweth,
324 usb_sndctrlpipe(kaweth->dev, 0),
325 KAWETH_COMMAND_SET_URB_SIZE,
326 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
329 (void *)&kaweth->scratch,
331 KAWETH_CONTROL_TIMEOUT);
336 /****************************************************************
337 * kaweth_set_sofs_wait
338 ****************************************************************/
339 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
343 netdev_dbg(kaweth->net, "Set SOFS wait to %d\n", (unsigned)sofs_wait);
345 retval = kaweth_control(kaweth,
346 usb_sndctrlpipe(kaweth->dev, 0),
347 KAWETH_COMMAND_SET_SOFS_WAIT,
348 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
351 (void *)&kaweth->scratch,
353 KAWETH_CONTROL_TIMEOUT);
358 /****************************************************************
359 * kaweth_set_receive_filter
360 ****************************************************************/
361 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
362 __u16 receive_filter)
366 netdev_dbg(kaweth->net, "Set receive filter to %d\n",
367 (unsigned)receive_filter);
369 retval = kaweth_control(kaweth,
370 usb_sndctrlpipe(kaweth->dev, 0),
371 KAWETH_COMMAND_SET_PACKET_FILTER,
372 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
375 (void *)&kaweth->scratch,
377 KAWETH_CONTROL_TIMEOUT);
382 /****************************************************************
383 * kaweth_download_firmware
384 ****************************************************************/
385 static int kaweth_download_firmware(struct kaweth_device *kaweth,
390 const struct firmware *fw;
394 ret = request_firmware(&fw, fwname, &kaweth->dev->dev);
396 dev_err(&kaweth->intf->dev, "Firmware request failed\n");
400 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
401 dev_err(&kaweth->intf->dev, "Firmware too big: %zu\n",
403 release_firmware(fw);
407 memcpy(kaweth->firmware_buf, fw->data, fw->size);
409 release_firmware(fw);
411 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
412 kaweth->firmware_buf[3] = data_len >> 8;
413 kaweth->firmware_buf[4] = type;
414 kaweth->firmware_buf[5] = interrupt;
416 netdev_dbg(kaweth->net, "High: %i, Low:%i\n", kaweth->firmware_buf[3],
417 kaweth->firmware_buf[2]);
419 netdev_dbg(kaweth->net,
420 "Downloading firmware at %p to kaweth device at %p\n",
421 kaweth->firmware_buf, kaweth);
422 netdev_dbg(kaweth->net, "Firmware length: %d\n", data_len);
424 return kaweth_control(kaweth,
425 usb_sndctrlpipe(kaweth->dev, 0),
427 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
430 (void *)kaweth->firmware_buf,
432 KAWETH_CONTROL_TIMEOUT);
435 /****************************************************************
436 * kaweth_trigger_firmware
437 ****************************************************************/
438 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
441 kaweth->firmware_buf[0] = 0xB6;
442 kaweth->firmware_buf[1] = 0xC3;
443 kaweth->firmware_buf[2] = 0x01;
444 kaweth->firmware_buf[3] = 0x00;
445 kaweth->firmware_buf[4] = 0x06;
446 kaweth->firmware_buf[5] = interrupt;
447 kaweth->firmware_buf[6] = 0x00;
448 kaweth->firmware_buf[7] = 0x00;
450 return kaweth_control(kaweth,
451 usb_sndctrlpipe(kaweth->dev, 0),
453 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
456 (void *)kaweth->firmware_buf,
458 KAWETH_CONTROL_TIMEOUT);
461 /****************************************************************
463 ****************************************************************/
464 static int kaweth_reset(struct kaweth_device *kaweth)
468 result = usb_reset_configuration(kaweth->dev);
471 netdev_dbg(kaweth->net, "kaweth_reset() returns %d.\n", result);
476 static void kaweth_usb_receive(struct urb *);
477 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
479 /****************************************************************
481 *****************************************************************/
483 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
487 status = usb_submit_urb (kaweth->irq_urb, mf);
488 if (unlikely(status == -ENOMEM)) {
489 kaweth->suspend_lowmem_ctrl = 1;
490 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
492 kaweth->suspend_lowmem_ctrl = 0;
496 dev_err(&kaweth->intf->dev,
497 "can't resubmit intr, %s-%s, status %d\n",
498 kaweth->dev->bus->bus_name,
499 kaweth->dev->devpath, status);
502 static void int_callback(struct urb *u)
504 struct kaweth_device *kaweth = u->context;
506 int status = u->status;
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(struct work_struct *work)
535 struct kaweth_device *kaweth =
536 container_of(work, struct kaweth_device, lowmem_work.work);
538 if (IS_BLOCKED(kaweth->status))
541 if (kaweth->suspend_lowmem_rx)
542 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
544 if (kaweth->suspend_lowmem_ctrl)
545 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
549 /****************************************************************
550 * kaweth_resubmit_rx_urb
551 ****************************************************************/
552 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
557 usb_fill_bulk_urb(kaweth->rx_urb,
559 usb_rcvbulkpipe(kaweth->dev, 1),
564 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
565 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
567 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
568 if (result == -ENOMEM) {
569 kaweth->suspend_lowmem_rx = 1;
570 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
572 dev_err(&kaweth->intf->dev, "resubmitting rx_urb %d failed\n",
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 device *dev = &urb->dev->dev;
589 struct kaweth_device *kaweth = urb->context;
590 struct net_device *net = kaweth->net;
591 int status = urb->status;
593 int count = urb->actual_length;
594 int count2 = urb->transfer_buffer_length;
596 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
600 if (unlikely(status == -EPIPE)) {
601 kaweth->stats.rx_errors++;
603 wake_up(&kaweth->term_wait);
604 dev_dbg(dev, "Status was -EPIPE.\n");
607 if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
608 /* we are killed - set a flag and wake the disconnect handler */
610 wake_up(&kaweth->term_wait);
611 dev_dbg(dev, "Status was -ECONNRESET or -ESHUTDOWN.\n");
614 if (unlikely(status == -EPROTO || status == -ETIME ||
615 status == -EILSEQ)) {
616 kaweth->stats.rx_errors++;
617 dev_dbg(dev, "Status was -EPROTO, -ETIME, or -EILSEQ.\n");
620 if (unlikely(status == -EOVERFLOW)) {
621 kaweth->stats.rx_errors++;
622 dev_dbg(dev, "Status was -EOVERFLOW.\n");
624 spin_lock(&kaweth->device_lock);
625 if (IS_BLOCKED(kaweth->status)) {
626 spin_unlock(&kaweth->device_lock);
629 spin_unlock(&kaweth->device_lock);
631 if(status && status != -EREMOTEIO && count != 1) {
632 dev_err(&kaweth->intf->dev,
633 "%s RX status: %d count: %d packet_len: %d\n",
634 net->name, status, count, (int)pkt_len);
635 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
639 if(kaweth->net && (count > 2)) {
640 if(pkt_len > (count - 2)) {
641 dev_err(&kaweth->intf->dev,
642 "Packet length too long for USB frame (pkt_len: %x, count: %x)\n",
644 dev_err(&kaweth->intf->dev, "Packet len & 2047: %x\n",
646 dev_err(&kaweth->intf->dev, "Count 2: %x\n", count2);
647 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
651 if(!(skb = dev_alloc_skb(pkt_len+2))) {
652 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
656 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
658 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
660 skb_put(skb, pkt_len);
662 skb->protocol = eth_type_trans(skb, net);
666 kaweth->stats.rx_packets++;
667 kaweth->stats.rx_bytes += pkt_len;
670 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
673 /****************************************************************
675 ****************************************************************/
676 static int kaweth_open(struct net_device *net)
678 struct kaweth_device *kaweth = netdev_priv(net);
681 res = usb_autopm_get_interface(kaweth->intf);
683 dev_err(&kaweth->intf->dev, "Interface cannot be resumed.\n");
686 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
693 usb_rcvintpipe(kaweth->dev, 3),
698 250); /* overriding the descriptor */
699 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
700 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
702 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
704 usb_kill_urb(kaweth->rx_urb);
709 netif_start_queue(net);
711 kaweth_async_set_rx_mode(kaweth);
715 usb_autopm_put_interface(kaweth->intf);
719 /****************************************************************
721 ****************************************************************/
722 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
724 usb_kill_urb(kaweth->irq_urb);
725 usb_kill_urb(kaweth->rx_urb);
726 usb_kill_urb(kaweth->tx_urb);
728 cancel_delayed_work_sync(&kaweth->lowmem_work);
730 /* a scheduled work may have resubmitted,
732 usb_kill_urb(kaweth->irq_urb);
733 usb_kill_urb(kaweth->rx_urb);
736 /****************************************************************
738 ****************************************************************/
739 static int kaweth_close(struct net_device *net)
741 struct kaweth_device *kaweth = netdev_priv(net);
743 netif_stop_queue(net);
746 kaweth->status |= KAWETH_STATUS_CLOSING;
748 kaweth_kill_urbs(kaweth);
750 kaweth->status &= ~KAWETH_STATUS_CLOSING;
752 usb_autopm_put_interface(kaweth->intf);
757 static u32 kaweth_get_link(struct net_device *dev)
759 struct kaweth_device *kaweth = netdev_priv(dev);
761 return kaweth->linkstate;
764 static const struct ethtool_ops ops = {
765 .get_link = kaweth_get_link
768 /****************************************************************
769 * kaweth_usb_transmit_complete
770 ****************************************************************/
771 static void kaweth_usb_transmit_complete(struct urb *urb)
773 struct kaweth_device *kaweth = urb->context;
774 struct sk_buff *skb = kaweth->tx_skb;
775 int status = urb->status;
777 if (unlikely(status != 0))
778 if (status != -ENOENT)
779 dev_dbg(&urb->dev->dev, "%s: TX status %d.\n",
780 kaweth->net->name, status);
782 netif_wake_queue(kaweth->net);
783 dev_kfree_skb_irq(skb);
786 /****************************************************************
788 ****************************************************************/
789 static netdev_tx_t kaweth_start_xmit(struct sk_buff *skb,
790 struct net_device *net)
792 struct kaweth_device *kaweth = netdev_priv(net);
793 __le16 *private_header;
797 spin_lock_irq(&kaweth->device_lock);
799 kaweth_async_set_rx_mode(kaweth);
800 netif_stop_queue(net);
801 if (IS_BLOCKED(kaweth->status)) {
805 /* We now decide whether we can put our special header into the sk_buff */
806 if (skb_cow_head(skb, 2)) {
807 kaweth->stats.tx_errors++;
808 netif_start_queue(net);
809 spin_unlock_irq(&kaweth->device_lock);
810 dev_kfree_skb_any(skb);
814 private_header = (__le16 *)__skb_push(skb, 2);
815 *private_header = cpu_to_le16(skb->len-2);
816 kaweth->tx_skb = skb;
818 usb_fill_bulk_urb(kaweth->tx_urb,
820 usb_sndbulkpipe(kaweth->dev, 2),
823 kaweth_usb_transmit_complete,
827 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
829 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
831 kaweth->stats.tx_errors++;
833 netif_start_queue(net);
834 dev_kfree_skb_irq(skb);
838 kaweth->stats.tx_packets++;
839 kaweth->stats.tx_bytes += skb->len;
842 spin_unlock_irq(&kaweth->device_lock);
847 /****************************************************************
849 ****************************************************************/
850 static void kaweth_set_rx_mode(struct net_device *net)
852 struct kaweth_device *kaweth = netdev_priv(net);
854 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
855 KAWETH_PACKET_FILTER_BROADCAST |
856 KAWETH_PACKET_FILTER_MULTICAST;
858 netdev_dbg(net, "Setting Rx mode to %d\n", packet_filter_bitmap);
860 netif_stop_queue(net);
862 if (net->flags & IFF_PROMISC) {
863 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
865 else if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI)) {
866 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
869 kaweth->packet_filter_bitmap = packet_filter_bitmap;
870 netif_wake_queue(net);
873 /****************************************************************
874 * kaweth_async_set_rx_mode
875 ****************************************************************/
876 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
879 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
881 kaweth->packet_filter_bitmap = 0;
882 if (packet_filter_bitmap == 0)
888 result = kaweth_control(kaweth,
889 usb_sndctrlpipe(kaweth->dev, 0),
890 KAWETH_COMMAND_SET_PACKET_FILTER,
891 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
892 packet_filter_bitmap,
894 (void *)&kaweth->scratch,
896 KAWETH_CONTROL_TIMEOUT);
899 dev_err(&kaweth->intf->dev, "Failed to set Rx mode: %d\n",
903 netdev_dbg(kaweth->net, "Set Rx mode to %d\n",
904 packet_filter_bitmap);
908 /****************************************************************
909 * kaweth_netdev_stats
910 ****************************************************************/
911 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
913 struct kaweth_device *kaweth = netdev_priv(dev);
914 return &kaweth->stats;
917 /****************************************************************
919 ****************************************************************/
920 static void kaweth_tx_timeout(struct net_device *net)
922 struct kaweth_device *kaweth = netdev_priv(net);
924 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
925 kaweth->stats.tx_errors++;
926 netif_trans_update(net);
928 usb_unlink_urb(kaweth->tx_urb);
931 /****************************************************************
933 ****************************************************************/
934 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
936 struct kaweth_device *kaweth = usb_get_intfdata(intf);
939 spin_lock_irqsave(&kaweth->device_lock, flags);
940 kaweth->status |= KAWETH_STATUS_SUSPENDING;
941 spin_unlock_irqrestore(&kaweth->device_lock, flags);
943 kaweth_kill_urbs(kaweth);
947 /****************************************************************
949 ****************************************************************/
950 static int kaweth_resume(struct usb_interface *intf)
952 struct kaweth_device *kaweth = usb_get_intfdata(intf);
955 spin_lock_irqsave(&kaweth->device_lock, flags);
956 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
957 spin_unlock_irqrestore(&kaweth->device_lock, flags);
961 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
962 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
967 /****************************************************************
969 ****************************************************************/
972 static const struct net_device_ops kaweth_netdev_ops = {
973 .ndo_open = kaweth_open,
974 .ndo_stop = kaweth_close,
975 .ndo_start_xmit = kaweth_start_xmit,
976 .ndo_tx_timeout = kaweth_tx_timeout,
977 .ndo_set_rx_mode = kaweth_set_rx_mode,
978 .ndo_get_stats = kaweth_netdev_stats,
979 .ndo_set_mac_address = eth_mac_addr,
980 .ndo_validate_addr = eth_validate_addr,
983 static int kaweth_probe(
984 struct usb_interface *intf,
985 const struct usb_device_id *id /* from id_table */
988 struct device *dev = &intf->dev;
989 struct usb_device *udev = interface_to_usbdev(intf);
990 struct kaweth_device *kaweth;
991 struct net_device *netdev;
992 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
997 "Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x\n",
998 udev->devnum, le16_to_cpu(udev->descriptor.idVendor),
999 le16_to_cpu(udev->descriptor.idProduct),
1000 le16_to_cpu(udev->descriptor.bcdDevice));
1002 dev_dbg(dev, "Device at %p\n", udev);
1004 dev_dbg(dev, "Descriptor length: %x type: %x\n",
1005 (int)udev->descriptor.bLength,
1006 (int)udev->descriptor.bDescriptorType);
1008 netdev = alloc_etherdev(sizeof(*kaweth));
1012 kaweth = netdev_priv(netdev);
1014 kaweth->net = netdev;
1015 kaweth->intf = intf;
1017 spin_lock_init(&kaweth->device_lock);
1018 init_waitqueue_head(&kaweth->term_wait);
1020 dev_dbg(dev, "Resetting.\n");
1022 kaweth_reset(kaweth);
1025 * If high byte of bcdDevice is nonzero, firmware is already
1026 * downloaded. Don't try to do it again, or we'll hang the device.
1029 if (le16_to_cpu(udev->descriptor.bcdDevice) >> 8) {
1030 dev_info(dev, "Firmware present in device.\n");
1032 /* Download the firmware */
1033 dev_info(dev, "Downloading firmware...\n");
1034 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1035 if (!kaweth->firmware_buf) {
1037 goto err_free_netdev;
1039 if ((result = kaweth_download_firmware(kaweth,
1040 "kaweth/new_code.bin",
1043 dev_err(dev, "Error downloading firmware (%d)\n",
1048 if ((result = kaweth_download_firmware(kaweth,
1049 "kaweth/new_code_fix.bin",
1052 dev_err(dev, "Error downloading firmware fix (%d)\n",
1057 if ((result = kaweth_download_firmware(kaweth,
1058 "kaweth/trigger_code.bin",
1061 dev_err(dev, "Error downloading trigger code (%d)\n",
1067 if ((result = kaweth_download_firmware(kaweth,
1068 "kaweth/trigger_code_fix.bin",
1071 dev_err(dev, "Error downloading trigger code fix (%d)\n", result);
1076 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1077 dev_err(dev, "Error triggering firmware (%d)\n", result);
1081 /* Device will now disappear for a moment... */
1082 dev_info(dev, "Firmware loaded. I'll be back...\n");
1084 free_page((unsigned long)kaweth->firmware_buf);
1085 free_netdev(netdev);
1089 result = kaweth_read_configuration(kaweth);
1092 dev_err(dev, "Error reading configuration (%d), no net device created\n", result);
1093 goto err_free_netdev;
1096 dev_info(dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
1097 dev_info(dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1098 dev_info(dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
1099 dev_info(dev, "Read MAC address %pM\n", kaweth->configuration.hw_addr);
1101 if(!memcmp(&kaweth->configuration.hw_addr,
1103 sizeof(bcast_addr))) {
1104 dev_err(dev, "Firmware not functioning properly, no net device created\n");
1105 goto err_free_netdev;
1108 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1109 dev_dbg(dev, "Error setting URB size\n");
1110 goto err_free_netdev;
1113 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1114 dev_err(dev, "Error setting SOFS wait\n");
1115 goto err_free_netdev;
1118 result = kaweth_set_receive_filter(kaweth,
1119 KAWETH_PACKET_FILTER_DIRECTED |
1120 KAWETH_PACKET_FILTER_BROADCAST |
1121 KAWETH_PACKET_FILTER_MULTICAST);
1124 dev_err(dev, "Error setting receive filter\n");
1125 goto err_free_netdev;
1128 dev_dbg(dev, "Initializing net device.\n");
1130 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1131 if (!kaweth->tx_urb)
1132 goto err_free_netdev;
1133 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1134 if (!kaweth->rx_urb)
1136 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1137 if (!kaweth->irq_urb)
1140 kaweth->intbuffer = usb_alloc_coherent( kaweth->dev,
1143 &kaweth->intbufferhandle);
1144 if (!kaweth->intbuffer)
1145 goto err_tx_and_rx_and_irq;
1146 kaweth->rx_buf = usb_alloc_coherent( kaweth->dev,
1149 &kaweth->rxbufferhandle);
1150 if (!kaweth->rx_buf)
1151 goto err_all_but_rxbuf;
1153 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1154 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1155 sizeof(kaweth->configuration.hw_addr));
1157 netdev->netdev_ops = &kaweth_netdev_ops;
1158 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1159 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1160 netdev->ethtool_ops = &ops;
1162 /* kaweth is zeroed as part of alloc_netdev */
1163 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1164 usb_set_intfdata(intf, kaweth);
1166 SET_NETDEV_DEV(netdev, dev);
1167 if (register_netdev(netdev) != 0) {
1168 dev_err(dev, "Error registering netdev.\n");
1172 dev_info(dev, "kaweth interface created at %s\n",
1178 usb_set_intfdata(intf, NULL);
1179 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1181 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1182 err_tx_and_rx_and_irq:
1183 usb_free_urb(kaweth->irq_urb);
1185 usb_free_urb(kaweth->rx_urb);
1187 usb_free_urb(kaweth->tx_urb);
1189 free_netdev(netdev);
1194 /****************************************************************
1196 ****************************************************************/
1197 static void kaweth_disconnect(struct usb_interface *intf)
1199 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1200 struct net_device *netdev;
1202 usb_set_intfdata(intf, NULL);
1204 dev_warn(&intf->dev, "unregistering non-existent device\n");
1207 netdev = kaweth->net;
1209 netdev_dbg(kaweth->net, "Unregistering net device\n");
1210 unregister_netdev(netdev);
1212 usb_free_urb(kaweth->rx_urb);
1213 usb_free_urb(kaweth->tx_urb);
1214 usb_free_urb(kaweth->irq_urb);
1216 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1217 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1219 free_netdev(netdev);
1223 // FIXME this completion stuff is a modified clone of
1224 // an OLD version of some stuff in usb.c ...
1225 struct usb_api_data {
1226 wait_queue_head_t wqh;
1230 /*-------------------------------------------------------------------*
1231 * completion handler for compatibility wrappers (sync control/bulk) *
1232 *-------------------------------------------------------------------*/
1233 static void usb_api_blocking_completion(struct urb *urb)
1235 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1241 /*-------------------------------------------------------------------*
1242 * COMPATIBILITY STUFF *
1243 *-------------------------------------------------------------------*/
1245 // Starts urb and waits for completion or timeout
1246 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1248 struct usb_api_data awd;
1251 init_waitqueue_head(&awd.wqh);
1254 urb->context = &awd;
1255 status = usb_submit_urb(urb, GFP_ATOMIC);
1257 // something went wrong
1262 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1264 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1265 usb_kill_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)
1289 int length = 0; /* shut up GCC */
1291 urb = usb_alloc_urb(0, GFP_ATOMIC);
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);
1307 module_usb_driver(kaweth_driver);