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 * Develop test procedures for USB net interfaces
36 * Fix bugs from previous two steps
37 * Snoop other OSs for any tricks we're not doing
38 * Reduce arbitrary timeouts
39 * Smart multicast support
40 * Temporary MAC change support
41 * Tunable SOFs parameter - ioctl()?
42 * Ethernet stats collection
43 * Code formatting improvements
46 #include <linux/module.h>
47 #include <linux/slab.h>
48 #include <linux/string.h>
49 #include <linux/init.h>
50 #include <linux/delay.h>
51 #include <linux/netdevice.h>
52 #include <linux/etherdevice.h>
53 #include <linux/usb.h>
54 #include <linux/types.h>
55 #include <linux/ethtool.h>
56 #include <linux/dma-mapping.h>
57 #include <linux/wait.h>
58 #include <linux/firmware.h>
59 #include <asm/uaccess.h>
60 #include <asm/byteorder.h>
64 #define KAWETH_MTU 1514
65 #define KAWETH_BUF_SIZE 1664
66 #define KAWETH_TX_TIMEOUT (5 * HZ)
67 #define KAWETH_SCRATCH_SIZE 32
68 #define KAWETH_FIRMWARE_BUF_SIZE 4096
69 #define KAWETH_CONTROL_TIMEOUT (30000)
71 #define KAWETH_STATUS_BROKEN 0x0000001
72 #define KAWETH_STATUS_CLOSING 0x0000002
73 #define KAWETH_STATUS_SUSPENDING 0x0000004
75 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
77 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
78 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
79 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
80 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
81 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
84 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
85 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
86 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
87 #define KAWETH_COMMAND_STATISTICS 0x03
88 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
89 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
90 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
91 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
92 #define KAWETH_COMMAND_SCAN 0xFF
94 #define KAWETH_SOFS_TO_WAIT 0x05
96 #define INTBUFFERSIZE 4
98 #define STATE_OFFSET 0
99 #define STATE_MASK 0x40
100 #define STATE_SHIFT 5
102 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
105 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>");
106 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
107 MODULE_LICENSE("GPL");
108 MODULE_FIRMWARE("kaweth/new_code.bin");
109 MODULE_FIRMWARE("kaweth/new_code_fix.bin");
110 MODULE_FIRMWARE("kaweth/trigger_code.bin");
111 MODULE_FIRMWARE("kaweth/trigger_code_fix.bin");
113 static const char driver_name
[] = "kaweth";
115 static int kaweth_probe(
116 struct usb_interface
*intf
,
117 const struct usb_device_id
*id
/* from id_table */
119 static void kaweth_disconnect(struct usb_interface
*intf
);
120 static int kaweth_internal_control_msg(struct usb_device
*usb_dev
,
122 struct usb_ctrlrequest
*cmd
, void *data
,
123 int len
, int timeout
);
124 static int kaweth_suspend(struct usb_interface
*intf
, pm_message_t message
);
125 static int kaweth_resume(struct usb_interface
*intf
);
127 /****************************************************************
129 ****************************************************************/
130 static struct usb_device_id usb_klsi_table
[] = {
131 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
132 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
133 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
134 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
135 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
136 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
137 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
138 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
139 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
140 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
141 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
142 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
143 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
144 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
145 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
146 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
147 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
148 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
149 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
150 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
151 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
152 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
153 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
154 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
155 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
156 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
157 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
158 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
159 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
160 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
161 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
162 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
163 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
164 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
165 {} /* Null terminator */
168 MODULE_DEVICE_TABLE (usb
, usb_klsi_table
);
170 /****************************************************************
172 ****************************************************************/
173 static struct usb_driver kaweth_driver
= {
175 .probe
= kaweth_probe
,
176 .disconnect
= kaweth_disconnect
,
177 .suspend
= kaweth_suspend
,
178 .resume
= kaweth_resume
,
179 .id_table
= usb_klsi_table
,
180 .supports_autosuspend
= 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
;
209 } __attribute__ ((packed
));
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
;
268 dbg("kaweth_control()");
271 dbg("in_interrupt()");
275 dr
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_ATOMIC
);
278 dbg("kmalloc() failed");
282 dr
->bRequestType
= requesttype
;
283 dr
->bRequest
= request
;
284 dr
->wValue
= cpu_to_le16(value
);
285 dr
->wIndex
= cpu_to_le16(index
);
286 dr
->wLength
= cpu_to_le16(size
);
288 retval
= kaweth_internal_control_msg(kaweth
->dev
,
299 /****************************************************************
300 * kaweth_read_configuration
301 ****************************************************************/
302 static int kaweth_read_configuration(struct kaweth_device
*kaweth
)
306 dbg("Reading kaweth configuration");
308 retval
= kaweth_control(kaweth
,
309 usb_rcvctrlpipe(kaweth
->dev
, 0),
310 KAWETH_COMMAND_GET_ETHERNET_DESC
,
311 USB_TYPE_VENDOR
| USB_DIR_IN
| USB_RECIP_DEVICE
,
314 (void *)&kaweth
->configuration
,
315 sizeof(kaweth
->configuration
),
316 KAWETH_CONTROL_TIMEOUT
);
321 /****************************************************************
322 * kaweth_set_urb_size
323 ****************************************************************/
324 static int kaweth_set_urb_size(struct kaweth_device
*kaweth
, __u16 urb_size
)
328 dbg("Setting URB size to %d", (unsigned)urb_size
);
330 retval
= kaweth_control(kaweth
,
331 usb_sndctrlpipe(kaweth
->dev
, 0),
332 KAWETH_COMMAND_SET_URB_SIZE
,
333 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
336 (void *)&kaweth
->scratch
,
338 KAWETH_CONTROL_TIMEOUT
);
343 /****************************************************************
344 * kaweth_set_sofs_wait
345 ****************************************************************/
346 static int kaweth_set_sofs_wait(struct kaweth_device
*kaweth
, __u16 sofs_wait
)
350 dbg("Set SOFS wait to %d", (unsigned)sofs_wait
);
352 retval
= kaweth_control(kaweth
,
353 usb_sndctrlpipe(kaweth
->dev
, 0),
354 KAWETH_COMMAND_SET_SOFS_WAIT
,
355 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
358 (void *)&kaweth
->scratch
,
360 KAWETH_CONTROL_TIMEOUT
);
365 /****************************************************************
366 * kaweth_set_receive_filter
367 ****************************************************************/
368 static int kaweth_set_receive_filter(struct kaweth_device
*kaweth
,
369 __u16 receive_filter
)
373 dbg("Set receive filter to %d", (unsigned)receive_filter
);
375 retval
= kaweth_control(kaweth
,
376 usb_sndctrlpipe(kaweth
->dev
, 0),
377 KAWETH_COMMAND_SET_PACKET_FILTER
,
378 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
381 (void *)&kaweth
->scratch
,
383 KAWETH_CONTROL_TIMEOUT
);
388 /****************************************************************
389 * kaweth_download_firmware
390 ****************************************************************/
391 static int kaweth_download_firmware(struct kaweth_device
*kaweth
,
396 const struct firmware
*fw
;
400 ret
= request_firmware(&fw
, fwname
, &kaweth
->dev
->dev
);
402 err("Firmware request failed\n");
406 if (fw
->size
> KAWETH_FIRMWARE_BUF_SIZE
) {
407 err("Firmware too big: %zu", fw
->size
);
411 memcpy(kaweth
->firmware_buf
, fw
->data
, fw
->size
);
413 release_firmware(fw
);
415 kaweth
->firmware_buf
[2] = (data_len
& 0xFF) - 7;
416 kaweth
->firmware_buf
[3] = data_len
>> 8;
417 kaweth
->firmware_buf
[4] = type
;
418 kaweth
->firmware_buf
[5] = interrupt
;
420 dbg("High: %i, Low:%i", kaweth
->firmware_buf
[3],
421 kaweth
->firmware_buf
[2]);
423 dbg("Downloading firmware at %p to kaweth device at %p",
425 dbg("Firmware length: %d", data_len
);
427 return kaweth_control(kaweth
,
428 usb_sndctrlpipe(kaweth
->dev
, 0),
430 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
433 (void *)kaweth
->firmware_buf
,
435 KAWETH_CONTROL_TIMEOUT
);
438 /****************************************************************
439 * kaweth_trigger_firmware
440 ****************************************************************/
441 static int kaweth_trigger_firmware(struct kaweth_device
*kaweth
,
444 kaweth
->firmware_buf
[0] = 0xB6;
445 kaweth
->firmware_buf
[1] = 0xC3;
446 kaweth
->firmware_buf
[2] = 0x01;
447 kaweth
->firmware_buf
[3] = 0x00;
448 kaweth
->firmware_buf
[4] = 0x06;
449 kaweth
->firmware_buf
[5] = interrupt
;
450 kaweth
->firmware_buf
[6] = 0x00;
451 kaweth
->firmware_buf
[7] = 0x00;
453 dbg("Triggering firmware");
455 return kaweth_control(kaweth
,
456 usb_sndctrlpipe(kaweth
->dev
, 0),
458 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
461 (void *)kaweth
->firmware_buf
,
463 KAWETH_CONTROL_TIMEOUT
);
466 /****************************************************************
468 ****************************************************************/
469 static int kaweth_reset(struct kaweth_device
*kaweth
)
473 dbg("kaweth_reset(%p)", kaweth
);
474 result
= usb_reset_configuration(kaweth
->dev
);
477 dbg("kaweth_reset() returns %d.",result
);
482 static void kaweth_usb_receive(struct urb
*);
483 static int kaweth_resubmit_rx_urb(struct kaweth_device
*, gfp_t
);
485 /****************************************************************
487 *****************************************************************/
489 static void kaweth_resubmit_int_urb(struct kaweth_device
*kaweth
, gfp_t mf
)
493 status
= usb_submit_urb (kaweth
->irq_urb
, mf
);
494 if (unlikely(status
== -ENOMEM
)) {
495 kaweth
->suspend_lowmem_ctrl
= 1;
496 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
498 kaweth
->suspend_lowmem_ctrl
= 0;
502 err ("can't resubmit intr, %s-%s, status %d",
503 kaweth
->dev
->bus
->bus_name
,
504 kaweth
->dev
->devpath
, status
);
507 static void int_callback(struct urb
*u
)
509 struct kaweth_device
*kaweth
= u
->context
;
511 int status
= u
->status
;
514 case 0: /* success */
516 case -ECONNRESET
: /* unlink */
520 /* -EPIPE: should clear the halt */
525 /* we check the link state to report changes */
526 if (kaweth
->linkstate
!= (act_state
= ( kaweth
->intbuffer
[STATE_OFFSET
] | STATE_MASK
) >> STATE_SHIFT
)) {
528 netif_carrier_on(kaweth
->net
);
530 netif_carrier_off(kaweth
->net
);
532 kaweth
->linkstate
= act_state
;
535 kaweth_resubmit_int_urb(kaweth
, GFP_ATOMIC
);
538 static void kaweth_resubmit_tl(struct work_struct
*work
)
540 struct kaweth_device
*kaweth
=
541 container_of(work
, struct kaweth_device
, lowmem_work
.work
);
543 if (IS_BLOCKED(kaweth
->status
))
546 if (kaweth
->suspend_lowmem_rx
)
547 kaweth_resubmit_rx_urb(kaweth
, GFP_NOIO
);
549 if (kaweth
->suspend_lowmem_ctrl
)
550 kaweth_resubmit_int_urb(kaweth
, GFP_NOIO
);
554 /****************************************************************
555 * kaweth_resubmit_rx_urb
556 ****************************************************************/
557 static int kaweth_resubmit_rx_urb(struct kaweth_device
*kaweth
,
562 usb_fill_bulk_urb(kaweth
->rx_urb
,
564 usb_rcvbulkpipe(kaweth
->dev
, 1),
569 kaweth
->rx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
570 kaweth
->rx_urb
->transfer_dma
= kaweth
->rxbufferhandle
;
572 if((result
= usb_submit_urb(kaweth
->rx_urb
, mem_flags
))) {
573 if (result
== -ENOMEM
) {
574 kaweth
->suspend_lowmem_rx
= 1;
575 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
577 err("resubmitting rx_urb %d failed", result
);
579 kaweth
->suspend_lowmem_rx
= 0;
585 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
);
587 /****************************************************************
589 ****************************************************************/
590 static void kaweth_usb_receive(struct urb
*urb
)
592 struct kaweth_device
*kaweth
= urb
->context
;
593 struct net_device
*net
= kaweth
->net
;
594 int status
= urb
->status
;
596 int count
= urb
->actual_length
;
597 int count2
= urb
->transfer_buffer_length
;
599 __u16 pkt_len
= le16_to_cpup((__le16
*)kaweth
->rx_buf
);
603 if (unlikely(status
== -EPIPE
)) {
604 kaweth
->stats
.rx_errors
++;
606 wake_up(&kaweth
->term_wait
);
607 dbg("Status was -EPIPE.");
610 if (unlikely(status
== -ECONNRESET
|| status
== -ESHUTDOWN
)) {
611 /* we are killed - set a flag and wake the disconnect handler */
613 wake_up(&kaweth
->term_wait
);
614 dbg("Status was -ECONNRESET or -ESHUTDOWN.");
617 if (unlikely(status
== -EPROTO
|| status
== -ETIME
||
618 status
== -EILSEQ
)) {
619 kaweth
->stats
.rx_errors
++;
620 dbg("Status was -EPROTO, -ETIME, or -EILSEQ.");
623 if (unlikely(status
== -EOVERFLOW
)) {
624 kaweth
->stats
.rx_errors
++;
625 dbg("Status was -EOVERFLOW.");
627 spin_lock(&kaweth
->device_lock
);
628 if (IS_BLOCKED(kaweth
->status
)) {
629 spin_unlock(&kaweth
->device_lock
);
632 spin_unlock(&kaweth
->device_lock
);
634 if(status
&& status
!= -EREMOTEIO
&& count
!= 1) {
635 err("%s RX status: %d count: %d packet_len: %d",
640 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
644 if(kaweth
->net
&& (count
> 2)) {
645 if(pkt_len
> (count
- 2)) {
646 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len
, count
);
647 err("Packet len & 2047: %x", pkt_len
& 2047);
648 err("Count 2: %x", count2
);
649 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
653 if(!(skb
= dev_alloc_skb(pkt_len
+2))) {
654 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
658 skb_reserve(skb
, 2); /* Align IP on 16 byte boundaries */
660 skb_copy_to_linear_data(skb
, kaweth
->rx_buf
+ 2, pkt_len
);
662 skb_put(skb
, pkt_len
);
664 skb
->protocol
= eth_type_trans(skb
, net
);
668 kaweth
->stats
.rx_packets
++;
669 kaweth
->stats
.rx_bytes
+= pkt_len
;
672 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
675 /****************************************************************
677 ****************************************************************/
678 static int kaweth_open(struct net_device
*net
)
680 struct kaweth_device
*kaweth
= netdev_priv(net
);
683 dbg("Opening network device.");
685 res
= usb_autopm_get_interface(kaweth
->intf
);
687 err("Interface cannot be resumed.");
690 res
= kaweth_resubmit_rx_urb(kaweth
, GFP_KERNEL
);
697 usb_rcvintpipe(kaweth
->dev
, 3),
702 250); /* overriding the descriptor */
703 kaweth
->irq_urb
->transfer_dma
= kaweth
->intbufferhandle
;
704 kaweth
->irq_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
706 res
= usb_submit_urb(kaweth
->irq_urb
, GFP_KERNEL
);
708 usb_kill_urb(kaweth
->rx_urb
);
713 netif_start_queue(net
);
715 kaweth_async_set_rx_mode(kaweth
);
719 usb_autopm_put_interface(kaweth
->intf
);
723 /****************************************************************
725 ****************************************************************/
726 static void kaweth_kill_urbs(struct kaweth_device
*kaweth
)
728 usb_kill_urb(kaweth
->irq_urb
);
729 usb_kill_urb(kaweth
->rx_urb
);
730 usb_kill_urb(kaweth
->tx_urb
);
732 cancel_delayed_work_sync(&kaweth
->lowmem_work
);
734 /* a scheduled work may have resubmitted,
736 usb_kill_urb(kaweth
->irq_urb
);
737 usb_kill_urb(kaweth
->rx_urb
);
740 /****************************************************************
742 ****************************************************************/
743 static int kaweth_close(struct net_device
*net
)
745 struct kaweth_device
*kaweth
= netdev_priv(net
);
747 netif_stop_queue(net
);
750 kaweth
->status
|= KAWETH_STATUS_CLOSING
;
752 kaweth_kill_urbs(kaweth
);
754 kaweth
->status
&= ~KAWETH_STATUS_CLOSING
;
756 usb_autopm_put_interface(kaweth
->intf
);
761 static void kaweth_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
)
763 struct kaweth_device
*kaweth
= netdev_priv(dev
);
765 strlcpy(info
->driver
, driver_name
, sizeof(info
->driver
));
766 usb_make_path(kaweth
->dev
, info
->bus_info
, sizeof (info
->bus_info
));
769 static u32
kaweth_get_link(struct net_device
*dev
)
771 struct kaweth_device
*kaweth
= netdev_priv(dev
);
773 return kaweth
->linkstate
;
776 static const struct ethtool_ops ops
= {
777 .get_drvinfo
= kaweth_get_drvinfo
,
778 .get_link
= kaweth_get_link
781 /****************************************************************
782 * kaweth_usb_transmit_complete
783 ****************************************************************/
784 static void kaweth_usb_transmit_complete(struct urb
*urb
)
786 struct kaweth_device
*kaweth
= urb
->context
;
787 struct sk_buff
*skb
= kaweth
->tx_skb
;
788 int status
= urb
->status
;
790 if (unlikely(status
!= 0))
791 if (status
!= -ENOENT
)
792 dbg("%s: TX status %d.", kaweth
->net
->name
, status
);
794 netif_wake_queue(kaweth
->net
);
795 dev_kfree_skb_irq(skb
);
798 /****************************************************************
800 ****************************************************************/
801 static netdev_tx_t
kaweth_start_xmit(struct sk_buff
*skb
,
802 struct net_device
*net
)
804 struct kaweth_device
*kaweth
= netdev_priv(net
);
805 __le16
*private_header
;
809 spin_lock_irq(&kaweth
->device_lock
);
811 kaweth_async_set_rx_mode(kaweth
);
812 netif_stop_queue(net
);
813 if (IS_BLOCKED(kaweth
->status
)) {
817 /* We now decide whether we can put our special header into the sk_buff */
818 if (skb_cloned(skb
) || skb_headroom(skb
) < 2) {
819 /* no such luck - we make our own */
820 struct sk_buff
*copied_skb
;
821 copied_skb
= skb_copy_expand(skb
, 2, 0, GFP_ATOMIC
);
822 dev_kfree_skb_irq(skb
);
825 kaweth
->stats
.tx_errors
++;
826 netif_start_queue(net
);
827 spin_unlock_irq(&kaweth
->device_lock
);
832 private_header
= (__le16
*)__skb_push(skb
, 2);
833 *private_header
= cpu_to_le16(skb
->len
-2);
834 kaweth
->tx_skb
= skb
;
836 usb_fill_bulk_urb(kaweth
->tx_urb
,
838 usb_sndbulkpipe(kaweth
->dev
, 2),
841 kaweth_usb_transmit_complete
,
845 if((res
= usb_submit_urb(kaweth
->tx_urb
, GFP_ATOMIC
)))
847 dev_warn(&net
->dev
, "kaweth failed tx_urb %d\n", res
);
849 kaweth
->stats
.tx_errors
++;
851 netif_start_queue(net
);
852 dev_kfree_skb_irq(skb
);
856 kaweth
->stats
.tx_packets
++;
857 kaweth
->stats
.tx_bytes
+= skb
->len
;
858 net
->trans_start
= jiffies
;
861 spin_unlock_irq(&kaweth
->device_lock
);
866 /****************************************************************
868 ****************************************************************/
869 static void kaweth_set_rx_mode(struct net_device
*net
)
871 struct kaweth_device
*kaweth
= netdev_priv(net
);
873 __u16 packet_filter_bitmap
= KAWETH_PACKET_FILTER_DIRECTED
|
874 KAWETH_PACKET_FILTER_BROADCAST
|
875 KAWETH_PACKET_FILTER_MULTICAST
;
877 dbg("Setting Rx mode to %d", packet_filter_bitmap
);
879 netif_stop_queue(net
);
881 if (net
->flags
& IFF_PROMISC
) {
882 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_PROMISCUOUS
;
884 else if (!netdev_mc_empty(net
) || (net
->flags
& IFF_ALLMULTI
)) {
885 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_ALL_MULTICAST
;
888 kaweth
->packet_filter_bitmap
= packet_filter_bitmap
;
889 netif_wake_queue(net
);
892 /****************************************************************
893 * kaweth_async_set_rx_mode
894 ****************************************************************/
895 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
)
898 __u16 packet_filter_bitmap
= kaweth
->packet_filter_bitmap
;
900 kaweth
->packet_filter_bitmap
= 0;
901 if (packet_filter_bitmap
== 0)
907 result
= kaweth_control(kaweth
,
908 usb_sndctrlpipe(kaweth
->dev
, 0),
909 KAWETH_COMMAND_SET_PACKET_FILTER
,
910 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
911 packet_filter_bitmap
,
913 (void *)&kaweth
->scratch
,
915 KAWETH_CONTROL_TIMEOUT
);
918 err("Failed to set Rx mode: %d", result
);
921 dbg("Set Rx mode to %d", packet_filter_bitmap
);
925 /****************************************************************
926 * kaweth_netdev_stats
927 ****************************************************************/
928 static struct net_device_stats
*kaweth_netdev_stats(struct net_device
*dev
)
930 struct kaweth_device
*kaweth
= netdev_priv(dev
);
931 return &kaweth
->stats
;
934 /****************************************************************
936 ****************************************************************/
937 static void kaweth_tx_timeout(struct net_device
*net
)
939 struct kaweth_device
*kaweth
= netdev_priv(net
);
941 dev_warn(&net
->dev
, "%s: Tx timed out. Resetting.\n", net
->name
);
942 kaweth
->stats
.tx_errors
++;
943 net
->trans_start
= jiffies
;
945 usb_unlink_urb(kaweth
->tx_urb
);
948 /****************************************************************
950 ****************************************************************/
951 static int kaweth_suspend(struct usb_interface
*intf
, pm_message_t message
)
953 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
956 dbg("Suspending device");
957 spin_lock_irqsave(&kaweth
->device_lock
, flags
);
958 kaweth
->status
|= KAWETH_STATUS_SUSPENDING
;
959 spin_unlock_irqrestore(&kaweth
->device_lock
, flags
);
961 kaweth_kill_urbs(kaweth
);
965 /****************************************************************
967 ****************************************************************/
968 static int kaweth_resume(struct usb_interface
*intf
)
970 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
973 dbg("Resuming device");
974 spin_lock_irqsave(&kaweth
->device_lock
, flags
);
975 kaweth
->status
&= ~KAWETH_STATUS_SUSPENDING
;
976 spin_unlock_irqrestore(&kaweth
->device_lock
, flags
);
980 kaweth_resubmit_rx_urb(kaweth
, GFP_NOIO
);
981 kaweth_resubmit_int_urb(kaweth
, GFP_NOIO
);
986 /****************************************************************
988 ****************************************************************/
991 static const struct net_device_ops kaweth_netdev_ops
= {
992 .ndo_open
= kaweth_open
,
993 .ndo_stop
= kaweth_close
,
994 .ndo_start_xmit
= kaweth_start_xmit
,
995 .ndo_tx_timeout
= kaweth_tx_timeout
,
996 .ndo_set_multicast_list
= kaweth_set_rx_mode
,
997 .ndo_get_stats
= kaweth_netdev_stats
,
998 .ndo_change_mtu
= eth_change_mtu
,
999 .ndo_set_mac_address
= eth_mac_addr
,
1000 .ndo_validate_addr
= eth_validate_addr
,
1003 static int kaweth_probe(
1004 struct usb_interface
*intf
,
1005 const struct usb_device_id
*id
/* from id_table */
1008 struct usb_device
*dev
= interface_to_usbdev(intf
);
1009 struct kaweth_device
*kaweth
;
1010 struct net_device
*netdev
;
1011 const eth_addr_t bcast_addr
= { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1014 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1016 le16_to_cpu(dev
->descriptor
.idVendor
),
1017 le16_to_cpu(dev
->descriptor
.idProduct
),
1018 le16_to_cpu(dev
->descriptor
.bcdDevice
));
1020 dbg("Device at %p", dev
);
1022 dbg("Descriptor length: %x type: %x",
1023 (int)dev
->descriptor
.bLength
,
1024 (int)dev
->descriptor
.bDescriptorType
);
1026 netdev
= alloc_etherdev(sizeof(*kaweth
));
1030 kaweth
= netdev_priv(netdev
);
1032 kaweth
->net
= netdev
;
1034 spin_lock_init(&kaweth
->device_lock
);
1035 init_waitqueue_head(&kaweth
->term_wait
);
1039 kaweth_reset(kaweth
);
1042 * If high byte of bcdDevice is nonzero, firmware is already
1043 * downloaded. Don't try to do it again, or we'll hang the device.
1046 if (le16_to_cpu(dev
->descriptor
.bcdDevice
) >> 8) {
1047 dev_info(&intf
->dev
, "Firmware present in device.\n");
1049 /* Download the firmware */
1050 dev_info(&intf
->dev
, "Downloading firmware...\n");
1051 kaweth
->firmware_buf
= (__u8
*)__get_free_page(GFP_KERNEL
);
1052 if ((result
= kaweth_download_firmware(kaweth
,
1053 "kaweth/new_code.bin",
1056 err("Error downloading firmware (%d)", result
);
1060 if ((result
= kaweth_download_firmware(kaweth
,
1061 "kaweth/new_code_fix.bin",
1064 err("Error downloading firmware fix (%d)", result
);
1068 if ((result
= kaweth_download_firmware(kaweth
,
1069 "kaweth/trigger_code.bin",
1072 err("Error downloading trigger code (%d)", result
);
1077 if ((result
= kaweth_download_firmware(kaweth
,
1078 "kaweth/trigger_code_fix.bin",
1081 err("Error downloading trigger code fix (%d)", result
);
1086 if ((result
= kaweth_trigger_firmware(kaweth
, 126)) < 0) {
1087 err("Error triggering firmware (%d)", result
);
1091 /* Device will now disappear for a moment... */
1092 dev_info(&intf
->dev
, "Firmware loaded. I'll be back...\n");
1094 free_page((unsigned long)kaweth
->firmware_buf
);
1095 free_netdev(netdev
);
1099 result
= kaweth_read_configuration(kaweth
);
1102 err("Error reading configuration (%d), no net device created", result
);
1103 goto err_free_netdev
;
1106 dev_info(&intf
->dev
, "Statistics collection: %x\n", kaweth
->configuration
.statistics_mask
);
1107 dev_info(&intf
->dev
, "Multicast filter limit: %x\n", kaweth
->configuration
.max_multicast_filters
& ((1 << 15) - 1));
1108 dev_info(&intf
->dev
, "MTU: %d\n", le16_to_cpu(kaweth
->configuration
.segment_size
));
1109 dev_info(&intf
->dev
, "Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1110 (int)kaweth
->configuration
.hw_addr
[0],
1111 (int)kaweth
->configuration
.hw_addr
[1],
1112 (int)kaweth
->configuration
.hw_addr
[2],
1113 (int)kaweth
->configuration
.hw_addr
[3],
1114 (int)kaweth
->configuration
.hw_addr
[4],
1115 (int)kaweth
->configuration
.hw_addr
[5]);
1117 if(!memcmp(&kaweth
->configuration
.hw_addr
,
1119 sizeof(bcast_addr
))) {
1120 err("Firmware not functioning properly, no net device created");
1121 goto err_free_netdev
;
1124 if(kaweth_set_urb_size(kaweth
, KAWETH_BUF_SIZE
) < 0) {
1125 dbg("Error setting URB size");
1126 goto err_free_netdev
;
1129 if(kaweth_set_sofs_wait(kaweth
, KAWETH_SOFS_TO_WAIT
) < 0) {
1130 err("Error setting SOFS wait");
1131 goto err_free_netdev
;
1134 result
= kaweth_set_receive_filter(kaweth
,
1135 KAWETH_PACKET_FILTER_DIRECTED
|
1136 KAWETH_PACKET_FILTER_BROADCAST
|
1137 KAWETH_PACKET_FILTER_MULTICAST
);
1140 err("Error setting receive filter");
1141 goto err_free_netdev
;
1144 dbg("Initializing net device.");
1146 kaweth
->intf
= intf
;
1148 kaweth
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1149 if (!kaweth
->tx_urb
)
1150 goto err_free_netdev
;
1151 kaweth
->rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1152 if (!kaweth
->rx_urb
)
1154 kaweth
->irq_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1155 if (!kaweth
->irq_urb
)
1158 kaweth
->intbuffer
= usb_buffer_alloc( kaweth
->dev
,
1161 &kaweth
->intbufferhandle
);
1162 if (!kaweth
->intbuffer
)
1163 goto err_tx_and_rx_and_irq
;
1164 kaweth
->rx_buf
= usb_buffer_alloc( kaweth
->dev
,
1167 &kaweth
->rxbufferhandle
);
1168 if (!kaweth
->rx_buf
)
1169 goto err_all_but_rxbuf
;
1171 memcpy(netdev
->broadcast
, &bcast_addr
, sizeof(bcast_addr
));
1172 memcpy(netdev
->dev_addr
, &kaweth
->configuration
.hw_addr
,
1173 sizeof(kaweth
->configuration
.hw_addr
));
1175 netdev
->netdev_ops
= &kaweth_netdev_ops
;
1176 netdev
->watchdog_timeo
= KAWETH_TX_TIMEOUT
;
1177 netdev
->mtu
= le16_to_cpu(kaweth
->configuration
.segment_size
);
1178 SET_ETHTOOL_OPS(netdev
, &ops
);
1180 /* kaweth is zeroed as part of alloc_netdev */
1181 INIT_DELAYED_WORK(&kaweth
->lowmem_work
, kaweth_resubmit_tl
);
1182 usb_set_intfdata(intf
, kaweth
);
1185 // dma_supported() is deeply broken on almost all architectures
1186 if (dma_supported (&intf
->dev
, 0xffffffffffffffffULL
))
1187 kaweth
->net
->features
|= NETIF_F_HIGHDMA
;
1190 SET_NETDEV_DEV(netdev
, &intf
->dev
);
1191 if (register_netdev(netdev
) != 0) {
1192 err("Error registering netdev.");
1196 dev_info(&intf
->dev
, "kaweth interface created at %s\n",
1199 dbg("Kaweth probe returning.");
1204 usb_set_intfdata(intf
, NULL
);
1205 usb_buffer_free(kaweth
->dev
, KAWETH_BUF_SIZE
, (void *)kaweth
->rx_buf
, kaweth
->rxbufferhandle
);
1207 usb_buffer_free(kaweth
->dev
, INTBUFFERSIZE
, (void *)kaweth
->intbuffer
, kaweth
->intbufferhandle
);
1208 err_tx_and_rx_and_irq
:
1209 usb_free_urb(kaweth
->irq_urb
);
1211 usb_free_urb(kaweth
->rx_urb
);
1213 usb_free_urb(kaweth
->tx_urb
);
1215 free_netdev(netdev
);
1220 /****************************************************************
1222 ****************************************************************/
1223 static void kaweth_disconnect(struct usb_interface
*intf
)
1225 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
1226 struct net_device
*netdev
;
1228 dev_info(&intf
->dev
, "Unregistering\n");
1230 usb_set_intfdata(intf
, NULL
);
1232 dev_warn(&intf
->dev
, "unregistering non-existant device\n");
1235 netdev
= kaweth
->net
;
1237 dbg("Unregistering net device");
1238 unregister_netdev(netdev
);
1240 usb_free_urb(kaweth
->rx_urb
);
1241 usb_free_urb(kaweth
->tx_urb
);
1242 usb_free_urb(kaweth
->irq_urb
);
1244 usb_buffer_free(kaweth
->dev
, KAWETH_BUF_SIZE
, (void *)kaweth
->rx_buf
, kaweth
->rxbufferhandle
);
1245 usb_buffer_free(kaweth
->dev
, INTBUFFERSIZE
, (void *)kaweth
->intbuffer
, kaweth
->intbufferhandle
);
1247 free_netdev(netdev
);
1251 // FIXME this completion stuff is a modified clone of
1252 // an OLD version of some stuff in usb.c ...
1253 struct usb_api_data
{
1254 wait_queue_head_t wqh
;
1258 /*-------------------------------------------------------------------*
1259 * completion handler for compatibility wrappers (sync control/bulk) *
1260 *-------------------------------------------------------------------*/
1261 static void usb_api_blocking_completion(struct urb
*urb
)
1263 struct usb_api_data
*awd
= (struct usb_api_data
*)urb
->context
;
1269 /*-------------------------------------------------------------------*
1270 * COMPATIBILITY STUFF *
1271 *-------------------------------------------------------------------*/
1273 // Starts urb and waits for completion or timeout
1274 static int usb_start_wait_urb(struct urb
*urb
, int timeout
, int* actual_length
)
1276 struct usb_api_data awd
;
1279 init_waitqueue_head(&awd
.wqh
);
1282 urb
->context
= &awd
;
1283 status
= usb_submit_urb(urb
, GFP_NOIO
);
1285 // something went wrong
1290 if (!wait_event_timeout(awd
.wqh
, awd
.done
, timeout
)) {
1292 dev_warn(&urb
->dev
->dev
, "usb_control/bulk_msg: timeout\n");
1293 usb_kill_urb(urb
); // remove urb safely
1294 status
= -ETIMEDOUT
;
1297 status
= urb
->status
;
1300 if (actual_length
) {
1301 *actual_length
= urb
->actual_length
;
1308 /*-------------------------------------------------------------------*/
1309 // returns status (negative) or length (positive)
1310 static int kaweth_internal_control_msg(struct usb_device
*usb_dev
,
1312 struct usb_ctrlrequest
*cmd
, void *data
,
1313 int len
, int timeout
)
1317 int length
= 0; /* shut up GCC */
1319 urb
= usb_alloc_urb(0, GFP_NOIO
);
1323 usb_fill_control_urb(urb
, usb_dev
, pipe
, (unsigned char*)cmd
, data
,
1324 len
, usb_api_blocking_completion
, NULL
);
1326 retv
= usb_start_wait_urb(urb
, timeout
, &length
);
1336 /****************************************************************
1338 ****************************************************************/
1339 static int __init
kaweth_init(void)
1341 dbg("Driver loading");
1342 return usb_register(&kaweth_driver
);
1345 /****************************************************************
1347 ****************************************************************/
1348 static void __exit
kaweth_exit(void)
1350 usb_deregister(&kaweth_driver
);
1353 module_init(kaweth_init
);
1354 module_exit(kaweth_exit
);