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
39 * Reduce arbitrary timeouts
40 * Smart multicast support
41 * Temporary MAC change support
42 * Tunable SOFs parameter - ioctl()?
43 * Ethernet stats collection
44 * Code formatting improvements
47 #include <linux/module.h>
48 #include <linux/slab.h>
49 #include <linux/string.h>
50 #include <linux/init.h>
51 #include <linux/delay.h>
52 #include <linux/netdevice.h>
53 #include <linux/etherdevice.h>
54 #include <linux/usb.h>
55 #include <linux/types.h>
56 #include <linux/ethtool.h>
57 #include <linux/dma-mapping.h>
58 #include <linux/wait.h>
59 #include <linux/firmware.h>
60 #include <asm/uaccess.h>
61 #include <asm/byteorder.h>
65 #define KAWETH_MTU 1514
66 #define KAWETH_BUF_SIZE 1664
67 #define KAWETH_TX_TIMEOUT (5 * HZ)
68 #define KAWETH_SCRATCH_SIZE 32
69 #define KAWETH_FIRMWARE_BUF_SIZE 4096
70 #define KAWETH_CONTROL_TIMEOUT (30000)
72 #define KAWETH_STATUS_BROKEN 0x0000001
73 #define KAWETH_STATUS_CLOSING 0x0000002
74 #define KAWETH_STATUS_SUSPENDING 0x0000004
76 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
78 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
79 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
80 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
81 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
82 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
85 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
86 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
87 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
88 #define KAWETH_COMMAND_STATISTICS 0x03
89 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
90 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
91 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
92 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
93 #define KAWETH_COMMAND_SCAN 0xFF
95 #define KAWETH_SOFS_TO_WAIT 0x05
97 #define INTBUFFERSIZE 4
99 #define STATE_OFFSET 0
100 #define STATE_MASK 0x40
101 #define STATE_SHIFT 5
103 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
106 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>");
107 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
108 MODULE_LICENSE("GPL");
109 MODULE_FIRMWARE("kaweth/new_code.bin");
110 MODULE_FIRMWARE("kaweth/new_code_fix.bin");
111 MODULE_FIRMWARE("kaweth/trigger_code.bin");
112 MODULE_FIRMWARE("kaweth/trigger_code_fix.bin");
114 static const char driver_name
[] = "kaweth";
116 static int kaweth_probe(
117 struct usb_interface
*intf
,
118 const struct usb_device_id
*id
/* from id_table */
120 static void kaweth_disconnect(struct usb_interface
*intf
);
121 static int kaweth_internal_control_msg(struct usb_device
*usb_dev
,
123 struct usb_ctrlrequest
*cmd
, void *data
,
124 int len
, int timeout
);
125 static int kaweth_suspend(struct usb_interface
*intf
, pm_message_t message
);
126 static int kaweth_resume(struct usb_interface
*intf
);
128 /****************************************************************
130 ****************************************************************/
131 static struct usb_device_id usb_klsi_table
[] = {
132 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
133 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
134 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
135 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
136 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
137 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
138 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
139 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
140 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
141 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
142 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
143 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
144 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
145 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
146 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
147 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
148 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
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
;
210 } __attribute__ ((packed
));
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
;
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 return kaweth_internal_control_msg(kaweth
->dev
,
296 /****************************************************************
297 * kaweth_read_configuration
298 ****************************************************************/
299 static int kaweth_read_configuration(struct kaweth_device
*kaweth
)
303 dbg("Reading kaweth configuration");
305 retval
= kaweth_control(kaweth
,
306 usb_rcvctrlpipe(kaweth
->dev
, 0),
307 KAWETH_COMMAND_GET_ETHERNET_DESC
,
308 USB_TYPE_VENDOR
| USB_DIR_IN
| USB_RECIP_DEVICE
,
311 (void *)&kaweth
->configuration
,
312 sizeof(kaweth
->configuration
),
313 KAWETH_CONTROL_TIMEOUT
);
318 /****************************************************************
319 * kaweth_set_urb_size
320 ****************************************************************/
321 static int kaweth_set_urb_size(struct kaweth_device
*kaweth
, __u16 urb_size
)
325 dbg("Setting URB size to %d", (unsigned)urb_size
);
327 retval
= kaweth_control(kaweth
,
328 usb_sndctrlpipe(kaweth
->dev
, 0),
329 KAWETH_COMMAND_SET_URB_SIZE
,
330 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
333 (void *)&kaweth
->scratch
,
335 KAWETH_CONTROL_TIMEOUT
);
340 /****************************************************************
341 * kaweth_set_sofs_wait
342 ****************************************************************/
343 static int kaweth_set_sofs_wait(struct kaweth_device
*kaweth
, __u16 sofs_wait
)
347 dbg("Set SOFS wait to %d", (unsigned)sofs_wait
);
349 retval
= kaweth_control(kaweth
,
350 usb_sndctrlpipe(kaweth
->dev
, 0),
351 KAWETH_COMMAND_SET_SOFS_WAIT
,
352 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
355 (void *)&kaweth
->scratch
,
357 KAWETH_CONTROL_TIMEOUT
);
362 /****************************************************************
363 * kaweth_set_receive_filter
364 ****************************************************************/
365 static int kaweth_set_receive_filter(struct kaweth_device
*kaweth
,
366 __u16 receive_filter
)
370 dbg("Set receive filter to %d", (unsigned)receive_filter
);
372 retval
= kaweth_control(kaweth
,
373 usb_sndctrlpipe(kaweth
->dev
, 0),
374 KAWETH_COMMAND_SET_PACKET_FILTER
,
375 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
378 (void *)&kaweth
->scratch
,
380 KAWETH_CONTROL_TIMEOUT
);
385 /****************************************************************
386 * kaweth_download_firmware
387 ****************************************************************/
388 static int kaweth_download_firmware(struct kaweth_device
*kaweth
,
393 const struct firmware
*fw
;
397 ret
= request_firmware(&fw
, fwname
, &kaweth
->dev
->dev
);
399 err("Firmware request failed\n");
403 if (fw
->size
> KAWETH_FIRMWARE_BUF_SIZE
) {
404 err("Firmware too big: %zu", fw
->size
);
408 memcpy(kaweth
->firmware_buf
, fw
->data
, fw
->size
);
410 release_firmware(fw
);
412 kaweth
->firmware_buf
[2] = (data_len
& 0xFF) - 7;
413 kaweth
->firmware_buf
[3] = data_len
>> 8;
414 kaweth
->firmware_buf
[4] = type
;
415 kaweth
->firmware_buf
[5] = interrupt
;
417 dbg("High: %i, Low:%i", kaweth
->firmware_buf
[3],
418 kaweth
->firmware_buf
[2]);
420 dbg("Downloading firmware at %p to kaweth device at %p",
422 dbg("Firmware length: %d", data_len
);
424 return kaweth_control(kaweth
,
425 usb_sndctrlpipe(kaweth
->dev
, 0),
427 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
430 (void *)kaweth
->firmware_buf
,
432 KAWETH_CONTROL_TIMEOUT
);
435 /****************************************************************
436 * kaweth_trigger_firmware
437 ****************************************************************/
438 static int kaweth_trigger_firmware(struct kaweth_device
*kaweth
,
441 kaweth
->firmware_buf
[0] = 0xB6;
442 kaweth
->firmware_buf
[1] = 0xC3;
443 kaweth
->firmware_buf
[2] = 0x01;
444 kaweth
->firmware_buf
[3] = 0x00;
445 kaweth
->firmware_buf
[4] = 0x06;
446 kaweth
->firmware_buf
[5] = interrupt
;
447 kaweth
->firmware_buf
[6] = 0x00;
448 kaweth
->firmware_buf
[7] = 0x00;
450 dbg("Triggering firmware");
452 return kaweth_control(kaweth
,
453 usb_sndctrlpipe(kaweth
->dev
, 0),
455 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
458 (void *)kaweth
->firmware_buf
,
460 KAWETH_CONTROL_TIMEOUT
);
463 /****************************************************************
465 ****************************************************************/
466 static int kaweth_reset(struct kaweth_device
*kaweth
)
470 dbg("kaweth_reset(%p)", kaweth
);
471 result
= kaweth_control(kaweth
,
472 usb_sndctrlpipe(kaweth
->dev
, 0),
473 USB_REQ_SET_CONFIGURATION
,
475 kaweth
->dev
->config
[0].desc
.bConfigurationValue
,
479 KAWETH_CONTROL_TIMEOUT
);
483 dbg("kaweth_reset() returns %d.",result
);
488 static void kaweth_usb_receive(struct urb
*);
489 static int kaweth_resubmit_rx_urb(struct kaweth_device
*, gfp_t
);
491 /****************************************************************
493 *****************************************************************/
495 static void kaweth_resubmit_int_urb(struct kaweth_device
*kaweth
, gfp_t mf
)
499 status
= usb_submit_urb (kaweth
->irq_urb
, mf
);
500 if (unlikely(status
== -ENOMEM
)) {
501 kaweth
->suspend_lowmem_ctrl
= 1;
502 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
504 kaweth
->suspend_lowmem_ctrl
= 0;
508 err ("can't resubmit intr, %s-%s, status %d",
509 kaweth
->dev
->bus
->bus_name
,
510 kaweth
->dev
->devpath
, status
);
513 static void int_callback(struct urb
*u
)
515 struct kaweth_device
*kaweth
= u
->context
;
517 int status
= u
->status
;
520 case 0: /* success */
522 case -ECONNRESET
: /* unlink */
526 /* -EPIPE: should clear the halt */
531 /* we check the link state to report changes */
532 if (kaweth
->linkstate
!= (act_state
= ( kaweth
->intbuffer
[STATE_OFFSET
] | STATE_MASK
) >> STATE_SHIFT
)) {
534 netif_carrier_on(kaweth
->net
);
536 netif_carrier_off(kaweth
->net
);
538 kaweth
->linkstate
= act_state
;
541 kaweth_resubmit_int_urb(kaweth
, GFP_ATOMIC
);
544 static void kaweth_resubmit_tl(struct work_struct
*work
)
546 struct kaweth_device
*kaweth
=
547 container_of(work
, struct kaweth_device
, lowmem_work
.work
);
549 if (IS_BLOCKED(kaweth
->status
))
552 if (kaweth
->suspend_lowmem_rx
)
553 kaweth_resubmit_rx_urb(kaweth
, GFP_NOIO
);
555 if (kaweth
->suspend_lowmem_ctrl
)
556 kaweth_resubmit_int_urb(kaweth
, GFP_NOIO
);
560 /****************************************************************
561 * kaweth_resubmit_rx_urb
562 ****************************************************************/
563 static int kaweth_resubmit_rx_urb(struct kaweth_device
*kaweth
,
568 usb_fill_bulk_urb(kaweth
->rx_urb
,
570 usb_rcvbulkpipe(kaweth
->dev
, 1),
575 kaweth
->rx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
576 kaweth
->rx_urb
->transfer_dma
= kaweth
->rxbufferhandle
;
578 if((result
= usb_submit_urb(kaweth
->rx_urb
, mem_flags
))) {
579 if (result
== -ENOMEM
) {
580 kaweth
->suspend_lowmem_rx
= 1;
581 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
583 err("resubmitting rx_urb %d failed", result
);
585 kaweth
->suspend_lowmem_rx
= 0;
591 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
);
593 /****************************************************************
595 ****************************************************************/
596 static void kaweth_usb_receive(struct urb
*urb
)
598 struct kaweth_device
*kaweth
= urb
->context
;
599 struct net_device
*net
= kaweth
->net
;
600 int status
= urb
->status
;
602 int count
= urb
->actual_length
;
603 int count2
= urb
->transfer_buffer_length
;
605 __u16 pkt_len
= le16_to_cpup((__le16
*)kaweth
->rx_buf
);
609 if(unlikely(status
== -ECONNRESET
|| status
== -ESHUTDOWN
))
610 /* we are killed - set a flag and wake the disconnect handler */
613 wake_up(&kaweth
->term_wait
);
617 spin_lock(&kaweth
->device_lock
);
618 if (IS_BLOCKED(kaweth
->status
)) {
619 spin_unlock(&kaweth
->device_lock
);
622 spin_unlock(&kaweth
->device_lock
);
624 if(status
&& status
!= -EREMOTEIO
&& count
!= 1) {
625 err("%s RX status: %d count: %d packet_len: %d",
630 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
634 if(kaweth
->net
&& (count
> 2)) {
635 if(pkt_len
> (count
- 2)) {
636 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len
, count
);
637 err("Packet len & 2047: %x", pkt_len
& 2047);
638 err("Count 2: %x", count2
);
639 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
643 if(!(skb
= dev_alloc_skb(pkt_len
+2))) {
644 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
648 skb_reserve(skb
, 2); /* Align IP on 16 byte boundaries */
650 skb_copy_to_linear_data(skb
, kaweth
->rx_buf
+ 2, pkt_len
);
652 skb_put(skb
, pkt_len
);
654 skb
->protocol
= eth_type_trans(skb
, net
);
658 kaweth
->stats
.rx_packets
++;
659 kaweth
->stats
.rx_bytes
+= pkt_len
;
662 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
665 /****************************************************************
667 ****************************************************************/
668 static int kaweth_open(struct net_device
*net
)
670 struct kaweth_device
*kaweth
= netdev_priv(net
);
673 dbg("Opening network device.");
675 res
= usb_autopm_get_interface(kaweth
->intf
);
677 err("Interface cannot be resumed.");
680 res
= kaweth_resubmit_rx_urb(kaweth
, GFP_KERNEL
);
687 usb_rcvintpipe(kaweth
->dev
, 3),
692 250); /* overriding the descriptor */
693 kaweth
->irq_urb
->transfer_dma
= kaweth
->intbufferhandle
;
694 kaweth
->irq_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
696 res
= usb_submit_urb(kaweth
->irq_urb
, GFP_KERNEL
);
698 usb_kill_urb(kaweth
->rx_urb
);
703 netif_start_queue(net
);
705 kaweth_async_set_rx_mode(kaweth
);
709 usb_autopm_enable(kaweth
->intf
);
713 /****************************************************************
715 ****************************************************************/
716 static void kaweth_kill_urbs(struct kaweth_device
*kaweth
)
718 usb_kill_urb(kaweth
->irq_urb
);
719 usb_kill_urb(kaweth
->rx_urb
);
720 usb_kill_urb(kaweth
->tx_urb
);
722 cancel_delayed_work_sync(&kaweth
->lowmem_work
);
724 /* a scheduled work may have resubmitted,
726 usb_kill_urb(kaweth
->irq_urb
);
727 usb_kill_urb(kaweth
->rx_urb
);
730 /****************************************************************
732 ****************************************************************/
733 static int kaweth_close(struct net_device
*net
)
735 struct kaweth_device
*kaweth
= netdev_priv(net
);
737 netif_stop_queue(net
);
740 kaweth
->status
|= KAWETH_STATUS_CLOSING
;
742 kaweth_kill_urbs(kaweth
);
744 kaweth
->status
&= ~KAWETH_STATUS_CLOSING
;
746 usb_autopm_enable(kaweth
->intf
);
751 static void kaweth_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
)
753 struct kaweth_device
*kaweth
= netdev_priv(dev
);
755 strlcpy(info
->driver
, driver_name
, sizeof(info
->driver
));
756 usb_make_path(kaweth
->dev
, info
->bus_info
, sizeof (info
->bus_info
));
759 static u32
kaweth_get_link(struct net_device
*dev
)
761 struct kaweth_device
*kaweth
= netdev_priv(dev
);
763 return kaweth
->linkstate
;
766 static struct ethtool_ops ops
= {
767 .get_drvinfo
= kaweth_get_drvinfo
,
768 .get_link
= kaweth_get_link
771 /****************************************************************
772 * kaweth_usb_transmit_complete
773 ****************************************************************/
774 static void kaweth_usb_transmit_complete(struct urb
*urb
)
776 struct kaweth_device
*kaweth
= urb
->context
;
777 struct sk_buff
*skb
= kaweth
->tx_skb
;
778 int status
= urb
->status
;
780 if (unlikely(status
!= 0))
781 if (status
!= -ENOENT
)
782 dbg("%s: TX status %d.", kaweth
->net
->name
, status
);
784 netif_wake_queue(kaweth
->net
);
785 dev_kfree_skb_irq(skb
);
788 /****************************************************************
790 ****************************************************************/
791 static int kaweth_start_xmit(struct sk_buff
*skb
, struct net_device
*net
)
793 struct kaweth_device
*kaweth
= netdev_priv(net
);
794 __le16
*private_header
;
798 spin_lock_irq(&kaweth
->device_lock
);
800 kaweth_async_set_rx_mode(kaweth
);
801 netif_stop_queue(net
);
802 if (IS_BLOCKED(kaweth
->status
)) {
806 /* We now decide whether we can put our special header into the sk_buff */
807 if (skb_cloned(skb
) || skb_headroom(skb
) < 2) {
808 /* no such luck - we make our own */
809 struct sk_buff
*copied_skb
;
810 copied_skb
= skb_copy_expand(skb
, 2, 0, GFP_ATOMIC
);
811 dev_kfree_skb_irq(skb
);
814 kaweth
->stats
.tx_errors
++;
815 netif_start_queue(net
);
816 spin_unlock_irq(&kaweth
->device_lock
);
821 private_header
= (__le16
*)__skb_push(skb
, 2);
822 *private_header
= cpu_to_le16(skb
->len
-2);
823 kaweth
->tx_skb
= skb
;
825 usb_fill_bulk_urb(kaweth
->tx_urb
,
827 usb_sndbulkpipe(kaweth
->dev
, 2),
830 kaweth_usb_transmit_complete
,
834 if((res
= usb_submit_urb(kaweth
->tx_urb
, GFP_ATOMIC
)))
836 dev_warn(&net
->dev
, "kaweth failed tx_urb %d\n", res
);
838 kaweth
->stats
.tx_errors
++;
840 netif_start_queue(net
);
841 dev_kfree_skb_irq(skb
);
845 kaweth
->stats
.tx_packets
++;
846 kaweth
->stats
.tx_bytes
+= skb
->len
;
847 net
->trans_start
= jiffies
;
850 spin_unlock_irq(&kaweth
->device_lock
);
855 /****************************************************************
857 ****************************************************************/
858 static void kaweth_set_rx_mode(struct net_device
*net
)
860 struct kaweth_device
*kaweth
= netdev_priv(net
);
862 __u16 packet_filter_bitmap
= KAWETH_PACKET_FILTER_DIRECTED
|
863 KAWETH_PACKET_FILTER_BROADCAST
|
864 KAWETH_PACKET_FILTER_MULTICAST
;
866 dbg("Setting Rx mode to %d", packet_filter_bitmap
);
868 netif_stop_queue(net
);
870 if (net
->flags
& IFF_PROMISC
) {
871 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_PROMISCUOUS
;
873 else if ((net
->mc_count
) || (net
->flags
& IFF_ALLMULTI
)) {
874 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_ALL_MULTICAST
;
877 kaweth
->packet_filter_bitmap
= packet_filter_bitmap
;
878 netif_wake_queue(net
);
881 /****************************************************************
882 * kaweth_async_set_rx_mode
883 ****************************************************************/
884 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
)
886 __u16 packet_filter_bitmap
= kaweth
->packet_filter_bitmap
;
887 kaweth
->packet_filter_bitmap
= 0;
888 if (packet_filter_bitmap
== 0)
893 result
= kaweth_control(kaweth
,
894 usb_sndctrlpipe(kaweth
->dev
, 0),
895 KAWETH_COMMAND_SET_PACKET_FILTER
,
896 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
897 packet_filter_bitmap
,
899 (void *)&kaweth
->scratch
,
901 KAWETH_CONTROL_TIMEOUT
);
904 err("Failed to set Rx mode: %d", result
);
907 dbg("Set Rx mode to %d", packet_filter_bitmap
);
912 /****************************************************************
913 * kaweth_netdev_stats
914 ****************************************************************/
915 static struct net_device_stats
*kaweth_netdev_stats(struct net_device
*dev
)
917 struct kaweth_device
*kaweth
= netdev_priv(dev
);
918 return &kaweth
->stats
;
921 /****************************************************************
923 ****************************************************************/
924 static void kaweth_tx_timeout(struct net_device
*net
)
926 struct kaweth_device
*kaweth
= netdev_priv(net
);
928 dev_warn(&net
->dev
, "%s: Tx timed out. Resetting.\n", net
->name
);
929 kaweth
->stats
.tx_errors
++;
930 net
->trans_start
= jiffies
;
932 usb_unlink_urb(kaweth
->tx_urb
);
935 /****************************************************************
937 ****************************************************************/
938 static int kaweth_suspend(struct usb_interface
*intf
, pm_message_t message
)
940 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
943 dbg("Suspending device");
944 spin_lock_irqsave(&kaweth
->device_lock
, flags
);
945 kaweth
->status
|= KAWETH_STATUS_SUSPENDING
;
946 spin_unlock_irqrestore(&kaweth
->device_lock
, flags
);
948 kaweth_kill_urbs(kaweth
);
952 /****************************************************************
954 ****************************************************************/
955 static int kaweth_resume(struct usb_interface
*intf
)
957 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
960 dbg("Resuming device");
961 spin_lock_irqsave(&kaweth
->device_lock
, flags
);
962 kaweth
->status
&= ~KAWETH_STATUS_SUSPENDING
;
963 spin_unlock_irqrestore(&kaweth
->device_lock
, flags
);
967 kaweth_resubmit_rx_urb(kaweth
, GFP_NOIO
);
968 kaweth_resubmit_int_urb(kaweth
, GFP_NOIO
);
973 /****************************************************************
975 ****************************************************************/
978 static const struct net_device_ops kaweth_netdev_ops
= {
979 .ndo_open
= kaweth_open
,
980 .ndo_stop
= kaweth_close
,
981 .ndo_start_xmit
= kaweth_start_xmit
,
982 .ndo_tx_timeout
= kaweth_tx_timeout
,
983 .ndo_set_multicast_list
= kaweth_set_rx_mode
,
984 .ndo_get_stats
= kaweth_netdev_stats
,
987 static int kaweth_probe(
988 struct usb_interface
*intf
,
989 const struct usb_device_id
*id
/* from id_table */
992 struct usb_device
*dev
= interface_to_usbdev(intf
);
993 struct kaweth_device
*kaweth
;
994 struct net_device
*netdev
;
995 const eth_addr_t bcast_addr
= { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
998 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1000 le16_to_cpu(dev
->descriptor
.idVendor
),
1001 le16_to_cpu(dev
->descriptor
.idProduct
),
1002 le16_to_cpu(dev
->descriptor
.bcdDevice
));
1004 dbg("Device at %p", dev
);
1006 dbg("Descriptor length: %x type: %x",
1007 (int)dev
->descriptor
.bLength
,
1008 (int)dev
->descriptor
.bDescriptorType
);
1010 netdev
= alloc_etherdev(sizeof(*kaweth
));
1014 kaweth
= netdev_priv(netdev
);
1016 kaweth
->net
= netdev
;
1018 spin_lock_init(&kaweth
->device_lock
);
1019 init_waitqueue_head(&kaweth
->term_wait
);
1023 kaweth_reset(kaweth
);
1026 * If high byte of bcdDevice is nonzero, firmware is already
1027 * downloaded. Don't try to do it again, or we'll hang the device.
1030 if (le16_to_cpu(dev
->descriptor
.bcdDevice
) >> 8) {
1031 dev_info(&intf
->dev
, "Firmware present in device.\n");
1033 /* Download the firmware */
1034 dev_info(&intf
->dev
, "Downloading firmware...\n");
1035 kaweth
->firmware_buf
= (__u8
*)__get_free_page(GFP_KERNEL
);
1036 if ((result
= kaweth_download_firmware(kaweth
,
1037 "kaweth/new_code.bin",
1040 err("Error downloading firmware (%d)", result
);
1044 if ((result
= kaweth_download_firmware(kaweth
,
1045 "kaweth/new_code_fix.bin",
1048 err("Error downloading firmware fix (%d)", result
);
1052 if ((result
= kaweth_download_firmware(kaweth
,
1053 "kaweth/trigger_code.bin",
1056 err("Error downloading trigger code (%d)", result
);
1061 if ((result
= kaweth_download_firmware(kaweth
,
1062 "kaweth/trigger_code_fix.bin",
1065 err("Error downloading trigger code fix (%d)", result
);
1070 if ((result
= kaweth_trigger_firmware(kaweth
, 126)) < 0) {
1071 err("Error triggering firmware (%d)", result
);
1075 /* Device will now disappear for a moment... */
1076 dev_info(&intf
->dev
, "Firmware loaded. I'll be back...\n");
1078 free_page((unsigned long)kaweth
->firmware_buf
);
1079 free_netdev(netdev
);
1083 result
= kaweth_read_configuration(kaweth
);
1086 err("Error reading configuration (%d), no net device created", result
);
1087 goto err_free_netdev
;
1090 dev_info(&intf
->dev
, "Statistics collection: %x\n", kaweth
->configuration
.statistics_mask
);
1091 dev_info(&intf
->dev
, "Multicast filter limit: %x\n", kaweth
->configuration
.max_multicast_filters
& ((1 << 15) - 1));
1092 dev_info(&intf
->dev
, "MTU: %d\n", le16_to_cpu(kaweth
->configuration
.segment_size
));
1093 dev_info(&intf
->dev
, "Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1094 (int)kaweth
->configuration
.hw_addr
[0],
1095 (int)kaweth
->configuration
.hw_addr
[1],
1096 (int)kaweth
->configuration
.hw_addr
[2],
1097 (int)kaweth
->configuration
.hw_addr
[3],
1098 (int)kaweth
->configuration
.hw_addr
[4],
1099 (int)kaweth
->configuration
.hw_addr
[5]);
1101 if(!memcmp(&kaweth
->configuration
.hw_addr
,
1103 sizeof(bcast_addr
))) {
1104 err("Firmware not functioning properly, no net device created");
1105 goto err_free_netdev
;
1108 if(kaweth_set_urb_size(kaweth
, KAWETH_BUF_SIZE
) < 0) {
1109 dbg("Error setting URB size");
1110 goto err_free_netdev
;
1113 if(kaweth_set_sofs_wait(kaweth
, KAWETH_SOFS_TO_WAIT
) < 0) {
1114 err("Error setting SOFS wait");
1115 goto err_free_netdev
;
1118 result
= kaweth_set_receive_filter(kaweth
,
1119 KAWETH_PACKET_FILTER_DIRECTED
|
1120 KAWETH_PACKET_FILTER_BROADCAST
|
1121 KAWETH_PACKET_FILTER_MULTICAST
);
1124 err("Error setting receive filter");
1125 goto err_free_netdev
;
1128 dbg("Initializing net device.");
1130 kaweth
->intf
= intf
;
1132 kaweth
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1133 if (!kaweth
->tx_urb
)
1134 goto err_free_netdev
;
1135 kaweth
->rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1136 if (!kaweth
->rx_urb
)
1138 kaweth
->irq_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1139 if (!kaweth
->irq_urb
)
1142 kaweth
->intbuffer
= usb_buffer_alloc( kaweth
->dev
,
1145 &kaweth
->intbufferhandle
);
1146 if (!kaweth
->intbuffer
)
1147 goto err_tx_and_rx_and_irq
;
1148 kaweth
->rx_buf
= usb_buffer_alloc( kaweth
->dev
,
1151 &kaweth
->rxbufferhandle
);
1152 if (!kaweth
->rx_buf
)
1153 goto err_all_but_rxbuf
;
1155 memcpy(netdev
->broadcast
, &bcast_addr
, sizeof(bcast_addr
));
1156 memcpy(netdev
->dev_addr
, &kaweth
->configuration
.hw_addr
,
1157 sizeof(kaweth
->configuration
.hw_addr
));
1159 netdev
->netdev_ops
= &kaweth_netdev_ops
;
1160 netdev
->watchdog_timeo
= KAWETH_TX_TIMEOUT
;
1161 netdev
->mtu
= le16_to_cpu(kaweth
->configuration
.segment_size
);
1162 SET_ETHTOOL_OPS(netdev
, &ops
);
1164 /* kaweth is zeroed as part of alloc_netdev */
1165 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
);