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