Merge branch 'master' of master.kernel.org:/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / net / usb / kaweth.c
blob200fe3d525ca5a1ddc04499c265133a51a1db9fe
1 /****************************************************************
3 * kaweth.c - driver for KL5KUSB101 based USB->Ethernet
5 * (c) 2000 Interlan Communications
6 * (c) 2000 Stephane Alnet
7 * (C) 2001 Brad Hards
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 ****************************************************************/
33 /* TODO:
34 * Develop test procedures for USB net interfaces
35 * Run test procedures
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>
62 #undef DEBUG
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
83 /* Table 7 */
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,
121 unsigned int pipe,
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 /****************************************************************
128 * usb_device_id
129 ****************************************************************/
130 static struct usb_device_id usb_klsi_table[] = {
131 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
132 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
133 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
134 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
135 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
136 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
137 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
138 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
139 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
140 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
141 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
142 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
143 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
144 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
145 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
146 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
147 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
148 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
149 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
150 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
151 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
152 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
153 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
154 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
155 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
156 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
157 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
158 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
159 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
160 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
161 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
162 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
163 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
164 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
165 {} /* Null terminator */
168 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
170 /****************************************************************
171 * kaweth_driver
172 ****************************************************************/
173 static struct usb_driver kaweth_driver = {
174 .name = driver_name,
175 .probe = kaweth_probe,
176 .disconnect = kaweth_disconnect,
177 .suspend = kaweth_suspend,
178 .resume = kaweth_resume,
179 .id_table = usb_klsi_table,
180 .supports_autosuspend = 1,
183 typedef __u8 eth_addr_t[6];
185 /****************************************************************
186 * usb_eth_dev
187 ****************************************************************/
188 struct usb_eth_dev {
189 char *name;
190 __u16 vendor;
191 __u16 device;
192 void *pdata;
195 /****************************************************************
196 * kaweth_ethernet_configuration
197 * Refer Table 8
198 ****************************************************************/
199 struct kaweth_ethernet_configuration
201 __u8 size;
202 __u8 reserved1;
203 __u8 reserved2;
204 eth_addr_t hw_addr;
205 __u32 statistics_mask;
206 __le16 segment_size;
207 __u16 max_multicast_filters;
208 __u8 reserved3;
209 } __attribute__ ((packed));
211 /****************************************************************
212 * kaweth_device
213 ****************************************************************/
214 struct kaweth_device
216 spinlock_t device_lock;
218 __u32 status;
219 int end;
220 int suspend_lowmem_rx;
221 int suspend_lowmem_ctrl;
222 int linkstate;
223 int opened;
224 struct delayed_work lowmem_work;
226 struct usb_device *dev;
227 struct usb_interface *intf;
228 struct net_device *net;
229 wait_queue_head_t term_wait;
231 struct urb *rx_urb;
232 struct urb *tx_urb;
233 struct urb *irq_urb;
235 dma_addr_t intbufferhandle;
236 __u8 *intbuffer;
237 dma_addr_t rxbufferhandle;
238 __u8 *rx_buf;
241 struct sk_buff *tx_skb;
243 __u8 *firmware_buf;
244 __u8 scratch[KAWETH_SCRATCH_SIZE];
245 __u16 packet_filter_bitmap;
247 struct kaweth_ethernet_configuration configuration;
249 struct net_device_stats stats;
252 /****************************************************************
253 * kaweth_control
254 ****************************************************************/
255 static int kaweth_control(struct kaweth_device *kaweth,
256 unsigned int pipe,
257 __u8 request,
258 __u8 requesttype,
259 __u16 value,
260 __u16 index,
261 void *data,
262 __u16 size,
263 int timeout)
265 struct usb_ctrlrequest *dr;
267 dbg("kaweth_control()");
269 if(in_interrupt()) {
270 dbg("in_interrupt()");
271 return -EBUSY;
274 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
276 if (!dr) {
277 dbg("kmalloc() failed");
278 return -ENOMEM;
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 return kaweth_internal_control_msg(kaweth->dev,
288 pipe,
290 data,
291 size,
292 timeout);
295 /****************************************************************
296 * kaweth_read_configuration
297 ****************************************************************/
298 static int kaweth_read_configuration(struct kaweth_device *kaweth)
300 int retval;
302 dbg("Reading kaweth configuration");
304 retval = kaweth_control(kaweth,
305 usb_rcvctrlpipe(kaweth->dev, 0),
306 KAWETH_COMMAND_GET_ETHERNET_DESC,
307 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
310 (void *)&kaweth->configuration,
311 sizeof(kaweth->configuration),
312 KAWETH_CONTROL_TIMEOUT);
314 return retval;
317 /****************************************************************
318 * kaweth_set_urb_size
319 ****************************************************************/
320 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
322 int retval;
324 dbg("Setting URB size to %d", (unsigned)urb_size);
326 retval = kaweth_control(kaweth,
327 usb_sndctrlpipe(kaweth->dev, 0),
328 KAWETH_COMMAND_SET_URB_SIZE,
329 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
330 urb_size,
332 (void *)&kaweth->scratch,
334 KAWETH_CONTROL_TIMEOUT);
336 return retval;
339 /****************************************************************
340 * kaweth_set_sofs_wait
341 ****************************************************************/
342 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
344 int retval;
346 dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
348 retval = kaweth_control(kaweth,
349 usb_sndctrlpipe(kaweth->dev, 0),
350 KAWETH_COMMAND_SET_SOFS_WAIT,
351 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
352 sofs_wait,
354 (void *)&kaweth->scratch,
356 KAWETH_CONTROL_TIMEOUT);
358 return retval;
361 /****************************************************************
362 * kaweth_set_receive_filter
363 ****************************************************************/
364 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
365 __u16 receive_filter)
367 int retval;
369 dbg("Set receive filter to %d", (unsigned)receive_filter);
371 retval = kaweth_control(kaweth,
372 usb_sndctrlpipe(kaweth->dev, 0),
373 KAWETH_COMMAND_SET_PACKET_FILTER,
374 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
375 receive_filter,
377 (void *)&kaweth->scratch,
379 KAWETH_CONTROL_TIMEOUT);
381 return retval;
384 /****************************************************************
385 * kaweth_download_firmware
386 ****************************************************************/
387 static int kaweth_download_firmware(struct kaweth_device *kaweth,
388 const char *fwname,
389 __u8 interrupt,
390 __u8 type)
392 const struct firmware *fw;
393 int data_len;
394 int ret;
396 ret = request_firmware(&fw, fwname, &kaweth->dev->dev);
397 if (ret) {
398 err("Firmware request failed\n");
399 return ret;
402 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
403 err("Firmware too big: %zu", fw->size);
404 return -ENOSPC;
406 data_len = fw->size;
407 memcpy(kaweth->firmware_buf, fw->data, fw->size);
409 release_firmware(fw);
411 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
412 kaweth->firmware_buf[3] = data_len >> 8;
413 kaweth->firmware_buf[4] = type;
414 kaweth->firmware_buf[5] = interrupt;
416 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
417 kaweth->firmware_buf[2]);
419 dbg("Downloading firmware at %p to kaweth device at %p",
420 fw->data, kaweth);
421 dbg("Firmware length: %d", data_len);
423 return kaweth_control(kaweth,
424 usb_sndctrlpipe(kaweth->dev, 0),
425 KAWETH_COMMAND_SCAN,
426 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
429 (void *)kaweth->firmware_buf,
430 data_len,
431 KAWETH_CONTROL_TIMEOUT);
434 /****************************************************************
435 * kaweth_trigger_firmware
436 ****************************************************************/
437 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
438 __u8 interrupt)
440 kaweth->firmware_buf[0] = 0xB6;
441 kaweth->firmware_buf[1] = 0xC3;
442 kaweth->firmware_buf[2] = 0x01;
443 kaweth->firmware_buf[3] = 0x00;
444 kaweth->firmware_buf[4] = 0x06;
445 kaweth->firmware_buf[5] = interrupt;
446 kaweth->firmware_buf[6] = 0x00;
447 kaweth->firmware_buf[7] = 0x00;
449 dbg("Triggering firmware");
451 return kaweth_control(kaweth,
452 usb_sndctrlpipe(kaweth->dev, 0),
453 KAWETH_COMMAND_SCAN,
454 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
457 (void *)kaweth->firmware_buf,
459 KAWETH_CONTROL_TIMEOUT);
462 /****************************************************************
463 * kaweth_reset
464 ****************************************************************/
465 static int kaweth_reset(struct kaweth_device *kaweth)
467 int result;
469 dbg("kaweth_reset(%p)", kaweth);
470 result = kaweth_control(kaweth,
471 usb_sndctrlpipe(kaweth->dev, 0),
472 USB_REQ_SET_CONFIGURATION,
474 kaweth->dev->config[0].desc.bConfigurationValue,
476 NULL,
478 KAWETH_CONTROL_TIMEOUT);
480 mdelay(10);
482 dbg("kaweth_reset() returns %d.",result);
484 return result;
487 static void kaweth_usb_receive(struct urb *);
488 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
490 /****************************************************************
491 int_callback
492 *****************************************************************/
494 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
496 int status;
498 status = usb_submit_urb (kaweth->irq_urb, mf);
499 if (unlikely(status == -ENOMEM)) {
500 kaweth->suspend_lowmem_ctrl = 1;
501 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
502 } else {
503 kaweth->suspend_lowmem_ctrl = 0;
506 if (status)
507 err ("can't resubmit intr, %s-%s, status %d",
508 kaweth->dev->bus->bus_name,
509 kaweth->dev->devpath, status);
512 static void int_callback(struct urb *u)
514 struct kaweth_device *kaweth = u->context;
515 int act_state;
516 int status = u->status;
518 switch (status) {
519 case 0: /* success */
520 break;
521 case -ECONNRESET: /* unlink */
522 case -ENOENT:
523 case -ESHUTDOWN:
524 return;
525 /* -EPIPE: should clear the halt */
526 default: /* error */
527 goto resubmit;
530 /* we check the link state to report changes */
531 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
532 if (act_state)
533 netif_carrier_on(kaweth->net);
534 else
535 netif_carrier_off(kaweth->net);
537 kaweth->linkstate = act_state;
539 resubmit:
540 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
543 static void kaweth_resubmit_tl(struct work_struct *work)
545 struct kaweth_device *kaweth =
546 container_of(work, struct kaweth_device, lowmem_work.work);
548 if (IS_BLOCKED(kaweth->status))
549 return;
551 if (kaweth->suspend_lowmem_rx)
552 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
554 if (kaweth->suspend_lowmem_ctrl)
555 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
559 /****************************************************************
560 * kaweth_resubmit_rx_urb
561 ****************************************************************/
562 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
563 gfp_t mem_flags)
565 int result;
567 usb_fill_bulk_urb(kaweth->rx_urb,
568 kaweth->dev,
569 usb_rcvbulkpipe(kaweth->dev, 1),
570 kaweth->rx_buf,
571 KAWETH_BUF_SIZE,
572 kaweth_usb_receive,
573 kaweth);
574 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
575 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
577 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
578 if (result == -ENOMEM) {
579 kaweth->suspend_lowmem_rx = 1;
580 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
582 err("resubmitting rx_urb %d failed", result);
583 } else {
584 kaweth->suspend_lowmem_rx = 0;
587 return result;
590 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
592 /****************************************************************
593 * kaweth_usb_receive
594 ****************************************************************/
595 static void kaweth_usb_receive(struct urb *urb)
597 struct kaweth_device *kaweth = urb->context;
598 struct net_device *net = kaweth->net;
599 int status = urb->status;
601 int count = urb->actual_length;
602 int count2 = urb->transfer_buffer_length;
604 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
606 struct sk_buff *skb;
608 if (unlikely(status == -EPIPE)) {
609 kaweth->stats.rx_errors++;
610 kaweth->end = 1;
611 wake_up(&kaweth->term_wait);
612 dbg("Status was -EPIPE.");
613 return;
615 if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
616 /* we are killed - set a flag and wake the disconnect handler */
617 kaweth->end = 1;
618 wake_up(&kaweth->term_wait);
619 dbg("Status was -ECONNRESET or -ESHUTDOWN.");
620 return;
622 if (unlikely(status == -EPROTO || status == -ETIME ||
623 status == -EILSEQ)) {
624 kaweth->stats.rx_errors++;
625 dbg("Status was -EPROTO, -ETIME, or -EILSEQ.");
626 return;
628 if (unlikely(status == -EOVERFLOW)) {
629 kaweth->stats.rx_errors++;
630 dbg("Status was -EOVERFLOW.");
632 spin_lock(&kaweth->device_lock);
633 if (IS_BLOCKED(kaweth->status)) {
634 spin_unlock(&kaweth->device_lock);
635 return;
637 spin_unlock(&kaweth->device_lock);
639 if(status && status != -EREMOTEIO && count != 1) {
640 err("%s RX status: %d count: %d packet_len: %d",
641 net->name,
642 status,
643 count,
644 (int)pkt_len);
645 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
646 return;
649 if(kaweth->net && (count > 2)) {
650 if(pkt_len > (count - 2)) {
651 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
652 err("Packet len & 2047: %x", pkt_len & 2047);
653 err("Count 2: %x", count2);
654 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
655 return;
658 if(!(skb = dev_alloc_skb(pkt_len+2))) {
659 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
660 return;
663 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
665 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
667 skb_put(skb, pkt_len);
669 skb->protocol = eth_type_trans(skb, net);
671 netif_rx(skb);
673 kaweth->stats.rx_packets++;
674 kaweth->stats.rx_bytes += pkt_len;
677 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
680 /****************************************************************
681 * kaweth_open
682 ****************************************************************/
683 static int kaweth_open(struct net_device *net)
685 struct kaweth_device *kaweth = netdev_priv(net);
686 int res;
688 dbg("Opening network device.");
690 res = usb_autopm_get_interface(kaweth->intf);
691 if (res) {
692 err("Interface cannot be resumed.");
693 return -EIO;
695 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
696 if (res)
697 goto err_out;
699 usb_fill_int_urb(
700 kaweth->irq_urb,
701 kaweth->dev,
702 usb_rcvintpipe(kaweth->dev, 3),
703 kaweth->intbuffer,
704 INTBUFFERSIZE,
705 int_callback,
706 kaweth,
707 250); /* overriding the descriptor */
708 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
709 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
711 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
712 if (res) {
713 usb_kill_urb(kaweth->rx_urb);
714 goto err_out;
716 kaweth->opened = 1;
718 netif_start_queue(net);
720 kaweth_async_set_rx_mode(kaweth);
721 return 0;
723 err_out:
724 usb_autopm_enable(kaweth->intf);
725 return -EIO;
728 /****************************************************************
729 * kaweth_kill_urbs
730 ****************************************************************/
731 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
733 usb_kill_urb(kaweth->irq_urb);
734 usb_kill_urb(kaweth->rx_urb);
735 usb_kill_urb(kaweth->tx_urb);
737 cancel_delayed_work_sync(&kaweth->lowmem_work);
739 /* a scheduled work may have resubmitted,
740 we hit them again */
741 usb_kill_urb(kaweth->irq_urb);
742 usb_kill_urb(kaweth->rx_urb);
745 /****************************************************************
746 * kaweth_close
747 ****************************************************************/
748 static int kaweth_close(struct net_device *net)
750 struct kaweth_device *kaweth = netdev_priv(net);
752 netif_stop_queue(net);
753 kaweth->opened = 0;
755 kaweth->status |= KAWETH_STATUS_CLOSING;
757 kaweth_kill_urbs(kaweth);
759 kaweth->status &= ~KAWETH_STATUS_CLOSING;
761 usb_autopm_enable(kaweth->intf);
763 return 0;
766 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
768 struct kaweth_device *kaweth = netdev_priv(dev);
770 strlcpy(info->driver, driver_name, sizeof(info->driver));
771 usb_make_path(kaweth->dev, info->bus_info, sizeof (info->bus_info));
774 static u32 kaweth_get_link(struct net_device *dev)
776 struct kaweth_device *kaweth = netdev_priv(dev);
778 return kaweth->linkstate;
781 static struct ethtool_ops ops = {
782 .get_drvinfo = kaweth_get_drvinfo,
783 .get_link = kaweth_get_link
786 /****************************************************************
787 * kaweth_usb_transmit_complete
788 ****************************************************************/
789 static void kaweth_usb_transmit_complete(struct urb *urb)
791 struct kaweth_device *kaweth = urb->context;
792 struct sk_buff *skb = kaweth->tx_skb;
793 int status = urb->status;
795 if (unlikely(status != 0))
796 if (status != -ENOENT)
797 dbg("%s: TX status %d.", kaweth->net->name, status);
799 netif_wake_queue(kaweth->net);
800 dev_kfree_skb_irq(skb);
803 /****************************************************************
804 * kaweth_start_xmit
805 ****************************************************************/
806 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
808 struct kaweth_device *kaweth = netdev_priv(net);
809 __le16 *private_header;
811 int res;
813 spin_lock_irq(&kaweth->device_lock);
815 kaweth_async_set_rx_mode(kaweth);
816 netif_stop_queue(net);
817 if (IS_BLOCKED(kaweth->status)) {
818 goto skip;
821 /* We now decide whether we can put our special header into the sk_buff */
822 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
823 /* no such luck - we make our own */
824 struct sk_buff *copied_skb;
825 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
826 dev_kfree_skb_irq(skb);
827 skb = copied_skb;
828 if (!copied_skb) {
829 kaweth->stats.tx_errors++;
830 netif_start_queue(net);
831 spin_unlock_irq(&kaweth->device_lock);
832 return NETDEV_TX_OK;
836 private_header = (__le16 *)__skb_push(skb, 2);
837 *private_header = cpu_to_le16(skb->len-2);
838 kaweth->tx_skb = skb;
840 usb_fill_bulk_urb(kaweth->tx_urb,
841 kaweth->dev,
842 usb_sndbulkpipe(kaweth->dev, 2),
843 private_header,
844 skb->len,
845 kaweth_usb_transmit_complete,
846 kaweth);
847 kaweth->end = 0;
849 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
851 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
852 skip:
853 kaweth->stats.tx_errors++;
855 netif_start_queue(net);
856 dev_kfree_skb_irq(skb);
858 else
860 kaweth->stats.tx_packets++;
861 kaweth->stats.tx_bytes += skb->len;
862 net->trans_start = jiffies;
865 spin_unlock_irq(&kaweth->device_lock);
867 return NETDEV_TX_OK;
870 /****************************************************************
871 * kaweth_set_rx_mode
872 ****************************************************************/
873 static void kaweth_set_rx_mode(struct net_device *net)
875 struct kaweth_device *kaweth = netdev_priv(net);
877 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
878 KAWETH_PACKET_FILTER_BROADCAST |
879 KAWETH_PACKET_FILTER_MULTICAST;
881 dbg("Setting Rx mode to %d", packet_filter_bitmap);
883 netif_stop_queue(net);
885 if (net->flags & IFF_PROMISC) {
886 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
888 else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
889 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
892 kaweth->packet_filter_bitmap = packet_filter_bitmap;
893 netif_wake_queue(net);
896 /****************************************************************
897 * kaweth_async_set_rx_mode
898 ****************************************************************/
899 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
901 int result;
902 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
904 kaweth->packet_filter_bitmap = 0;
905 if (packet_filter_bitmap == 0)
906 return;
908 if (in_interrupt())
909 return;
911 result = kaweth_control(kaweth,
912 usb_sndctrlpipe(kaweth->dev, 0),
913 KAWETH_COMMAND_SET_PACKET_FILTER,
914 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
915 packet_filter_bitmap,
917 (void *)&kaweth->scratch,
919 KAWETH_CONTROL_TIMEOUT);
921 if(result < 0) {
922 err("Failed to set Rx mode: %d", result);
924 else {
925 dbg("Set Rx mode to %d", packet_filter_bitmap);
929 /****************************************************************
930 * kaweth_netdev_stats
931 ****************************************************************/
932 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
934 struct kaweth_device *kaweth = netdev_priv(dev);
935 return &kaweth->stats;
938 /****************************************************************
939 * kaweth_tx_timeout
940 ****************************************************************/
941 static void kaweth_tx_timeout(struct net_device *net)
943 struct kaweth_device *kaweth = netdev_priv(net);
945 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
946 kaweth->stats.tx_errors++;
947 net->trans_start = jiffies;
949 usb_unlink_urb(kaweth->tx_urb);
952 /****************************************************************
953 * kaweth_suspend
954 ****************************************************************/
955 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
957 struct kaweth_device *kaweth = usb_get_intfdata(intf);
958 unsigned long flags;
960 dbg("Suspending device");
961 spin_lock_irqsave(&kaweth->device_lock, flags);
962 kaweth->status |= KAWETH_STATUS_SUSPENDING;
963 spin_unlock_irqrestore(&kaweth->device_lock, flags);
965 kaweth_kill_urbs(kaweth);
966 return 0;
969 /****************************************************************
970 * kaweth_resume
971 ****************************************************************/
972 static int kaweth_resume(struct usb_interface *intf)
974 struct kaweth_device *kaweth = usb_get_intfdata(intf);
975 unsigned long flags;
977 dbg("Resuming device");
978 spin_lock_irqsave(&kaweth->device_lock, flags);
979 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
980 spin_unlock_irqrestore(&kaweth->device_lock, flags);
982 if (!kaweth->opened)
983 return 0;
984 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
985 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
987 return 0;
990 /****************************************************************
991 * kaweth_probe
992 ****************************************************************/
995 static const struct net_device_ops kaweth_netdev_ops = {
996 .ndo_open = kaweth_open,
997 .ndo_stop = kaweth_close,
998 .ndo_start_xmit = kaweth_start_xmit,
999 .ndo_tx_timeout = kaweth_tx_timeout,
1000 .ndo_set_multicast_list = kaweth_set_rx_mode,
1001 .ndo_get_stats = kaweth_netdev_stats,
1002 .ndo_change_mtu = eth_change_mtu,
1003 .ndo_set_mac_address = eth_mac_addr,
1004 .ndo_validate_addr = eth_validate_addr,
1007 static int kaweth_probe(
1008 struct usb_interface *intf,
1009 const struct usb_device_id *id /* from id_table */
1012 struct usb_device *dev = interface_to_usbdev(intf);
1013 struct kaweth_device *kaweth;
1014 struct net_device *netdev;
1015 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1016 int result = 0;
1018 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1019 dev->devnum,
1020 le16_to_cpu(dev->descriptor.idVendor),
1021 le16_to_cpu(dev->descriptor.idProduct),
1022 le16_to_cpu(dev->descriptor.bcdDevice));
1024 dbg("Device at %p", dev);
1026 dbg("Descriptor length: %x type: %x",
1027 (int)dev->descriptor.bLength,
1028 (int)dev->descriptor.bDescriptorType);
1030 netdev = alloc_etherdev(sizeof(*kaweth));
1031 if (!netdev)
1032 return -ENOMEM;
1034 kaweth = netdev_priv(netdev);
1035 kaweth->dev = dev;
1036 kaweth->net = netdev;
1038 spin_lock_init(&kaweth->device_lock);
1039 init_waitqueue_head(&kaweth->term_wait);
1041 dbg("Resetting.");
1043 kaweth_reset(kaweth);
1046 * If high byte of bcdDevice is nonzero, firmware is already
1047 * downloaded. Don't try to do it again, or we'll hang the device.
1050 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1051 dev_info(&intf->dev, "Firmware present in device.\n");
1052 } else {
1053 /* Download the firmware */
1054 dev_info(&intf->dev, "Downloading firmware...\n");
1055 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1056 if ((result = kaweth_download_firmware(kaweth,
1057 "kaweth/new_code.bin",
1058 100,
1059 2)) < 0) {
1060 err("Error downloading firmware (%d)", result);
1061 goto err_fw;
1064 if ((result = kaweth_download_firmware(kaweth,
1065 "kaweth/new_code_fix.bin",
1066 100,
1067 3)) < 0) {
1068 err("Error downloading firmware fix (%d)", result);
1069 goto err_fw;
1072 if ((result = kaweth_download_firmware(kaweth,
1073 "kaweth/trigger_code.bin",
1074 126,
1075 2)) < 0) {
1076 err("Error downloading trigger code (%d)", result);
1077 goto err_fw;
1081 if ((result = kaweth_download_firmware(kaweth,
1082 "kaweth/trigger_code_fix.bin",
1083 126,
1084 3)) < 0) {
1085 err("Error downloading trigger code fix (%d)", result);
1086 goto err_fw;
1090 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1091 err("Error triggering firmware (%d)", result);
1092 goto err_fw;
1095 /* Device will now disappear for a moment... */
1096 dev_info(&intf->dev, "Firmware loaded. I'll be back...\n");
1097 err_fw:
1098 free_page((unsigned long)kaweth->firmware_buf);
1099 free_netdev(netdev);
1100 return -EIO;
1103 result = kaweth_read_configuration(kaweth);
1105 if(result < 0) {
1106 err("Error reading configuration (%d), no net device created", result);
1107 goto err_free_netdev;
1110 dev_info(&intf->dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
1111 dev_info(&intf->dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1112 dev_info(&intf->dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
1113 dev_info(&intf->dev, "Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1114 (int)kaweth->configuration.hw_addr[0],
1115 (int)kaweth->configuration.hw_addr[1],
1116 (int)kaweth->configuration.hw_addr[2],
1117 (int)kaweth->configuration.hw_addr[3],
1118 (int)kaweth->configuration.hw_addr[4],
1119 (int)kaweth->configuration.hw_addr[5]);
1121 if(!memcmp(&kaweth->configuration.hw_addr,
1122 &bcast_addr,
1123 sizeof(bcast_addr))) {
1124 err("Firmware not functioning properly, no net device created");
1125 goto err_free_netdev;
1128 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1129 dbg("Error setting URB size");
1130 goto err_free_netdev;
1133 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1134 err("Error setting SOFS wait");
1135 goto err_free_netdev;
1138 result = kaweth_set_receive_filter(kaweth,
1139 KAWETH_PACKET_FILTER_DIRECTED |
1140 KAWETH_PACKET_FILTER_BROADCAST |
1141 KAWETH_PACKET_FILTER_MULTICAST);
1143 if(result < 0) {
1144 err("Error setting receive filter");
1145 goto err_free_netdev;
1148 dbg("Initializing net device.");
1150 kaweth->intf = intf;
1152 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1153 if (!kaweth->tx_urb)
1154 goto err_free_netdev;
1155 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1156 if (!kaweth->rx_urb)
1157 goto err_only_tx;
1158 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1159 if (!kaweth->irq_urb)
1160 goto err_tx_and_rx;
1162 kaweth->intbuffer = usb_buffer_alloc( kaweth->dev,
1163 INTBUFFERSIZE,
1164 GFP_KERNEL,
1165 &kaweth->intbufferhandle);
1166 if (!kaweth->intbuffer)
1167 goto err_tx_and_rx_and_irq;
1168 kaweth->rx_buf = usb_buffer_alloc( kaweth->dev,
1169 KAWETH_BUF_SIZE,
1170 GFP_KERNEL,
1171 &kaweth->rxbufferhandle);
1172 if (!kaweth->rx_buf)
1173 goto err_all_but_rxbuf;
1175 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1176 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1177 sizeof(kaweth->configuration.hw_addr));
1179 netdev->netdev_ops = &kaweth_netdev_ops;
1180 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1181 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1182 SET_ETHTOOL_OPS(netdev, &ops);
1184 /* kaweth is zeroed as part of alloc_netdev */
1185 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1186 usb_set_intfdata(intf, kaweth);
1188 #if 0
1189 // dma_supported() is deeply broken on almost all architectures
1190 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1191 kaweth->net->features |= NETIF_F_HIGHDMA;
1192 #endif
1194 SET_NETDEV_DEV(netdev, &intf->dev);
1195 if (register_netdev(netdev) != 0) {
1196 err("Error registering netdev.");
1197 goto err_intfdata;
1200 dev_info(&intf->dev, "kaweth interface created at %s\n",
1201 kaweth->net->name);
1203 dbg("Kaweth probe returning.");
1205 return 0;
1207 err_intfdata:
1208 usb_set_intfdata(intf, NULL);
1209 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1210 err_all_but_rxbuf:
1211 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1212 err_tx_and_rx_and_irq:
1213 usb_free_urb(kaweth->irq_urb);
1214 err_tx_and_rx:
1215 usb_free_urb(kaweth->rx_urb);
1216 err_only_tx:
1217 usb_free_urb(kaweth->tx_urb);
1218 err_free_netdev:
1219 free_netdev(netdev);
1221 return -EIO;
1224 /****************************************************************
1225 * kaweth_disconnect
1226 ****************************************************************/
1227 static void kaweth_disconnect(struct usb_interface *intf)
1229 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1230 struct net_device *netdev;
1232 dev_info(&intf->dev, "Unregistering\n");
1234 usb_set_intfdata(intf, NULL);
1235 if (!kaweth) {
1236 dev_warn(&intf->dev, "unregistering non-existant device\n");
1237 return;
1239 netdev = kaweth->net;
1241 dbg("Unregistering net device");
1242 unregister_netdev(netdev);
1244 usb_free_urb(kaweth->rx_urb);
1245 usb_free_urb(kaweth->tx_urb);
1246 usb_free_urb(kaweth->irq_urb);
1248 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1249 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1251 free_netdev(netdev);
1255 // FIXME this completion stuff is a modified clone of
1256 // an OLD version of some stuff in usb.c ...
1257 struct usb_api_data {
1258 wait_queue_head_t wqh;
1259 int done;
1262 /*-------------------------------------------------------------------*
1263 * completion handler for compatibility wrappers (sync control/bulk) *
1264 *-------------------------------------------------------------------*/
1265 static void usb_api_blocking_completion(struct urb *urb)
1267 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1269 awd->done=1;
1270 wake_up(&awd->wqh);
1273 /*-------------------------------------------------------------------*
1274 * COMPATIBILITY STUFF *
1275 *-------------------------------------------------------------------*/
1277 // Starts urb and waits for completion or timeout
1278 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1280 struct usb_api_data awd;
1281 int status;
1283 init_waitqueue_head(&awd.wqh);
1284 awd.done = 0;
1286 urb->context = &awd;
1287 status = usb_submit_urb(urb, GFP_NOIO);
1288 if (status) {
1289 // something went wrong
1290 usb_free_urb(urb);
1291 return status;
1294 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1295 // timeout
1296 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1297 usb_kill_urb(urb); // remove urb safely
1298 status = -ETIMEDOUT;
1300 else {
1301 status = urb->status;
1304 if (actual_length) {
1305 *actual_length = urb->actual_length;
1308 usb_free_urb(urb);
1309 return status;
1312 /*-------------------------------------------------------------------*/
1313 // returns status (negative) or length (positive)
1314 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1315 unsigned int pipe,
1316 struct usb_ctrlrequest *cmd, void *data,
1317 int len, int timeout)
1319 struct urb *urb;
1320 int retv;
1321 int length = 0; /* shut up GCC */
1323 urb = usb_alloc_urb(0, GFP_NOIO);
1324 if (!urb)
1325 return -ENOMEM;
1327 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1328 len, usb_api_blocking_completion, NULL);
1330 retv = usb_start_wait_urb(urb, timeout, &length);
1331 if (retv < 0) {
1332 return retv;
1334 else {
1335 return length;
1340 /****************************************************************
1341 * kaweth_init
1342 ****************************************************************/
1343 static int __init kaweth_init(void)
1345 dbg("Driver loading");
1346 return usb_register(&kaweth_driver);
1349 /****************************************************************
1350 * kaweth_exit
1351 ****************************************************************/
1352 static void __exit kaweth_exit(void)
1354 usb_deregister(&kaweth_driver);
1357 module_init(kaweth_init);
1358 module_exit(kaweth_exit);