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