enic: Add new firmware devcmds
[linux/fpc-iii.git] / drivers / net / usb / kaweth.c
blob5e98643a4a214b2734d738cc7a24b55ef0225298
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(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 /****************************************************************
172 * kaweth_driver
173 ****************************************************************/
174 static struct usb_driver kaweth_driver = {
175 .name = driver_name,
176 .probe = kaweth_probe,
177 .disconnect = kaweth_disconnect,
178 .suspend = kaweth_suspend,
179 .resume = kaweth_resume,
180 .id_table = usb_klsi_table,
181 .supports_autosuspend = 1,
184 typedef __u8 eth_addr_t[6];
186 /****************************************************************
187 * usb_eth_dev
188 ****************************************************************/
189 struct usb_eth_dev {
190 char *name;
191 __u16 vendor;
192 __u16 device;
193 void *pdata;
196 /****************************************************************
197 * kaweth_ethernet_configuration
198 * Refer Table 8
199 ****************************************************************/
200 struct kaweth_ethernet_configuration
202 __u8 size;
203 __u8 reserved1;
204 __u8 reserved2;
205 eth_addr_t hw_addr;
206 __u32 statistics_mask;
207 __le16 segment_size;
208 __u16 max_multicast_filters;
209 __u8 reserved3;
210 } __packed;
212 /****************************************************************
213 * kaweth_device
214 ****************************************************************/
215 struct kaweth_device
217 spinlock_t device_lock;
219 __u32 status;
220 int end;
221 int suspend_lowmem_rx;
222 int suspend_lowmem_ctrl;
223 int linkstate;
224 int opened;
225 struct delayed_work lowmem_work;
227 struct usb_device *dev;
228 struct usb_interface *intf;
229 struct net_device *net;
230 wait_queue_head_t term_wait;
232 struct urb *rx_urb;
233 struct urb *tx_urb;
234 struct urb *irq_urb;
236 dma_addr_t intbufferhandle;
237 __u8 *intbuffer;
238 dma_addr_t rxbufferhandle;
239 __u8 *rx_buf;
242 struct sk_buff *tx_skb;
244 __u8 *firmware_buf;
245 __u8 scratch[KAWETH_SCRATCH_SIZE];
246 __u16 packet_filter_bitmap;
248 struct kaweth_ethernet_configuration configuration;
250 struct net_device_stats stats;
253 /****************************************************************
254 * kaweth_control
255 ****************************************************************/
256 static int kaweth_control(struct kaweth_device *kaweth,
257 unsigned int pipe,
258 __u8 request,
259 __u8 requesttype,
260 __u16 value,
261 __u16 index,
262 void *data,
263 __u16 size,
264 int timeout)
266 struct usb_ctrlrequest *dr;
267 int retval;
269 dbg("kaweth_control()");
271 if(in_interrupt()) {
272 dbg("in_interrupt()");
273 return -EBUSY;
276 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
278 if (!dr) {
279 dbg("kmalloc() failed");
280 return -ENOMEM;
283 dr->bRequestType = requesttype;
284 dr->bRequest = request;
285 dr->wValue = cpu_to_le16(value);
286 dr->wIndex = cpu_to_le16(index);
287 dr->wLength = cpu_to_le16(size);
289 retval = kaweth_internal_control_msg(kaweth->dev,
290 pipe,
292 data,
293 size,
294 timeout);
296 kfree(dr);
297 return retval;
300 /****************************************************************
301 * kaweth_read_configuration
302 ****************************************************************/
303 static int kaweth_read_configuration(struct kaweth_device *kaweth)
305 int retval;
307 dbg("Reading kaweth configuration");
309 retval = kaweth_control(kaweth,
310 usb_rcvctrlpipe(kaweth->dev, 0),
311 KAWETH_COMMAND_GET_ETHERNET_DESC,
312 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
315 (void *)&kaweth->configuration,
316 sizeof(kaweth->configuration),
317 KAWETH_CONTROL_TIMEOUT);
319 return retval;
322 /****************************************************************
323 * kaweth_set_urb_size
324 ****************************************************************/
325 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
327 int retval;
329 dbg("Setting URB size to %d", (unsigned)urb_size);
331 retval = kaweth_control(kaweth,
332 usb_sndctrlpipe(kaweth->dev, 0),
333 KAWETH_COMMAND_SET_URB_SIZE,
334 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
335 urb_size,
337 (void *)&kaweth->scratch,
339 KAWETH_CONTROL_TIMEOUT);
341 return retval;
344 /****************************************************************
345 * kaweth_set_sofs_wait
346 ****************************************************************/
347 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
349 int retval;
351 dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
353 retval = kaweth_control(kaweth,
354 usb_sndctrlpipe(kaweth->dev, 0),
355 KAWETH_COMMAND_SET_SOFS_WAIT,
356 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
357 sofs_wait,
359 (void *)&kaweth->scratch,
361 KAWETH_CONTROL_TIMEOUT);
363 return retval;
366 /****************************************************************
367 * kaweth_set_receive_filter
368 ****************************************************************/
369 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
370 __u16 receive_filter)
372 int retval;
374 dbg("Set receive filter to %d", (unsigned)receive_filter);
376 retval = kaweth_control(kaweth,
377 usb_sndctrlpipe(kaweth->dev, 0),
378 KAWETH_COMMAND_SET_PACKET_FILTER,
379 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
380 receive_filter,
382 (void *)&kaweth->scratch,
384 KAWETH_CONTROL_TIMEOUT);
386 return retval;
389 /****************************************************************
390 * kaweth_download_firmware
391 ****************************************************************/
392 static int kaweth_download_firmware(struct kaweth_device *kaweth,
393 const char *fwname,
394 __u8 interrupt,
395 __u8 type)
397 const struct firmware *fw;
398 int data_len;
399 int ret;
401 ret = request_firmware(&fw, fwname, &kaweth->dev->dev);
402 if (ret) {
403 err("Firmware request failed\n");
404 return ret;
407 if (fw->size > KAWETH_FIRMWARE_BUF_SIZE) {
408 err("Firmware too big: %zu", fw->size);
409 return -ENOSPC;
411 data_len = fw->size;
412 memcpy(kaweth->firmware_buf, fw->data, fw->size);
414 release_firmware(fw);
416 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
417 kaweth->firmware_buf[3] = data_len >> 8;
418 kaweth->firmware_buf[4] = type;
419 kaweth->firmware_buf[5] = interrupt;
421 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
422 kaweth->firmware_buf[2]);
424 dbg("Downloading firmware at %p to kaweth device at %p",
425 fw->data, kaweth);
426 dbg("Firmware length: %d", data_len);
428 return kaweth_control(kaweth,
429 usb_sndctrlpipe(kaweth->dev, 0),
430 KAWETH_COMMAND_SCAN,
431 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
434 (void *)kaweth->firmware_buf,
435 data_len,
436 KAWETH_CONTROL_TIMEOUT);
439 /****************************************************************
440 * kaweth_trigger_firmware
441 ****************************************************************/
442 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
443 __u8 interrupt)
445 kaweth->firmware_buf[0] = 0xB6;
446 kaweth->firmware_buf[1] = 0xC3;
447 kaweth->firmware_buf[2] = 0x01;
448 kaweth->firmware_buf[3] = 0x00;
449 kaweth->firmware_buf[4] = 0x06;
450 kaweth->firmware_buf[5] = interrupt;
451 kaweth->firmware_buf[6] = 0x00;
452 kaweth->firmware_buf[7] = 0x00;
454 dbg("Triggering firmware");
456 return kaweth_control(kaweth,
457 usb_sndctrlpipe(kaweth->dev, 0),
458 KAWETH_COMMAND_SCAN,
459 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
462 (void *)kaweth->firmware_buf,
464 KAWETH_CONTROL_TIMEOUT);
467 /****************************************************************
468 * kaweth_reset
469 ****************************************************************/
470 static int kaweth_reset(struct kaweth_device *kaweth)
472 int result;
474 dbg("kaweth_reset(%p)", kaweth);
475 result = usb_reset_configuration(kaweth->dev);
476 mdelay(10);
478 dbg("kaweth_reset() returns %d.",result);
480 return result;
483 static void kaweth_usb_receive(struct urb *);
484 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
486 /****************************************************************
487 int_callback
488 *****************************************************************/
490 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
492 int status;
494 status = usb_submit_urb (kaweth->irq_urb, mf);
495 if (unlikely(status == -ENOMEM)) {
496 kaweth->suspend_lowmem_ctrl = 1;
497 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
498 } else {
499 kaweth->suspend_lowmem_ctrl = 0;
502 if (status)
503 err ("can't resubmit intr, %s-%s, status %d",
504 kaweth->dev->bus->bus_name,
505 kaweth->dev->devpath, status);
508 static void int_callback(struct urb *u)
510 struct kaweth_device *kaweth = u->context;
511 int act_state;
512 int status = u->status;
514 switch (status) {
515 case 0: /* success */
516 break;
517 case -ECONNRESET: /* unlink */
518 case -ENOENT:
519 case -ESHUTDOWN:
520 return;
521 /* -EPIPE: should clear the halt */
522 default: /* error */
523 goto resubmit;
526 /* we check the link state to report changes */
527 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
528 if (act_state)
529 netif_carrier_on(kaweth->net);
530 else
531 netif_carrier_off(kaweth->net);
533 kaweth->linkstate = act_state;
535 resubmit:
536 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
539 static void kaweth_resubmit_tl(struct work_struct *work)
541 struct kaweth_device *kaweth =
542 container_of(work, struct kaweth_device, lowmem_work.work);
544 if (IS_BLOCKED(kaweth->status))
545 return;
547 if (kaweth->suspend_lowmem_rx)
548 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
550 if (kaweth->suspend_lowmem_ctrl)
551 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
555 /****************************************************************
556 * kaweth_resubmit_rx_urb
557 ****************************************************************/
558 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
559 gfp_t mem_flags)
561 int result;
563 usb_fill_bulk_urb(kaweth->rx_urb,
564 kaweth->dev,
565 usb_rcvbulkpipe(kaweth->dev, 1),
566 kaweth->rx_buf,
567 KAWETH_BUF_SIZE,
568 kaweth_usb_receive,
569 kaweth);
570 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
571 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
573 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
574 if (result == -ENOMEM) {
575 kaweth->suspend_lowmem_rx = 1;
576 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
578 err("resubmitting rx_urb %d failed", result);
579 } else {
580 kaweth->suspend_lowmem_rx = 0;
583 return result;
586 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
588 /****************************************************************
589 * kaweth_usb_receive
590 ****************************************************************/
591 static void kaweth_usb_receive(struct urb *urb)
593 struct kaweth_device *kaweth = urb->context;
594 struct net_device *net = kaweth->net;
595 int status = urb->status;
597 int count = urb->actual_length;
598 int count2 = urb->transfer_buffer_length;
600 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
602 struct sk_buff *skb;
604 if (unlikely(status == -EPIPE)) {
605 kaweth->stats.rx_errors++;
606 kaweth->end = 1;
607 wake_up(&kaweth->term_wait);
608 dbg("Status was -EPIPE.");
609 return;
611 if (unlikely(status == -ECONNRESET || status == -ESHUTDOWN)) {
612 /* we are killed - set a flag and wake the disconnect handler */
613 kaweth->end = 1;
614 wake_up(&kaweth->term_wait);
615 dbg("Status was -ECONNRESET or -ESHUTDOWN.");
616 return;
618 if (unlikely(status == -EPROTO || status == -ETIME ||
619 status == -EILSEQ)) {
620 kaweth->stats.rx_errors++;
621 dbg("Status was -EPROTO, -ETIME, or -EILSEQ.");
622 return;
624 if (unlikely(status == -EOVERFLOW)) {
625 kaweth->stats.rx_errors++;
626 dbg("Status was -EOVERFLOW.");
628 spin_lock(&kaweth->device_lock);
629 if (IS_BLOCKED(kaweth->status)) {
630 spin_unlock(&kaweth->device_lock);
631 return;
633 spin_unlock(&kaweth->device_lock);
635 if(status && status != -EREMOTEIO && count != 1) {
636 err("%s RX status: %d count: %d packet_len: %d",
637 net->name,
638 status,
639 count,
640 (int)pkt_len);
641 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
642 return;
645 if(kaweth->net && (count > 2)) {
646 if(pkt_len > (count - 2)) {
647 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
648 err("Packet len & 2047: %x", pkt_len & 2047);
649 err("Count 2: %x", count2);
650 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
651 return;
654 if(!(skb = dev_alloc_skb(pkt_len+2))) {
655 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
656 return;
659 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
661 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
663 skb_put(skb, pkt_len);
665 skb->protocol = eth_type_trans(skb, net);
667 netif_rx(skb);
669 kaweth->stats.rx_packets++;
670 kaweth->stats.rx_bytes += pkt_len;
673 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
676 /****************************************************************
677 * kaweth_open
678 ****************************************************************/
679 static int kaweth_open(struct net_device *net)
681 struct kaweth_device *kaweth = netdev_priv(net);
682 int res;
684 dbg("Opening network device.");
686 res = usb_autopm_get_interface(kaweth->intf);
687 if (res) {
688 err("Interface cannot be resumed.");
689 return -EIO;
691 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
692 if (res)
693 goto err_out;
695 usb_fill_int_urb(
696 kaweth->irq_urb,
697 kaweth->dev,
698 usb_rcvintpipe(kaweth->dev, 3),
699 kaweth->intbuffer,
700 INTBUFFERSIZE,
701 int_callback,
702 kaweth,
703 250); /* overriding the descriptor */
704 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
705 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
707 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
708 if (res) {
709 usb_kill_urb(kaweth->rx_urb);
710 goto err_out;
712 kaweth->opened = 1;
714 netif_start_queue(net);
716 kaweth_async_set_rx_mode(kaweth);
717 return 0;
719 err_out:
720 usb_autopm_put_interface(kaweth->intf);
721 return -EIO;
724 /****************************************************************
725 * kaweth_kill_urbs
726 ****************************************************************/
727 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
729 usb_kill_urb(kaweth->irq_urb);
730 usb_kill_urb(kaweth->rx_urb);
731 usb_kill_urb(kaweth->tx_urb);
733 cancel_delayed_work_sync(&kaweth->lowmem_work);
735 /* a scheduled work may have resubmitted,
736 we hit them again */
737 usb_kill_urb(kaweth->irq_urb);
738 usb_kill_urb(kaweth->rx_urb);
741 /****************************************************************
742 * kaweth_close
743 ****************************************************************/
744 static int kaweth_close(struct net_device *net)
746 struct kaweth_device *kaweth = netdev_priv(net);
748 netif_stop_queue(net);
749 kaweth->opened = 0;
751 kaweth->status |= KAWETH_STATUS_CLOSING;
753 kaweth_kill_urbs(kaweth);
755 kaweth->status &= ~KAWETH_STATUS_CLOSING;
757 usb_autopm_put_interface(kaweth->intf);
759 return 0;
762 static u32 kaweth_get_link(struct net_device *dev)
764 struct kaweth_device *kaweth = netdev_priv(dev);
766 return kaweth->linkstate;
769 static const struct ethtool_ops ops = {
770 .get_link = kaweth_get_link
773 /****************************************************************
774 * kaweth_usb_transmit_complete
775 ****************************************************************/
776 static void kaweth_usb_transmit_complete(struct urb *urb)
778 struct kaweth_device *kaweth = urb->context;
779 struct sk_buff *skb = kaweth->tx_skb;
780 int status = urb->status;
782 if (unlikely(status != 0))
783 if (status != -ENOENT)
784 dbg("%s: TX status %d.", kaweth->net->name, status);
786 netif_wake_queue(kaweth->net);
787 dev_kfree_skb_irq(skb);
790 /****************************************************************
791 * kaweth_start_xmit
792 ****************************************************************/
793 static netdev_tx_t kaweth_start_xmit(struct sk_buff *skb,
794 struct net_device *net)
796 struct kaweth_device *kaweth = netdev_priv(net);
797 __le16 *private_header;
799 int res;
801 spin_lock_irq(&kaweth->device_lock);
803 kaweth_async_set_rx_mode(kaweth);
804 netif_stop_queue(net);
805 if (IS_BLOCKED(kaweth->status)) {
806 goto skip;
809 /* We now decide whether we can put our special header into the sk_buff */
810 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
811 /* no such luck - we make our own */
812 struct sk_buff *copied_skb;
813 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
814 dev_kfree_skb_irq(skb);
815 skb = copied_skb;
816 if (!copied_skb) {
817 kaweth->stats.tx_errors++;
818 netif_start_queue(net);
819 spin_unlock_irq(&kaweth->device_lock);
820 return NETDEV_TX_OK;
824 private_header = (__le16 *)__skb_push(skb, 2);
825 *private_header = cpu_to_le16(skb->len-2);
826 kaweth->tx_skb = skb;
828 usb_fill_bulk_urb(kaweth->tx_urb,
829 kaweth->dev,
830 usb_sndbulkpipe(kaweth->dev, 2),
831 private_header,
832 skb->len,
833 kaweth_usb_transmit_complete,
834 kaweth);
835 kaweth->end = 0;
837 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
839 dev_warn(&net->dev, "kaweth failed tx_urb %d\n", res);
840 skip:
841 kaweth->stats.tx_errors++;
843 netif_start_queue(net);
844 dev_kfree_skb_irq(skb);
846 else
848 kaweth->stats.tx_packets++;
849 kaweth->stats.tx_bytes += skb->len;
852 spin_unlock_irq(&kaweth->device_lock);
854 return NETDEV_TX_OK;
857 /****************************************************************
858 * kaweth_set_rx_mode
859 ****************************************************************/
860 static void kaweth_set_rx_mode(struct net_device *net)
862 struct kaweth_device *kaweth = netdev_priv(net);
864 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
865 KAWETH_PACKET_FILTER_BROADCAST |
866 KAWETH_PACKET_FILTER_MULTICAST;
868 dbg("Setting Rx mode to %d", packet_filter_bitmap);
870 netif_stop_queue(net);
872 if (net->flags & IFF_PROMISC) {
873 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
875 else if (!netdev_mc_empty(net) || (net->flags & IFF_ALLMULTI)) {
876 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
879 kaweth->packet_filter_bitmap = packet_filter_bitmap;
880 netif_wake_queue(net);
883 /****************************************************************
884 * kaweth_async_set_rx_mode
885 ****************************************************************/
886 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
888 int result;
889 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
891 kaweth->packet_filter_bitmap = 0;
892 if (packet_filter_bitmap == 0)
893 return;
895 if (in_interrupt())
896 return;
898 result = kaweth_control(kaweth,
899 usb_sndctrlpipe(kaweth->dev, 0),
900 KAWETH_COMMAND_SET_PACKET_FILTER,
901 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
902 packet_filter_bitmap,
904 (void *)&kaweth->scratch,
906 KAWETH_CONTROL_TIMEOUT);
908 if(result < 0) {
909 err("Failed to set Rx mode: %d", result);
911 else {
912 dbg("Set Rx mode to %d", packet_filter_bitmap);
916 /****************************************************************
917 * kaweth_netdev_stats
918 ****************************************************************/
919 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
921 struct kaweth_device *kaweth = netdev_priv(dev);
922 return &kaweth->stats;
925 /****************************************************************
926 * kaweth_tx_timeout
927 ****************************************************************/
928 static void kaweth_tx_timeout(struct net_device *net)
930 struct kaweth_device *kaweth = netdev_priv(net);
932 dev_warn(&net->dev, "%s: Tx timed out. Resetting.\n", net->name);
933 kaweth->stats.tx_errors++;
934 net->trans_start = jiffies;
936 usb_unlink_urb(kaweth->tx_urb);
939 /****************************************************************
940 * kaweth_suspend
941 ****************************************************************/
942 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
944 struct kaweth_device *kaweth = usb_get_intfdata(intf);
945 unsigned long flags;
947 dbg("Suspending device");
948 spin_lock_irqsave(&kaweth->device_lock, flags);
949 kaweth->status |= KAWETH_STATUS_SUSPENDING;
950 spin_unlock_irqrestore(&kaweth->device_lock, flags);
952 kaweth_kill_urbs(kaweth);
953 return 0;
956 /****************************************************************
957 * kaweth_resume
958 ****************************************************************/
959 static int kaweth_resume(struct usb_interface *intf)
961 struct kaweth_device *kaweth = usb_get_intfdata(intf);
962 unsigned long flags;
964 dbg("Resuming device");
965 spin_lock_irqsave(&kaweth->device_lock, flags);
966 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
967 spin_unlock_irqrestore(&kaweth->device_lock, flags);
969 if (!kaweth->opened)
970 return 0;
971 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
972 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
974 return 0;
977 /****************************************************************
978 * kaweth_probe
979 ****************************************************************/
982 static const struct net_device_ops kaweth_netdev_ops = {
983 .ndo_open = kaweth_open,
984 .ndo_stop = kaweth_close,
985 .ndo_start_xmit = kaweth_start_xmit,
986 .ndo_tx_timeout = kaweth_tx_timeout,
987 .ndo_set_multicast_list = kaweth_set_rx_mode,
988 .ndo_get_stats = kaweth_netdev_stats,
989 .ndo_change_mtu = eth_change_mtu,
990 .ndo_set_mac_address = eth_mac_addr,
991 .ndo_validate_addr = eth_validate_addr,
994 static int kaweth_probe(
995 struct usb_interface *intf,
996 const struct usb_device_id *id /* from id_table */
999 struct usb_device *dev = interface_to_usbdev(intf);
1000 struct kaweth_device *kaweth;
1001 struct net_device *netdev;
1002 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1003 int result = 0;
1005 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
1006 dev->devnum,
1007 le16_to_cpu(dev->descriptor.idVendor),
1008 le16_to_cpu(dev->descriptor.idProduct),
1009 le16_to_cpu(dev->descriptor.bcdDevice));
1011 dbg("Device at %p", dev);
1013 dbg("Descriptor length: %x type: %x",
1014 (int)dev->descriptor.bLength,
1015 (int)dev->descriptor.bDescriptorType);
1017 netdev = alloc_etherdev(sizeof(*kaweth));
1018 if (!netdev)
1019 return -ENOMEM;
1021 kaweth = netdev_priv(netdev);
1022 kaweth->dev = dev;
1023 kaweth->net = netdev;
1025 spin_lock_init(&kaweth->device_lock);
1026 init_waitqueue_head(&kaweth->term_wait);
1028 dbg("Resetting.");
1030 kaweth_reset(kaweth);
1033 * If high byte of bcdDevice is nonzero, firmware is already
1034 * downloaded. Don't try to do it again, or we'll hang the device.
1037 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1038 dev_info(&intf->dev, "Firmware present in device.\n");
1039 } else {
1040 /* Download the firmware */
1041 dev_info(&intf->dev, "Downloading firmware...\n");
1042 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1043 if ((result = kaweth_download_firmware(kaweth,
1044 "kaweth/new_code.bin",
1045 100,
1046 2)) < 0) {
1047 err("Error downloading firmware (%d)", result);
1048 goto err_fw;
1051 if ((result = kaweth_download_firmware(kaweth,
1052 "kaweth/new_code_fix.bin",
1053 100,
1054 3)) < 0) {
1055 err("Error downloading firmware fix (%d)", result);
1056 goto err_fw;
1059 if ((result = kaweth_download_firmware(kaweth,
1060 "kaweth/trigger_code.bin",
1061 126,
1062 2)) < 0) {
1063 err("Error downloading trigger code (%d)", result);
1064 goto err_fw;
1068 if ((result = kaweth_download_firmware(kaweth,
1069 "kaweth/trigger_code_fix.bin",
1070 126,
1071 3)) < 0) {
1072 err("Error downloading trigger code fix (%d)", result);
1073 goto err_fw;
1077 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1078 err("Error triggering firmware (%d)", result);
1079 goto err_fw;
1082 /* Device will now disappear for a moment... */
1083 dev_info(&intf->dev, "Firmware loaded. I'll be back...\n");
1084 err_fw:
1085 free_page((unsigned long)kaweth->firmware_buf);
1086 free_netdev(netdev);
1087 return -EIO;
1090 result = kaweth_read_configuration(kaweth);
1092 if(result < 0) {
1093 err("Error reading configuration (%d), no net device created", result);
1094 goto err_free_netdev;
1097 dev_info(&intf->dev, "Statistics collection: %x\n", kaweth->configuration.statistics_mask);
1098 dev_info(&intf->dev, "Multicast filter limit: %x\n", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1099 dev_info(&intf->dev, "MTU: %d\n", le16_to_cpu(kaweth->configuration.segment_size));
1100 dev_info(&intf->dev, "Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n",
1101 (int)kaweth->configuration.hw_addr[0],
1102 (int)kaweth->configuration.hw_addr[1],
1103 (int)kaweth->configuration.hw_addr[2],
1104 (int)kaweth->configuration.hw_addr[3],
1105 (int)kaweth->configuration.hw_addr[4],
1106 (int)kaweth->configuration.hw_addr[5]);
1108 if(!memcmp(&kaweth->configuration.hw_addr,
1109 &bcast_addr,
1110 sizeof(bcast_addr))) {
1111 err("Firmware not functioning properly, no net device created");
1112 goto err_free_netdev;
1115 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1116 dbg("Error setting URB size");
1117 goto err_free_netdev;
1120 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1121 err("Error setting SOFS wait");
1122 goto err_free_netdev;
1125 result = kaweth_set_receive_filter(kaweth,
1126 KAWETH_PACKET_FILTER_DIRECTED |
1127 KAWETH_PACKET_FILTER_BROADCAST |
1128 KAWETH_PACKET_FILTER_MULTICAST);
1130 if(result < 0) {
1131 err("Error setting receive filter");
1132 goto err_free_netdev;
1135 dbg("Initializing net device.");
1137 kaweth->intf = intf;
1139 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1140 if (!kaweth->tx_urb)
1141 goto err_free_netdev;
1142 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1143 if (!kaweth->rx_urb)
1144 goto err_only_tx;
1145 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1146 if (!kaweth->irq_urb)
1147 goto err_tx_and_rx;
1149 kaweth->intbuffer = usb_alloc_coherent( kaweth->dev,
1150 INTBUFFERSIZE,
1151 GFP_KERNEL,
1152 &kaweth->intbufferhandle);
1153 if (!kaweth->intbuffer)
1154 goto err_tx_and_rx_and_irq;
1155 kaweth->rx_buf = usb_alloc_coherent( kaweth->dev,
1156 KAWETH_BUF_SIZE,
1157 GFP_KERNEL,
1158 &kaweth->rxbufferhandle);
1159 if (!kaweth->rx_buf)
1160 goto err_all_but_rxbuf;
1162 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1163 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1164 sizeof(kaweth->configuration.hw_addr));
1166 netdev->netdev_ops = &kaweth_netdev_ops;
1167 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1168 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1169 SET_ETHTOOL_OPS(netdev, &ops);
1171 /* kaweth is zeroed as part of alloc_netdev */
1172 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1173 usb_set_intfdata(intf, kaweth);
1175 #if 0
1176 // dma_supported() is deeply broken on almost all architectures
1177 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1178 kaweth->net->features |= NETIF_F_HIGHDMA;
1179 #endif
1181 SET_NETDEV_DEV(netdev, &intf->dev);
1182 if (register_netdev(netdev) != 0) {
1183 err("Error registering netdev.");
1184 goto err_intfdata;
1187 dev_info(&intf->dev, "kaweth interface created at %s\n",
1188 kaweth->net->name);
1190 dbg("Kaweth probe returning.");
1192 return 0;
1194 err_intfdata:
1195 usb_set_intfdata(intf, NULL);
1196 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1197 err_all_but_rxbuf:
1198 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1199 err_tx_and_rx_and_irq:
1200 usb_free_urb(kaweth->irq_urb);
1201 err_tx_and_rx:
1202 usb_free_urb(kaweth->rx_urb);
1203 err_only_tx:
1204 usb_free_urb(kaweth->tx_urb);
1205 err_free_netdev:
1206 free_netdev(netdev);
1208 return -EIO;
1211 /****************************************************************
1212 * kaweth_disconnect
1213 ****************************************************************/
1214 static void kaweth_disconnect(struct usb_interface *intf)
1216 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1217 struct net_device *netdev;
1219 dev_info(&intf->dev, "Unregistering\n");
1221 usb_set_intfdata(intf, NULL);
1222 if (!kaweth) {
1223 dev_warn(&intf->dev, "unregistering non-existant device\n");
1224 return;
1226 netdev = kaweth->net;
1228 dbg("Unregistering net device");
1229 unregister_netdev(netdev);
1231 usb_free_urb(kaweth->rx_urb);
1232 usb_free_urb(kaweth->tx_urb);
1233 usb_free_urb(kaweth->irq_urb);
1235 usb_free_coherent(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1236 usb_free_coherent(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1238 free_netdev(netdev);
1242 // FIXME this completion stuff is a modified clone of
1243 // an OLD version of some stuff in usb.c ...
1244 struct usb_api_data {
1245 wait_queue_head_t wqh;
1246 int done;
1249 /*-------------------------------------------------------------------*
1250 * completion handler for compatibility wrappers (sync control/bulk) *
1251 *-------------------------------------------------------------------*/
1252 static void usb_api_blocking_completion(struct urb *urb)
1254 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1256 awd->done=1;
1257 wake_up(&awd->wqh);
1260 /*-------------------------------------------------------------------*
1261 * COMPATIBILITY STUFF *
1262 *-------------------------------------------------------------------*/
1264 // Starts urb and waits for completion or timeout
1265 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1267 struct usb_api_data awd;
1268 int status;
1270 init_waitqueue_head(&awd.wqh);
1271 awd.done = 0;
1273 urb->context = &awd;
1274 status = usb_submit_urb(urb, GFP_NOIO);
1275 if (status) {
1276 // something went wrong
1277 usb_free_urb(urb);
1278 return status;
1281 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1282 // timeout
1283 dev_warn(&urb->dev->dev, "usb_control/bulk_msg: timeout\n");
1284 usb_kill_urb(urb); // remove urb safely
1285 status = -ETIMEDOUT;
1287 else {
1288 status = urb->status;
1291 if (actual_length) {
1292 *actual_length = urb->actual_length;
1295 usb_free_urb(urb);
1296 return status;
1299 /*-------------------------------------------------------------------*/
1300 // returns status (negative) or length (positive)
1301 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1302 unsigned int pipe,
1303 struct usb_ctrlrequest *cmd, void *data,
1304 int len, int timeout)
1306 struct urb *urb;
1307 int retv;
1308 int length = 0; /* shut up GCC */
1310 urb = usb_alloc_urb(0, GFP_NOIO);
1311 if (!urb)
1312 return -ENOMEM;
1314 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1315 len, usb_api_blocking_completion, NULL);
1317 retv = usb_start_wait_urb(urb, timeout, &length);
1318 if (retv < 0) {
1319 return retv;
1321 else {
1322 return length;
1327 /****************************************************************
1328 * kaweth_init
1329 ****************************************************************/
1330 static int __init kaweth_init(void)
1332 dbg("Driver loading");
1333 return usb_register(&kaweth_driver);
1336 /****************************************************************
1337 * kaweth_exit
1338 ****************************************************************/
1339 static void __exit kaweth_exit(void)
1341 usb_deregister(&kaweth_driver);
1344 module_init(kaweth_init);
1345 module_exit(kaweth_exit);