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