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