vserver 1.9.5.x5
[linux-2.6.git] / drivers / usb / net / kaweth.c
1 /****************************************************************
2  *
3  *     kaweth.c - driver for KL5KUSB101 based USB->Ethernet
4  *
5  *     (c) 2000 Interlan Communications
6  *     (c) 2000 Stephane Alnet
7  *     (C) 2001 Brad Hards
8  *     (C) 2002 Oliver Neukum
9  *
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.
16  *
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.
21  *
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.
26  *
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.
30  *
31  ****************************************************************/
32
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
46  */
47
48 #include <linux/module.h>
49 #include <linux/sched.h>
50 #include <linux/slab.h>
51 #include <linux/string.h>
52 #include <linux/init.h>
53 #include <linux/delay.h>
54 #include <linux/netdevice.h>
55 #include <linux/etherdevice.h>
56 #include <linux/usb.h>
57 #include <linux/types.h>
58 #include <linux/ethtool.h>
59 #include <linux/pci.h>
60 #include <linux/dma-mapping.h>
61 #include <asm/uaccess.h>
62 #include <asm/semaphore.h>
63 #include <asm/byteorder.h>
64
65 #undef DEBUG
66
67 #ifdef DEBUG
68 #define kaweth_dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format "\n" ,##arg)
69 #else
70 #define kaweth_dbg(format, arg...) do {} while (0)
71 #endif
72 #define kaweth_err(format, arg...) printk(KERN_ERR __FILE__ ": " format "\n" ,##arg)
73 #define kaweth_info(format, arg...) printk(KERN_INFO __FILE__ ": " format "\n" , ##arg)
74 #define kaweth_warn(format, arg...) printk(KERN_WARNING __FILE__ ": " format "\n" , ##arg)
75
76
77 #include "kawethfw.h"
78
79 #define KAWETH_MTU                      1514
80 #define KAWETH_BUF_SIZE                 1664
81 #define KAWETH_TX_TIMEOUT               (5 * HZ)
82 #define KAWETH_SCRATCH_SIZE             32
83 #define KAWETH_FIRMWARE_BUF_SIZE        4096
84 #define KAWETH_CONTROL_TIMEOUT          (30 * HZ)
85
86 #define KAWETH_STATUS_BROKEN            0x0000001
87 #define KAWETH_STATUS_CLOSING           0x0000002
88
89 #define KAWETH_PACKET_FILTER_PROMISCUOUS        0x01
90 #define KAWETH_PACKET_FILTER_ALL_MULTICAST      0x02
91 #define KAWETH_PACKET_FILTER_DIRECTED           0x04
92 #define KAWETH_PACKET_FILTER_BROADCAST          0x08
93 #define KAWETH_PACKET_FILTER_MULTICAST          0x10
94
95 /* Table 7 */
96 #define KAWETH_COMMAND_GET_ETHERNET_DESC        0x00
97 #define KAWETH_COMMAND_MULTICAST_FILTERS        0x01
98 #define KAWETH_COMMAND_SET_PACKET_FILTER        0x02
99 #define KAWETH_COMMAND_STATISTICS               0x03
100 #define KAWETH_COMMAND_SET_TEMP_MAC             0x06
101 #define KAWETH_COMMAND_GET_TEMP_MAC             0x07
102 #define KAWETH_COMMAND_SET_URB_SIZE             0x08
103 #define KAWETH_COMMAND_SET_SOFS_WAIT            0x09
104 #define KAWETH_COMMAND_SCAN                     0xFF
105
106 #define KAWETH_SOFS_TO_WAIT                     0x05
107
108 #define INTBUFFERSIZE                           4
109
110 #define STATE_OFFSET                            0
111 #define STATE_MASK                              0x40
112 #define STATE_SHIFT                             5
113
114
115 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>");
116 MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
117 MODULE_LICENSE("GPL");
118
119 static const char driver_name[] = "kaweth";
120
121 static int kaweth_probe(
122                 struct usb_interface *intf,
123                 const struct usb_device_id *id  /* from id_table */
124         );
125 static void kaweth_disconnect(struct usb_interface *intf);
126 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
127                                        unsigned int pipe,
128                                        struct usb_ctrlrequest *cmd, void *data,
129                                        int len, int timeout);
130
131 /****************************************************************
132  *     usb_device_id
133  ****************************************************************/
134 static struct usb_device_id usb_klsi_table[] = {
135         { USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
136         { USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
137         { USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
138         { USB_DEVICE(0x0506, 0x11f8) }, /* 3Com 3C460 */
139         { USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
140         { USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
141         { USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
142         { USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
143         { USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
144         { USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
145         { USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
146         { USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
147         { USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
148         { USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
149         { USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
150         { USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
151         { USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
152         { USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
153         { USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
154         { USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
155         { USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
156         { USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
157         { USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
158         { USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
159         { USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
160         { USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
161         { USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
162         { USB_DEVICE(0x1485, 0x0001) }, /* Silicom U2E */
163         { USB_DEVICE(0x1485, 0x0002) }, /* Psion Dacom Gold Port Ethernet */
164         { USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
165         { USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
166         { USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
167         { USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
168         {} /* Null terminator */
169 };
170
171 MODULE_DEVICE_TABLE (usb, usb_klsi_table);
172
173 /****************************************************************
174  *     kaweth_driver
175  ****************************************************************/
176 static struct usb_driver kaweth_driver = {
177         .owner =        THIS_MODULE,
178         .name =         driver_name,
179         .probe =        kaweth_probe,
180         .disconnect =   kaweth_disconnect,
181         .id_table =     usb_klsi_table,
182 };
183
184 typedef __u8 eth_addr_t[6];
185
186 /****************************************************************
187  *     usb_eth_dev
188  ****************************************************************/
189 struct usb_eth_dev {
190         char *name;
191         __u16 vendor;
192         __u16 device;
193         void *pdata;
194 };
195
196 /****************************************************************
197  *     kaweth_ethernet_configuration
198  *     Refer Table 8
199  ****************************************************************/
200 struct kaweth_ethernet_configuration
201 {
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 } __attribute__ ((packed));
211
212 /****************************************************************
213  *     kaweth_device
214  ****************************************************************/
215 struct kaweth_device
216 {
217         spinlock_t device_lock;
218
219         __u32 status;
220         int end;
221         int removed;
222         int suspend_lowmem_rx;
223         int suspend_lowmem_ctrl;
224         int linkstate;
225         struct work_struct lowmem_work;
226
227         struct usb_device *dev;
228         struct net_device *net;
229         wait_queue_head_t term_wait;
230
231         struct urb *rx_urb;
232         struct urb *tx_urb;
233         struct urb *irq_urb;
234
235         dma_addr_t intbufferhandle;
236         __u8 *intbuffer;
237         dma_addr_t rxbufferhandle;
238         __u8 *rx_buf;
239
240         
241         struct sk_buff *tx_skb;
242
243         __u8 *firmware_buf;
244         __u8 scratch[KAWETH_SCRATCH_SIZE];
245         __u16 packet_filter_bitmap;
246
247         struct kaweth_ethernet_configuration configuration;
248
249         struct net_device_stats stats;
250 };
251
252
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)
265 {
266         struct usb_ctrlrequest *dr;
267
268         kaweth_dbg("kaweth_control()");
269
270         if(in_interrupt()) {
271                 kaweth_dbg("in_interrupt()");
272                 return -EBUSY;
273         }
274
275         dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
276
277         if (!dr) {
278                 kaweth_dbg("kmalloc() failed");
279                 return -ENOMEM;
280         }
281
282         dr->bRequestType= requesttype;
283         dr->bRequest = request;
284         dr->wValue = cpu_to_le16p(&value);
285         dr->wIndex = cpu_to_le16p(&index);
286         dr->wLength = cpu_to_le16p(&size);
287
288         return kaweth_internal_control_msg(kaweth->dev,
289                                         pipe,
290                                         dr,
291                                         data,
292                                         size,
293                                         timeout);
294 }
295
296 /****************************************************************
297  *     kaweth_read_configuration
298  ****************************************************************/
299 static int kaweth_read_configuration(struct kaweth_device *kaweth)
300 {
301         int retval;
302
303         kaweth_dbg("Reading kaweth configuration");
304
305         retval = kaweth_control(kaweth,
306                                 usb_rcvctrlpipe(kaweth->dev, 0),
307                                 KAWETH_COMMAND_GET_ETHERNET_DESC,
308                                 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
309                                 0,
310                                 0,
311                                 (void *)&kaweth->configuration,
312                                 sizeof(kaweth->configuration),
313                                 KAWETH_CONTROL_TIMEOUT);
314
315         return retval;
316 }
317
318 /****************************************************************
319  *     kaweth_set_urb_size
320  ****************************************************************/
321 static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
322 {
323         int retval;
324
325         kaweth_dbg("Setting URB size to %d", (unsigned)urb_size);
326
327         retval = kaweth_control(kaweth,
328                                 usb_sndctrlpipe(kaweth->dev, 0),
329                                 KAWETH_COMMAND_SET_URB_SIZE,
330                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
331                                 urb_size,
332                                 0,
333                                 (void *)&kaweth->scratch,
334                                 0,
335                                 KAWETH_CONTROL_TIMEOUT);
336
337         return retval;
338 }
339
340 /****************************************************************
341  *     kaweth_set_sofs_wait
342  ****************************************************************/
343 static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
344 {
345         int retval;
346
347         kaweth_dbg("Set SOFS wait to %d", (unsigned)sofs_wait);
348
349         retval = kaweth_control(kaweth,
350                                 usb_sndctrlpipe(kaweth->dev, 0),
351                                 KAWETH_COMMAND_SET_SOFS_WAIT,
352                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
353                                 sofs_wait,
354                                 0,
355                                 (void *)&kaweth->scratch,
356                                 0,
357                                 KAWETH_CONTROL_TIMEOUT);
358
359         return retval;
360 }
361
362 /****************************************************************
363  *     kaweth_set_receive_filter
364  ****************************************************************/
365 static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
366                                      __u16 receive_filter)
367 {
368         int retval;
369
370         kaweth_dbg("Set receive filter to %d", (unsigned)receive_filter);
371
372         retval = kaweth_control(kaweth,
373                                 usb_sndctrlpipe(kaweth->dev, 0),
374                                 KAWETH_COMMAND_SET_PACKET_FILTER,
375                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
376                                 receive_filter,
377                                 0,
378                                 (void *)&kaweth->scratch,
379                                 0,
380                                 KAWETH_CONTROL_TIMEOUT);
381
382         return retval;
383 }
384
385 /****************************************************************
386  *     kaweth_download_firmware
387  ****************************************************************/
388 static int kaweth_download_firmware(struct kaweth_device *kaweth,
389                                     __u8 *data,
390                                     __u16 data_len,
391                                     __u8 interrupt,
392                                     __u8 type)
393 {
394         if(data_len > KAWETH_FIRMWARE_BUF_SIZE) {
395                 kaweth_err("Firmware too big: %d", data_len);
396                 return -ENOSPC;
397         }
398
399         memcpy(kaweth->firmware_buf, data, data_len);
400
401         kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
402         kaweth->firmware_buf[3] = data_len >> 8;
403         kaweth->firmware_buf[4] = type;
404         kaweth->firmware_buf[5] = interrupt;
405
406         kaweth_dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
407                    kaweth->firmware_buf[2]);
408
409         kaweth_dbg("Downloading firmware at %p to kaweth device at %p",
410             data,
411             kaweth);
412         kaweth_dbg("Firmware length: %d", data_len);
413
414         return kaweth_control(kaweth,
415                               usb_sndctrlpipe(kaweth->dev, 0),
416                               KAWETH_COMMAND_SCAN,
417                               USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
418                               0,
419                               0,
420                               (void *)kaweth->firmware_buf,
421                               data_len,
422                               KAWETH_CONTROL_TIMEOUT);
423 }
424
425 /****************************************************************
426  *     kaweth_trigger_firmware
427  ****************************************************************/
428 static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
429                                    __u8 interrupt)
430 {
431         kaweth->firmware_buf[0] = 0xB6;
432         kaweth->firmware_buf[1] = 0xC3;
433         kaweth->firmware_buf[2] = 0x01;
434         kaweth->firmware_buf[3] = 0x00;
435         kaweth->firmware_buf[4] = 0x06;
436         kaweth->firmware_buf[5] = interrupt;
437         kaweth->firmware_buf[6] = 0x00;
438         kaweth->firmware_buf[7] = 0x00;
439
440         kaweth_dbg("Triggering firmware");
441
442         return kaweth_control(kaweth,
443                               usb_sndctrlpipe(kaweth->dev, 0),
444                               KAWETH_COMMAND_SCAN,
445                               USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
446                               0,
447                               0,
448                               (void *)kaweth->firmware_buf,
449                               8,
450                               KAWETH_CONTROL_TIMEOUT);
451 }
452
453 /****************************************************************
454  *     kaweth_reset
455  ****************************************************************/
456 static int kaweth_reset(struct kaweth_device *kaweth)
457 {
458         int result;
459
460         kaweth_dbg("kaweth_reset(%p)", kaweth);
461         result = kaweth_control(kaweth,
462                                 usb_sndctrlpipe(kaweth->dev, 0),
463                                 USB_REQ_SET_CONFIGURATION,
464                                 0,
465                                 kaweth->dev->config[0].desc.bConfigurationValue,
466                                 0,
467                                 NULL,
468                                 0,
469                                 KAWETH_CONTROL_TIMEOUT);
470
471         udelay(10000);
472
473         kaweth_dbg("kaweth_reset() returns %d.",result);
474
475         return result;
476 }
477
478 static void kaweth_usb_receive(struct urb *, struct pt_regs *regs);
479 static int kaweth_resubmit_rx_urb(struct kaweth_device *, int);
480
481 /****************************************************************
482         int_callback
483 *****************************************************************/
484
485 static void kaweth_resubmit_int_urb(struct kaweth_device *kaweth, int mf)
486 {
487         int status;
488
489         status = usb_submit_urb (kaweth->irq_urb, mf);
490         if (unlikely(status == -ENOMEM)) {
491                 kaweth->suspend_lowmem_ctrl = 1;
492                 schedule_delayed_work(&kaweth->lowmem_work, HZ/4);
493         } else {
494                 kaweth->suspend_lowmem_ctrl = 0;
495         }
496
497         if (status)
498                 err ("can't resubmit intr, %s-%s, status %d",
499                                 kaweth->dev->bus->bus_name,
500                                 kaweth->dev->devpath, status);
501 }
502
503 static void int_callback(struct urb *u, struct pt_regs *regs)
504 {
505         struct kaweth_device *kaweth = u->context;
506         int act_state;
507
508         switch (u->status) {
509         case 0:                 /* success */
510                 break;
511         case -ECONNRESET:       /* unlink */
512         case -ENOENT:
513         case -ESHUTDOWN:
514                 return;
515         /* -EPIPE:  should clear the halt */
516         default:                /* error */
517                 goto resubmit;
518         }
519
520         /* we check the link state to report changes */
521         if (kaweth->linkstate != (act_state = ( kaweth->intbuffer[STATE_OFFSET] | STATE_MASK) >> STATE_SHIFT)) {
522                 if (!act_state)
523                         netif_carrier_on(kaweth->net);
524                 else
525                         netif_carrier_off(kaweth->net);
526
527                 kaweth->linkstate = act_state;
528         }
529 resubmit:
530         kaweth_resubmit_int_urb(kaweth, GFP_ATOMIC);
531 }
532
533 static void kaweth_resubmit_tl(void *d)
534 {
535         struct kaweth_device *kaweth = (struct kaweth_device *)d;
536
537         if (kaweth->status | KAWETH_STATUS_CLOSING)
538                 return;
539
540         if (kaweth->suspend_lowmem_rx)
541                 kaweth_resubmit_rx_urb(kaweth, GFP_NOIO);
542
543         if (kaweth->suspend_lowmem_ctrl)
544                 kaweth_resubmit_int_urb(kaweth, GFP_NOIO);
545 }
546
547
548 /****************************************************************
549  *     kaweth_resubmit_rx_urb
550  ****************************************************************/
551 static int kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
552                                                 int mem_flags)
553 {
554         int result;
555
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;
565
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);
570                 }
571                 kaweth_err("resubmitting rx_urb %d failed", result);
572         } else {
573                 kaweth->suspend_lowmem_rx = 0;
574         }
575
576         return result;
577 }
578
579 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);
580
581 /****************************************************************
582  *     kaweth_usb_receive
583  ****************************************************************/
584 static void kaweth_usb_receive(struct urb *urb, struct pt_regs *regs)
585 {
586         struct kaweth_device *kaweth = urb->context;
587         struct net_device *net = kaweth->net;
588
589         int count = urb->actual_length;
590         int count2 = urb->transfer_buffer_length;
591
592         __u16 pkt_len = le16_to_cpup((__le16 *)kaweth->rx_buf);
593
594         struct sk_buff *skb;
595
596         if(unlikely(urb->status == -ECONNRESET || urb->status == -ECONNABORTED || urb->status == -ESHUTDOWN))
597         /* we are killed - set a flag and wake the disconnect handler */
598         {
599                 kaweth->end = 1;
600                 wake_up(&kaweth->term_wait);
601                 return;
602         }
603
604         if (kaweth->status & KAWETH_STATUS_CLOSING)
605                 return;
606
607         if(urb->status && urb->status != -EREMOTEIO && count != 1) {
608                 kaweth_err("%s RX status: %d count: %d packet_len: %d",
609                            net->name,
610                            urb->status,
611                            count,
612                            (int)pkt_len);
613                 kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
614                 return;
615         }
616
617         if(kaweth->net && (count > 2)) {
618                 if(pkt_len > (count - 2)) {
619                         kaweth_err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
620                         kaweth_err("Packet len & 2047: %x", pkt_len & 2047);
621                         kaweth_err("Count 2: %x", count2);
622                         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
623                         return;
624                 }
625
626                 if(!(skb = dev_alloc_skb(pkt_len+2))) {
627                         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
628                         return;
629                 }
630
631                 skb_reserve(skb, 2);    /* Align IP on 16 byte boundaries */
632
633                 skb->dev = net;
634
635                 eth_copy_and_sum(skb, kaweth->rx_buf + 2, pkt_len, 0);
636
637                 skb_put(skb, pkt_len);
638
639                 skb->protocol = eth_type_trans(skb, net);
640
641                 netif_rx(skb);
642
643                 kaweth->stats.rx_packets++;
644                 kaweth->stats.rx_bytes += pkt_len;
645         }
646
647         kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
648 }
649
650 /****************************************************************
651  *     kaweth_open
652  ****************************************************************/
653 static int kaweth_open(struct net_device *net)
654 {
655         struct kaweth_device *kaweth = netdev_priv(net);
656         int res;
657
658         kaweth_dbg("Opening network device.");
659
660         res = kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
661         if (res)
662                 return -EIO;
663
664         usb_fill_int_urb(
665                 kaweth->irq_urb,
666                 kaweth->dev,
667                 usb_rcvintpipe(kaweth->dev, 3),
668                 kaweth->intbuffer,
669                 INTBUFFERSIZE,
670                 int_callback,
671                 kaweth,
672                 250); /* overriding the descriptor */
673         kaweth->irq_urb->transfer_dma = kaweth->intbufferhandle;
674         kaweth->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
675
676         res = usb_submit_urb(kaweth->irq_urb, GFP_KERNEL);
677         if (res) {
678                 usb_kill_urb(kaweth->rx_urb);
679                 return -EIO;
680         }
681
682         netif_start_queue(net);
683
684         kaweth_async_set_rx_mode(kaweth);
685         return 0;
686 }
687
688 /****************************************************************
689  *     kaweth_close
690  ****************************************************************/
691 static int kaweth_close(struct net_device *net)
692 {
693         struct kaweth_device *kaweth = netdev_priv(net);
694
695         netif_stop_queue(net);
696
697         kaweth->status |= KAWETH_STATUS_CLOSING;
698
699         usb_kill_urb(kaweth->irq_urb);
700         usb_kill_urb(kaweth->rx_urb);
701
702         flush_scheduled_work();
703
704         /* a scheduled work may have resubmitted,
705            we hit them again */
706         usb_kill_urb(kaweth->irq_urb);
707         usb_kill_urb(kaweth->rx_urb);
708
709         kaweth->status &= ~KAWETH_STATUS_CLOSING;
710
711         return 0;
712 }
713
714 static void kaweth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
715 {
716
717         strlcpy(info->driver, driver_name, sizeof(info->driver));
718 }
719
720 static struct ethtool_ops ops = {
721         .get_drvinfo = kaweth_get_drvinfo
722 };
723
724 /****************************************************************
725  *     kaweth_usb_transmit_complete
726  ****************************************************************/
727 static void kaweth_usb_transmit_complete(struct urb *urb, struct pt_regs *regs)
728 {
729         struct kaweth_device *kaweth = urb->context;
730         struct sk_buff *skb = kaweth->tx_skb;
731
732         if (unlikely(urb->status != 0))
733                 if (urb->status != -ENOENT)
734                         kaweth_dbg("%s: TX status %d.", kaweth->net->name, urb->status);
735
736         netif_wake_queue(kaweth->net);
737         dev_kfree_skb_irq(skb);
738 }
739
740 /****************************************************************
741  *     kaweth_start_xmit
742  ****************************************************************/
743 static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
744 {
745         struct kaweth_device *kaweth = netdev_priv(net);
746         __le16 *private_header;
747
748         int res;
749
750         spin_lock(&kaweth->device_lock);
751
752         if (kaweth->removed) {
753         /* our device is undergoing disconnection - we bail out */
754                 spin_unlock(&kaweth->device_lock);
755                 dev_kfree_skb_irq(skb);
756                 return 0;
757         }
758
759         kaweth_async_set_rx_mode(kaweth);
760         netif_stop_queue(net);
761
762         /* We now decide whether we can put our special header into the sk_buff */
763         if (skb_cloned(skb) || skb_headroom(skb) < 2) {
764                 /* no such luck - we make our own */
765                 struct sk_buff *copied_skb;
766                 copied_skb = skb_copy_expand(skb, 2, 0, GFP_ATOMIC);
767                 dev_kfree_skb_irq(skb);
768                 skb = copied_skb;
769                 if (!copied_skb) {
770                         kaweth->stats.tx_errors++;
771                         netif_start_queue(net);
772                         spin_unlock(&kaweth->device_lock);
773                         return 0;
774                 }
775         }
776
777         private_header = (__le16 *)__skb_push(skb, 2);
778         *private_header = cpu_to_le16(skb->len-2);
779         kaweth->tx_skb = skb;
780
781         usb_fill_bulk_urb(kaweth->tx_urb,
782                       kaweth->dev,
783                       usb_sndbulkpipe(kaweth->dev, 2),
784                       private_header,
785                       skb->len,
786                       kaweth_usb_transmit_complete,
787                       kaweth);
788         kaweth->end = 0;
789         kaweth->tx_urb->transfer_flags |= URB_ASYNC_UNLINK;
790
791         if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
792         {
793                 kaweth_warn("kaweth failed tx_urb %d", res);
794                 kaweth->stats.tx_errors++;
795
796                 netif_start_queue(net);
797                 dev_kfree_skb_irq(skb);
798         }
799         else
800         {
801                 kaweth->stats.tx_packets++;
802                 kaweth->stats.tx_bytes += skb->len;
803                 net->trans_start = jiffies;
804         }
805
806         spin_unlock(&kaweth->device_lock);
807
808         return 0;
809 }
810
811 /****************************************************************
812  *     kaweth_set_rx_mode
813  ****************************************************************/
814 static void kaweth_set_rx_mode(struct net_device *net)
815 {
816         struct kaweth_device *kaweth = netdev_priv(net);
817
818         __u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
819                                      KAWETH_PACKET_FILTER_BROADCAST |
820                                      KAWETH_PACKET_FILTER_MULTICAST;
821
822         kaweth_dbg("Setting Rx mode to %d", packet_filter_bitmap);
823
824         netif_stop_queue(net);
825
826         if (net->flags & IFF_PROMISC) {
827                 packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
828         }
829         else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
830                 packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
831         }
832
833         kaweth->packet_filter_bitmap = packet_filter_bitmap;
834         netif_wake_queue(net);
835 }
836
837 /****************************************************************
838  *     kaweth_async_set_rx_mode
839  ****************************************************************/
840 static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
841 {
842         __u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
843         kaweth->packet_filter_bitmap = 0;
844         if (packet_filter_bitmap == 0)
845                 return;
846
847         {
848         int result;
849         result = kaweth_control(kaweth,
850                                 usb_sndctrlpipe(kaweth->dev, 0),
851                                 KAWETH_COMMAND_SET_PACKET_FILTER,
852                                 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
853                                 packet_filter_bitmap,
854                                 0,
855                                 (void *)&kaweth->scratch,
856                                 0,
857                                 KAWETH_CONTROL_TIMEOUT);
858
859         if(result < 0) {
860                 kaweth_err("Failed to set Rx mode: %d", result);
861         }
862         else {
863                 kaweth_dbg("Set Rx mode to %d", packet_filter_bitmap);
864         }
865         }
866 }
867
868 /****************************************************************
869  *     kaweth_netdev_stats
870  ****************************************************************/
871 static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
872 {
873         struct kaweth_device *kaweth = netdev_priv(dev);
874         return &kaweth->stats;
875 }
876
877 /****************************************************************
878  *     kaweth_tx_timeout
879  ****************************************************************/
880 static void kaweth_tx_timeout(struct net_device *net)
881 {
882         struct kaweth_device *kaweth = netdev_priv(net);
883
884         kaweth_warn("%s: Tx timed out. Resetting.", net->name);
885         kaweth->stats.tx_errors++;
886         net->trans_start = jiffies;
887
888         usb_unlink_urb(kaweth->tx_urb);
889 }
890
891 /****************************************************************
892  *     kaweth_probe
893  ****************************************************************/
894 static int kaweth_probe(
895                 struct usb_interface *intf,
896                 const struct usb_device_id *id      /* from id_table */
897         )
898 {
899         struct usb_device *dev = interface_to_usbdev(intf);
900         struct kaweth_device *kaweth;
901         struct net_device *netdev;
902         const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
903         int result = 0;
904
905         kaweth_dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
906                  dev->devnum,
907                  le16_to_cpu(dev->descriptor.idVendor),
908                  le16_to_cpu(dev->descriptor.idProduct),
909                  le16_to_cpu(dev->descriptor.bcdDevice));
910
911         kaweth_dbg("Device at %p", dev);
912
913         kaweth_dbg("Descriptor length: %x type: %x",
914                  (int)dev->descriptor.bLength,
915                  (int)dev->descriptor.bDescriptorType);
916
917         netdev = alloc_etherdev(sizeof(*kaweth));
918         if (!netdev)
919                 return -ENOMEM;
920
921         kaweth = netdev_priv(netdev);
922         kaweth->dev = dev;
923         kaweth->net = netdev;
924
925         spin_lock_init(&kaweth->device_lock);
926         init_waitqueue_head(&kaweth->term_wait);
927
928         kaweth_dbg("Resetting.");
929
930         kaweth_reset(kaweth);
931
932         /*
933          * If high byte of bcdDevice is nonzero, firmware is already
934          * downloaded. Don't try to do it again, or we'll hang the device.
935          */
936
937         if (le16_to_cpu(dev->descriptor.bcdDevice) >> 8) {
938                 kaweth_info("Firmware present in device.");
939         } else {
940                 /* Download the firmware */
941                 kaweth_info("Downloading firmware...");
942                 kaweth->firmware_buf = (__u8 *)__get_free_page(GFP_KERNEL);
943                 if ((result = kaweth_download_firmware(kaweth,
944                                                       kaweth_new_code,
945                                                       len_kaweth_new_code,
946                                                       100,
947                                                       2)) < 0) {
948                         kaweth_err("Error downloading firmware (%d)", result);
949                         goto err_fw;
950                 }
951
952                 if ((result = kaweth_download_firmware(kaweth,
953                                                       kaweth_new_code_fix,
954                                                       len_kaweth_new_code_fix,
955                                                       100,
956                                                       3)) < 0) {
957                         kaweth_err("Error downloading firmware fix (%d)", result);
958                         goto err_fw;
959                 }
960
961                 if ((result = kaweth_download_firmware(kaweth,
962                                                       kaweth_trigger_code,
963                                                       len_kaweth_trigger_code,
964                                                       126,
965                                                       2)) < 0) {
966                         kaweth_err("Error downloading trigger code (%d)", result);
967                         goto err_fw;
968
969                 }
970
971                 if ((result = kaweth_download_firmware(kaweth,
972                                                       kaweth_trigger_code_fix,
973                                                       len_kaweth_trigger_code_fix,
974                                                       126,
975                                                       3)) < 0) {
976                         kaweth_err("Error downloading trigger code fix (%d)", result);
977                         goto err_fw;
978                 }
979
980
981                 if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
982                         kaweth_err("Error triggering firmware (%d)", result);
983                         goto err_fw;
984                 }
985
986                 /* Device will now disappear for a moment...  */
987                 kaweth_info("Firmware loaded.  I'll be back...");
988 err_fw:
989                 free_page((unsigned long)kaweth->firmware_buf);
990                 free_netdev(netdev);
991                 return -EIO;
992         }
993
994         result = kaweth_read_configuration(kaweth);
995
996         if(result < 0) {
997                 kaweth_err("Error reading configuration (%d), no net device created", result);
998                 goto err_free_netdev;
999         }
1000
1001         kaweth_info("Statistics collection: %x", kaweth->configuration.statistics_mask);
1002         kaweth_info("Multicast filter limit: %x", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
1003         kaweth_info("MTU: %d", le16_to_cpu(kaweth->configuration.segment_size));
1004         kaweth_info("Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
1005                  (int)kaweth->configuration.hw_addr[0],
1006                  (int)kaweth->configuration.hw_addr[1],
1007                  (int)kaweth->configuration.hw_addr[2],
1008                  (int)kaweth->configuration.hw_addr[3],
1009                  (int)kaweth->configuration.hw_addr[4],
1010                  (int)kaweth->configuration.hw_addr[5]);
1011
1012         if(!memcmp(&kaweth->configuration.hw_addr,
1013                    &bcast_addr,
1014                    sizeof(bcast_addr))) {
1015                 kaweth_err("Firmware not functioning properly, no net device created");
1016                 goto err_free_netdev;
1017         }
1018
1019         if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
1020                 kaweth_dbg("Error setting URB size");
1021                 goto err_free_netdev;
1022         }
1023
1024         if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
1025                 kaweth_err("Error setting SOFS wait");
1026                 goto err_free_netdev;
1027         }
1028
1029         result = kaweth_set_receive_filter(kaweth,
1030                                            KAWETH_PACKET_FILTER_DIRECTED |
1031                                            KAWETH_PACKET_FILTER_BROADCAST |
1032                                            KAWETH_PACKET_FILTER_MULTICAST);
1033
1034         if(result < 0) {
1035                 kaweth_err("Error setting receive filter");
1036                 goto err_free_netdev;
1037         }
1038
1039         kaweth_dbg("Initializing net device.");
1040
1041         kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
1042         if (!kaweth->tx_urb)
1043                 goto err_free_netdev;
1044         kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
1045         if (!kaweth->rx_urb)
1046                 goto err_only_tx;
1047         kaweth->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
1048         if (!kaweth->irq_urb)
1049                 goto err_tx_and_rx;
1050
1051         kaweth->intbuffer = usb_buffer_alloc(   kaweth->dev,
1052                                                 INTBUFFERSIZE,
1053                                                 GFP_KERNEL,
1054                                                 &kaweth->intbufferhandle);
1055         if (!kaweth->intbuffer)
1056                 goto err_tx_and_rx_and_irq;
1057         kaweth->rx_buf = usb_buffer_alloc(      kaweth->dev,
1058                                                 KAWETH_BUF_SIZE,
1059                                                 GFP_KERNEL,
1060                                                 &kaweth->rxbufferhandle);
1061         if (!kaweth->rx_buf)
1062                 goto err_all_but_rxbuf;
1063
1064         memcpy(netdev->broadcast, &bcast_addr, sizeof(bcast_addr));
1065         memcpy(netdev->dev_addr, &kaweth->configuration.hw_addr,
1066                sizeof(kaweth->configuration.hw_addr));
1067
1068         netdev->open = kaweth_open;
1069         netdev->stop = kaweth_close;
1070
1071         netdev->watchdog_timeo = KAWETH_TX_TIMEOUT;
1072         netdev->tx_timeout = kaweth_tx_timeout;
1073
1074         netdev->hard_start_xmit = kaweth_start_xmit;
1075         netdev->set_multicast_list = kaweth_set_rx_mode;
1076         netdev->get_stats = kaweth_netdev_stats;
1077         netdev->mtu = le16_to_cpu(kaweth->configuration.segment_size);
1078         SET_ETHTOOL_OPS(netdev, &ops);
1079
1080         /* kaweth is zeroed as part of alloc_netdev */
1081
1082         INIT_WORK(&kaweth->lowmem_work, kaweth_resubmit_tl, (void *)kaweth);
1083
1084         SET_MODULE_OWNER(netdev);
1085
1086         usb_set_intfdata(intf, kaweth);
1087
1088 #if 0
1089 // dma_supported() is deeply broken on almost all architectures
1090         if (dma_supported (&intf->dev, 0xffffffffffffffffULL))
1091                 kaweth->net->features |= NETIF_F_HIGHDMA;
1092 #endif
1093
1094         SET_NETDEV_DEV(netdev, &intf->dev);
1095         if (register_netdev(netdev) != 0) {
1096                 kaweth_err("Error registering netdev.");
1097                 goto err_intfdata;
1098         }
1099
1100         kaweth_info("kaweth interface created at %s", kaweth->net->name);
1101
1102         kaweth_dbg("Kaweth probe returning.");
1103
1104         return 0;
1105
1106 err_intfdata:
1107         usb_set_intfdata(intf, NULL);
1108         usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1109 err_all_but_rxbuf:
1110         usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1111 err_tx_and_rx_and_irq:
1112         usb_free_urb(kaweth->irq_urb);
1113 err_tx_and_rx:
1114         usb_free_urb(kaweth->rx_urb);
1115 err_only_tx:
1116         usb_free_urb(kaweth->tx_urb);
1117 err_free_netdev:
1118         free_netdev(netdev);
1119
1120         return -EIO;
1121 }
1122
1123 /****************************************************************
1124  *     kaweth_disconnect
1125  ****************************************************************/
1126 static void kaweth_disconnect(struct usb_interface *intf)
1127 {
1128         struct kaweth_device *kaweth = usb_get_intfdata(intf);
1129         struct net_device *netdev;
1130
1131         kaweth_info("Unregistering");
1132
1133         usb_set_intfdata(intf, NULL);
1134         if (!kaweth) {
1135                 kaweth_warn("unregistering non-existant device");
1136                 return;
1137         }
1138         netdev = kaweth->net;
1139         kaweth->removed = 1;
1140         usb_kill_urb(kaweth->irq_urb);
1141         usb_kill_urb(kaweth->rx_urb);
1142         usb_kill_urb(kaweth->tx_urb);
1143
1144         kaweth_dbg("Unregistering net device");
1145         unregister_netdev(netdev);
1146
1147         usb_free_urb(kaweth->rx_urb);
1148         usb_free_urb(kaweth->tx_urb);
1149         usb_free_urb(kaweth->irq_urb);
1150
1151         usb_buffer_free(kaweth->dev, KAWETH_BUF_SIZE, (void *)kaweth->rx_buf, kaweth->rxbufferhandle);
1152         usb_buffer_free(kaweth->dev, INTBUFFERSIZE, (void *)kaweth->intbuffer, kaweth->intbufferhandle);
1153
1154         free_netdev(netdev);
1155 }
1156
1157
1158 // FIXME this completion stuff is a modified clone of
1159 // an OLD version of some stuff in usb.c ...
1160 struct usb_api_data {
1161         wait_queue_head_t wqh;
1162         int done;
1163 };
1164
1165 /*-------------------------------------------------------------------*
1166  * completion handler for compatibility wrappers (sync control/bulk) *
1167  *-------------------------------------------------------------------*/
1168 static void usb_api_blocking_completion(struct urb *urb, struct pt_regs *regs)
1169 {
1170         struct usb_api_data *awd = (struct usb_api_data *)urb->context;
1171
1172         awd->done=1;
1173         wake_up(&awd->wqh);
1174 }
1175
1176 /*-------------------------------------------------------------------*
1177  *                         COMPATIBILITY STUFF                       *
1178  *-------------------------------------------------------------------*/
1179
1180 // Starts urb and waits for completion or timeout
1181 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
1182 {
1183         DECLARE_WAITQUEUE(wait, current);
1184         struct usb_api_data awd;
1185         int status;
1186
1187         init_waitqueue_head(&awd.wqh);
1188         awd.done = 0;
1189
1190         add_wait_queue(&awd.wqh, &wait);
1191         urb->context = &awd;
1192         status = usb_submit_urb(urb, GFP_NOIO);
1193         if (status) {
1194                 // something went wrong
1195                 usb_free_urb(urb);
1196                 remove_wait_queue(&awd.wqh, &wait);
1197                 return status;
1198         }
1199
1200         while (timeout && !awd.done) {
1201                 set_current_state(TASK_UNINTERRUPTIBLE);
1202                 timeout = schedule_timeout(timeout);
1203         }
1204
1205         remove_wait_queue(&awd.wqh, &wait);
1206
1207         if (!timeout) {
1208                 // timeout
1209                 kaweth_warn("usb_control/bulk_msg: timeout");
1210                 usb_kill_urb(urb);  // remove urb safely
1211                 status = -ETIMEDOUT;
1212         }
1213         else {
1214                 status = urb->status;
1215         }
1216
1217         if (actual_length) {
1218                 *actual_length = urb->actual_length;
1219         }
1220
1221         usb_free_urb(urb);
1222         return status;
1223 }
1224
1225 /*-------------------------------------------------------------------*/
1226 // returns status (negative) or length (positive)
1227 static int kaweth_internal_control_msg(struct usb_device *usb_dev,
1228                                        unsigned int pipe,
1229                                        struct usb_ctrlrequest *cmd, void *data,
1230                                        int len, int timeout)
1231 {
1232         struct urb *urb;
1233         int retv;
1234         int length;
1235
1236         urb = usb_alloc_urb(0, GFP_NOIO);
1237         if (!urb)
1238                 return -ENOMEM;
1239
1240         usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char*)cmd, data,
1241                          len, usb_api_blocking_completion, NULL);
1242
1243         retv = usb_start_wait_urb(urb, timeout, &length);
1244         if (retv < 0) {
1245                 return retv;
1246         }
1247         else {
1248                 return length;
1249         }
1250 }
1251
1252
1253 /****************************************************************
1254  *     kaweth_init
1255  ****************************************************************/
1256 static int __init kaweth_init(void)
1257 {
1258         kaweth_dbg("Driver loading");
1259         return usb_register(&kaweth_driver);
1260 }
1261
1262 /****************************************************************
1263  *     kaweth_exit
1264  ****************************************************************/
1265 static void __exit kaweth_exit(void)
1266 {
1267         usb_deregister(&kaweth_driver);
1268 }
1269
1270 module_init(kaweth_init);
1271 module_exit(kaweth_exit);
1272
1273
1274
1275
1276
1277
1278
1279
1280