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