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