ia64/kvm: compilation fix. export account_system_vtime.
[pv_ops_mirror.git] / drivers / net / usb / kaweth.c
blob0dcfc0310264deddbe390ff13dda342a31b2f937
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 * Fix in_interrupt() problem
35 * Develop test procedures for USB net interfaces
36 * Run test procedures
37 * Fix bugs from previous two steps
38 * Snoop other OSs for any tricks we're not doing
39 * SMP locking
40 * Reduce arbitrary timeouts
41 * Smart multicast support
42 * Temporary MAC change support
43 * Tunable SOFs parameter - ioctl()?
44 * Ethernet stats collection
45 * Code formatting improvements
48 #include <linux/module.h>
49 #include <linux/slab.h>
50 #include <linux/string.h>
51 #include <linux/init.h>
52 #include <linux/delay.h>
53 #include <linux/netdevice.h>
54 #include <linux/etherdevice.h>
55 #include <linux/usb.h>
56 #include <linux/types.h>
57 #include <linux/ethtool.h>
58 #include <linux/dma-mapping.h>
59 #include <linux/wait.h>
60 #include <asm/uaccess.h>
61 #include <asm/byteorder.h>
63 #undef DEBUG
65 #include "kawethfw.h"
67 #define KAWETH_MTU 1514
68 #define KAWETH_BUF_SIZE 1664
69 #define KAWETH_TX_TIMEOUT (5 * HZ)
70 #define KAWETH_SCRATCH_SIZE 32
71 #define KAWETH_FIRMWARE_BUF_SIZE 4096
72 #define KAWETH_CONTROL_TIMEOUT (30000)
74 #define KAWETH_STATUS_BROKEN 0x0000001
75 #define KAWETH_STATUS_CLOSING 0x0000002
76 #define KAWETH_STATUS_SUSPENDING 0x0000004
78 #define KAWETH_STATUS_BLOCKED (KAWETH_STATUS_CLOSING | KAWETH_STATUS_SUSPENDING)
80 #define KAWETH_PACKET_FILTER_PROMISCUOUS 0x01
81 #define KAWETH_PACKET_FILTER_ALL_MULTICAST 0x02
82 #define KAWETH_PACKET_FILTER_DIRECTED 0x04
83 #define KAWETH_PACKET_FILTER_BROADCAST 0x08
84 #define KAWETH_PACKET_FILTER_MULTICAST 0x10
86 /* Table 7 */
87 #define KAWETH_COMMAND_GET_ETHERNET_DESC 0x00
88 #define KAWETH_COMMAND_MULTICAST_FILTERS 0x01
89 #define KAWETH_COMMAND_SET_PACKET_FILTER 0x02
90 #define KAWETH_COMMAND_STATISTICS 0x03
91 #define KAWETH_COMMAND_SET_TEMP_MAC 0x06
92 #define KAWETH_COMMAND_GET_TEMP_MAC 0x07
93 #define KAWETH_COMMAND_SET_URB_SIZE 0x08
94 #define KAWETH_COMMAND_SET_SOFS_WAIT 0x09
95 #define KAWETH_COMMAND_SCAN 0xFF
97 #define KAWETH_SOFS_TO_WAIT 0x05
99 #define INTBUFFERSIZE 4
101 #define STATE_OFFSET 0
102 #define STATE_MASK 0x40
103 #define STATE_SHIFT 5
105 #define IS_BLOCKED(s) (s & KAWETH_STATUS_BLOCKED)
108 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>");
109 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
110 MODULE_LICENSE("GPL");
112 static const char driver_name[] = "kaweth";
114 static int kaweth_probe(
115 struct usb_interface *intf,
116 const struct usb_device_id *id /* from id_table */
118 static void kaweth_disconnect(struct usb_interface *intf);
119 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
120 unsigned int pipe,
121 struct usb_ctrlrequest *cmd, void *data,
122 int len, int timeout);
123 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message);
124 static int kaweth_resume(struct usb_interface *intf);
126 /****************************************************************
127 * usb_device_id
128 ****************************************************************/
129 static struct usb_device_id usb_klsi_table[] = {
130 { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
131 { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
132 { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
133 { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
134 { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
135 { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
136 { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
137 { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
138 { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
139 { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
140 { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
141 { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
142 { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
143 { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
144 { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
145 { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
146 { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
147 { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
148 { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
149 { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
150 { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
151 { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
152 { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
153 { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
154 { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
155 { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
156 { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
157 { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
158 { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
159 { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
160 { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
161 { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
162 { USB_DEVICE(0x1668, 0x0323) }, /* Actiontec USB Ethernet */
163 { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
164 {} /* Null terminator */
167 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
169 /****************************************************************
170 * kaweth_driver
171 ****************************************************************/
172 static struct usb_driver kaweth_driver = {
173 .name = driver_name,
174 .probe = kaweth_probe,
175 .disconnect = kaweth_disconnect,
176 .suspend = kaweth_suspend,
177 .resume = kaweth_resume,
178 .id_table = usb_klsi_table,
179 .supports_autosuspend = 1,
182 typedef __u8 eth_addr_t[6];
184 /****************************************************************
185 * usb_eth_dev
186 ****************************************************************/
187 struct usb_eth_dev {
188 char *name;
189 __u16 vendor;
190 __u16 device;
191 void *pdata;
194 /****************************************************************
195 * kaweth_ethernet_configuration
196 * Refer Table 8
197 ****************************************************************/
198 struct kaweth_ethernet_configuration
200 __u8 size;
201 __u8 reserved1;
202 __u8 reserved2;
203 eth_addr_t hw_addr;
204 __u32 statistics_mask;
205 __le16 segment_size;
206 __u16 max_multicast_filters;
207 __u8 reserved3;
208 } __attribute__ ((packed));
210 /****************************************************************
211 * kaweth_device
212 ****************************************************************/
213 struct kaweth_device
215 spinlock_t device_lock;
217 __u32 status;
218 int end;
219 int suspend_lowmem_rx;
220 int suspend_lowmem_ctrl;
221 int linkstate;
222 int opened;
223 struct delayed_work lowmem_work;
225 struct usb_device *dev;
226 struct usb_interface *intf;
227 struct net_device *net;
228 wait_queue_head_t term_wait;
230 struct urb *rx_urb;
231 struct urb *tx_urb;
232 struct urb *irq_urb;
234 dma_addr_t intbufferhandle;
235 __u8 *intbuffer;
236 dma_addr_t rxbufferhandle;
237 __u8 *rx_buf;
240 struct sk_buff *tx_skb;
242 __u8 *firmware_buf;
243 __u8 scratch[KAWETH_SCRATCH_SIZE];
244 __u16 packet_filter_bitmap;
246 struct kaweth_ethernet_configuration configuration;
248 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_le16p(&value);
284 dr->wIndex = cpu_to_le16p(&index);
285 dr->wLength = cpu_to_le16p(&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 __u8 *data,
389 __u16 data_len,
390 __u8 interrupt,
391 __u8 type)
393 if(data_len > KAWETH_FIRMWARE_BUF_SIZE) {
394 err("Firmware too big: %d", data_len);
395 return -ENOSPC;
398 memcpy(kaweth->firmware_buf, data, data_len);
400 kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
401 kaweth->firmware_buf[3] = data_len >> 8;
402 kaweth->firmware_buf[4] = type;
403 kaweth->firmware_buf[5] = interrupt;
405 dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
406 kaweth->firmware_buf[2]);
408 dbg("Downloading firmware at %p to kaweth device at %p",
409 data,
410 kaweth);
411 dbg("Firmware length: %d", data_len);
413 return kaweth_control(kaweth,
414 usb_sndctrlpipe(kaweth->dev, 0),
415 KAWETH_COMMAND_SCAN,
416 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
419 (void *)kaweth->firmware_buf,
420 data_len,
421 KAWETH_CONTROL_TIMEOUT);
424 /****************************************************************
425 * kaweth_trigger_firmware
426 ****************************************************************/
427 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
428 __u8 interrupt)
430 kaweth->firmware_buf[0] = 0xB6;
431 kaweth->firmware_buf[1] = 0xC3;
432 kaweth->firmware_buf[2] = 0x01;
433 kaweth->firmware_buf[3] = 0x00;
434 kaweth->firmware_buf[4] = 0x06;
435 kaweth->firmware_buf[5] = interrupt;
436 kaweth->firmware_buf[6] = 0x00;
437 kaweth->firmware_buf[7] = 0x00;
439 dbg("Triggering firmware");
441 return kaweth_control(kaweth,
442 usb_sndctrlpipe(kaweth->dev, 0),
443 KAWETH_COMMAND_SCAN,
444 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
447 (void *)kaweth->firmware_buf,
449 KAWETH_CONTROL_TIMEOUT);
452 /****************************************************************
453 * kaweth_reset
454 ****************************************************************/
455 static int kaweth_reset(struct kaweth_device *kaweth)
457 int result;
459 dbg("kaweth_reset(%p)", kaweth);
460 result = kaweth_control(kaweth,
461 usb_sndctrlpipe(kaweth->dev, 0),
462 USB_REQ_SET_CONFIGURATION,
464 kaweth->dev->config[0].desc.bConfigurationValue,
466 NULL,
468 KAWETH_CONTROL_TIMEOUT);
470 mdelay(10);
472 dbg("kaweth_reset() returns %d.",result);
474 return result;
477 static void kaweth_usb_receive(struct urb *);
478 static int kaweth_resubmit_rx_urb(struct kaweth_device *, gfp_t);
480 /****************************************************************
481 int_callback
482 *****************************************************************/
484 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, gfp_t mf)
486 int status;
488 status = usb_submit_urb (kaweth->irq_urb, mf);
489 if (unlikely(status == -ENOMEM)) {
490 kaweth->suspend_lowmem_ctrl = 1;
491 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
492 } else {
493 kaweth->suspend_lowmem_ctrl = 0;
496 if (status)
497 err ("can't resubmit intr, %s-%s, status %d",
498 kaweth->dev->bus->bus_name,
499 kaweth->dev->devpath, status);
502 static void int_callback(struct urb *u)
504 struct kaweth_device *kaweth = u->context;
505 int act_state;
507 switch (u->status) {
508 case 0: /* success */
509 break;
510 case -ECONNRESET: /* unlink */
511 case -ENOENT:
512 case -ESHUTDOWN:
513 return;
514 /* -EPIPE: should clear the halt */
515 default: /* error */
516 goto resubmit;
519 /* we check the link state to report changes */
520 if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
521 if (act_state)
522 netif_carrier_on(kaweth->net);
523 else
524 netif_carrier_off(kaweth->net);
526 kaweth->linkstate = act_state;
528 resubmit:
529 kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
532 static void kaweth_resubmit_tl(struct work_struct *work)
534 struct kaweth_device *kaweth =
535 container_of(work, struct kaweth_device, lowmem_work.work);
537 if (IS_BLOCKED(kaweth->status))
538 return;
540 if (kaweth->suspend_lowmem_rx)
541 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
543 if (kaweth->suspend_lowmem_ctrl)
544 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
548 /****************************************************************
549 * kaweth_resubmit_rx_urb
550 ****************************************************************/
551 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
552 gfp_t mem_flags)
554 int result;
556 usb_fill_bulk_urb(kaweth->rx_urb,
557 kaweth->dev,
558 usb_rcvbulkpipe(kaweth->dev, 1),
559 kaweth->rx_buf,
560 KAWETH_BUF_SIZE,
561 kaweth_usb_receive,
562 kaweth);
563 kaweth->rx_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
564 kaweth->rx_urb->transfer_dma = kaweth->rxbufferhandle;
566 if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
567 if (result == -ENOMEM) {
568 kaweth->suspend_lowmem_rx = 1;
569 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
571 err("resubmitting rx_urb %d failed", result);
572 } else {
573 kaweth->suspend_lowmem_rx = 0;
576 return result;
579 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
581 /****************************************************************
582 * kaweth_usb_receive
583 ****************************************************************/
584 static void kaweth_usb_receive(struct urb *urb)
586 struct kaweth_device *kaweth = urb->context;
587 struct net_device *net = kaweth->net;
589 int count = urb->actual_length;
590 int count2 = urb->transfer_buffer_length;
592 __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
594 struct sk_buff *skb;
596 if(unlikely(urb->status == -ECONNRESET || urb->status == -ESHUTDOWN))
597 /* we are killed - set a flag and wake the disconnect handler */
599 kaweth->end = 1;
600 wake_up(&kaweth->term_wait);
601 return;
604 spin_lock(&kaweth->device_lock);
605 if (IS_BLOCKED(kaweth->status)) {
606 spin_unlock(&kaweth->device_lock);
607 return;
609 spin_unlock(&kaweth->device_lock);
611 if(urb->status && urb->status != -EREMOTEIO && count != 1) {
612 err("%s RX status: %d count: %d packet_len: %d",
613 net->name,
614 urb->status,
615 count,
616 (int)pkt_len);
617 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
618 return;
621 if(kaweth->net && (count > 2)) {
622 if(pkt_len > (count - 2)) {
623 err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
624 err("Packet len & 2047: %x", pkt_len & 2047);
625 err("Count 2: %x", count2);
626 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
627 return;
630 if(!(skb = dev_alloc_skb(pkt_len+2))) {
631 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
632 return;
635 skb_reserve(skb, 2); /* Align IP on 16 byte boundaries */
637 skb_copy_to_linear_data(skb, kaweth->rx_buf + 2, pkt_len);
639 skb_put(skb, pkt_len);
641 skb->protocol = eth_type_trans(skb, net);
643 netif_rx(skb);
645 kaweth->stats.rx_packets++;
646 kaweth->stats.rx_bytes += pkt_len;
649 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
652 /****************************************************************
653 * kaweth_open
654 ****************************************************************/
655 static int kaweth_open(struct net_device *net)
657 struct kaweth_device *kaweth = netdev_priv(net);
658 int res;
660 dbg("Opening network device.");
662 res = usb_autopm_get_interface(kaweth->intf);
663 if (res) {
664 err("Interface cannot be resumed.");
665 return -EIO;
667 res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
668 if (res)
669 goto err_out;
671 usb_fill_int_urb(
672 kaweth->irq_urb,
673 kaweth->dev,
674 usb_rcvintpipe(kaweth->dev, 3),
675 kaweth->intbuffer,
676 INTBUFFERSIZE,
677 int_callback,
678 kaweth,
679 250); /* overriding the descriptor */
680 kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
681 kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
683 res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
684 if (res) {
685 usb_kill_urb(kaweth->rx_urb);
686 goto err_out;
688 kaweth->opened = 1;
690 netif_start_queue(net);
692 kaweth_async_set_rx_mode(kaweth);
693 return 0;
695 err_out:
696 usb_autopm_enable(kaweth->intf);
697 return -EIO;
700 /****************************************************************
701 * kaweth_kill_urbs
702 ****************************************************************/
703 static void kaweth_kill_urbs(struct kaweth_device *kaweth)
705 usb_kill_urb(kaweth->irq_urb);
706 usb_kill_urb(kaweth->rx_urb);
707 usb_kill_urb(kaweth->tx_urb);
709 flush_scheduled_work();
711 /* a scheduled work may have resubmitted,
712 we hit them again */
713 usb_kill_urb(kaweth->irq_urb);
714 usb_kill_urb(kaweth->rx_urb);
717 /****************************************************************
718 * kaweth_close
719 ****************************************************************/
720 static int kaweth_close(struct net_device *net)
722 struct kaweth_device *kaweth = netdev_priv(net);
724 netif_stop_queue(net);
725 kaweth->opened = 0;
727 kaweth->status |= KAWETH_STATUS_CLOSING;
729 kaweth_kill_urbs(kaweth);
731 kaweth->status &= ~KAWETH_STATUS_CLOSING;
733 usb_autopm_enable(kaweth->intf);
735 return 0;
738 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
740 struct kaweth_device *kaweth = netdev_priv(dev);
742 strlcpy(info->driver, driver_name, sizeof(info->driver));
743 usb_make_path(kaweth->dev, info->bus_info, sizeof (info->bus_info));
746 static u32 kaweth_get_link(struct net_device *dev)
748 struct kaweth_device *kaweth = netdev_priv(dev);
750 return kaweth->linkstate;
753 static struct ethtool_ops ops = {
754 .get_drvinfo = kaweth_get_drvinfo,
755 .get_link = kaweth_get_link
758 /****************************************************************
759 * kaweth_usb_transmit_complete
760 ****************************************************************/
761 static void kaweth_usb_transmit_complete(struct urb *urb)
763 struct kaweth_device *kaweth = urb->context;
764 struct sk_buff *skb = kaweth->tx_skb;
766 if (unlikely(urb->status != 0))
767 if (urb->status != -ENOENT)
768 dbg("%s: TX status %d.", kaweth->net->name, urb->status);
770 netif_wake_queue(kaweth->net);
771 dev_kfree_skb_irq(skb);
774 /****************************************************************
775 * kaweth_start_xmit
776 ****************************************************************/
777 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
779 struct kaweth_device *kaweth = netdev_priv(net);
780 __le16 *private_header;
782 int res;
784 spin_lock(&kaweth->device_lock);
786 kaweth_async_set_rx_mode(kaweth);
787 netif_stop_queue(net);
788 if (IS_BLOCKED(kaweth->status)) {
789 goto skip;
792 /* We now decide whether we can put our special header into the sk_buff */
793 if (skb_cloned(skb) || skb_headroom(skb) < 2) {
794 /* no such luck - we make our own */
795 struct sk_buff *copied_skb;
796 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
797 dev_kfree_skb_irq(skb);
798 skb = copied_skb;
799 if (!copied_skb) {
800 kaweth->stats.tx_errors++;
801 netif_start_queue(net);
802 spin_unlock(&kaweth->device_lock);
803 return 0;
807 private_header = (__le16 *)__skb_push(skb, 2);
808 *private_header = cpu_to_le16(skb->len-2);
809 kaweth->tx_skb = skb;
811 usb_fill_bulk_urb(kaweth->tx_urb,
812 kaweth->dev,
813 usb_sndbulkpipe(kaweth->dev, 2),
814 private_header,
815 skb->len,
816 kaweth_usb_transmit_complete,
817 kaweth);
818 kaweth->end = 0;
820 if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
822 warn("kaweth failed tx_urb %d", res);
823 skip:
824 kaweth->stats.tx_errors++;
826 netif_start_queue(net);
827 dev_kfree_skb_irq(skb);
829 else
831 kaweth->stats.tx_packets++;
832 kaweth->stats.tx_bytes += skb->len;
833 net->trans_start = jiffies;
836 spin_unlock(&kaweth->device_lock);
838 return 0;
841 /****************************************************************
842 * kaweth_set_rx_mode
843 ****************************************************************/
844 static void kaweth_set_rx_mode(struct net_device *net)
846 struct kaweth_device *kaweth = netdev_priv(net);
848 __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
849 KAWETH_PACKET_FILTER_BROADCAST |
850 KAWETH_PACKET_FILTER_MULTICAST;
852 dbg("Setting Rx mode to %d", packet_filter_bitmap);
854 netif_stop_queue(net);
856 if (net->flags & IFF_PROMISC) {
857 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
859 else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
860 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
863 kaweth->packet_filter_bitmap = packet_filter_bitmap;
864 netif_wake_queue(net);
867 /****************************************************************
868 * kaweth_async_set_rx_mode
869 ****************************************************************/
870 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
872 __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
873 kaweth->packet_filter_bitmap = 0;
874 if (packet_filter_bitmap == 0)
875 return;
878 int result;
879 result = kaweth_control(kaweth,
880 usb_sndctrlpipe(kaweth->dev, 0),
881 KAWETH_COMMAND_SET_PACKET_FILTER,
882 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
883 packet_filter_bitmap,
885 (void *)&kaweth->scratch,
887 KAWETH_CONTROL_TIMEOUT);
889 if(result < 0) {
890 err("Failed to set Rx mode: %d", result);
892 else {
893 dbg("Set Rx mode to %d", packet_filter_bitmap);
898 /****************************************************************
899 * kaweth_netdev_stats
900 ****************************************************************/
901 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
903 struct kaweth_device *kaweth = netdev_priv(dev);
904 return &kaweth->stats;
907 /****************************************************************
908 * kaweth_tx_timeout
909 ****************************************************************/
910 static void kaweth_tx_timeout(struct net_device *net)
912 struct kaweth_device *kaweth = netdev_priv(net);
914 warn("%s: Tx timed out. Resetting.", net->name);
915 kaweth->stats.tx_errors++;
916 net->trans_start = jiffies;
918 usb_unlink_urb(kaweth->tx_urb);
921 /****************************************************************
922 * kaweth_suspend
923 ****************************************************************/
924 static int kaweth_suspend(struct usb_interface *intf, pm_message_t message)
926 struct kaweth_device *kaweth = usb_get_intfdata(intf);
927 unsigned long flags;
929 dbg("Suspending device");
930 spin_lock_irqsave(&kaweth->device_lock, flags);
931 kaweth->status |= KAWETH_STATUS_SUSPENDING;
932 spin_unlock_irqrestore(&kaweth->device_lock, flags);
934 kaweth_kill_urbs(kaweth);
935 return 0;
938 /****************************************************************
939 * kaweth_resume
940 ****************************************************************/
941 static int kaweth_resume(struct usb_interface *intf)
943 struct kaweth_device *kaweth = usb_get_intfdata(intf);
944 unsigned long flags;
946 dbg("Resuming device");
947 spin_lock_irqsave(&kaweth->device_lock, flags);
948 kaweth->status &= ~KAWETH_STATUS_SUSPENDING;
949 spin_unlock_irqrestore(&kaweth->device_lock, flags);
951 if (!kaweth->opened)
952 return 0;
953 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
954 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
956 return 0;
959 /****************************************************************
960 * kaweth_probe
961 ****************************************************************/
962 static int kaweth_probe(
963 struct usb_interface *intf,
964 const struct usb_device_id *id /* from id_table */
967 struct usb_device *dev = interface_to_usbdev(intf);
968 struct kaweth_device *kaweth;
969 struct net_device *netdev;
970 const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
971 int result = 0;
973 dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
974 dev->devnum,
975 le16_to_cpu(dev->descriptor.idVendor),
976 le16_to_cpu(dev->descriptor.idProduct),
977 le16_to_cpu(dev->descriptor.bcdDevice));
979 dbg("Device at %p", dev);
981 dbg("Descriptor length: %x type: %x",
982 (int)dev->descriptor.bLength,
983 (int)dev->descriptor.bDescriptorType);
985 netdev = alloc_etherdev(sizeof(*kaweth));
986 if (!netdev)
987 return -ENOMEM;
989 kaweth = netdev_priv(netdev);
990 kaweth->dev = dev;
991 kaweth->net = netdev;
993 spin_lock_init(&kaweth->device_lock);
994 init_waitqueue_head(&kaweth->term_wait);
996 dbg("Resetting.");
998 kaweth_reset(kaweth);
1001 * If high byte of bcdDevice is nonzero, firmware is already
1002 * downloaded. Don't try to do it again, or we'll hang the device.
1005 if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
1006 info("Firmware present in device.");
1007 } else {
1008 /* Download the firmware */
1009 info("Downloading firmware...");
1010 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
1011 if ((result = kaweth_download_firmware(kaweth,
1012 kaweth_new_code,
1013 len_kaweth_new_code,
1014 100,
1015 2)) < 0) {
1016 err("Error downloading firmware (%d)", result);
1017 goto err_fw;
1020 if ((result = kaweth_download_firmware(kaweth,
1021 kaweth_new_code_fix,
1022 len_kaweth_new_code_fix,
1023 100,
1024 3)) < 0) {
1025 err("Error downloading firmware fix (%d)", result);
1026 goto err_fw;
1029 if ((result = kaweth_download_firmware(kaweth,
1030 kaweth_trigger_code,
1031 len_kaweth_trigger_code,
1032 126,
1033 2)) < 0) {
1034 err("Error downloading trigger code (%d)", result);
1035 goto err_fw;
1039 if ((result = kaweth_download_firmware(kaweth,
1040 kaweth_trigger_code_fix,
1041 len_kaweth_trigger_code_fix,
1042 126,
1043 3)) < 0) {
1044 err("Error downloading trigger code fix (%d)", result);
1045 goto err_fw;
1049 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
1050 err("Error triggering firmware (%d)", result);
1051 goto err_fw;
1054 /* Device will now disappear for a moment... */
1055 info("Firmware loaded. I'll be back...");
1056 err_fw:
1057 free_page((unsigned long)kaweth->firmware_buf);
1058 free_netdev(netdev);
1059 return -EIO;
1062 result = kaweth_read_configuration(kaweth);
1064 if(result < 0) {
1065 err("Error reading configuration (%d), no net device created", result);
1066 goto err_free_netdev;
1069 info("Statistics collection: %x", kaweth->configuration.statistics_mask);
1070 info("Multicast filter limit: %x", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1071 info("MTU: %d", le16_to_cpu(kaweth->configuration.segment_size));
1072 info("Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
1073 (int)kaweth->configuration.hw_addr[0],
1074 (int)kaweth->configuration.hw_addr[1],
1075 (int)kaweth->configuration.hw_addr[2],
1076 (int)kaweth->configuration.hw_addr[3],
1077 (int)kaweth->configuration.hw_addr[4],
1078 (int)kaweth->configuration.hw_addr[5]);
1080 if(!memcmp(&kaweth->configuration.hw_addr,
1081 &bcast_addr,
1082 sizeof(bcast_addr))) {
1083 err("Firmware not functioning properly, no net device created");
1084 goto err_free_netdev;
1087 if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1088 dbg("Error setting URB size");
1089 goto err_free_netdev;
1092 if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1093 err("Error setting SOFS wait");
1094 goto err_free_netdev;
1097 result = kaweth_set_receive_filter(kaweth,
1098 KAWETH_PACKET_FILTER_DIRECTED |
1099 KAWETH_PACKET_FILTER_BROADCAST |
1100 KAWETH_PACKET_FILTER_MULTICAST);
1102 if(result < 0) {
1103 err("Error setting receive filter");
1104 goto err_free_netdev;
1107 dbg("Initializing net device.");
1109 kaweth->intf = intf;
1111 kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1112 if (!kaweth->tx_urb)
1113 goto err_free_netdev;
1114 kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1115 if (!kaweth->rx_urb)
1116 goto err_only_tx;
1117 kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1118 if (!kaweth->irq_urb)
1119 goto err_tx_and_rx;
1121 kaweth->intbuffer = usb_buffer_alloc( kaweth->dev,
1122 INTBUFFERSIZE,
1123 GFP_KERNEL,
1124 &kaweth->intbufferhandle);
1125 if (!kaweth->intbuffer)
1126 goto err_tx_and_rx_and_irq;
1127 kaweth->rx_buf = usb_buffer_alloc( kaweth->dev,
1128 KAWETH_BUF_SIZE,
1129 GFP_KERNEL,
1130 &kaweth->rxbufferhandle);
1131 if (!kaweth->rx_buf)
1132 goto err_all_but_rxbuf;
1134 memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1135 memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1136 sizeof(kaweth->configuration.hw_addr));
1138 netdev->open = kaweth_open;
1139 netdev->stop = kaweth_close;
1141 netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1142 netdev->tx_timeout = kaweth_tx_timeout;
1144 netdev->hard_start_xmit = kaweth_start_xmit;
1145 netdev->set_multicast_list = kaweth_set_rx_mode;
1146 netdev->get_stats = kaweth_netdev_stats;
1147 netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1148 SET_ETHTOOL_OPS(netdev, &ops);
1150 /* kaweth is zeroed as part of alloc_netdev */
1152 INIT_DELAYED_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl);
1154 usb_set_intfdata(intf, kaweth);
1156 #if 0
1157 // dma_supported() is deeply broken on almost all architectures
1158 if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1159 kaweth->net->features |= NETIF_F_HIGHDMA;
1160 #endif
1162 SET_NETDEV_DEV(netdev, &intf->dev);
1163 if (register_netdev(netdev) != 0) {
1164 err("Error registering netdev.");
1165 goto err_intfdata;
1168 info("kaweth interface created at %s", kaweth->net->name);
1170 dbg("Kaweth probe returning.");
1172 return 0;
1174 err_intfdata:
1175 usb_set_intfdata(intf, NULL);
1176 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1177 err_all_but_rxbuf:
1178 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1179 err_tx_and_rx_and_irq:
1180 usb_free_urb(kaweth->irq_urb);
1181 err_tx_and_rx:
1182 usb_free_urb(kaweth->rx_urb);
1183 err_only_tx:
1184 usb_free_urb(kaweth->tx_urb);
1185 err_free_netdev:
1186 free_netdev(netdev);
1188 return -EIO;
1191 /****************************************************************
1192 * kaweth_disconnect
1193 ****************************************************************/
1194 static void kaweth_disconnect(struct usb_interface *intf)
1196 struct kaweth_device *kaweth = usb_get_intfdata(intf);
1197 struct net_device *netdev;
1199 info("Unregistering");
1201 usb_set_intfdata(intf, NULL);
1202 if (!kaweth) {
1203 warn("unregistering non-existant device");
1204 return;
1206 netdev = kaweth->net;
1208 dbg("Unregistering net device");
1209 unregister_netdev(netdev);
1211 usb_free_urb(kaweth->rx_urb);
1212 usb_free_urb(kaweth->tx_urb);
1213 usb_free_urb(kaweth->irq_urb);
1215 usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1216 usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1218 free_netdev(netdev);
1222 // FIXME this completion stuff is a modified clone of
1223 // an OLD version of some stuff in usb.c ...
1224 struct usb_api_data {
1225 wait_queue_head_t wqh;
1226 int done;
1229 /*-------------------------------------------------------------------*
1230 * completion handler for compatibility wrappers (sync control/bulk) *
1231 *-------------------------------------------------------------------*/
1232 static void usb_api_blocking_completion(struct urb *urb)
1234 struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1236 awd->done=1;
1237 wake_up(&awd->wqh);
1240 /*-------------------------------------------------------------------*
1241 * COMPATIBILITY STUFF *
1242 *-------------------------------------------------------------------*/
1244 // Starts urb and waits for completion or timeout
1245 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1247 struct usb_api_data awd;
1248 int status;
1250 init_waitqueue_head(&awd.wqh);
1251 awd.done = 0;
1253 urb->context = &awd;
1254 status = usb_submit_urb(urb, GFP_NOIO);
1255 if (status) {
1256 // something went wrong
1257 usb_free_urb(urb);
1258 return status;
1261 if (!wait_event_timeout(awd.wqh, awd.done, timeout)) {
1262 // timeout
1263 warn("usb_control/bulk_msg: timeout");
1264 usb_kill_urb(urb); // remove urb safely
1265 status = -ETIMEDOUT;
1267 else {
1268 status = urb->status;
1271 if (actual_length) {
1272 *actual_length = urb->actual_length;
1275 usb_free_urb(urb);
1276 return status;
1279 /*-------------------------------------------------------------------*/
1280 // returns status (negative) or length (positive)
1281 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1282 unsigned int pipe,
1283 struct usb_ctrlrequest *cmd, void *data,
1284 int len, int timeout)
1286 struct urb *urb;
1287 int retv;
1288 int length = 0; /* shut up GCC */
1290 urb = usb_alloc_urb(0, GFP_NOIO);
1291 if (!urb)
1292 return -ENOMEM;
1294 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1295 len, usb_api_blocking_completion, NULL);
1297 retv = usb_start_wait_urb(urb, timeout, &length);
1298 if (retv < 0) {
1299 return retv;
1301 else {
1302 return length;
1307 /****************************************************************
1308 * kaweth_init
1309 ****************************************************************/
1310 static int __init kaweth_init(void)
1312 dbg("Driver loading");
1313 return usb_register(&kaweth_driver);
1316 /****************************************************************
1317 * kaweth_exit
1318 ****************************************************************/
1319 static void __exit kaweth_exit(void)
1321 usb_deregister(&kaweth_driver);
1324 module_init(kaweth_init);
1325 module_exit(kaweth_exit);