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/dma-mapping.h>
59 #include <linux/wait.h>
60 #include <linux/firmware.h>
61 #include <asm/uaccess.h>
62 #include <asm/byteorder.h>
66 #define KAWETH_MTU 1514
67 #define KAWETH_BUF_SIZE 1664
68 #define KAWETH_TX_TIMEOUT (5 * HZ)
69 #define KAWETH_SCRATCH_SIZE 32
70 #define KAWETH_FIRMWARE_BUF_SIZE 4096
71 #define KAWETH_CONTROL_TIMEOUT (30000)
73 #define KAWETH_STATUS_BROKEN 0x0000001
74 #define KAWETH_STATUS_CLOSING 0x0000002
75 #define KAWETH_STATUS_SUSPENDING 0x0000004
77 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
79 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
80 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
81 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
82 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
83 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
86 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
87 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
88 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
89 #define KAWETH_COMMAND_STATISTICS 0x03
90 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
91 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
92 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
93 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
94 #define KAWETH_COMMAND_SCAN 0xFF
96 #define KAWETH_SOFS_TO_WAIT 0x05
98 #define INTBUFFERSIZE 4
100 #define STATE_OFFSET 0
101 #define STATE_MASK 0x40
102 #define STATE_SHIFT 5
104 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
107 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>");
108 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
109 MODULE_LICENSE("GPL");
110 MODULE_FIRMWARE("kaweth/new_code.bin");
111 MODULE_FIRMWARE("kaweth/new_code_fix.bin");
112 MODULE_FIRMWARE("kaweth/trigger_code.bin");
113 MODULE_FIRMWARE("kaweth/trigger_code_fix.bin");
115 static const char driver_name[] = "kaweth";
117 static int kaweth_probe(
118 struct usb_interface *intf,
119 const struct usb_device_id *id /* from id_table */
121 static void kaweth_disconnect(struct usb_interface *intf);
122 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
124 struct usb_ctrlrequest *cmd, void *data,
125 int len, int timeout);
126 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
127 static int kaweth_resume(struct usb_interface *intf);
129 /****************************************************************
131 ****************************************************************/
132 static struct usb_device_id usb_klsi_table[] = {
133 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
134 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
135 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
136 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
137 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
138 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
139 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
140 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
141 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
142 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
143 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
144 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
145 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
146 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
147 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
148 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
149 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
150 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
151 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
152 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
153 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
154 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
155 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
156 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
157 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
158 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
159 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
160 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
161 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
162 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
163 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
164 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
165 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
166 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
167 {} /* Null terminator */
170 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
172 /****************************************************************
174 ****************************************************************/
175 static struct usb_driver kaweth_driver = {
177 .probe = kaweth_probe,
178 .disconnect = kaweth_disconnect,
179 .suspend = kaweth_suspend,
180 .resume = kaweth_resume,
181 .id_table = usb_klsi_table,
182 .supports_autosuspend = 1,
185 typedef __u8 eth_addr_t[6];
187 /****************************************************************
189 ****************************************************************/
197 /****************************************************************
198 * kaweth_ethernet_configuration
200 ****************************************************************/
201 struct kaweth_ethernet_configuration
207 __u32 statistics_mask;
209 __u16 max_multicast_filters;
211 } __attribute__ ((packed));
213 /****************************************************************
215 ****************************************************************/
218 spinlock_t device_lock;
222 int suspend_lowmem_rx;
223 int suspend_lowmem_ctrl;
226 struct delayed_work lowmem_work;
228 struct usb_device *dev;
229 struct usb_interface *intf;
230 struct net_device *net;
231 wait_queue_head_t term_wait;
237 dma_addr_t intbufferhandle;
239 dma_addr_t rxbufferhandle;
243 struct sk_buff *tx_skb;
246 __u8 scratch[KAWETH_SCRATCH_SIZE];
247 __u16 packet_filter_bitmap;
249 struct kaweth_ethernet_configuration configuration;
251 struct net_device_stats stats;
255 /****************************************************************
257 ****************************************************************/
258 static int kaweth_control(struct kaweth_device *kaweth,
268 struct usb_ctrlrequest *dr;
270 dbg("kaweth_control()");
273 dbg("in_interrupt()");
277 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
280 dbg("kmalloc() failed");
284 dr->bRequestType= requesttype;
285 dr->bRequest = request;
286 dr->wValue = cpu_to_le16p(&value);
287 dr->wIndex = cpu_to_le16p(&index);
288 dr->wLength = cpu_to_le16p(&size);
290 return kaweth_internal_control_msg(kaweth->dev,
298 /****************************************************************
299 * kaweth_read_configuration
300 ****************************************************************/
301 static int kaweth_read_configuration(struct kaweth_device *kaweth)
305 dbg("Reading kaweth configuration");
307 retval = kaweth_control(kaweth,
308 usb_rcvctrlpipe(kaweth->dev, 0),
309 KAWETH_COMMAND_GET_ETHERNET_DESC,
310 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
313 (void *)&kaweth->configuration,
314 sizeof(kaweth->configuration),
315 KAWETH_CONTROL_TIMEOUT);
320 /****************************************************************
321 * kaweth_set_urb_size
322 ****************************************************************/
323 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
327 dbg("Setting URB size to %d", (unsigned)urb_size);
329 retval = kaweth_control(kaweth,
330 usb_sndctrlpipe(kaweth->dev, 0),
331 KAWETH_COMMAND_SET_URB_SIZE,
332 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
335 (void *)&kaweth->scratch,
337 KAWETH_CONTROL_TIMEOUT);
342 /****************************************************************
343 * kaweth_set_sofs_wait
344 ****************************************************************/
345 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
349 dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
351 retval = kaweth_control(kaweth,
352 usb_sndctrlpipe(kaweth->dev, 0),
353 KAWETH_COMMAND_SET_SOFS_WAIT,
354 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
357 (void *)&kaweth->scratch,
359 KAWETH_CONTROL_TIMEOUT);
364 /****************************************************************
365 * kaweth_set_receive_filter
366 ****************************************************************/
367 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
368 __u16 receive_filter)
372 dbg("Set receive filter to %d", (unsigned)receive_filter);
374 retval = kaweth_control(kaweth,
375 usb_sndctrlpipe(kaweth->dev, 0),
376 KAWETH_COMMAND_SET_PACKET_FILTER,
377 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
380 (void *)&kaweth->scratch,
382 KAWETH_CONTROL_TIMEOUT);
387 /****************************************************************
388 * kaweth_download_firmware
389 ****************************************************************/
390 static int kaweth_download_firmware(struct kaweth_device *kaweth,
395 const struct firmware *fw;
399 ret = request_firmware(&fw, fwname, &kaweth->dev->dev);
401 err("Firmware request failed\n");
405 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
406 err("Firmware too big: %zu", fw->size);
410 memcpy(kaweth->firmware_buf, fw->data, fw->size);
412 release_firmware(fw);
414 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
415 kaweth->firmware_buf[3] = data_len >> 8;
416 kaweth->firmware_buf[4] = type;
417 kaweth->firmware_buf[5] = interrupt;
419 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
420 kaweth->firmware_buf[2]);
422 dbg("Downloading firmware at %p to kaweth device at %p",
424 dbg("Firmware length: %d", data_len);
426 return kaweth_control(kaweth,
427 usb_sndctrlpipe(kaweth->dev, 0),
429 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
432 (void *)kaweth->firmware_buf,
434 KAWETH_CONTROL_TIMEOUT);
437 /****************************************************************
438 * kaweth_trigger_firmware
439 ****************************************************************/
440 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
443 kaweth->firmware_buf[0] = 0xB6;
444 kaweth->firmware_buf[1] = 0xC3;
445 kaweth->firmware_buf[2] = 0x01;
446 kaweth->firmware_buf[3] = 0x00;
447 kaweth->firmware_buf[4] = 0x06;
448 kaweth->firmware_buf[5] = interrupt;
449 kaweth->firmware_buf[6] = 0x00;
450 kaweth->firmware_buf[7] = 0x00;
452 dbg("Triggering firmware");
454 return kaweth_control(kaweth,
455 usb_sndctrlpipe(kaweth->dev, 0),
457 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
460 (void *)kaweth->firmware_buf,
462 KAWETH_CONTROL_TIMEOUT);
465 /****************************************************************
467 ****************************************************************/
468 static int kaweth_reset(struct kaweth_device *kaweth)
472 dbg("kaweth_reset(%p)", kaweth);
473 result = kaweth_control(kaweth,
474 usb_sndctrlpipe(kaweth->dev, 0),
475 USB_REQ_SET_CONFIGURATION,
477 kaweth->dev->config[0].desc.bConfigurationValue,
481 KAWETH_CONTROL_TIMEOUT);
485 dbg("kaweth_reset() returns %d.",result);
490 static void kaweth_usb_receive(struct urb *);
491 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
493 /****************************************************************
495 *****************************************************************/
497 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
501 status = usb_submit_urb (kaweth->irq_urb, mf);
502 if (unlikely(status == -ENOMEM)) {
503 kaweth->suspend_lowmem_ctrl = 1;
504 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
506 kaweth->suspend_lowmem_ctrl = 0;
510 err ("can't resubmit intr, %s-%s, status %d",
511 kaweth->dev->bus->bus_name,
512 kaweth->dev->devpath, status);
515 static void int_callback(struct urb *u)
517 struct kaweth_device *kaweth = u->context;
519 int status = u->status;
522 case 0: /* success */
524 case -ECONNRESET: /* unlink */
528 /* -EPIPE: should clear the halt */
533 /* we check the link state to report changes */
534 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
536 netif_carrier_on(kaweth->net);
538 netif_carrier_off(kaweth->net);
540 kaweth->linkstate = act_state;
543 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
546 static void kaweth_resubmit_tl(struct work_struct *work)
548 struct kaweth_device *kaweth =
549 container_of(work, struct kaweth_device, lowmem_work.work);
551 if (IS_BLOCKED(kaweth->status))
554 if (kaweth->suspend_lowmem_rx)
555 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
557 if (kaweth->suspend_lowmem_ctrl)
558 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
562 /****************************************************************
563 * kaweth_resubmit_rx_urb
564 ****************************************************************/
565 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
570 usb_fill_bulk_urb(kaweth->rx_urb,
572 usb_rcvbulkpipe(kaweth->dev, 1),
577 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
578 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
580 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
581 if (result == -ENOMEM) {
582 kaweth->suspend_lowmem_rx = 1;
583 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
585 err("resubmitting rx_urb %d failed", result);
587 kaweth->suspend_lowmem_rx = 0;
593 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
595 /****************************************************************
597 ****************************************************************/
598 static void kaweth_usb_receive(struct urb *urb)
600 struct kaweth_device *kaweth = urb->context;
601 struct net_device *net = kaweth->net;
602 int status = urb->status;
604 int count = urb->actual_length;
605 int count2 = urb->transfer_buffer_length;
607 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
611 if(unlikely(status == -ECONNRESET || status == -ESHUTDOWN))
612 /* we are killed - set a flag and wake the disconnect handler */
615 wake_up(&kaweth->term_wait);
619 spin_lock(&kaweth->device_lock);
620 if (IS_BLOCKED(kaweth->status)) {
621 spin_unlock(&kaweth->device_lock);
624 spin_unlock(&kaweth->device_lock);
626 if(status && status != -EREMOTEIO && count != 1) {
627 err("%s RX status: %d count: %d packet_len: %d",
632 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
636 if(kaweth->net && (count > 2)) {
637 if(pkt_len > (count - 2)) {
638 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
639 err("Packet len & 2047: %x", pkt_len & 2047);
640 err("Count 2: %x", count2);
641 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
645 if(!(skb = dev_alloc_skb(pkt_len+2))) {
646 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
650 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
652 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
654 skb_put(skb, pkt_len);
656 skb->protocol = eth_type_trans(skb, net);
660 kaweth->stats.rx_packets++;
661 kaweth->stats.rx_bytes += pkt_len;
664 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
667 /****************************************************************
669 ****************************************************************/
670 static int kaweth_open(struct net_device *net)
672 struct kaweth_device *kaweth = netdev_priv(net);
675 dbg("Opening network device.");
677 res = usb_autopm_get_interface(kaweth->intf);
679 err("Interface cannot be resumed.");
682 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
689 usb_rcvintpipe(kaweth->dev, 3),
694 250); /* overriding the descriptor */
695 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
696 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
698 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
700 usb_kill_urb(kaweth->rx_urb);
705 netif_start_queue(net);
707 kaweth_async_set_rx_mode(kaweth);
711 usb_autopm_enable(kaweth->intf);
715 /****************************************************************
717 ****************************************************************/
718 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
720 usb_kill_urb(kaweth->irq_urb);
721 usb_kill_urb(kaweth->rx_urb);
722 usb_kill_urb(kaweth->tx_urb);
724 cancel_delayed_work_sync(&kaweth->lowmem_work);
726 /* a scheduled work may have resubmitted,
728 usb_kill_urb(kaweth->irq_urb);
729 usb_kill_urb(kaweth->rx_urb);
732 /****************************************************************
734 ****************************************************************/
735 static int kaweth_close(struct net_device *net)
737 struct kaweth_device *kaweth = netdev_priv(net);
739 netif_stop_queue(net);
742 kaweth->status |= KAWETH_STATUS_CLOSING;
744 kaweth_kill_urbs(kaweth);
746 kaweth->status &= ~KAWETH_STATUS_CLOSING;
748 usb_autopm_enable(kaweth->intf);
753 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
755 struct kaweth_device *kaweth = netdev_priv(dev);
757 strlcpy(info->driver, driver_name, sizeof(info->driver));
758 usb_make_path(kaweth->dev, info->bus_info, sizeof (info->bus_info));
761 static u32 kaweth_get_link(struct net_device *dev)
763 struct kaweth_device *kaweth = netdev_priv(dev);
765 return kaweth->linkstate;
768 static struct ethtool_ops ops = {
769 .get_drvinfo = kaweth_get_drvinfo,
770 .get_link = kaweth_get_link
773 /****************************************************************
774 * kaweth_usb_transmit_complete
775 ****************************************************************/
776 static void kaweth_usb_transmit_complete(struct urb *urb)
778 struct kaweth_device *kaweth = urb->context;
779 struct sk_buff *skb = kaweth->tx_skb;
780 int status = urb->status;
782 if (unlikely(status != 0))
783 if (status != -ENOENT)
784 dbg("%s: TX status %d.", kaweth->net->name, status);
786 netif_wake_queue(kaweth->net);
787 dev_kfree_skb_irq(skb);
790 /****************************************************************
792 ****************************************************************/
793 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
795 struct kaweth_device *kaweth = netdev_priv(net);
796 __le16 *private_header;
800 spin_lock(&kaweth->device_lock);
802 kaweth_async_set_rx_mode(kaweth);
803 netif_stop_queue(net);
804 if (IS_BLOCKED(kaweth->status)) {
808 /* We now decide whether we can put our special header into the sk_buff */
809 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
810 /* no such luck - we make our own */
811 struct sk_buff *copied_skb;
812 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
813 dev_kfree_skb_irq(skb);
816 kaweth->stats.tx_errors++;
817 netif_start_queue(net);
818 spin_unlock(&kaweth->device_lock);
823 private_header = (__le16 *)__skb_push(skb, 2);
824 *private_header = cpu_to_le16(skb->len-2);
825 kaweth->tx_skb = skb;
827 usb_fill_bulk_urb(kaweth->tx_urb,
829 usb_sndbulkpipe(kaweth->dev, 2),
832 kaweth_usb_transmit_complete,
836 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
838 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
840 kaweth->stats.tx_errors++;
842 netif_start_queue(net);
843 dev_kfree_skb_irq(skb);
847 kaweth->stats.tx_packets++;
848 kaweth->stats.tx_bytes += skb->len;
849 net->trans_start = jiffies;
852 spin_unlock(&kaweth->device_lock);
857 /****************************************************************
859 ****************************************************************/
860 static void kaweth_set_rx_mode(struct net_device *net)
862 struct kaweth_device *kaweth = netdev_priv(net);
864 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
865 KAWETH_PACKET_FILTER_BROADCAST |
866 KAWETH_PACKET_FILTER_MULTICAST;
868 dbg("Setting Rx mode to %d", packet_filter_bitmap);
870 netif_stop_queue(net);
872 if (net->flags & IFF_PROMISC) {
873 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
875 else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
876 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
879 kaweth->packet_filter_bitmap = packet_filter_bitmap;
880 netif_wake_queue(net);
883 /****************************************************************
884 * kaweth_async_set_rx_mode
885 ****************************************************************/
886 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
888 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
889 kaweth->packet_filter_bitmap = 0;
890 if (packet_filter_bitmap == 0)
895 result = kaweth_control(kaweth,
896 usb_sndctrlpipe(kaweth->dev, 0),
897 KAWETH_COMMAND_SET_PACKET_FILTER,
898 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
899 packet_filter_bitmap,
901 (void *)&kaweth->scratch,
903 KAWETH_CONTROL_TIMEOUT);
906 err("Failed to set Rx mode: %d", result);
909 dbg("Set Rx mode to %d", packet_filter_bitmap);
914 /****************************************************************
915 * kaweth_netdev_stats
916 ****************************************************************/
917 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
919 struct kaweth_device *kaweth = netdev_priv(dev);
920 return &kaweth->stats;
923 /****************************************************************
925 ****************************************************************/
926 static void kaweth_tx_timeout(struct net_device *net)
928 struct kaweth_device *kaweth = netdev_priv(net);
930 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
931 kaweth->stats.tx_errors++;
932 net->trans_start = jiffies;
934 usb_unlink_urb(kaweth->tx_urb);
937 /****************************************************************
939 ****************************************************************/
940 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
942 struct kaweth_device *kaweth = usb_get_intfdata(intf);
945 dbg("Suspending device");
946 spin_lock_irqsave(&kaweth->device_lock, flags);
947 kaweth->status |= KAWETH_STATUS_SUSPENDING;
948 spin_unlock_irqrestore(&kaweth->device_lock, flags);
950 kaweth_kill_urbs(kaweth);
954 /****************************************************************
956 ****************************************************************/
957 static int kaweth_resume(struct usb_interface *intf)
959 struct kaweth_device *kaweth = usb_get_intfdata(intf);
962 dbg("Resuming device");
963 spin_lock_irqsave(&kaweth->device_lock, flags);
964 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
965 spin_unlock_irqrestore(&kaweth->device_lock, flags);
969 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
970 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
975 /****************************************************************
977 ****************************************************************/
978 static int kaweth_probe(
979 struct usb_interface *intf,
980 const struct usb_device_id *id /* from id_table */
983 struct usb_device *dev = interface_to_usbdev(intf);
984 struct kaweth_device *kaweth;
985 struct net_device *netdev;
986 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
989 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
991 le16_to_cpu(dev->descriptor.idVendor),
992 le16_to_cpu(dev->descriptor.idProduct),
993 le16_to_cpu(dev->descriptor.bcdDevice));
995 dbg("Device at %p", dev);
997 dbg("Descriptor length: %x type: %x",
998 (int)dev->descriptor.bLength,
999 (int)dev->descriptor.bDescriptorType);
1001 netdev = alloc_etherdev(sizeof(*kaweth));
1005 kaweth = netdev_priv(netdev);
1007 kaweth->net = netdev;
1009 spin_lock_init(&kaweth->device_lock);
1010 init_waitqueue_head(&kaweth->term_wait);
1014 kaweth_reset(kaweth);
1017 * If high byte of bcdDevice is nonzero, firmware is already
1018 * downloaded. Don't try to do it again, or we'll hang the device.
1021 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1022 dev_info(&intf->dev, "Firmware present in device.\n");
1024 /* Download the firmware */
1025 dev_info(&intf->dev, "Downloading firmware...\n");
1026 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1027 if ((result = kaweth_download_firmware(kaweth,
1028 "kaweth/new_code.bin",
1031 err("Error downloading firmware (%d)", result);
1035 if ((result = kaweth_download_firmware(kaweth,
1036 "kaweth/new_code_fix.bin",
1039 err("Error downloading firmware fix (%d)", result);
1043 if ((result = kaweth_download_firmware(kaweth,
1044 "kaweth/trigger_code.bin",
1047 err("Error downloading trigger code (%d)", result);
1052 if ((result = kaweth_download_firmware(kaweth,
1053 "kaweth/trigger_code_fix.bin",
1056 err("Error downloading trigger code fix (%d)", result);
1061 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1062 err("Error triggering firmware (%d)", result);
1066 /* Device will now disappear for a moment... */
1067 dev_info(&intf->dev, "Firmware loaded. I'll be back...\n");
1069 free_page((unsigned long)kaweth->firmware_buf);
1070 free_netdev(netdev);
1074 result = kaweth_read_configuration(kaweth);
1077 err("Error reading configuration (%d), no net device created", result);
1078 goto err_free_netdev;
1081 dev_info(&intf->dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
1082 dev_info(&intf->dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1083 dev_info(&intf->dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
1084 dev_info(&intf->dev, "Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1085 (int)kaweth->configuration.hw_addr[0],
1086 (int)kaweth->configuration.hw_addr[1],
1087 (int)kaweth->configuration.hw_addr[2],
1088 (int)kaweth->configuration.hw_addr[3],
1089 (int)kaweth->configuration.hw_addr[4],
1090 (int)kaweth->configuration.hw_addr[5]);
1092 if(!memcmp(&kaweth->configuration.hw_addr,
1094 sizeof(bcast_addr))) {
1095 err("Firmware not functioning properly, no net device created");
1096 goto err_free_netdev;
1099 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1100 dbg("Error setting URB size");
1101 goto err_free_netdev;
1104 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1105 err("Error setting SOFS wait");
1106 goto err_free_netdev;
1109 result = kaweth_set_receive_filter(kaweth,
1110 KAWETH_PACKET_FILTER_DIRECTED |
1111 KAWETH_PACKET_FILTER_BROADCAST |
1112 KAWETH_PACKET_FILTER_MULTICAST);
1115 err("Error setting receive filter");
1116 goto err_free_netdev;
1119 dbg("Initializing net device.");
1121 kaweth->intf = intf;
1123 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1124 if (!kaweth->tx_urb)
1125 goto err_free_netdev;
1126 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1127 if (!kaweth->rx_urb)
1129 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1130 if (!kaweth->irq_urb)
1133 kaweth->intbuffer = usb_buffer_alloc( kaweth->dev,
1136 &kaweth->intbufferhandle);
1137 if (!kaweth->intbuffer)
1138 goto err_tx_and_rx_and_irq;
1139 kaweth->rx_buf = usb_buffer_alloc( kaweth->dev,
1142 &kaweth->rxbufferhandle);
1143 if (!kaweth->rx_buf)
1144 goto err_all_but_rxbuf;
1146 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1147 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1148 sizeof(kaweth->configuration.hw_addr));
1150 netdev->open = kaweth_open;
1151 netdev->stop = kaweth_close;
1153 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1154 netdev->tx_timeout = kaweth_tx_timeout;
1156 netdev->hard_start_xmit = kaweth_start_xmit;
1157 netdev->set_multicast_list = kaweth_set_rx_mode;
1158 netdev->get_stats = kaweth_netdev_stats;
1159 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1160 SET_ETHTOOL_OPS(netdev, &ops);
1162 /* kaweth is zeroed as part of alloc_netdev */
1164 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1166 usb_set_intfdata(intf, kaweth);
1169 // dma_supported() is deeply broken on almost all architectures
1170 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1171 kaweth->net->features |= NETIF_F_HIGHDMA;
1174 SET_NETDEV_DEV(netdev, &intf->dev);
1175 if (register_netdev(netdev) != 0) {
1176 err("Error registering netdev.");
1180 dev_info(&intf->dev, "kaweth interface created at %s\n",
1183 dbg("Kaweth probe returning.");
1188 usb_set_intfdata(intf, NULL);
1189 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1191 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1192 err_tx_and_rx_and_irq:
1193 usb_free_urb(kaweth->irq_urb);
1195 usb_free_urb(kaweth->rx_urb);
1197 usb_free_urb(kaweth->tx_urb);
1199 free_netdev(netdev);
1204 /****************************************************************
1206 ****************************************************************/
1207 static void kaweth_disconnect(struct usb_interface *intf)
1209 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1210 struct net_device *netdev;
1212 dev_info(&intf->dev, "Unregistering\n");
1214 usb_set_intfdata(intf, NULL);
1216 dev_warn(&intf->dev, "unregistering non-existant device\n");
1219 netdev = kaweth->net;
1221 dbg("Unregistering net device");
1222 unregister_netdev(netdev);
1224 usb_free_urb(kaweth->rx_urb);
1225 usb_free_urb(kaweth->tx_urb);
1226 usb_free_urb(kaweth->irq_urb);
1228 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1229 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1231 free_netdev(netdev);
1235 // FIXME this completion stuff is a modified clone of
1236 // an OLD version of some stuff in usb.c ...
1237 struct usb_api_data {
1238 wait_queue_head_t wqh;
1242 /*-------------------------------------------------------------------*
1243 * completion handler for compatibility wrappers (sync control/bulk) *
1244 *-------------------------------------------------------------------*/
1245 static void usb_api_blocking_completion(struct urb *urb)
1247 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1253 /*-------------------------------------------------------------------*
1254 * COMPATIBILITY STUFF *
1255 *-------------------------------------------------------------------*/
1257 // Starts urb and waits for completion or timeout
1258 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1260 struct usb_api_data awd;
1263 init_waitqueue_head(&awd.wqh);
1266 urb->context = &awd;
1267 status = usb_submit_urb(urb, GFP_NOIO);
1269 // something went wrong
1274 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1276 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1277 usb_kill_urb(urb); // remove urb safely
1278 status = -ETIMEDOUT;
1281 status = urb->status;
1284 if (actual_length) {
1285 *actual_length = urb->actual_length;
1292 /*-------------------------------------------------------------------*/
1293 // returns status (negative) or length (positive)
1294 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1296 struct usb_ctrlrequest *cmd, void *data,
1297 int len, int timeout)
1301 int length = 0; /* shut up GCC */
1303 urb = usb_alloc_urb(0, GFP_NOIO);
1307 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1308 len, usb_api_blocking_completion, NULL);
1310 retv = usb_start_wait_urb(urb, timeout, &length);
1320 /****************************************************************
1322 ****************************************************************/
1323 static int __init kaweth_init(void)
1325 dbg("Driver loading");
1326 return usb_register(&kaweth_driver);
1329 /****************************************************************
1331 ****************************************************************/
1332 static void __exit kaweth_exit(void)
1334 usb_deregister(&kaweth_driver);
1337 module_init(kaweth_init);
1338 module_exit(kaweth_exit);