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(0x07c9, 0xb010) }, /* Allied Telesyn AT-USB10 USB Ethernet Adapter */
149 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
150 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
151 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
152 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
153 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
154 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
155 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
156 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
157 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
158 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
159 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
160 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
161 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
162 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
163 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
164 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
165 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
166 {} /* Null terminator */
169 MODULE_DEVICE_TABLE (usb
, usb_klsi_table
);
171 /****************************************************************
173 ****************************************************************/
174 static struct usb_driver kaweth_driver
= {
176 .probe
= kaweth_probe
,
177 .disconnect
= kaweth_disconnect
,
178 .suspend
= kaweth_suspend
,
179 .resume
= kaweth_resume
,
180 .id_table
= usb_klsi_table
,
181 .supports_autosuspend
= 1,
184 typedef __u8 eth_addr_t
[6];
186 /****************************************************************
188 ****************************************************************/
196 /****************************************************************
197 * kaweth_ethernet_configuration
199 ****************************************************************/
200 struct kaweth_ethernet_configuration
206 __u32 statistics_mask
;
208 __u16 max_multicast_filters
;
212 /****************************************************************
214 ****************************************************************/
217 spinlock_t device_lock
;
221 int suspend_lowmem_rx
;
222 int suspend_lowmem_ctrl
;
225 struct delayed_work lowmem_work
;
227 struct usb_device
*dev
;
228 struct usb_interface
*intf
;
229 struct net_device
*net
;
230 wait_queue_head_t term_wait
;
236 dma_addr_t intbufferhandle
;
238 dma_addr_t rxbufferhandle
;
242 struct sk_buff
*tx_skb
;
245 __u8 scratch
[KAWETH_SCRATCH_SIZE
];
246 __u16 packet_filter_bitmap
;
248 struct kaweth_ethernet_configuration configuration
;
250 struct net_device_stats stats
;
253 /****************************************************************
255 ****************************************************************/
256 static int kaweth_control(struct kaweth_device
*kaweth
,
266 struct usb_ctrlrequest
*dr
;
269 dbg("kaweth_control()");
272 dbg("in_interrupt()");
276 dr
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_ATOMIC
);
279 dbg("kmalloc() failed");
283 dr
->bRequestType
= requesttype
;
284 dr
->bRequest
= request
;
285 dr
->wValue
= cpu_to_le16(value
);
286 dr
->wIndex
= cpu_to_le16(index
);
287 dr
->wLength
= cpu_to_le16(size
);
289 retval
= kaweth_internal_control_msg(kaweth
->dev
,
300 /****************************************************************
301 * kaweth_read_configuration
302 ****************************************************************/
303 static int kaweth_read_configuration(struct kaweth_device
*kaweth
)
307 dbg("Reading kaweth configuration");
309 retval
= kaweth_control(kaweth
,
310 usb_rcvctrlpipe(kaweth
->dev
, 0),
311 KAWETH_COMMAND_GET_ETHERNET_DESC
,
312 USB_TYPE_VENDOR
| USB_DIR_IN
| USB_RECIP_DEVICE
,
315 (void *)&kaweth
->configuration
,
316 sizeof(kaweth
->configuration
),
317 KAWETH_CONTROL_TIMEOUT
);
322 /****************************************************************
323 * kaweth_set_urb_size
324 ****************************************************************/
325 static int kaweth_set_urb_size(struct kaweth_device
*kaweth
, __u16 urb_size
)
329 dbg("Setting URB size to %d", (unsigned)urb_size
);
331 retval
= kaweth_control(kaweth
,
332 usb_sndctrlpipe(kaweth
->dev
, 0),
333 KAWETH_COMMAND_SET_URB_SIZE
,
334 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
337 (void *)&kaweth
->scratch
,
339 KAWETH_CONTROL_TIMEOUT
);
344 /****************************************************************
345 * kaweth_set_sofs_wait
346 ****************************************************************/
347 static int kaweth_set_sofs_wait(struct kaweth_device
*kaweth
, __u16 sofs_wait
)
351 dbg("Set SOFS wait to %d", (unsigned)sofs_wait
);
353 retval
= kaweth_control(kaweth
,
354 usb_sndctrlpipe(kaweth
->dev
, 0),
355 KAWETH_COMMAND_SET_SOFS_WAIT
,
356 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
359 (void *)&kaweth
->scratch
,
361 KAWETH_CONTROL_TIMEOUT
);
366 /****************************************************************
367 * kaweth_set_receive_filter
368 ****************************************************************/
369 static int kaweth_set_receive_filter(struct kaweth_device
*kaweth
,
370 __u16 receive_filter
)
374 dbg("Set receive filter to %d", (unsigned)receive_filter
);
376 retval
= kaweth_control(kaweth
,
377 usb_sndctrlpipe(kaweth
->dev
, 0),
378 KAWETH_COMMAND_SET_PACKET_FILTER
,
379 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
382 (void *)&kaweth
->scratch
,
384 KAWETH_CONTROL_TIMEOUT
);
389 /****************************************************************
390 * kaweth_download_firmware
391 ****************************************************************/
392 static int kaweth_download_firmware(struct kaweth_device
*kaweth
,
397 const struct firmware
*fw
;
401 ret
= request_firmware(&fw
, fwname
, &kaweth
->dev
->dev
);
403 err("Firmware request failed\n");
407 if (fw
->size
> KAWETH_FIRMWARE_BUF_SIZE
) {
408 err("Firmware too big: %zu", fw
->size
);
409 release_firmware(fw
);
413 memcpy(kaweth
->firmware_buf
, fw
->data
, fw
->size
);
415 release_firmware(fw
);
417 kaweth
->firmware_buf
[2] = (data_len
& 0xFF) - 7;
418 kaweth
->firmware_buf
[3] = data_len
>> 8;
419 kaweth
->firmware_buf
[4] = type
;
420 kaweth
->firmware_buf
[5] = interrupt
;
422 dbg("High: %i, Low:%i", kaweth
->firmware_buf
[3],
423 kaweth
->firmware_buf
[2]);
425 dbg("Downloading firmware at %p to kaweth device at %p",
427 dbg("Firmware length: %d", data_len
);
429 return kaweth_control(kaweth
,
430 usb_sndctrlpipe(kaweth
->dev
, 0),
432 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
435 (void *)kaweth
->firmware_buf
,
437 KAWETH_CONTROL_TIMEOUT
);
440 /****************************************************************
441 * kaweth_trigger_firmware
442 ****************************************************************/
443 static int kaweth_trigger_firmware(struct kaweth_device
*kaweth
,
446 kaweth
->firmware_buf
[0] = 0xB6;
447 kaweth
->firmware_buf
[1] = 0xC3;
448 kaweth
->firmware_buf
[2] = 0x01;
449 kaweth
->firmware_buf
[3] = 0x00;
450 kaweth
->firmware_buf
[4] = 0x06;
451 kaweth
->firmware_buf
[5] = interrupt
;
452 kaweth
->firmware_buf
[6] = 0x00;
453 kaweth
->firmware_buf
[7] = 0x00;
455 dbg("Triggering firmware");
457 return kaweth_control(kaweth
,
458 usb_sndctrlpipe(kaweth
->dev
, 0),
460 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
463 (void *)kaweth
->firmware_buf
,
465 KAWETH_CONTROL_TIMEOUT
);
468 /****************************************************************
470 ****************************************************************/
471 static int kaweth_reset(struct kaweth_device
*kaweth
)
475 dbg("kaweth_reset(%p)", kaweth
);
476 result
= usb_reset_configuration(kaweth
->dev
);
479 dbg("kaweth_reset() returns %d.",result
);
484 static void kaweth_usb_receive(struct urb
*);
485 static int kaweth_resubmit_rx_urb(struct kaweth_device
*, gfp_t
);
487 /****************************************************************
489 *****************************************************************/
491 static void kaweth_resubmit_int_urb(struct kaweth_device
*kaweth
, gfp_t mf
)
495 status
= usb_submit_urb (kaweth
->irq_urb
, mf
);
496 if (unlikely(status
== -ENOMEM
)) {
497 kaweth
->suspend_lowmem_ctrl
= 1;
498 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
500 kaweth
->suspend_lowmem_ctrl
= 0;
504 err ("can't resubmit intr, %s-%s, status %d",
505 kaweth
->dev
->bus
->bus_name
,
506 kaweth
->dev
->devpath
, status
);
509 static void int_callback(struct urb
*u
)
511 struct kaweth_device
*kaweth
= u
->context
;
513 int status
= u
->status
;
516 case 0: /* success */
518 case -ECONNRESET
: /* unlink */
522 /* -EPIPE: should clear the halt */
527 /* we check the link state to report changes */
528 if (kaweth
->linkstate
!= (act_state
= ( kaweth
->intbuffer
[STATE_OFFSET
] | STATE_MASK
) >> STATE_SHIFT
)) {
530 netif_carrier_on(kaweth
->net
);
532 netif_carrier_off(kaweth
->net
);
534 kaweth
->linkstate
= act_state
;
537 kaweth_resubmit_int_urb(kaweth
, GFP_ATOMIC
);
540 static void kaweth_resubmit_tl(struct work_struct
*work
)
542 struct kaweth_device
*kaweth
=
543 container_of(work
, struct kaweth_device
, lowmem_work
.work
);
545 if (IS_BLOCKED(kaweth
->status
))
548 if (kaweth
->suspend_lowmem_rx
)
549 kaweth_resubmit_rx_urb(kaweth
, GFP_NOIO
);
551 if (kaweth
->suspend_lowmem_ctrl
)
552 kaweth_resubmit_int_urb(kaweth
, GFP_NOIO
);
556 /****************************************************************
557 * kaweth_resubmit_rx_urb
558 ****************************************************************/
559 static int kaweth_resubmit_rx_urb(struct kaweth_device
*kaweth
,
564 usb_fill_bulk_urb(kaweth
->rx_urb
,
566 usb_rcvbulkpipe(kaweth
->dev
, 1),
571 kaweth
->rx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
572 kaweth
->rx_urb
->transfer_dma
= kaweth
->rxbufferhandle
;
574 if((result
= usb_submit_urb(kaweth
->rx_urb
, mem_flags
))) {
575 if (result
== -ENOMEM
) {
576 kaweth
->suspend_lowmem_rx
= 1;
577 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
579 err("resubmitting rx_urb %d failed", result
);
581 kaweth
->suspend_lowmem_rx
= 0;
587 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
);
589 /****************************************************************
591 ****************************************************************/
592 static void kaweth_usb_receive(struct urb
*urb
)
594 struct kaweth_device
*kaweth
= urb
->context
;
595 struct net_device
*net
= kaweth
->net
;
596 int status
= urb
->status
;
598 int count
= urb
->actual_length
;
599 int count2
= urb
->transfer_buffer_length
;
601 __u16 pkt_len
= le16_to_cpup((__le16
*)kaweth
->rx_buf
);
605 if (unlikely(status
== -EPIPE
)) {
606 kaweth
->stats
.rx_errors
++;
608 wake_up(&kaweth
->term_wait
);
609 dbg("Status was -EPIPE.");
612 if (unlikely(status
== -ECONNRESET
|| status
== -ESHUTDOWN
)) {
613 /* we are killed - set a flag and wake the disconnect handler */
615 wake_up(&kaweth
->term_wait
);
616 dbg("Status was -ECONNRESET or -ESHUTDOWN.");
619 if (unlikely(status
== -EPROTO
|| status
== -ETIME
||
620 status
== -EILSEQ
)) {
621 kaweth
->stats
.rx_errors
++;
622 dbg("Status was -EPROTO, -ETIME, or -EILSEQ.");
625 if (unlikely(status
== -EOVERFLOW
)) {
626 kaweth
->stats
.rx_errors
++;
627 dbg("Status was -EOVERFLOW.");
629 spin_lock(&kaweth
->device_lock
);
630 if (IS_BLOCKED(kaweth
->status
)) {
631 spin_unlock(&kaweth
->device_lock
);
634 spin_unlock(&kaweth
->device_lock
);
636 if(status
&& status
!= -EREMOTEIO
&& count
!= 1) {
637 err("%s RX status: %d count: %d packet_len: %d",
642 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
646 if(kaweth
->net
&& (count
> 2)) {
647 if(pkt_len
> (count
- 2)) {
648 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len
, count
);
649 err("Packet len & 2047: %x", pkt_len
& 2047);
650 err("Count 2: %x", count2
);
651 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
655 if(!(skb
= dev_alloc_skb(pkt_len
+2))) {
656 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
660 skb_reserve(skb
, 2); /* Align IP on 16 byte boundaries */
662 skb_copy_to_linear_data(skb
, kaweth
->rx_buf
+ 2, pkt_len
);
664 skb_put(skb
, pkt_len
);
666 skb
->protocol
= eth_type_trans(skb
, net
);
670 kaweth
->stats
.rx_packets
++;
671 kaweth
->stats
.rx_bytes
+= pkt_len
;
674 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
677 /****************************************************************
679 ****************************************************************/
680 static int kaweth_open(struct net_device
*net
)
682 struct kaweth_device
*kaweth
= netdev_priv(net
);
685 dbg("Opening network device.");
687 res
= usb_autopm_get_interface(kaweth
->intf
);
689 err("Interface cannot be resumed.");
692 res
= kaweth_resubmit_rx_urb(kaweth
, GFP_KERNEL
);
699 usb_rcvintpipe(kaweth
->dev
, 3),
704 250); /* overriding the descriptor */
705 kaweth
->irq_urb
->transfer_dma
= kaweth
->intbufferhandle
;
706 kaweth
->irq_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
708 res
= usb_submit_urb(kaweth
->irq_urb
, GFP_KERNEL
);
710 usb_kill_urb(kaweth
->rx_urb
);
715 netif_start_queue(net
);
717 kaweth_async_set_rx_mode(kaweth
);
721 usb_autopm_put_interface(kaweth
->intf
);
725 /****************************************************************
727 ****************************************************************/
728 static void kaweth_kill_urbs(struct kaweth_device
*kaweth
)
730 usb_kill_urb(kaweth
->irq_urb
);
731 usb_kill_urb(kaweth
->rx_urb
);
732 usb_kill_urb(kaweth
->tx_urb
);
734 cancel_delayed_work_sync(&kaweth
->lowmem_work
);
736 /* a scheduled work may have resubmitted,
738 usb_kill_urb(kaweth
->irq_urb
);
739 usb_kill_urb(kaweth
->rx_urb
);
742 /****************************************************************
744 ****************************************************************/
745 static int kaweth_close(struct net_device
*net
)
747 struct kaweth_device
*kaweth
= netdev_priv(net
);
749 netif_stop_queue(net
);
752 kaweth
->status
|= KAWETH_STATUS_CLOSING
;
754 kaweth_kill_urbs(kaweth
);
756 kaweth
->status
&= ~KAWETH_STATUS_CLOSING
;
758 usb_autopm_put_interface(kaweth
->intf
);
763 static u32
kaweth_get_link(struct net_device
*dev
)
765 struct kaweth_device
*kaweth
= netdev_priv(dev
);
767 return kaweth
->linkstate
;
770 static const struct ethtool_ops ops
= {
771 .get_link
= kaweth_get_link
774 /****************************************************************
775 * kaweth_usb_transmit_complete
776 ****************************************************************/
777 static void kaweth_usb_transmit_complete(struct urb
*urb
)
779 struct kaweth_device
*kaweth
= urb
->context
;
780 struct sk_buff
*skb
= kaweth
->tx_skb
;
781 int status
= urb
->status
;
783 if (unlikely(status
!= 0))
784 if (status
!= -ENOENT
)
785 dbg("%s: TX status %d.", kaweth
->net
->name
, status
);
787 netif_wake_queue(kaweth
->net
);
788 dev_kfree_skb_irq(skb
);
791 /****************************************************************
793 ****************************************************************/
794 static netdev_tx_t
kaweth_start_xmit(struct sk_buff
*skb
,
795 struct net_device
*net
)
797 struct kaweth_device
*kaweth
= netdev_priv(net
);
798 __le16
*private_header
;
802 spin_lock_irq(&kaweth
->device_lock
);
804 kaweth_async_set_rx_mode(kaweth
);
805 netif_stop_queue(net
);
806 if (IS_BLOCKED(kaweth
->status
)) {
810 /* We now decide whether we can put our special header into the sk_buff */
811 if (skb_cloned(skb
) || skb_headroom(skb
) < 2) {
812 /* no such luck - we make our own */
813 struct sk_buff
*copied_skb
;
814 copied_skb
= skb_copy_expand(skb
, 2, 0, GFP_ATOMIC
);
815 dev_kfree_skb_irq(skb
);
818 kaweth
->stats
.tx_errors
++;
819 netif_start_queue(net
);
820 spin_unlock_irq(&kaweth
->device_lock
);
825 private_header
= (__le16
*)__skb_push(skb
, 2);
826 *private_header
= cpu_to_le16(skb
->len
-2);
827 kaweth
->tx_skb
= skb
;
829 usb_fill_bulk_urb(kaweth
->tx_urb
,
831 usb_sndbulkpipe(kaweth
->dev
, 2),
834 kaweth_usb_transmit_complete
,
838 if((res
= usb_submit_urb(kaweth
->tx_urb
, GFP_ATOMIC
)))
840 dev_warn(&net
->dev
, "kaweth failed tx_urb %d\n", res
);
842 kaweth
->stats
.tx_errors
++;
844 netif_start_queue(net
);
845 dev_kfree_skb_irq(skb
);
849 kaweth
->stats
.tx_packets
++;
850 kaweth
->stats
.tx_bytes
+= skb
->len
;
853 spin_unlock_irq(&kaweth
->device_lock
);
858 /****************************************************************
860 ****************************************************************/
861 static void kaweth_set_rx_mode(struct net_device
*net
)
863 struct kaweth_device
*kaweth
= netdev_priv(net
);
865 __u16 packet_filter_bitmap
= KAWETH_PACKET_FILTER_DIRECTED
|
866 KAWETH_PACKET_FILTER_BROADCAST
|
867 KAWETH_PACKET_FILTER_MULTICAST
;
869 dbg("Setting Rx mode to %d", packet_filter_bitmap
);
871 netif_stop_queue(net
);
873 if (net
->flags
& IFF_PROMISC
) {
874 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_PROMISCUOUS
;
876 else if (!netdev_mc_empty(net
) || (net
->flags
& IFF_ALLMULTI
)) {
877 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_ALL_MULTICAST
;
880 kaweth
->packet_filter_bitmap
= packet_filter_bitmap
;
881 netif_wake_queue(net
);
884 /****************************************************************
885 * kaweth_async_set_rx_mode
886 ****************************************************************/
887 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
)
890 __u16 packet_filter_bitmap
= kaweth
->packet_filter_bitmap
;
892 kaweth
->packet_filter_bitmap
= 0;
893 if (packet_filter_bitmap
== 0)
899 result
= kaweth_control(kaweth
,
900 usb_sndctrlpipe(kaweth
->dev
, 0),
901 KAWETH_COMMAND_SET_PACKET_FILTER
,
902 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
903 packet_filter_bitmap
,
905 (void *)&kaweth
->scratch
,
907 KAWETH_CONTROL_TIMEOUT
);
910 err("Failed to set Rx mode: %d", result
);
913 dbg("Set Rx mode to %d", packet_filter_bitmap
);
917 /****************************************************************
918 * kaweth_netdev_stats
919 ****************************************************************/
920 static struct net_device_stats
*kaweth_netdev_stats(struct net_device
*dev
)
922 struct kaweth_device
*kaweth
= netdev_priv(dev
);
923 return &kaweth
->stats
;
926 /****************************************************************
928 ****************************************************************/
929 static void kaweth_tx_timeout(struct net_device
*net
)
931 struct kaweth_device
*kaweth
= netdev_priv(net
);
933 dev_warn(&net
->dev
, "%s: Tx timed out. Resetting.\n", net
->name
);
934 kaweth
->stats
.tx_errors
++;
935 net
->trans_start
= jiffies
;
937 usb_unlink_urb(kaweth
->tx_urb
);
940 /****************************************************************
942 ****************************************************************/
943 static int kaweth_suspend(struct usb_interface
*intf
, pm_message_t message
)
945 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
948 dbg("Suspending device");
949 spin_lock_irqsave(&kaweth
->device_lock
, flags
);
950 kaweth
->status
|= KAWETH_STATUS_SUSPENDING
;
951 spin_unlock_irqrestore(&kaweth
->device_lock
, flags
);
953 kaweth_kill_urbs(kaweth
);
957 /****************************************************************
959 ****************************************************************/
960 static int kaweth_resume(struct usb_interface
*intf
)
962 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
965 dbg("Resuming device");
966 spin_lock_irqsave(&kaweth
->device_lock
, flags
);
967 kaweth
->status
&= ~KAWETH_STATUS_SUSPENDING
;
968 spin_unlock_irqrestore(&kaweth
->device_lock
, flags
);
972 kaweth_resubmit_rx_urb(kaweth
, GFP_NOIO
);
973 kaweth_resubmit_int_urb(kaweth
, GFP_NOIO
);
978 /****************************************************************
980 ****************************************************************/
983 static const struct net_device_ops kaweth_netdev_ops
= {
984 .ndo_open
= kaweth_open
,
985 .ndo_stop
= kaweth_close
,
986 .ndo_start_xmit
= kaweth_start_xmit
,
987 .ndo_tx_timeout
= kaweth_tx_timeout
,
988 .ndo_set_multicast_list
= kaweth_set_rx_mode
,
989 .ndo_get_stats
= kaweth_netdev_stats
,
990 .ndo_change_mtu
= eth_change_mtu
,
991 .ndo_set_mac_address
= eth_mac_addr
,
992 .ndo_validate_addr
= eth_validate_addr
,
995 static int kaweth_probe(
996 struct usb_interface
*intf
,
997 const struct usb_device_id
*id
/* from id_table */
1000 struct usb_device
*dev
= interface_to_usbdev(intf
);
1001 struct kaweth_device
*kaweth
;
1002 struct net_device
*netdev
;
1003 const eth_addr_t bcast_addr
= { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1006 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1008 le16_to_cpu(dev
->descriptor
.idVendor
),
1009 le16_to_cpu(dev
->descriptor
.idProduct
),
1010 le16_to_cpu(dev
->descriptor
.bcdDevice
));
1012 dbg("Device at %p", dev
);
1014 dbg("Descriptor length: %x type: %x",
1015 (int)dev
->descriptor
.bLength
,
1016 (int)dev
->descriptor
.bDescriptorType
);
1018 netdev
= alloc_etherdev(sizeof(*kaweth
));
1022 kaweth
= netdev_priv(netdev
);
1024 kaweth
->net
= netdev
;
1026 spin_lock_init(&kaweth
->device_lock
);
1027 init_waitqueue_head(&kaweth
->term_wait
);
1031 kaweth_reset(kaweth
);
1034 * If high byte of bcdDevice is nonzero, firmware is already
1035 * downloaded. Don't try to do it again, or we'll hang the device.
1038 if (le16_to_cpu(dev
->descriptor
.bcdDevice
) >> 8) {
1039 dev_info(&intf
->dev
, "Firmware present in device.\n");
1041 /* Download the firmware */
1042 dev_info(&intf
->dev
, "Downloading firmware...\n");
1043 kaweth
->firmware_buf
= (__u8
*)__get_free_page(GFP_KERNEL
);
1044 if ((result
= kaweth_download_firmware(kaweth
,
1045 "kaweth/new_code.bin",
1048 err("Error downloading firmware (%d)", result
);
1052 if ((result
= kaweth_download_firmware(kaweth
,
1053 "kaweth/new_code_fix.bin",
1056 err("Error downloading firmware fix (%d)", result
);
1060 if ((result
= kaweth_download_firmware(kaweth
,
1061 "kaweth/trigger_code.bin",
1064 err("Error downloading trigger code (%d)", result
);
1069 if ((result
= kaweth_download_firmware(kaweth
,
1070 "kaweth/trigger_code_fix.bin",
1073 err("Error downloading trigger code fix (%d)", result
);
1078 if ((result
= kaweth_trigger_firmware(kaweth
, 126)) < 0) {
1079 err("Error triggering firmware (%d)", result
);
1083 /* Device will now disappear for a moment... */
1084 dev_info(&intf
->dev
, "Firmware loaded. I'll be back...\n");
1086 free_page((unsigned long)kaweth
->firmware_buf
);
1087 free_netdev(netdev
);
1091 result
= kaweth_read_configuration(kaweth
);
1094 err("Error reading configuration (%d), no net device created", result
);
1095 goto err_free_netdev
;
1098 dev_info(&intf
->dev
, "Statistics collection: %x\n", kaweth
->configuration
.statistics_mask
);
1099 dev_info(&intf
->dev
, "Multicast filter limit: %x\n", kaweth
->configuration
.max_multicast_filters
& ((1 << 15) - 1));
1100 dev_info(&intf
->dev
, "MTU: %d\n", le16_to_cpu(kaweth
->configuration
.segment_size
));
1101 dev_info(&intf
->dev
, "Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1102 (int)kaweth
->configuration
.hw_addr
[0],
1103 (int)kaweth
->configuration
.hw_addr
[1],
1104 (int)kaweth
->configuration
.hw_addr
[2],
1105 (int)kaweth
->configuration
.hw_addr
[3],
1106 (int)kaweth
->configuration
.hw_addr
[4],
1107 (int)kaweth
->configuration
.hw_addr
[5]);
1109 if(!memcmp(&kaweth
->configuration
.hw_addr
,
1111 sizeof(bcast_addr
))) {
1112 err("Firmware not functioning properly, no net device created");
1113 goto err_free_netdev
;
1116 if(kaweth_set_urb_size(kaweth
, KAWETH_BUF_SIZE
) < 0) {
1117 dbg("Error setting URB size");
1118 goto err_free_netdev
;
1121 if(kaweth_set_sofs_wait(kaweth
, KAWETH_SOFS_TO_WAIT
) < 0) {
1122 err("Error setting SOFS wait");
1123 goto err_free_netdev
;
1126 result
= kaweth_set_receive_filter(kaweth
,
1127 KAWETH_PACKET_FILTER_DIRECTED
|
1128 KAWETH_PACKET_FILTER_BROADCAST
|
1129 KAWETH_PACKET_FILTER_MULTICAST
);
1132 err("Error setting receive filter");
1133 goto err_free_netdev
;
1136 dbg("Initializing net device.");
1138 kaweth
->intf
= intf
;
1140 kaweth
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1141 if (!kaweth
->tx_urb
)
1142 goto err_free_netdev
;
1143 kaweth
->rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1144 if (!kaweth
->rx_urb
)
1146 kaweth
->irq_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1147 if (!kaweth
->irq_urb
)
1150 kaweth
->intbuffer
= usb_alloc_coherent( kaweth
->dev
,
1153 &kaweth
->intbufferhandle
);
1154 if (!kaweth
->intbuffer
)
1155 goto err_tx_and_rx_and_irq
;
1156 kaweth
->rx_buf
= usb_alloc_coherent( kaweth
->dev
,
1159 &kaweth
->rxbufferhandle
);
1160 if (!kaweth
->rx_buf
)
1161 goto err_all_but_rxbuf
;
1163 memcpy(netdev
->broadcast
, &bcast_addr
, sizeof(bcast_addr
));
1164 memcpy(netdev
->dev_addr
, &kaweth
->configuration
.hw_addr
,
1165 sizeof(kaweth
->configuration
.hw_addr
));
1167 netdev
->netdev_ops
= &kaweth_netdev_ops
;
1168 netdev
->watchdog_timeo
= KAWETH_TX_TIMEOUT
;
1169 netdev
->mtu
= le16_to_cpu(kaweth
->configuration
.segment_size
);
1170 SET_ETHTOOL_OPS(netdev
, &ops
);
1172 /* kaweth is zeroed as part of alloc_netdev */
1173 INIT_DELAYED_WORK(&kaweth
->lowmem_work
, kaweth_resubmit_tl
);
1174 usb_set_intfdata(intf
, kaweth
);
1177 // dma_supported() is deeply broken on almost all architectures
1178 if (dma_supported (&intf
->dev
, 0xffffffffffffffffULL
))
1179 kaweth
->net
->features
|= NETIF_F_HIGHDMA
;
1182 SET_NETDEV_DEV(netdev
, &intf
->dev
);
1183 if (register_netdev(netdev
) != 0) {
1184 err("Error registering netdev.");
1188 dev_info(&intf
->dev
, "kaweth interface created at %s\n",
1191 dbg("Kaweth probe returning.");
1196 usb_set_intfdata(intf
, NULL
);
1197 usb_free_coherent(kaweth
->dev
, KAWETH_BUF_SIZE
, (void *)kaweth
->rx_buf
, kaweth
->rxbufferhandle
);
1199 usb_free_coherent(kaweth
->dev
, INTBUFFERSIZE
, (void *)kaweth
->intbuffer
, kaweth
->intbufferhandle
);
1200 err_tx_and_rx_and_irq
:
1201 usb_free_urb(kaweth
->irq_urb
);
1203 usb_free_urb(kaweth
->rx_urb
);
1205 usb_free_urb(kaweth
->tx_urb
);
1207 free_netdev(netdev
);
1212 /****************************************************************
1214 ****************************************************************/
1215 static void kaweth_disconnect(struct usb_interface
*intf
)
1217 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
1218 struct net_device
*netdev
;
1220 dev_info(&intf
->dev
, "Unregistering\n");
1222 usb_set_intfdata(intf
, NULL
);
1224 dev_warn(&intf
->dev
, "unregistering non-existant device\n");
1227 netdev
= kaweth
->net
;
1229 dbg("Unregistering net device");
1230 unregister_netdev(netdev
);
1232 usb_free_urb(kaweth
->rx_urb
);
1233 usb_free_urb(kaweth
->tx_urb
);
1234 usb_free_urb(kaweth
->irq_urb
);
1236 usb_free_coherent(kaweth
->dev
, KAWETH_BUF_SIZE
, (void *)kaweth
->rx_buf
, kaweth
->rxbufferhandle
);
1237 usb_free_coherent(kaweth
->dev
, INTBUFFERSIZE
, (void *)kaweth
->intbuffer
, kaweth
->intbufferhandle
);
1239 free_netdev(netdev
);
1243 // FIXME this completion stuff is a modified clone of
1244 // an OLD version of some stuff in usb.c ...
1245 struct usb_api_data
{
1246 wait_queue_head_t wqh
;
1250 /*-------------------------------------------------------------------*
1251 * completion handler for compatibility wrappers (sync control/bulk) *
1252 *-------------------------------------------------------------------*/
1253 static void usb_api_blocking_completion(struct urb
*urb
)
1255 struct usb_api_data
*awd
= (struct usb_api_data
*)urb
->context
;
1261 /*-------------------------------------------------------------------*
1262 * COMPATIBILITY STUFF *
1263 *-------------------------------------------------------------------*/
1265 // Starts urb and waits for completion or timeout
1266 static int usb_start_wait_urb(struct urb
*urb
, int timeout
, int* actual_length
)
1268 struct usb_api_data awd
;
1271 init_waitqueue_head(&awd
.wqh
);
1274 urb
->context
= &awd
;
1275 status
= usb_submit_urb(urb
, GFP_NOIO
);
1277 // something went wrong
1282 if (!wait_event_timeout(awd
.wqh
, awd
.done
, timeout
)) {
1284 dev_warn(&urb
->dev
->dev
, "usb_control/bulk_msg: timeout\n");
1285 usb_kill_urb(urb
); // remove urb safely
1286 status
= -ETIMEDOUT
;
1289 status
= urb
->status
;
1292 if (actual_length
) {
1293 *actual_length
= urb
->actual_length
;
1300 /*-------------------------------------------------------------------*/
1301 // returns status (negative) or length (positive)
1302 static int kaweth_internal_control_msg(struct usb_device
*usb_dev
,
1304 struct usb_ctrlrequest
*cmd
, void *data
,
1305 int len
, int timeout
)
1309 int length
= 0; /* shut up GCC */
1311 urb
= usb_alloc_urb(0, GFP_NOIO
);
1315 usb_fill_control_urb(urb
, usb_dev
, pipe
, (unsigned char*)cmd
, data
,
1316 len
, usb_api_blocking_completion
, NULL
);
1318 retv
= usb_start_wait_urb(urb
, timeout
, &length
);
1328 /****************************************************************
1330 ****************************************************************/
1331 static int __init
kaweth_init(void)
1333 dbg("Driver loading");
1334 return usb_register(&kaweth_driver
);
1337 /****************************************************************
1339 ****************************************************************/
1340 static void __exit
kaweth_exit(void)
1342 usb_deregister(&kaweth_driver
);
1345 module_init(kaweth_init
);
1346 module_exit(kaweth_exit
);