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,
182 .disable_hub_initiated_lpm
= 1,
185 typedef __u8 eth_addr_t
[6];
187 /****************************************************************
189 ****************************************************************/
197 /****************************************************************
198 * kaweth_ethernet_configuration
200 ****************************************************************/
201 struct kaweth_ethernet_configuration
207 __u32 statistics_mask
;
209 __u16 max_multicast_filters
;
213 /****************************************************************
215 ****************************************************************/
218 spinlock_t device_lock
;
222 int suspend_lowmem_rx
;
223 int suspend_lowmem_ctrl
;
226 struct delayed_work lowmem_work
;
228 struct usb_device
*dev
;
229 struct usb_interface
*intf
;
230 struct net_device
*net
;
231 wait_queue_head_t term_wait
;
237 dma_addr_t intbufferhandle
;
239 dma_addr_t rxbufferhandle
;
243 struct sk_buff
*tx_skb
;
246 __u8 scratch
[KAWETH_SCRATCH_SIZE
];
247 __u16 packet_filter_bitmap
;
249 struct kaweth_ethernet_configuration configuration
;
251 struct net_device_stats stats
;
254 /****************************************************************
256 ****************************************************************/
257 static int kaweth_control(struct kaweth_device
*kaweth
,
267 struct usb_ctrlrequest
*dr
;
270 netdev_dbg(kaweth
->net
, "kaweth_control()\n");
273 netdev_dbg(kaweth
->net
, "in_interrupt()\n");
277 dr
= kmalloc(sizeof(struct usb_ctrlrequest
), GFP_ATOMIC
);
281 dr
->bRequestType
= requesttype
;
282 dr
->bRequest
= request
;
283 dr
->wValue
= cpu_to_le16(value
);
284 dr
->wIndex
= cpu_to_le16(index
);
285 dr
->wLength
= cpu_to_le16(size
);
287 retval
= kaweth_internal_control_msg(kaweth
->dev
,
298 /****************************************************************
299 * kaweth_read_configuration
300 ****************************************************************/
301 static int kaweth_read_configuration(struct kaweth_device
*kaweth
)
305 netdev_dbg(kaweth
->net
, "Reading kaweth configuration\n");
307 retval
= kaweth_control(kaweth
,
308 usb_rcvctrlpipe(kaweth
->dev
, 0),
309 KAWETH_COMMAND_GET_ETHERNET_DESC
,
310 USB_TYPE_VENDOR
| USB_DIR_IN
| USB_RECIP_DEVICE
,
313 (void *)&kaweth
->configuration
,
314 sizeof(kaweth
->configuration
),
315 KAWETH_CONTROL_TIMEOUT
);
320 /****************************************************************
321 * kaweth_set_urb_size
322 ****************************************************************/
323 static int kaweth_set_urb_size(struct kaweth_device
*kaweth
, __u16 urb_size
)
327 netdev_dbg(kaweth
->net
, "Setting URB size to %d\n", (unsigned)urb_size
);
329 retval
= kaweth_control(kaweth
,
330 usb_sndctrlpipe(kaweth
->dev
, 0),
331 KAWETH_COMMAND_SET_URB_SIZE
,
332 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
335 (void *)&kaweth
->scratch
,
337 KAWETH_CONTROL_TIMEOUT
);
342 /****************************************************************
343 * kaweth_set_sofs_wait
344 ****************************************************************/
345 static int kaweth_set_sofs_wait(struct kaweth_device
*kaweth
, __u16 sofs_wait
)
349 netdev_dbg(kaweth
->net
, "Set SOFS wait to %d\n", (unsigned)sofs_wait
);
351 retval
= kaweth_control(kaweth
,
352 usb_sndctrlpipe(kaweth
->dev
, 0),
353 KAWETH_COMMAND_SET_SOFS_WAIT
,
354 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
357 (void *)&kaweth
->scratch
,
359 KAWETH_CONTROL_TIMEOUT
);
364 /****************************************************************
365 * kaweth_set_receive_filter
366 ****************************************************************/
367 static int kaweth_set_receive_filter(struct kaweth_device
*kaweth
,
368 __u16 receive_filter
)
372 netdev_dbg(kaweth
->net
, "Set receive filter to %d\n",
373 (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 dev_err(&kaweth
->intf
->dev
, "Firmware request failed\n");
406 if (fw
->size
> KAWETH_FIRMWARE_BUF_SIZE
) {
407 dev_err(&kaweth
->intf
->dev
, "Firmware too big: %zu\n",
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 netdev_dbg(kaweth
->net
, "High: %i, Low:%i\n", kaweth
->firmware_buf
[3],
423 kaweth
->firmware_buf
[2]);
425 netdev_dbg(kaweth
->net
,
426 "Downloading firmware at %p to kaweth device at %p\n",
427 kaweth
->firmware_buf
, kaweth
);
428 netdev_dbg(kaweth
->net
, "Firmware length: %d\n", data_len
);
430 return kaweth_control(kaweth
,
431 usb_sndctrlpipe(kaweth
->dev
, 0),
433 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
436 (void *)kaweth
->firmware_buf
,
438 KAWETH_CONTROL_TIMEOUT
);
441 /****************************************************************
442 * kaweth_trigger_firmware
443 ****************************************************************/
444 static int kaweth_trigger_firmware(struct kaweth_device
*kaweth
,
447 kaweth
->firmware_buf
[0] = 0xB6;
448 kaweth
->firmware_buf
[1] = 0xC3;
449 kaweth
->firmware_buf
[2] = 0x01;
450 kaweth
->firmware_buf
[3] = 0x00;
451 kaweth
->firmware_buf
[4] = 0x06;
452 kaweth
->firmware_buf
[5] = interrupt
;
453 kaweth
->firmware_buf
[6] = 0x00;
454 kaweth
->firmware_buf
[7] = 0x00;
456 netdev_dbg(kaweth
->net
, "Triggering firmware\n");
458 return kaweth_control(kaweth
,
459 usb_sndctrlpipe(kaweth
->dev
, 0),
461 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
464 (void *)kaweth
->firmware_buf
,
466 KAWETH_CONTROL_TIMEOUT
);
469 /****************************************************************
471 ****************************************************************/
472 static int kaweth_reset(struct kaweth_device
*kaweth
)
476 netdev_dbg(kaweth
->net
, "kaweth_reset(%p)\n", kaweth
);
477 result
= usb_reset_configuration(kaweth
->dev
);
480 netdev_dbg(kaweth
->net
, "kaweth_reset() returns %d.\n", result
);
485 static void kaweth_usb_receive(struct urb
*);
486 static int kaweth_resubmit_rx_urb(struct kaweth_device
*, gfp_t
);
488 /****************************************************************
490 *****************************************************************/
492 static void kaweth_resubmit_int_urb(struct kaweth_device
*kaweth
, gfp_t mf
)
496 status
= usb_submit_urb (kaweth
->irq_urb
, mf
);
497 if (unlikely(status
== -ENOMEM
)) {
498 kaweth
->suspend_lowmem_ctrl
= 1;
499 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
501 kaweth
->suspend_lowmem_ctrl
= 0;
505 dev_err(&kaweth
->intf
->dev
,
506 "can't resubmit intr, %s-%s, status %d\n",
507 kaweth
->dev
->bus
->bus_name
,
508 kaweth
->dev
->devpath
, status
);
511 static void int_callback(struct urb
*u
)
513 struct kaweth_device
*kaweth
= u
->context
;
515 int status
= u
->status
;
518 case 0: /* success */
520 case -ECONNRESET
: /* unlink */
524 /* -EPIPE: should clear the halt */
529 /* we check the link state to report changes */
530 if (kaweth
->linkstate
!= (act_state
= ( kaweth
->intbuffer
[STATE_OFFSET
] | STATE_MASK
) >> STATE_SHIFT
)) {
532 netif_carrier_on(kaweth
->net
);
534 netif_carrier_off(kaweth
->net
);
536 kaweth
->linkstate
= act_state
;
539 kaweth_resubmit_int_urb(kaweth
, GFP_ATOMIC
);
542 static void kaweth_resubmit_tl(struct work_struct
*work
)
544 struct kaweth_device
*kaweth
=
545 container_of(work
, struct kaweth_device
, lowmem_work
.work
);
547 if (IS_BLOCKED(kaweth
->status
))
550 if (kaweth
->suspend_lowmem_rx
)
551 kaweth_resubmit_rx_urb(kaweth
, GFP_NOIO
);
553 if (kaweth
->suspend_lowmem_ctrl
)
554 kaweth_resubmit_int_urb(kaweth
, GFP_NOIO
);
558 /****************************************************************
559 * kaweth_resubmit_rx_urb
560 ****************************************************************/
561 static int kaweth_resubmit_rx_urb(struct kaweth_device
*kaweth
,
566 usb_fill_bulk_urb(kaweth
->rx_urb
,
568 usb_rcvbulkpipe(kaweth
->dev
, 1),
573 kaweth
->rx_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
574 kaweth
->rx_urb
->transfer_dma
= kaweth
->rxbufferhandle
;
576 if((result
= usb_submit_urb(kaweth
->rx_urb
, mem_flags
))) {
577 if (result
== -ENOMEM
) {
578 kaweth
->suspend_lowmem_rx
= 1;
579 schedule_delayed_work(&kaweth
->lowmem_work
, HZ
/4);
581 dev_err(&kaweth
->intf
->dev
, "resubmitting rx_urb %d failed\n",
584 kaweth
->suspend_lowmem_rx
= 0;
590 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
);
592 /****************************************************************
594 ****************************************************************/
595 static void kaweth_usb_receive(struct urb
*urb
)
597 struct device
*dev
= &urb
->dev
->dev
;
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
== -EPIPE
)) {
610 kaweth
->stats
.rx_errors
++;
612 wake_up(&kaweth
->term_wait
);
613 dev_dbg(dev
, "Status was -EPIPE.\n");
616 if (unlikely(status
== -ECONNRESET
|| status
== -ESHUTDOWN
)) {
617 /* we are killed - set a flag and wake the disconnect handler */
619 wake_up(&kaweth
->term_wait
);
620 dev_dbg(dev
, "Status was -ECONNRESET or -ESHUTDOWN.\n");
623 if (unlikely(status
== -EPROTO
|| status
== -ETIME
||
624 status
== -EILSEQ
)) {
625 kaweth
->stats
.rx_errors
++;
626 dev_dbg(dev
, "Status was -EPROTO, -ETIME, or -EILSEQ.\n");
629 if (unlikely(status
== -EOVERFLOW
)) {
630 kaweth
->stats
.rx_errors
++;
631 dev_dbg(dev
, "Status was -EOVERFLOW.\n");
633 spin_lock(&kaweth
->device_lock
);
634 if (IS_BLOCKED(kaweth
->status
)) {
635 spin_unlock(&kaweth
->device_lock
);
638 spin_unlock(&kaweth
->device_lock
);
640 if(status
&& status
!= -EREMOTEIO
&& count
!= 1) {
641 dev_err(&kaweth
->intf
->dev
,
642 "%s RX status: %d count: %d packet_len: %d\n",
643 net
->name
, status
, count
, (int)pkt_len
);
644 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
648 if(kaweth
->net
&& (count
> 2)) {
649 if(pkt_len
> (count
- 2)) {
650 dev_err(&kaweth
->intf
->dev
,
651 "Packet length too long for USB frame (pkt_len: %x, count: %x)\n",
653 dev_err(&kaweth
->intf
->dev
, "Packet len & 2047: %x\n",
655 dev_err(&kaweth
->intf
->dev
, "Count 2: %x\n", count2
);
656 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
660 if(!(skb
= dev_alloc_skb(pkt_len
+2))) {
661 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
665 skb_reserve(skb
, 2); /* Align IP on 16 byte boundaries */
667 skb_copy_to_linear_data(skb
, kaweth
->rx_buf
+ 2, pkt_len
);
669 skb_put(skb
, pkt_len
);
671 skb
->protocol
= eth_type_trans(skb
, net
);
675 kaweth
->stats
.rx_packets
++;
676 kaweth
->stats
.rx_bytes
+= pkt_len
;
679 kaweth_resubmit_rx_urb(kaweth
, GFP_ATOMIC
);
682 /****************************************************************
684 ****************************************************************/
685 static int kaweth_open(struct net_device
*net
)
687 struct kaweth_device
*kaweth
= netdev_priv(net
);
690 netdev_dbg(kaweth
->net
, "Opening network device.\n");
692 res
= usb_autopm_get_interface(kaweth
->intf
);
694 dev_err(&kaweth
->intf
->dev
, "Interface cannot be resumed.\n");
697 res
= kaweth_resubmit_rx_urb(kaweth
, GFP_KERNEL
);
704 usb_rcvintpipe(kaweth
->dev
, 3),
709 250); /* overriding the descriptor */
710 kaweth
->irq_urb
->transfer_dma
= kaweth
->intbufferhandle
;
711 kaweth
->irq_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
713 res
= usb_submit_urb(kaweth
->irq_urb
, GFP_KERNEL
);
715 usb_kill_urb(kaweth
->rx_urb
);
720 netif_start_queue(net
);
722 kaweth_async_set_rx_mode(kaweth
);
726 usb_autopm_put_interface(kaweth
->intf
);
730 /****************************************************************
732 ****************************************************************/
733 static void kaweth_kill_urbs(struct kaweth_device
*kaweth
)
735 usb_kill_urb(kaweth
->irq_urb
);
736 usb_kill_urb(kaweth
->rx_urb
);
737 usb_kill_urb(kaweth
->tx_urb
);
739 cancel_delayed_work_sync(&kaweth
->lowmem_work
);
741 /* a scheduled work may have resubmitted,
743 usb_kill_urb(kaweth
->irq_urb
);
744 usb_kill_urb(kaweth
->rx_urb
);
747 /****************************************************************
749 ****************************************************************/
750 static int kaweth_close(struct net_device
*net
)
752 struct kaweth_device
*kaweth
= netdev_priv(net
);
754 netif_stop_queue(net
);
757 kaweth
->status
|= KAWETH_STATUS_CLOSING
;
759 kaweth_kill_urbs(kaweth
);
761 kaweth
->status
&= ~KAWETH_STATUS_CLOSING
;
763 usb_autopm_put_interface(kaweth
->intf
);
768 static u32
kaweth_get_link(struct net_device
*dev
)
770 struct kaweth_device
*kaweth
= netdev_priv(dev
);
772 return kaweth
->linkstate
;
775 static const struct ethtool_ops ops
= {
776 .get_link
= kaweth_get_link
779 /****************************************************************
780 * kaweth_usb_transmit_complete
781 ****************************************************************/
782 static void kaweth_usb_transmit_complete(struct urb
*urb
)
784 struct kaweth_device
*kaweth
= urb
->context
;
785 struct sk_buff
*skb
= kaweth
->tx_skb
;
786 int status
= urb
->status
;
788 if (unlikely(status
!= 0))
789 if (status
!= -ENOENT
)
790 dev_dbg(&urb
->dev
->dev
, "%s: TX status %d.\n",
791 kaweth
->net
->name
, status
);
793 netif_wake_queue(kaweth
->net
);
794 dev_kfree_skb_irq(skb
);
797 /****************************************************************
799 ****************************************************************/
800 static netdev_tx_t
kaweth_start_xmit(struct sk_buff
*skb
,
801 struct net_device
*net
)
803 struct kaweth_device
*kaweth
= netdev_priv(net
);
804 __le16
*private_header
;
808 spin_lock_irq(&kaweth
->device_lock
);
810 kaweth_async_set_rx_mode(kaweth
);
811 netif_stop_queue(net
);
812 if (IS_BLOCKED(kaweth
->status
)) {
816 /* We now decide whether we can put our special header into the sk_buff */
817 if (skb_cloned(skb
) || skb_headroom(skb
) < 2) {
818 /* no such luck - we make our own */
819 struct sk_buff
*copied_skb
;
820 copied_skb
= skb_copy_expand(skb
, 2, 0, GFP_ATOMIC
);
821 dev_kfree_skb_irq(skb
);
824 kaweth
->stats
.tx_errors
++;
825 netif_start_queue(net
);
826 spin_unlock_irq(&kaweth
->device_lock
);
831 private_header
= (__le16
*)__skb_push(skb
, 2);
832 *private_header
= cpu_to_le16(skb
->len
-2);
833 kaweth
->tx_skb
= skb
;
835 usb_fill_bulk_urb(kaweth
->tx_urb
,
837 usb_sndbulkpipe(kaweth
->dev
, 2),
840 kaweth_usb_transmit_complete
,
844 if((res
= usb_submit_urb(kaweth
->tx_urb
, GFP_ATOMIC
)))
846 dev_warn(&net
->dev
, "kaweth failed tx_urb %d\n", res
);
848 kaweth
->stats
.tx_errors
++;
850 netif_start_queue(net
);
851 dev_kfree_skb_irq(skb
);
855 kaweth
->stats
.tx_packets
++;
856 kaweth
->stats
.tx_bytes
+= skb
->len
;
859 spin_unlock_irq(&kaweth
->device_lock
);
864 /****************************************************************
866 ****************************************************************/
867 static void kaweth_set_rx_mode(struct net_device
*net
)
869 struct kaweth_device
*kaweth
= netdev_priv(net
);
871 __u16 packet_filter_bitmap
= KAWETH_PACKET_FILTER_DIRECTED
|
872 KAWETH_PACKET_FILTER_BROADCAST
|
873 KAWETH_PACKET_FILTER_MULTICAST
;
875 netdev_dbg(net
, "Setting Rx mode to %d\n", packet_filter_bitmap
);
877 netif_stop_queue(net
);
879 if (net
->flags
& IFF_PROMISC
) {
880 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_PROMISCUOUS
;
882 else if (!netdev_mc_empty(net
) || (net
->flags
& IFF_ALLMULTI
)) {
883 packet_filter_bitmap
|= KAWETH_PACKET_FILTER_ALL_MULTICAST
;
886 kaweth
->packet_filter_bitmap
= packet_filter_bitmap
;
887 netif_wake_queue(net
);
890 /****************************************************************
891 * kaweth_async_set_rx_mode
892 ****************************************************************/
893 static void kaweth_async_set_rx_mode(struct kaweth_device
*kaweth
)
896 __u16 packet_filter_bitmap
= kaweth
->packet_filter_bitmap
;
898 kaweth
->packet_filter_bitmap
= 0;
899 if (packet_filter_bitmap
== 0)
905 result
= kaweth_control(kaweth
,
906 usb_sndctrlpipe(kaweth
->dev
, 0),
907 KAWETH_COMMAND_SET_PACKET_FILTER
,
908 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_DEVICE
,
909 packet_filter_bitmap
,
911 (void *)&kaweth
->scratch
,
913 KAWETH_CONTROL_TIMEOUT
);
916 dev_err(&kaweth
->intf
->dev
, "Failed to set Rx mode: %d\n",
920 netdev_dbg(kaweth
->net
, "Set Rx mode to %d\n",
921 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 dev_dbg(&intf
->dev
, "Suspending device\n");
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 dev_dbg(&intf
->dev
, "Resuming device\n");
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_rx_mode
= 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 device
*dev
= &intf
->dev
;
1009 struct usb_device
*udev
= interface_to_usbdev(intf
);
1010 struct kaweth_device
*kaweth
;
1011 struct net_device
*netdev
;
1012 const eth_addr_t bcast_addr
= { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1016 "Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x\n",
1017 udev
->devnum
, le16_to_cpu(udev
->descriptor
.idVendor
),
1018 le16_to_cpu(udev
->descriptor
.idProduct
),
1019 le16_to_cpu(udev
->descriptor
.bcdDevice
));
1021 dev_dbg(dev
, "Device at %p\n", udev
);
1023 dev_dbg(dev
, "Descriptor length: %x type: %x\n",
1024 (int)udev
->descriptor
.bLength
,
1025 (int)udev
->descriptor
.bDescriptorType
);
1027 netdev
= alloc_etherdev(sizeof(*kaweth
));
1031 kaweth
= netdev_priv(netdev
);
1033 kaweth
->net
= netdev
;
1035 spin_lock_init(&kaweth
->device_lock
);
1036 init_waitqueue_head(&kaweth
->term_wait
);
1038 dev_dbg(dev
, "Resetting.\n");
1040 kaweth_reset(kaweth
);
1043 * If high byte of bcdDevice is nonzero, firmware is already
1044 * downloaded. Don't try to do it again, or we'll hang the device.
1047 if (le16_to_cpu(udev
->descriptor
.bcdDevice
) >> 8) {
1048 dev_info(dev
, "Firmware present in device.\n");
1050 /* Download the firmware */
1051 dev_info(dev
, "Downloading firmware...\n");
1052 kaweth
->firmware_buf
= (__u8
*)__get_free_page(GFP_KERNEL
);
1053 if ((result
= kaweth_download_firmware(kaweth
,
1054 "kaweth/new_code.bin",
1057 dev_err(dev
, "Error downloading firmware (%d)\n",
1062 if ((result
= kaweth_download_firmware(kaweth
,
1063 "kaweth/new_code_fix.bin",
1066 dev_err(dev
, "Error downloading firmware fix (%d)\n",
1071 if ((result
= kaweth_download_firmware(kaweth
,
1072 "kaweth/trigger_code.bin",
1075 dev_err(dev
, "Error downloading trigger code (%d)\n",
1081 if ((result
= kaweth_download_firmware(kaweth
,
1082 "kaweth/trigger_code_fix.bin",
1085 dev_err(dev
, "Error downloading trigger code fix (%d)\n", result
);
1090 if ((result
= kaweth_trigger_firmware(kaweth
, 126)) < 0) {
1091 dev_err(dev
, "Error triggering firmware (%d)\n", result
);
1095 /* Device will now disappear for a moment... */
1096 dev_info(dev
, "Firmware loaded. I'll be back...\n");
1098 free_page((unsigned long)kaweth
->firmware_buf
);
1099 free_netdev(netdev
);
1103 result
= kaweth_read_configuration(kaweth
);
1106 dev_err(dev
, "Error reading configuration (%d), no net device created\n", result
);
1107 goto err_free_netdev
;
1110 dev_info(dev
, "Statistics collection: %x\n", kaweth
->configuration
.statistics_mask
);
1111 dev_info(dev
, "Multicast filter limit: %x\n", kaweth
->configuration
.max_multicast_filters
& ((1 << 15) - 1));
1112 dev_info(dev
, "MTU: %d\n", le16_to_cpu(kaweth
->configuration
.segment_size
));
1113 dev_info(dev
, "Read MAC address %pM\n", kaweth
->configuration
.hw_addr
);
1115 if(!memcmp(&kaweth
->configuration
.hw_addr
,
1117 sizeof(bcast_addr
))) {
1118 dev_err(dev
, "Firmware not functioning properly, no net device created\n");
1119 goto err_free_netdev
;
1122 if(kaweth_set_urb_size(kaweth
, KAWETH_BUF_SIZE
) < 0) {
1123 dev_dbg(dev
, "Error setting URB size\n");
1124 goto err_free_netdev
;
1127 if(kaweth_set_sofs_wait(kaweth
, KAWETH_SOFS_TO_WAIT
) < 0) {
1128 dev_err(dev
, "Error setting SOFS wait\n");
1129 goto err_free_netdev
;
1132 result
= kaweth_set_receive_filter(kaweth
,
1133 KAWETH_PACKET_FILTER_DIRECTED
|
1134 KAWETH_PACKET_FILTER_BROADCAST
|
1135 KAWETH_PACKET_FILTER_MULTICAST
);
1138 dev_err(dev
, "Error setting receive filter\n");
1139 goto err_free_netdev
;
1142 dev_dbg(dev
, "Initializing net device.\n");
1144 kaweth
->intf
= intf
;
1146 kaweth
->tx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1147 if (!kaweth
->tx_urb
)
1148 goto err_free_netdev
;
1149 kaweth
->rx_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1150 if (!kaweth
->rx_urb
)
1152 kaweth
->irq_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1153 if (!kaweth
->irq_urb
)
1156 kaweth
->intbuffer
= usb_alloc_coherent( kaweth
->dev
,
1159 &kaweth
->intbufferhandle
);
1160 if (!kaweth
->intbuffer
)
1161 goto err_tx_and_rx_and_irq
;
1162 kaweth
->rx_buf
= usb_alloc_coherent( kaweth
->dev
,
1165 &kaweth
->rxbufferhandle
);
1166 if (!kaweth
->rx_buf
)
1167 goto err_all_but_rxbuf
;
1169 memcpy(netdev
->broadcast
, &bcast_addr
, sizeof(bcast_addr
));
1170 memcpy(netdev
->dev_addr
, &kaweth
->configuration
.hw_addr
,
1171 sizeof(kaweth
->configuration
.hw_addr
));
1173 netdev
->netdev_ops
= &kaweth_netdev_ops
;
1174 netdev
->watchdog_timeo
= KAWETH_TX_TIMEOUT
;
1175 netdev
->mtu
= le16_to_cpu(kaweth
->configuration
.segment_size
);
1176 SET_ETHTOOL_OPS(netdev
, &ops
);
1178 /* kaweth is zeroed as part of alloc_netdev */
1179 INIT_DELAYED_WORK(&kaweth
->lowmem_work
, kaweth_resubmit_tl
);
1180 usb_set_intfdata(intf
, kaweth
);
1183 // dma_supported() is deeply broken on almost all architectures
1184 if (dma_supported (dev
, 0xffffffffffffffffULL
))
1185 kaweth
->net
->features
|= NETIF_F_HIGHDMA
;
1188 SET_NETDEV_DEV(netdev
, dev
);
1189 if (register_netdev(netdev
) != 0) {
1190 dev_err(dev
, "Error registering netdev.\n");
1194 dev_info(dev
, "kaweth interface created at %s\n",
1197 dev_dbg(dev
, "Kaweth probe returning.\n");
1202 usb_set_intfdata(intf
, NULL
);
1203 usb_free_coherent(kaweth
->dev
, KAWETH_BUF_SIZE
, (void *)kaweth
->rx_buf
, kaweth
->rxbufferhandle
);
1205 usb_free_coherent(kaweth
->dev
, INTBUFFERSIZE
, (void *)kaweth
->intbuffer
, kaweth
->intbufferhandle
);
1206 err_tx_and_rx_and_irq
:
1207 usb_free_urb(kaweth
->irq_urb
);
1209 usb_free_urb(kaweth
->rx_urb
);
1211 usb_free_urb(kaweth
->tx_urb
);
1213 free_netdev(netdev
);
1218 /****************************************************************
1220 ****************************************************************/
1221 static void kaweth_disconnect(struct usb_interface
*intf
)
1223 struct kaweth_device
*kaweth
= usb_get_intfdata(intf
);
1224 struct net_device
*netdev
;
1226 dev_info(&intf
->dev
, "Unregistering\n");
1228 usb_set_intfdata(intf
, NULL
);
1230 dev_warn(&intf
->dev
, "unregistering non-existent device\n");
1233 netdev
= kaweth
->net
;
1235 netdev_dbg(kaweth
->net
, "Unregistering net device\n");
1236 unregister_netdev(netdev
);
1238 usb_free_urb(kaweth
->rx_urb
);
1239 usb_free_urb(kaweth
->tx_urb
);
1240 usb_free_urb(kaweth
->irq_urb
);
1242 usb_free_coherent(kaweth
->dev
, KAWETH_BUF_SIZE
, (void *)kaweth
->rx_buf
, kaweth
->rxbufferhandle
);
1243 usb_free_coherent(kaweth
->dev
, INTBUFFERSIZE
, (void *)kaweth
->intbuffer
, kaweth
->intbufferhandle
);
1245 free_netdev(netdev
);
1249 // FIXME this completion stuff is a modified clone of
1250 // an OLD version of some stuff in usb.c ...
1251 struct usb_api_data
{
1252 wait_queue_head_t wqh
;
1256 /*-------------------------------------------------------------------*
1257 * completion handler for compatibility wrappers (sync control/bulk) *
1258 *-------------------------------------------------------------------*/
1259 static void usb_api_blocking_completion(struct urb
*urb
)
1261 struct usb_api_data
*awd
= (struct usb_api_data
*)urb
->context
;
1267 /*-------------------------------------------------------------------*
1268 * COMPATIBILITY STUFF *
1269 *-------------------------------------------------------------------*/
1271 // Starts urb and waits for completion or timeout
1272 static int usb_start_wait_urb(struct urb
*urb
, int timeout
, int* actual_length
)
1274 struct usb_api_data awd
;
1277 init_waitqueue_head(&awd
.wqh
);
1280 urb
->context
= &awd
;
1281 status
= usb_submit_urb(urb
, GFP_NOIO
);
1283 // something went wrong
1288 if (!wait_event_timeout(awd
.wqh
, awd
.done
, timeout
)) {
1290 dev_warn(&urb
->dev
->dev
, "usb_control/bulk_msg: timeout\n");
1291 usb_kill_urb(urb
); // remove urb safely
1292 status
= -ETIMEDOUT
;
1295 status
= urb
->status
;
1298 if (actual_length
) {
1299 *actual_length
= urb
->actual_length
;
1306 /*-------------------------------------------------------------------*/
1307 // returns status (negative) or length (positive)
1308 static int kaweth_internal_control_msg(struct usb_device
*usb_dev
,
1310 struct usb_ctrlrequest
*cmd
, void *data
,
1311 int len
, int timeout
)
1315 int length
= 0; /* shut up GCC */
1317 urb
= usb_alloc_urb(0, GFP_ATOMIC
);
1321 usb_fill_control_urb(urb
, usb_dev
, pipe
, (unsigned char*)cmd
, data
,
1322 len
, usb_api_blocking_completion
, NULL
);
1324 retv
= usb_start_wait_urb(urb
, timeout
, &length
);
1333 module_usb_driver(kaweth_driver
);