[ARM] pxa: Gumstix Verdex PCMCIA support
[linux-2.6/verdex.git] / drivers / net / usb / kaweth.c
blobe391ef969c288c9ddec730895f8bd2cb96cbfab5
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;
266 int retval;
268 dbg("kaweth_control()");
270 if(in_interrupt()) {
271 dbg("in_interrupt()");
272 return -EBUSY;
275 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
277 if (!dr) {
278 dbg("kmalloc() failed");
279 return -ENOMEM;
282 dr->bRequestType = requesttype;
283 dr->bRequest = request;
284 dr->wValue = cpu_to_le16(value);
285 dr->wIndex = cpu_to_le16(index);
286 dr->wLength = cpu_to_le16(size);
288 retval = kaweth_internal_control_msg(kaweth->dev,
289 pipe,
291 data,
292 size,
293 timeout);
295 kfree(dr);
296 return retval;
299 /****************************************************************
300 * kaweth_read_configuration
301 ****************************************************************/
302 static int kaweth_read_configuration(struct kaweth_device *kaweth)
304 int retval;
306 dbg("Reading kaweth configuration");
308 retval = kaweth_control(kaweth,
309 usb_rcvctrlpipe(kaweth->dev, 0),
310 KAWETH_COMMAND_GET_ETHERNET_DESC,
311 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
314 (void *)&kaweth->configuration,
315 sizeof(kaweth->configuration),
316 KAWETH_CONTROL_TIMEOUT);
318 return retval;
321 /****************************************************************
322 * kaweth_set_urb_size
323 ****************************************************************/
324 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
326 int retval;
328 dbg("Setting URB size to %d", (unsigned)urb_size);
330 retval = kaweth_control(kaweth,
331 usb_sndctrlpipe(kaweth->dev, 0),
332 KAWETH_COMMAND_SET_URB_SIZE,
333 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
334 urb_size,
336 (void *)&kaweth->scratch,
338 KAWETH_CONTROL_TIMEOUT);
340 return retval;
343 /****************************************************************
344 * kaweth_set_sofs_wait
345 ****************************************************************/
346 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
348 int retval;
350 dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
352 retval = kaweth_control(kaweth,
353 usb_sndctrlpipe(kaweth->dev, 0),
354 KAWETH_COMMAND_SET_SOFS_WAIT,
355 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
356 sofs_wait,
358 (void *)&kaweth->scratch,
360 KAWETH_CONTROL_TIMEOUT);
362 return retval;
365 /****************************************************************
366 * kaweth_set_receive_filter
367 ****************************************************************/
368 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
369 __u16 receive_filter)
371 int retval;
373 dbg("Set receive filter to %d", (unsigned)receive_filter);
375 retval = kaweth_control(kaweth,
376 usb_sndctrlpipe(kaweth->dev, 0),
377 KAWETH_COMMAND_SET_PACKET_FILTER,
378 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
379 receive_filter,
381 (void *)&kaweth->scratch,
383 KAWETH_CONTROL_TIMEOUT);
385 return retval;
388 /****************************************************************
389 * kaweth_download_firmware
390 ****************************************************************/
391 static int kaweth_download_firmware(struct kaweth_device *kaweth,
392 const char *fwname,
393 __u8 interrupt,
394 __u8 type)
396 const struct firmware *fw;
397 int data_len;
398 int ret;
400 ret = request_firmware(&fw, fwname, &kaweth->dev->dev);
401 if (ret) {
402 err("Firmware request failed\n");
403 return ret;
406 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
407 err("Firmware too big: %zu", fw->size);
408 return -ENOSPC;
410 data_len = fw->size;
411 memcpy(kaweth->firmware_buf, fw->data, fw->size);
413 release_firmware(fw);
415 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
416 kaweth->firmware_buf[3] = data_len >> 8;
417 kaweth->firmware_buf[4] = type;
418 kaweth->firmware_buf[5] = interrupt;
420 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
421 kaweth->firmware_buf[2]);
423 dbg("Downloading firmware at %p to kaweth device at %p",
424 fw->data, kaweth);
425 dbg("Firmware length: %d", data_len);
427 return kaweth_control(kaweth,
428 usb_sndctrlpipe(kaweth->dev, 0),
429 KAWETH_COMMAND_SCAN,
430 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
433 (void *)kaweth->firmware_buf,
434 data_len,
435 KAWETH_CONTROL_TIMEOUT);
438 /****************************************************************
439 * kaweth_trigger_firmware
440 ****************************************************************/
441 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
442 __u8 interrupt)
444 kaweth->firmware_buf[0] = 0xB6;
445 kaweth->firmware_buf[1] = 0xC3;
446 kaweth->firmware_buf[2] = 0x01;
447 kaweth->firmware_buf[3] = 0x00;
448 kaweth->firmware_buf[4] = 0x06;
449 kaweth->firmware_buf[5] = interrupt;
450 kaweth->firmware_buf[6] = 0x00;
451 kaweth->firmware_buf[7] = 0x00;
453 dbg("Triggering firmware");
455 return kaweth_control(kaweth,
456 usb_sndctrlpipe(kaweth->dev, 0),
457 KAWETH_COMMAND_SCAN,
458 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
461 (void *)kaweth->firmware_buf,
463 KAWETH_CONTROL_TIMEOUT);
466 /****************************************************************
467 * kaweth_reset
468 ****************************************************************/
469 static int kaweth_reset(struct kaweth_device *kaweth)
471 int result;
473 dbg("kaweth_reset(%p)", kaweth);
474 result = kaweth_control(kaweth,
475 usb_sndctrlpipe(kaweth->dev, 0),
476 USB_REQ_SET_CONFIGURATION,
478 kaweth->dev->config[0].desc.bConfigurationValue,
480 NULL,
482 KAWETH_CONTROL_TIMEOUT);
484 mdelay(10);
486 dbg("kaweth_reset() returns %d.",result);
488 return result;
491 static void kaweth_usb_receive(struct urb *);
492 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
494 /****************************************************************
495 int_callback
496 *****************************************************************/
498 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
500 int status;
502 status = usb_submit_urb (kaweth->irq_urb, mf);
503 if (unlikely(status == -ENOMEM)) {
504 kaweth->suspend_lowmem_ctrl = 1;
505 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
506 } else {
507 kaweth->suspend_lowmem_ctrl = 0;
510 if (status)
511 err ("can't resubmit intr, %s-%s, status %d",
512 kaweth->dev->bus->bus_name,
513 kaweth->dev->devpath, status);
516 static void int_callback(struct urb *u)
518 struct kaweth_device *kaweth = u->context;
519 int act_state;
520 int status = u->status;
522 switch (status) {
523 case 0: /* success */
524 break;
525 case -ECONNRESET: /* unlink */
526 case -ENOENT:
527 case -ESHUTDOWN:
528 return;
529 /* -EPIPE: should clear the halt */
530 default: /* error */
531 goto resubmit;
534 /* we check the link state to report changes */
535 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
536 if (act_state)
537 netif_carrier_on(kaweth->net);
538 else
539 netif_carrier_off(kaweth->net);
541 kaweth->linkstate = act_state;
543 resubmit:
544 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
547 static void kaweth_resubmit_tl(struct work_struct *work)
549 struct kaweth_device *kaweth =
550 container_of(work, struct kaweth_device, lowmem_work.work);
552 if (IS_BLOCKED(kaweth->status))
553 return;
555 if (kaweth->suspend_lowmem_rx)
556 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
558 if (kaweth->suspend_lowmem_ctrl)
559 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
563 /****************************************************************
564 * kaweth_resubmit_rx_urb
565 ****************************************************************/
566 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
567 gfp_t mem_flags)
569 int result;
571 usb_fill_bulk_urb(kaweth->rx_urb,
572 kaweth->dev,
573 usb_rcvbulkpipe(kaweth->dev, 1),
574 kaweth->rx_buf,
575 KAWETH_BUF_SIZE,
576 kaweth_usb_receive,
577 kaweth);
578 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
579 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
581 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
582 if (result == -ENOMEM) {
583 kaweth->suspend_lowmem_rx = 1;
584 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
586 err("resubmitting rx_urb %d failed", result);
587 } else {
588 kaweth->suspend_lowmem_rx = 0;
591 return result;
594 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
596 /****************************************************************
597 * kaweth_usb_receive
598 ****************************************************************/
599 static void kaweth_usb_receive(struct urb *urb)
601 struct kaweth_device *kaweth = urb->context;
602 struct net_device *net = kaweth->net;
603 int status = urb->status;
605 int count = urb->actual_length;
606 int count2 = urb->transfer_buffer_length;
608 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
610 struct sk_buff *skb;
612 if (unlikely(status == -EPIPE)) {
613 kaweth->stats.rx_errors++;
614 kaweth->end = 1;
615 wake_up(&kaweth->term_wait);
616 dbg("Status was -EPIPE.");
617 return;
619 if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
620 /* we are killed - set a flag and wake the disconnect handler */
621 kaweth->end = 1;
622 wake_up(&kaweth->term_wait);
623 dbg("Status was -ECONNRESET or -ESHUTDOWN.");
624 return;
626 if (unlikely(status == -EPROTO || status == -ETIME ||
627 status == -EILSEQ)) {
628 kaweth->stats.rx_errors++;
629 dbg("Status was -EPROTO, -ETIME, or -EILSEQ.");
630 return;
632 if (unlikely(status == -EOVERFLOW)) {
633 kaweth->stats.rx_errors++;
634 dbg("Status was -EOVERFLOW.");
636 spin_lock(&kaweth->device_lock);
637 if (IS_BLOCKED(kaweth->status)) {
638 spin_unlock(&kaweth->device_lock);
639 return;
641 spin_unlock(&kaweth->device_lock);
643 if(status && status != -EREMOTEIO && count != 1) {
644 err("%s RX status: %d count: %d packet_len: %d",
645 net->name,
646 status,
647 count,
648 (int)pkt_len);
649 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
650 return;
653 if(kaweth->net && (count > 2)) {
654 if(pkt_len > (count - 2)) {
655 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
656 err("Packet len & 2047: %x", pkt_len & 2047);
657 err("Count 2: %x", count2);
658 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
659 return;
662 if(!(skb = dev_alloc_skb(pkt_len+2))) {
663 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
664 return;
667 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
669 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
671 skb_put(skb, pkt_len);
673 skb->protocol = eth_type_trans(skb, net);
675 netif_rx(skb);
677 kaweth->stats.rx_packets++;
678 kaweth->stats.rx_bytes += pkt_len;
681 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
684 /****************************************************************
685 * kaweth_open
686 ****************************************************************/
687 static int kaweth_open(struct net_device *net)
689 struct kaweth_device *kaweth = netdev_priv(net);
690 int res;
692 dbg("Opening network device.");
694 res = usb_autopm_get_interface(kaweth->intf);
695 if (res) {
696 err("Interface cannot be resumed.");
697 return -EIO;
699 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
700 if (res)
701 goto err_out;
703 usb_fill_int_urb(
704 kaweth->irq_urb,
705 kaweth->dev,
706 usb_rcvintpipe(kaweth->dev, 3),
707 kaweth->intbuffer,
708 INTBUFFERSIZE,
709 int_callback,
710 kaweth,
711 250); /* overriding the descriptor */
712 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
713 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
715 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
716 if (res) {
717 usb_kill_urb(kaweth->rx_urb);
718 goto err_out;
720 kaweth->opened = 1;
722 netif_start_queue(net);
724 kaweth_async_set_rx_mode(kaweth);
725 return 0;
727 err_out:
728 usb_autopm_enable(kaweth->intf);
729 return -EIO;
732 /****************************************************************
733 * kaweth_kill_urbs
734 ****************************************************************/
735 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
737 usb_kill_urb(kaweth->irq_urb);
738 usb_kill_urb(kaweth->rx_urb);
739 usb_kill_urb(kaweth->tx_urb);
741 cancel_delayed_work_sync(&kaweth->lowmem_work);
743 /* a scheduled work may have resubmitted,
744 we hit them again */
745 usb_kill_urb(kaweth->irq_urb);
746 usb_kill_urb(kaweth->rx_urb);
749 /****************************************************************
750 * kaweth_close
751 ****************************************************************/
752 static int kaweth_close(struct net_device *net)
754 struct kaweth_device *kaweth = netdev_priv(net);
756 netif_stop_queue(net);
757 kaweth->opened = 0;
759 kaweth->status |= KAWETH_STATUS_CLOSING;
761 kaweth_kill_urbs(kaweth);
763 kaweth->status &= ~KAWETH_STATUS_CLOSING;
765 usb_autopm_enable(kaweth->intf);
767 return 0;
770 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
772 struct kaweth_device *kaweth = netdev_priv(dev);
774 strlcpy(info->driver, driver_name, sizeof(info->driver));
775 usb_make_path(kaweth->dev, info->bus_info, sizeof (info->bus_info));
778 static u32 kaweth_get_link(struct net_device *dev)
780 struct kaweth_device *kaweth = netdev_priv(dev);
782 return kaweth->linkstate;
785 static const struct ethtool_ops ops = {
786 .get_drvinfo = kaweth_get_drvinfo,
787 .get_link = kaweth_get_link
790 /****************************************************************
791 * kaweth_usb_transmit_complete
792 ****************************************************************/
793 static void kaweth_usb_transmit_complete(struct urb *urb)
795 struct kaweth_device *kaweth = urb->context;
796 struct sk_buff *skb = kaweth->tx_skb;
797 int status = urb->status;
799 if (unlikely(status != 0))
800 if (status != -ENOENT)
801 dbg("%s: TX status %d.", kaweth->net->name, status);
803 netif_wake_queue(kaweth->net);
804 dev_kfree_skb_irq(skb);
807 /****************************************************************
808 * kaweth_start_xmit
809 ****************************************************************/
810 static netdev_tx_t kaweth_start_xmit(struct sk_buff *skb,
811 struct net_device *net)
813 struct kaweth_device *kaweth = netdev_priv(net);
814 __le16 *private_header;
816 int res;
818 spin_lock_irq(&kaweth->device_lock);
820 kaweth_async_set_rx_mode(kaweth);
821 netif_stop_queue(net);
822 if (IS_BLOCKED(kaweth->status)) {
823 goto skip;
826 /* We now decide whether we can put our special header into the sk_buff */
827 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
828 /* no such luck - we make our own */
829 struct sk_buff *copied_skb;
830 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
831 dev_kfree_skb_irq(skb);
832 skb = copied_skb;
833 if (!copied_skb) {
834 kaweth->stats.tx_errors++;
835 netif_start_queue(net);
836 spin_unlock_irq(&kaweth->device_lock);
837 return NETDEV_TX_OK;
841 private_header = (__le16 *)__skb_push(skb, 2);
842 *private_header = cpu_to_le16(skb->len-2);
843 kaweth->tx_skb = skb;
845 usb_fill_bulk_urb(kaweth->tx_urb,
846 kaweth->dev,
847 usb_sndbulkpipe(kaweth->dev, 2),
848 private_header,
849 skb->len,
850 kaweth_usb_transmit_complete,
851 kaweth);
852 kaweth->end = 0;
854 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
856 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
857 skip:
858 kaweth->stats.tx_errors++;
860 netif_start_queue(net);
861 dev_kfree_skb_irq(skb);
863 else
865 kaweth->stats.tx_packets++;
866 kaweth->stats.tx_bytes += skb->len;
867 net->trans_start = jiffies;
870 spin_unlock_irq(&kaweth->device_lock);
872 return NETDEV_TX_OK;
875 /****************************************************************
876 * kaweth_set_rx_mode
877 ****************************************************************/
878 static void kaweth_set_rx_mode(struct net_device *net)
880 struct kaweth_device *kaweth = netdev_priv(net);
882 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
883 KAWETH_PACKET_FILTER_BROADCAST |
884 KAWETH_PACKET_FILTER_MULTICAST;
886 dbg("Setting Rx mode to %d", packet_filter_bitmap);
888 netif_stop_queue(net);
890 if (net->flags & IFF_PROMISC) {
891 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
893 else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
894 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
897 kaweth->packet_filter_bitmap = packet_filter_bitmap;
898 netif_wake_queue(net);
901 /****************************************************************
902 * kaweth_async_set_rx_mode
903 ****************************************************************/
904 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
906 int result;
907 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
909 kaweth->packet_filter_bitmap = 0;
910 if (packet_filter_bitmap == 0)
911 return;
913 if (in_interrupt())
914 return;
916 result = kaweth_control(kaweth,
917 usb_sndctrlpipe(kaweth->dev, 0),
918 KAWETH_COMMAND_SET_PACKET_FILTER,
919 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
920 packet_filter_bitmap,
922 (void *)&kaweth->scratch,
924 KAWETH_CONTROL_TIMEOUT);
926 if(result < 0) {
927 err("Failed to set Rx mode: %d", result);
929 else {
930 dbg("Set Rx mode to %d", packet_filter_bitmap);
934 /****************************************************************
935 * kaweth_netdev_stats
936 ****************************************************************/
937 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
939 struct kaweth_device *kaweth = netdev_priv(dev);
940 return &kaweth->stats;
943 /****************************************************************
944 * kaweth_tx_timeout
945 ****************************************************************/
946 static void kaweth_tx_timeout(struct net_device *net)
948 struct kaweth_device *kaweth = netdev_priv(net);
950 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
951 kaweth->stats.tx_errors++;
952 net->trans_start = jiffies;
954 usb_unlink_urb(kaweth->tx_urb);
957 /****************************************************************
958 * kaweth_suspend
959 ****************************************************************/
960 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
962 struct kaweth_device *kaweth = usb_get_intfdata(intf);
963 unsigned long flags;
965 dbg("Suspending device");
966 spin_lock_irqsave(&kaweth->device_lock, flags);
967 kaweth->status |= KAWETH_STATUS_SUSPENDING;
968 spin_unlock_irqrestore(&kaweth->device_lock, flags);
970 kaweth_kill_urbs(kaweth);
971 return 0;
974 /****************************************************************
975 * kaweth_resume
976 ****************************************************************/
977 static int kaweth_resume(struct usb_interface *intf)
979 struct kaweth_device *kaweth = usb_get_intfdata(intf);
980 unsigned long flags;
982 dbg("Resuming device");
983 spin_lock_irqsave(&kaweth->device_lock, flags);
984 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
985 spin_unlock_irqrestore(&kaweth->device_lock, flags);
987 if (!kaweth->opened)
988 return 0;
989 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
990 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
992 return 0;
995 /****************************************************************
996 * kaweth_probe
997 ****************************************************************/
1000 static const struct net_device_ops kaweth_netdev_ops = {
1001 .ndo_open = kaweth_open,
1002 .ndo_stop = kaweth_close,
1003 .ndo_start_xmit = kaweth_start_xmit,
1004 .ndo_tx_timeout = kaweth_tx_timeout,
1005 .ndo_set_multicast_list = kaweth_set_rx_mode,
1006 .ndo_get_stats = kaweth_netdev_stats,
1007 .ndo_change_mtu = eth_change_mtu,
1008 .ndo_set_mac_address = eth_mac_addr,
1009 .ndo_validate_addr = eth_validate_addr,
1012 static int kaweth_probe(
1013 struct usb_interface *intf,
1014 const struct usb_device_id *id /* from id_table */
1017 struct usb_device *dev = interface_to_usbdev(intf);
1018 struct kaweth_device *kaweth;
1019 struct net_device *netdev;
1020 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1021 int result = 0;
1023 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1024 dev->devnum,
1025 le16_to_cpu(dev->descriptor.idVendor),
1026 le16_to_cpu(dev->descriptor.idProduct),
1027 le16_to_cpu(dev->descriptor.bcdDevice));
1029 dbg("Device at %p", dev);
1031 dbg("Descriptor length: %x type: %x",
1032 (int)dev->descriptor.bLength,
1033 (int)dev->descriptor.bDescriptorType);
1035 netdev = alloc_etherdev(sizeof(*kaweth));
1036 if (!netdev)
1037 return -ENOMEM;
1039 kaweth = netdev_priv(netdev);
1040 kaweth->dev = dev;
1041 kaweth->net = netdev;
1043 spin_lock_init(&kaweth->device_lock);
1044 init_waitqueue_head(&kaweth->term_wait);
1046 dbg("Resetting.");
1048 kaweth_reset(kaweth);
1051 * If high byte of bcdDevice is nonzero, firmware is already
1052 * downloaded. Don't try to do it again, or we'll hang the device.
1055 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1056 dev_info(&intf->dev, "Firmware present in device.\n");
1057 } else {
1058 /* Download the firmware */
1059 dev_info(&intf->dev, "Downloading firmware...\n");
1060 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1061 if ((result = kaweth_download_firmware(kaweth,
1062 "kaweth/new_code.bin",
1063 100,
1064 2)) < 0) {
1065 err("Error downloading firmware (%d)", result);
1066 goto err_fw;
1069 if ((result = kaweth_download_firmware(kaweth,
1070 "kaweth/new_code_fix.bin",
1071 100,
1072 3)) < 0) {
1073 err("Error downloading firmware fix (%d)", result);
1074 goto err_fw;
1077 if ((result = kaweth_download_firmware(kaweth,
1078 "kaweth/trigger_code.bin",
1079 126,
1080 2)) < 0) {
1081 err("Error downloading trigger code (%d)", result);
1082 goto err_fw;
1086 if ((result = kaweth_download_firmware(kaweth,
1087 "kaweth/trigger_code_fix.bin",
1088 126,
1089 3)) < 0) {
1090 err("Error downloading trigger code fix (%d)", result);
1091 goto err_fw;
1095 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1096 err("Error triggering firmware (%d)", result);
1097 goto err_fw;
1100 /* Device will now disappear for a moment... */
1101 dev_info(&intf->dev, "Firmware loaded. I'll be back...\n");
1102 err_fw:
1103 free_page((unsigned long)kaweth->firmware_buf);
1104 free_netdev(netdev);
1105 return -EIO;
1108 result = kaweth_read_configuration(kaweth);
1110 if(result < 0) {
1111 err("Error reading configuration (%d), no net device created", result);
1112 goto err_free_netdev;
1115 dev_info(&intf->dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
1116 dev_info(&intf->dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1117 dev_info(&intf->dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
1118 dev_info(&intf->dev, "Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1119 (int)kaweth->configuration.hw_addr[0],
1120 (int)kaweth->configuration.hw_addr[1],
1121 (int)kaweth->configuration.hw_addr[2],
1122 (int)kaweth->configuration.hw_addr[3],
1123 (int)kaweth->configuration.hw_addr[4],
1124 (int)kaweth->configuration.hw_addr[5]);
1126 if(!memcmp(&kaweth->configuration.hw_addr,
1127 &bcast_addr,
1128 sizeof(bcast_addr))) {
1129 err("Firmware not functioning properly, no net device created");
1130 goto err_free_netdev;
1133 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1134 dbg("Error setting URB size");
1135 goto err_free_netdev;
1138 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1139 err("Error setting SOFS wait");
1140 goto err_free_netdev;
1143 result = kaweth_set_receive_filter(kaweth,
1144 KAWETH_PACKET_FILTER_DIRECTED |
1145 KAWETH_PACKET_FILTER_BROADCAST |
1146 KAWETH_PACKET_FILTER_MULTICAST);
1148 if(result < 0) {
1149 err("Error setting receive filter");
1150 goto err_free_netdev;
1153 dbg("Initializing net device.");
1155 kaweth->intf = intf;
1157 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1158 if (!kaweth->tx_urb)
1159 goto err_free_netdev;
1160 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1161 if (!kaweth->rx_urb)
1162 goto err_only_tx;
1163 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1164 if (!kaweth->irq_urb)
1165 goto err_tx_and_rx;
1167 kaweth->intbuffer = usb_buffer_alloc( kaweth->dev,
1168 INTBUFFERSIZE,
1169 GFP_KERNEL,
1170 &kaweth->intbufferhandle);
1171 if (!kaweth->intbuffer)
1172 goto err_tx_and_rx_and_irq;
1173 kaweth->rx_buf = usb_buffer_alloc( kaweth->dev,
1174 KAWETH_BUF_SIZE,
1175 GFP_KERNEL,
1176 &kaweth->rxbufferhandle);
1177 if (!kaweth->rx_buf)
1178 goto err_all_but_rxbuf;
1180 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1181 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1182 sizeof(kaweth->configuration.hw_addr));
1184 netdev->netdev_ops = &kaweth_netdev_ops;
1185 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1186 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1187 SET_ETHTOOL_OPS(netdev, &ops);
1189 /* kaweth is zeroed as part of alloc_netdev */
1190 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1191 usb_set_intfdata(intf, kaweth);
1193 #if 0
1194 // dma_supported() is deeply broken on almost all architectures
1195 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1196 kaweth->net->features |= NETIF_F_HIGHDMA;
1197 #endif
1199 SET_NETDEV_DEV(netdev, &intf->dev);
1200 if (register_netdev(netdev) != 0) {
1201 err("Error registering netdev.");
1202 goto err_intfdata;
1205 dev_info(&intf->dev, "kaweth interface created at %s\n",
1206 kaweth->net->name);
1208 dbg("Kaweth probe returning.");
1210 return 0;
1212 err_intfdata:
1213 usb_set_intfdata(intf, NULL);
1214 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1215 err_all_but_rxbuf:
1216 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1217 err_tx_and_rx_and_irq:
1218 usb_free_urb(kaweth->irq_urb);
1219 err_tx_and_rx:
1220 usb_free_urb(kaweth->rx_urb);
1221 err_only_tx:
1222 usb_free_urb(kaweth->tx_urb);
1223 err_free_netdev:
1224 free_netdev(netdev);
1226 return -EIO;
1229 /****************************************************************
1230 * kaweth_disconnect
1231 ****************************************************************/
1232 static void kaweth_disconnect(struct usb_interface *intf)
1234 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1235 struct net_device *netdev;
1237 dev_info(&intf->dev, "Unregistering\n");
1239 usb_set_intfdata(intf, NULL);
1240 if (!kaweth) {
1241 dev_warn(&intf->dev, "unregistering non-existant device\n");
1242 return;
1244 netdev = kaweth->net;
1246 dbg("Unregistering net device");
1247 unregister_netdev(netdev);
1249 usb_free_urb(kaweth->rx_urb);
1250 usb_free_urb(kaweth->tx_urb);
1251 usb_free_urb(kaweth->irq_urb);
1253 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1254 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1256 free_netdev(netdev);
1260 // FIXME this completion stuff is a modified clone of
1261 // an OLD version of some stuff in usb.c ...
1262 struct usb_api_data {
1263 wait_queue_head_t wqh;
1264 int done;
1267 /*-------------------------------------------------------------------*
1268 * completion handler for compatibility wrappers (sync control/bulk) *
1269 *-------------------------------------------------------------------*/
1270 static void usb_api_blocking_completion(struct urb *urb)
1272 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1274 awd->done=1;
1275 wake_up(&awd->wqh);
1278 /*-------------------------------------------------------------------*
1279 * COMPATIBILITY STUFF *
1280 *-------------------------------------------------------------------*/
1282 // Starts urb and waits for completion or timeout
1283 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1285 struct usb_api_data awd;
1286 int status;
1288 init_waitqueue_head(&awd.wqh);
1289 awd.done = 0;
1291 urb->context = &awd;
1292 status = usb_submit_urb(urb, GFP_NOIO);
1293 if (status) {
1294 // something went wrong
1295 usb_free_urb(urb);
1296 return status;
1299 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1300 // timeout
1301 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1302 usb_kill_urb(urb); // remove urb safely
1303 status = -ETIMEDOUT;
1305 else {
1306 status = urb->status;
1309 if (actual_length) {
1310 *actual_length = urb->actual_length;
1313 usb_free_urb(urb);
1314 return status;
1317 /*-------------------------------------------------------------------*/
1318 // returns status (negative) or length (positive)
1319 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1320 unsigned int pipe,
1321 struct usb_ctrlrequest *cmd, void *data,
1322 int len, int timeout)
1324 struct urb *urb;
1325 int retv;
1326 int length = 0; /* shut up GCC */
1328 urb = usb_alloc_urb(0, GFP_NOIO);
1329 if (!urb)
1330 return -ENOMEM;
1332 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1333 len, usb_api_blocking_completion, NULL);
1335 retv = usb_start_wait_urb(urb, timeout, &length);
1336 if (retv < 0) {
1337 return retv;
1339 else {
1340 return length;
1345 /****************************************************************
1346 * kaweth_init
1347 ****************************************************************/
1348 static int __init kaweth_init(void)
1350 dbg("Driver loading");
1351 return usb_register(&kaweth_driver);
1354 /****************************************************************
1355 * kaweth_exit
1356 ****************************************************************/
1357 static void __exit kaweth_exit(void)
1359 usb_deregister(&kaweth_driver);
1362 module_init(kaweth_init);
1363 module_exit(kaweth_exit);