Loading...
1/*
2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * This is a generic "USB networking" framework that works with several
22 * kinds of full and high speed networking devices: host-to-host cables,
23 * smart usb peripherals, and actual Ethernet adapters.
24 *
25 * These devices usually differ in terms of control protocols (if they
26 * even have one!) and sometimes they define new framing to wrap or batch
27 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
28 * so interface (un)binding, endpoint I/O queues, fault handling, and other
29 * issues can usefully be addressed by this framework.
30 */
31
32// #define DEBUG // error path messages, extra info
33// #define VERBOSE // more; success messages
34
35#include <linux/module.h>
36#include <linux/init.h>
37#include <linux/netdevice.h>
38#include <linux/etherdevice.h>
39#include <linux/ctype.h>
40#include <linux/ethtool.h>
41#include <linux/workqueue.h>
42#include <linux/mii.h>
43#include <linux/usb.h>
44#include <linux/usb/usbnet.h>
45#include <linux/slab.h>
46#include <linux/kernel.h>
47#include <linux/pm_runtime.h>
48
49#define DRIVER_VERSION "22-Aug-2005"
50
51
52/*-------------------------------------------------------------------------*/
53
54/*
55 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
56 * Several dozen bytes of IPv4 data can fit in two such transactions.
57 * One maximum size Ethernet packet takes twenty four of them.
58 * For high speed, each frame comfortably fits almost 36 max size
59 * Ethernet packets (so queues should be bigger).
60 *
61 * The goal is to let the USB host controller be busy for 5msec or
62 * more before an irq is required, under load. Jumbograms change
63 * the equation.
64 */
65#define MAX_QUEUE_MEMORY (60 * 1518)
66#define RX_QLEN(dev) ((dev)->rx_qlen)
67#define TX_QLEN(dev) ((dev)->tx_qlen)
68
69// reawaken network queue this soon after stopping; else watchdog barks
70#define TX_TIMEOUT_JIFFIES (5*HZ)
71
72// throttle rx/tx briefly after some faults, so khubd might disconnect()
73// us (it polls at HZ/4 usually) before we report too many false errors.
74#define THROTTLE_JIFFIES (HZ/8)
75
76// between wakeups
77#define UNLINK_TIMEOUT_MS 3
78
79/*-------------------------------------------------------------------------*/
80
81// randomly generated ethernet address
82static u8 node_id [ETH_ALEN];
83
84static const char driver_name [] = "usbnet";
85
86/* use ethtool to change the level for any given device */
87static int msg_level = -1;
88module_param (msg_level, int, 0);
89MODULE_PARM_DESC (msg_level, "Override default message level");
90
91/*-------------------------------------------------------------------------*/
92
93/* handles CDC Ethernet and many other network "bulk data" interfaces */
94int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
95{
96 int tmp;
97 struct usb_host_interface *alt = NULL;
98 struct usb_host_endpoint *in = NULL, *out = NULL;
99 struct usb_host_endpoint *status = NULL;
100
101 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
102 unsigned ep;
103
104 in = out = status = NULL;
105 alt = intf->altsetting + tmp;
106
107 /* take the first altsetting with in-bulk + out-bulk;
108 * remember any status endpoint, just in case;
109 * ignore other endpoints and altsettings.
110 */
111 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
112 struct usb_host_endpoint *e;
113 int intr = 0;
114
115 e = alt->endpoint + ep;
116 switch (e->desc.bmAttributes) {
117 case USB_ENDPOINT_XFER_INT:
118 if (!usb_endpoint_dir_in(&e->desc))
119 continue;
120 intr = 1;
121 /* FALLTHROUGH */
122 case USB_ENDPOINT_XFER_BULK:
123 break;
124 default:
125 continue;
126 }
127 if (usb_endpoint_dir_in(&e->desc)) {
128 if (!intr && !in)
129 in = e;
130 else if (intr && !status)
131 status = e;
132 } else {
133 if (!out)
134 out = e;
135 }
136 }
137 if (in && out)
138 break;
139 }
140 if (!alt || !in || !out)
141 return -EINVAL;
142
143 if (alt->desc.bAlternateSetting != 0 ||
144 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
145 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
146 alt->desc.bAlternateSetting);
147 if (tmp < 0)
148 return tmp;
149 }
150
151 dev->in = usb_rcvbulkpipe (dev->udev,
152 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
153 dev->out = usb_sndbulkpipe (dev->udev,
154 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
155 dev->status = status;
156 return 0;
157}
158EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
159
160int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
161{
162 int tmp, i;
163 unsigned char buf [13];
164
165 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
166 if (tmp != 12) {
167 dev_dbg(&dev->udev->dev,
168 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
169 if (tmp >= 0)
170 tmp = -EINVAL;
171 return tmp;
172 }
173 for (i = tmp = 0; i < 6; i++, tmp += 2)
174 dev->net->dev_addr [i] =
175 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
176 return 0;
177}
178EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
179
180static void intr_complete (struct urb *urb)
181{
182 struct usbnet *dev = urb->context;
183 int status = urb->status;
184
185 switch (status) {
186 /* success */
187 case 0:
188 dev->driver_info->status(dev, urb);
189 break;
190
191 /* software-driven interface shutdown */
192 case -ENOENT: /* urb killed */
193 case -ESHUTDOWN: /* hardware gone */
194 netif_dbg(dev, ifdown, dev->net,
195 "intr shutdown, code %d\n", status);
196 return;
197
198 /* NOTE: not throttling like RX/TX, since this endpoint
199 * already polls infrequently
200 */
201 default:
202 netdev_dbg(dev->net, "intr status %d\n", status);
203 break;
204 }
205
206 status = usb_submit_urb (urb, GFP_ATOMIC);
207 if (status != 0)
208 netif_err(dev, timer, dev->net,
209 "intr resubmit --> %d\n", status);
210}
211
212static int init_status (struct usbnet *dev, struct usb_interface *intf)
213{
214 char *buf = NULL;
215 unsigned pipe = 0;
216 unsigned maxp;
217 unsigned period;
218
219 if (!dev->driver_info->status)
220 return 0;
221
222 pipe = usb_rcvintpipe (dev->udev,
223 dev->status->desc.bEndpointAddress
224 & USB_ENDPOINT_NUMBER_MASK);
225 maxp = usb_maxpacket (dev->udev, pipe, 0);
226
227 /* avoid 1 msec chatter: min 8 msec poll rate */
228 period = max ((int) dev->status->desc.bInterval,
229 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
230
231 buf = kmalloc (maxp, GFP_KERNEL);
232 if (buf) {
233 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
234 if (!dev->interrupt) {
235 kfree (buf);
236 return -ENOMEM;
237 } else {
238 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
239 buf, maxp, intr_complete, dev, period);
240 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
241 dev_dbg(&intf->dev,
242 "status ep%din, %d bytes period %d\n",
243 usb_pipeendpoint(pipe), maxp, period);
244 }
245 }
246 return 0;
247}
248
249/* Submit the interrupt URB if not previously submitted, increasing refcount */
250int usbnet_status_start(struct usbnet *dev, gfp_t mem_flags)
251{
252 int ret = 0;
253
254 WARN_ON_ONCE(dev->interrupt == NULL);
255 if (dev->interrupt) {
256 mutex_lock(&dev->interrupt_mutex);
257
258 if (++dev->interrupt_count == 1)
259 ret = usb_submit_urb(dev->interrupt, mem_flags);
260
261 dev_dbg(&dev->udev->dev, "incremented interrupt URB count to %d\n",
262 dev->interrupt_count);
263 mutex_unlock(&dev->interrupt_mutex);
264 }
265 return ret;
266}
267EXPORT_SYMBOL_GPL(usbnet_status_start);
268
269/* For resume; submit interrupt URB if previously submitted */
270static int __usbnet_status_start_force(struct usbnet *dev, gfp_t mem_flags)
271{
272 int ret = 0;
273
274 mutex_lock(&dev->interrupt_mutex);
275 if (dev->interrupt_count) {
276 ret = usb_submit_urb(dev->interrupt, mem_flags);
277 dev_dbg(&dev->udev->dev,
278 "submitted interrupt URB for resume\n");
279 }
280 mutex_unlock(&dev->interrupt_mutex);
281 return ret;
282}
283
284/* Kill the interrupt URB if all submitters want it killed */
285void usbnet_status_stop(struct usbnet *dev)
286{
287 if (dev->interrupt) {
288 mutex_lock(&dev->interrupt_mutex);
289 WARN_ON(dev->interrupt_count == 0);
290
291 if (dev->interrupt_count && --dev->interrupt_count == 0)
292 usb_kill_urb(dev->interrupt);
293
294 dev_dbg(&dev->udev->dev,
295 "decremented interrupt URB count to %d\n",
296 dev->interrupt_count);
297 mutex_unlock(&dev->interrupt_mutex);
298 }
299}
300EXPORT_SYMBOL_GPL(usbnet_status_stop);
301
302/* For suspend; always kill interrupt URB */
303static void __usbnet_status_stop_force(struct usbnet *dev)
304{
305 if (dev->interrupt) {
306 mutex_lock(&dev->interrupt_mutex);
307 usb_kill_urb(dev->interrupt);
308 dev_dbg(&dev->udev->dev, "killed interrupt URB for suspend\n");
309 mutex_unlock(&dev->interrupt_mutex);
310 }
311}
312
313/* Passes this packet up the stack, updating its accounting.
314 * Some link protocols batch packets, so their rx_fixup paths
315 * can return clones as well as just modify the original skb.
316 */
317void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
318{
319 int status;
320
321 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
322 skb_queue_tail(&dev->rxq_pause, skb);
323 return;
324 }
325
326 skb->protocol = eth_type_trans (skb, dev->net);
327 dev->net->stats.rx_packets++;
328 dev->net->stats.rx_bytes += skb->len;
329
330 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
331 skb->len + sizeof (struct ethhdr), skb->protocol);
332 memset (skb->cb, 0, sizeof (struct skb_data));
333
334 if (skb_defer_rx_timestamp(skb))
335 return;
336
337 status = netif_rx (skb);
338 if (status != NET_RX_SUCCESS)
339 netif_dbg(dev, rx_err, dev->net,
340 "netif_rx status %d\n", status);
341}
342EXPORT_SYMBOL_GPL(usbnet_skb_return);
343
344/* must be called if hard_mtu or rx_urb_size changed */
345void usbnet_update_max_qlen(struct usbnet *dev)
346{
347 enum usb_device_speed speed = dev->udev->speed;
348
349 switch (speed) {
350 case USB_SPEED_HIGH:
351 dev->rx_qlen = MAX_QUEUE_MEMORY / dev->rx_urb_size;
352 dev->tx_qlen = MAX_QUEUE_MEMORY / dev->hard_mtu;
353 break;
354 case USB_SPEED_SUPER:
355 /*
356 * Not take default 5ms qlen for super speed HC to
357 * save memory, and iperf tests show 2.5ms qlen can
358 * work well
359 */
360 dev->rx_qlen = 5 * MAX_QUEUE_MEMORY / dev->rx_urb_size;
361 dev->tx_qlen = 5 * MAX_QUEUE_MEMORY / dev->hard_mtu;
362 break;
363 default:
364 dev->rx_qlen = dev->tx_qlen = 4;
365 }
366}
367EXPORT_SYMBOL_GPL(usbnet_update_max_qlen);
368
369
370/*-------------------------------------------------------------------------
371 *
372 * Network Device Driver (peer link to "Host Device", from USB host)
373 *
374 *-------------------------------------------------------------------------*/
375
376int usbnet_change_mtu (struct net_device *net, int new_mtu)
377{
378 struct usbnet *dev = netdev_priv(net);
379 int ll_mtu = new_mtu + net->hard_header_len;
380 int old_hard_mtu = dev->hard_mtu;
381 int old_rx_urb_size = dev->rx_urb_size;
382
383 if (new_mtu <= 0)
384 return -EINVAL;
385 // no second zero-length packet read wanted after mtu-sized packets
386 if ((ll_mtu % dev->maxpacket) == 0)
387 return -EDOM;
388 net->mtu = new_mtu;
389
390 dev->hard_mtu = net->mtu + net->hard_header_len;
391 if (dev->rx_urb_size == old_hard_mtu) {
392 dev->rx_urb_size = dev->hard_mtu;
393 if (dev->rx_urb_size > old_rx_urb_size)
394 usbnet_unlink_rx_urbs(dev);
395 }
396
397 /* max qlen depend on hard_mtu and rx_urb_size */
398 usbnet_update_max_qlen(dev);
399
400 return 0;
401}
402EXPORT_SYMBOL_GPL(usbnet_change_mtu);
403
404/* The caller must hold list->lock */
405static void __usbnet_queue_skb(struct sk_buff_head *list,
406 struct sk_buff *newsk, enum skb_state state)
407{
408 struct skb_data *entry = (struct skb_data *) newsk->cb;
409
410 __skb_queue_tail(list, newsk);
411 entry->state = state;
412}
413
414/*-------------------------------------------------------------------------*/
415
416/* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
417 * completion callbacks. 2.5 should have fixed those bugs...
418 */
419
420static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
421 struct sk_buff_head *list, enum skb_state state)
422{
423 unsigned long flags;
424 enum skb_state old_state;
425 struct skb_data *entry = (struct skb_data *) skb->cb;
426
427 spin_lock_irqsave(&list->lock, flags);
428 old_state = entry->state;
429 entry->state = state;
430 __skb_unlink(skb, list);
431 spin_unlock(&list->lock);
432 spin_lock(&dev->done.lock);
433 __skb_queue_tail(&dev->done, skb);
434 if (dev->done.qlen == 1)
435 tasklet_schedule(&dev->bh);
436 spin_unlock_irqrestore(&dev->done.lock, flags);
437 return old_state;
438}
439
440/* some work can't be done in tasklets, so we use keventd
441 *
442 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
443 * but tasklet_schedule() doesn't. hope the failure is rare.
444 */
445void usbnet_defer_kevent (struct usbnet *dev, int work)
446{
447 set_bit (work, &dev->flags);
448 if (!schedule_work (&dev->kevent)) {
449 if (net_ratelimit())
450 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
451 } else {
452 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
453 }
454}
455EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
456
457/*-------------------------------------------------------------------------*/
458
459static void rx_complete (struct urb *urb);
460
461static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
462{
463 struct sk_buff *skb;
464 struct skb_data *entry;
465 int retval = 0;
466 unsigned long lockflags;
467 size_t size = dev->rx_urb_size;
468
469 /* prevent rx skb allocation when error ratio is high */
470 if (test_bit(EVENT_RX_KILL, &dev->flags)) {
471 usb_free_urb(urb);
472 return -ENOLINK;
473 }
474
475 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
476 if (!skb) {
477 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
478 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
479 usb_free_urb (urb);
480 return -ENOMEM;
481 }
482
483 entry = (struct skb_data *) skb->cb;
484 entry->urb = urb;
485 entry->dev = dev;
486 entry->length = 0;
487
488 usb_fill_bulk_urb (urb, dev->udev, dev->in,
489 skb->data, size, rx_complete, skb);
490
491 spin_lock_irqsave (&dev->rxq.lock, lockflags);
492
493 if (netif_running (dev->net) &&
494 netif_device_present (dev->net) &&
495 !test_bit (EVENT_RX_HALT, &dev->flags) &&
496 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
497 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
498 case -EPIPE:
499 usbnet_defer_kevent (dev, EVENT_RX_HALT);
500 break;
501 case -ENOMEM:
502 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
503 break;
504 case -ENODEV:
505 netif_dbg(dev, ifdown, dev->net, "device gone\n");
506 netif_device_detach (dev->net);
507 break;
508 case -EHOSTUNREACH:
509 retval = -ENOLINK;
510 break;
511 default:
512 netif_dbg(dev, rx_err, dev->net,
513 "rx submit, %d\n", retval);
514 tasklet_schedule (&dev->bh);
515 break;
516 case 0:
517 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
518 }
519 } else {
520 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
521 retval = -ENOLINK;
522 }
523 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
524 if (retval) {
525 dev_kfree_skb_any (skb);
526 usb_free_urb (urb);
527 }
528 return retval;
529}
530
531
532/*-------------------------------------------------------------------------*/
533
534static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
535{
536 if (dev->driver_info->rx_fixup &&
537 !dev->driver_info->rx_fixup (dev, skb)) {
538 /* With RX_ASSEMBLE, rx_fixup() must update counters */
539 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
540 dev->net->stats.rx_errors++;
541 goto done;
542 }
543 // else network stack removes extra byte if we forced a short packet
544
545 /* all data was already cloned from skb inside the driver */
546 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
547 goto done;
548
549 if (skb->len < ETH_HLEN) {
550 dev->net->stats.rx_errors++;
551 dev->net->stats.rx_length_errors++;
552 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
553 } else {
554 usbnet_skb_return(dev, skb);
555 return;
556 }
557
558done:
559 skb_queue_tail(&dev->done, skb);
560}
561
562/*-------------------------------------------------------------------------*/
563
564static void rx_complete (struct urb *urb)
565{
566 struct sk_buff *skb = (struct sk_buff *) urb->context;
567 struct skb_data *entry = (struct skb_data *) skb->cb;
568 struct usbnet *dev = entry->dev;
569 int urb_status = urb->status;
570 enum skb_state state;
571
572 skb_put (skb, urb->actual_length);
573 state = rx_done;
574 entry->urb = NULL;
575
576 switch (urb_status) {
577 /* success */
578 case 0:
579 break;
580
581 /* stalls need manual reset. this is rare ... except that
582 * when going through USB 2.0 TTs, unplug appears this way.
583 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
584 * storm, recovering as needed.
585 */
586 case -EPIPE:
587 dev->net->stats.rx_errors++;
588 usbnet_defer_kevent (dev, EVENT_RX_HALT);
589 // FALLTHROUGH
590
591 /* software-driven interface shutdown */
592 case -ECONNRESET: /* async unlink */
593 case -ESHUTDOWN: /* hardware gone */
594 netif_dbg(dev, ifdown, dev->net,
595 "rx shutdown, code %d\n", urb_status);
596 goto block;
597
598 /* we get controller i/o faults during khubd disconnect() delays.
599 * throttle down resubmits, to avoid log floods; just temporarily,
600 * so we still recover when the fault isn't a khubd delay.
601 */
602 case -EPROTO:
603 case -ETIME:
604 case -EILSEQ:
605 dev->net->stats.rx_errors++;
606 if (!timer_pending (&dev->delay)) {
607 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
608 netif_dbg(dev, link, dev->net,
609 "rx throttle %d\n", urb_status);
610 }
611block:
612 state = rx_cleanup;
613 entry->urb = urb;
614 urb = NULL;
615 break;
616
617 /* data overrun ... flush fifo? */
618 case -EOVERFLOW:
619 dev->net->stats.rx_over_errors++;
620 // FALLTHROUGH
621
622 default:
623 state = rx_cleanup;
624 dev->net->stats.rx_errors++;
625 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
626 break;
627 }
628
629 /* stop rx if packet error rate is high */
630 if (++dev->pkt_cnt > 30) {
631 dev->pkt_cnt = 0;
632 dev->pkt_err = 0;
633 } else {
634 if (state == rx_cleanup)
635 dev->pkt_err++;
636 if (dev->pkt_err > 20)
637 set_bit(EVENT_RX_KILL, &dev->flags);
638 }
639
640 state = defer_bh(dev, skb, &dev->rxq, state);
641
642 if (urb) {
643 if (netif_running (dev->net) &&
644 !test_bit (EVENT_RX_HALT, &dev->flags) &&
645 state != unlink_start) {
646 rx_submit (dev, urb, GFP_ATOMIC);
647 usb_mark_last_busy(dev->udev);
648 return;
649 }
650 usb_free_urb (urb);
651 }
652 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
653}
654
655/*-------------------------------------------------------------------------*/
656void usbnet_pause_rx(struct usbnet *dev)
657{
658 set_bit(EVENT_RX_PAUSED, &dev->flags);
659
660 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
661}
662EXPORT_SYMBOL_GPL(usbnet_pause_rx);
663
664void usbnet_resume_rx(struct usbnet *dev)
665{
666 struct sk_buff *skb;
667 int num = 0;
668
669 clear_bit(EVENT_RX_PAUSED, &dev->flags);
670
671 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
672 usbnet_skb_return(dev, skb);
673 num++;
674 }
675
676 tasklet_schedule(&dev->bh);
677
678 netif_dbg(dev, rx_status, dev->net,
679 "paused rx queue disabled, %d skbs requeued\n", num);
680}
681EXPORT_SYMBOL_GPL(usbnet_resume_rx);
682
683void usbnet_purge_paused_rxq(struct usbnet *dev)
684{
685 skb_queue_purge(&dev->rxq_pause);
686}
687EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
688
689/*-------------------------------------------------------------------------*/
690
691// unlink pending rx/tx; completion handlers do all other cleanup
692
693static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
694{
695 unsigned long flags;
696 struct sk_buff *skb;
697 int count = 0;
698
699 spin_lock_irqsave (&q->lock, flags);
700 while (!skb_queue_empty(q)) {
701 struct skb_data *entry;
702 struct urb *urb;
703 int retval;
704
705 skb_queue_walk(q, skb) {
706 entry = (struct skb_data *) skb->cb;
707 if (entry->state != unlink_start)
708 goto found;
709 }
710 break;
711found:
712 entry->state = unlink_start;
713 urb = entry->urb;
714
715 /*
716 * Get reference count of the URB to avoid it to be
717 * freed during usb_unlink_urb, which may trigger
718 * use-after-free problem inside usb_unlink_urb since
719 * usb_unlink_urb is always racing with .complete
720 * handler(include defer_bh).
721 */
722 usb_get_urb(urb);
723 spin_unlock_irqrestore(&q->lock, flags);
724 // during some PM-driven resume scenarios,
725 // these (async) unlinks complete immediately
726 retval = usb_unlink_urb (urb);
727 if (retval != -EINPROGRESS && retval != 0)
728 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
729 else
730 count++;
731 usb_put_urb(urb);
732 spin_lock_irqsave(&q->lock, flags);
733 }
734 spin_unlock_irqrestore (&q->lock, flags);
735 return count;
736}
737
738// Flush all pending rx urbs
739// minidrivers may need to do this when the MTU changes
740
741void usbnet_unlink_rx_urbs(struct usbnet *dev)
742{
743 if (netif_running(dev->net)) {
744 (void) unlink_urbs (dev, &dev->rxq);
745 tasklet_schedule(&dev->bh);
746 }
747}
748EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
749
750/*-------------------------------------------------------------------------*/
751
752// precondition: never called in_interrupt
753static void usbnet_terminate_urbs(struct usbnet *dev)
754{
755 DECLARE_WAITQUEUE(wait, current);
756 int temp;
757
758 /* ensure there are no more active urbs */
759 add_wait_queue(&dev->wait, &wait);
760 set_current_state(TASK_UNINTERRUPTIBLE);
761 temp = unlink_urbs(dev, &dev->txq) +
762 unlink_urbs(dev, &dev->rxq);
763
764 /* maybe wait for deletions to finish. */
765 while (!skb_queue_empty(&dev->rxq)
766 && !skb_queue_empty(&dev->txq)
767 && !skb_queue_empty(&dev->done)) {
768 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
769 set_current_state(TASK_UNINTERRUPTIBLE);
770 netif_dbg(dev, ifdown, dev->net,
771 "waited for %d urb completions\n", temp);
772 }
773 set_current_state(TASK_RUNNING);
774 remove_wait_queue(&dev->wait, &wait);
775}
776
777int usbnet_stop (struct net_device *net)
778{
779 struct usbnet *dev = netdev_priv(net);
780 struct driver_info *info = dev->driver_info;
781 int retval, pm;
782
783 clear_bit(EVENT_DEV_OPEN, &dev->flags);
784 netif_stop_queue (net);
785
786 netif_info(dev, ifdown, dev->net,
787 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
788 net->stats.rx_packets, net->stats.tx_packets,
789 net->stats.rx_errors, net->stats.tx_errors);
790
791 /* to not race resume */
792 pm = usb_autopm_get_interface(dev->intf);
793 /* allow minidriver to stop correctly (wireless devices to turn off
794 * radio etc) */
795 if (info->stop) {
796 retval = info->stop(dev);
797 if (retval < 0)
798 netif_info(dev, ifdown, dev->net,
799 "stop fail (%d) usbnet usb-%s-%s, %s\n",
800 retval,
801 dev->udev->bus->bus_name, dev->udev->devpath,
802 info->description);
803 }
804
805 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
806 usbnet_terminate_urbs(dev);
807
808 usbnet_status_stop(dev);
809
810 usbnet_purge_paused_rxq(dev);
811
812 /* deferred work (task, timer, softirq) must also stop.
813 * can't flush_scheduled_work() until we drop rtnl (later),
814 * else workers could deadlock; so make workers a NOP.
815 */
816 dev->flags = 0;
817 del_timer_sync (&dev->delay);
818 tasklet_kill (&dev->bh);
819 if (!pm)
820 usb_autopm_put_interface(dev->intf);
821
822 if (info->manage_power &&
823 !test_and_clear_bit(EVENT_NO_RUNTIME_PM, &dev->flags))
824 info->manage_power(dev, 0);
825 else
826 usb_autopm_put_interface(dev->intf);
827
828 return 0;
829}
830EXPORT_SYMBOL_GPL(usbnet_stop);
831
832/*-------------------------------------------------------------------------*/
833
834// posts reads, and enables write queuing
835
836// precondition: never called in_interrupt
837
838int usbnet_open (struct net_device *net)
839{
840 struct usbnet *dev = netdev_priv(net);
841 int retval;
842 struct driver_info *info = dev->driver_info;
843
844 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
845 netif_info(dev, ifup, dev->net,
846 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
847 retval,
848 dev->udev->bus->bus_name,
849 dev->udev->devpath,
850 info->description);
851 goto done_nopm;
852 }
853
854 // put into "known safe" state
855 if (info->reset && (retval = info->reset (dev)) < 0) {
856 netif_info(dev, ifup, dev->net,
857 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
858 retval,
859 dev->udev->bus->bus_name,
860 dev->udev->devpath,
861 info->description);
862 goto done;
863 }
864
865 /* hard_mtu or rx_urb_size may change in reset() */
866 usbnet_update_max_qlen(dev);
867
868 // insist peer be connected
869 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
870 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
871 goto done;
872 }
873
874 /* start any status interrupt transfer */
875 if (dev->interrupt) {
876 retval = usbnet_status_start(dev, GFP_KERNEL);
877 if (retval < 0) {
878 netif_err(dev, ifup, dev->net,
879 "intr submit %d\n", retval);
880 goto done;
881 }
882 }
883
884 set_bit(EVENT_DEV_OPEN, &dev->flags);
885 netif_start_queue (net);
886 netif_info(dev, ifup, dev->net,
887 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
888 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
889 dev->net->mtu,
890 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
891 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
892 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
893 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
894 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
895 "simple");
896
897 /* reset rx error state */
898 dev->pkt_cnt = 0;
899 dev->pkt_err = 0;
900 clear_bit(EVENT_RX_KILL, &dev->flags);
901
902 // delay posting reads until we're fully open
903 tasklet_schedule (&dev->bh);
904 if (info->manage_power) {
905 retval = info->manage_power(dev, 1);
906 if (retval < 0) {
907 retval = 0;
908 set_bit(EVENT_NO_RUNTIME_PM, &dev->flags);
909 } else {
910 usb_autopm_put_interface(dev->intf);
911 }
912 }
913 return retval;
914done:
915 usb_autopm_put_interface(dev->intf);
916done_nopm:
917 return retval;
918}
919EXPORT_SYMBOL_GPL(usbnet_open);
920
921/*-------------------------------------------------------------------------*/
922
923/* ethtool methods; minidrivers may need to add some more, but
924 * they'll probably want to use this base set.
925 */
926
927int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
928{
929 struct usbnet *dev = netdev_priv(net);
930
931 if (!dev->mii.mdio_read)
932 return -EOPNOTSUPP;
933
934 return mii_ethtool_gset(&dev->mii, cmd);
935}
936EXPORT_SYMBOL_GPL(usbnet_get_settings);
937
938int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
939{
940 struct usbnet *dev = netdev_priv(net);
941 int retval;
942
943 if (!dev->mii.mdio_write)
944 return -EOPNOTSUPP;
945
946 retval = mii_ethtool_sset(&dev->mii, cmd);
947
948 /* link speed/duplex might have changed */
949 if (dev->driver_info->link_reset)
950 dev->driver_info->link_reset(dev);
951
952 /* hard_mtu or rx_urb_size may change in link_reset() */
953 usbnet_update_max_qlen(dev);
954
955 return retval;
956
957}
958EXPORT_SYMBOL_GPL(usbnet_set_settings);
959
960u32 usbnet_get_link (struct net_device *net)
961{
962 struct usbnet *dev = netdev_priv(net);
963
964 /* If a check_connect is defined, return its result */
965 if (dev->driver_info->check_connect)
966 return dev->driver_info->check_connect (dev) == 0;
967
968 /* if the device has mii operations, use those */
969 if (dev->mii.mdio_read)
970 return mii_link_ok(&dev->mii);
971
972 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
973 return ethtool_op_get_link(net);
974}
975EXPORT_SYMBOL_GPL(usbnet_get_link);
976
977int usbnet_nway_reset(struct net_device *net)
978{
979 struct usbnet *dev = netdev_priv(net);
980
981 if (!dev->mii.mdio_write)
982 return -EOPNOTSUPP;
983
984 return mii_nway_restart(&dev->mii);
985}
986EXPORT_SYMBOL_GPL(usbnet_nway_reset);
987
988void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
989{
990 struct usbnet *dev = netdev_priv(net);
991
992 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
993 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
994 strlcpy (info->fw_version, dev->driver_info->description,
995 sizeof info->fw_version);
996 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
997}
998EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
999
1000u32 usbnet_get_msglevel (struct net_device *net)
1001{
1002 struct usbnet *dev = netdev_priv(net);
1003
1004 return dev->msg_enable;
1005}
1006EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
1007
1008void usbnet_set_msglevel (struct net_device *net, u32 level)
1009{
1010 struct usbnet *dev = netdev_priv(net);
1011
1012 dev->msg_enable = level;
1013}
1014EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
1015
1016/* drivers may override default ethtool_ops in their bind() routine */
1017static const struct ethtool_ops usbnet_ethtool_ops = {
1018 .get_settings = usbnet_get_settings,
1019 .set_settings = usbnet_set_settings,
1020 .get_link = usbnet_get_link,
1021 .nway_reset = usbnet_nway_reset,
1022 .get_drvinfo = usbnet_get_drvinfo,
1023 .get_msglevel = usbnet_get_msglevel,
1024 .set_msglevel = usbnet_set_msglevel,
1025 .get_ts_info = ethtool_op_get_ts_info,
1026};
1027
1028/*-------------------------------------------------------------------------*/
1029
1030static void __handle_link_change(struct usbnet *dev)
1031{
1032 if (!test_bit(EVENT_DEV_OPEN, &dev->flags))
1033 return;
1034
1035 if (!netif_carrier_ok(dev->net)) {
1036 /* kill URBs for reading packets to save bus bandwidth */
1037 unlink_urbs(dev, &dev->rxq);
1038
1039 /*
1040 * tx_timeout will unlink URBs for sending packets and
1041 * tx queue is stopped by netcore after link becomes off
1042 */
1043 } else {
1044 /* submitting URBs for reading packets */
1045 tasklet_schedule(&dev->bh);
1046 }
1047
1048 /* hard_mtu or rx_urb_size may change during link change */
1049 usbnet_update_max_qlen(dev);
1050
1051 clear_bit(EVENT_LINK_CHANGE, &dev->flags);
1052}
1053
1054/* work that cannot be done in interrupt context uses keventd.
1055 *
1056 * NOTE: with 2.5 we could do more of this using completion callbacks,
1057 * especially now that control transfers can be queued.
1058 */
1059static void
1060kevent (struct work_struct *work)
1061{
1062 struct usbnet *dev =
1063 container_of(work, struct usbnet, kevent);
1064 int status;
1065
1066 /* usb_clear_halt() needs a thread context */
1067 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
1068 unlink_urbs (dev, &dev->txq);
1069 status = usb_autopm_get_interface(dev->intf);
1070 if (status < 0)
1071 goto fail_pipe;
1072 status = usb_clear_halt (dev->udev, dev->out);
1073 usb_autopm_put_interface(dev->intf);
1074 if (status < 0 &&
1075 status != -EPIPE &&
1076 status != -ESHUTDOWN) {
1077 if (netif_msg_tx_err (dev))
1078fail_pipe:
1079 netdev_err(dev->net, "can't clear tx halt, status %d\n",
1080 status);
1081 } else {
1082 clear_bit (EVENT_TX_HALT, &dev->flags);
1083 if (status != -ESHUTDOWN)
1084 netif_wake_queue (dev->net);
1085 }
1086 }
1087 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
1088 unlink_urbs (dev, &dev->rxq);
1089 status = usb_autopm_get_interface(dev->intf);
1090 if (status < 0)
1091 goto fail_halt;
1092 status = usb_clear_halt (dev->udev, dev->in);
1093 usb_autopm_put_interface(dev->intf);
1094 if (status < 0 &&
1095 status != -EPIPE &&
1096 status != -ESHUTDOWN) {
1097 if (netif_msg_rx_err (dev))
1098fail_halt:
1099 netdev_err(dev->net, "can't clear rx halt, status %d\n",
1100 status);
1101 } else {
1102 clear_bit (EVENT_RX_HALT, &dev->flags);
1103 tasklet_schedule (&dev->bh);
1104 }
1105 }
1106
1107 /* tasklet could resubmit itself forever if memory is tight */
1108 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
1109 struct urb *urb = NULL;
1110 int resched = 1;
1111
1112 if (netif_running (dev->net))
1113 urb = usb_alloc_urb (0, GFP_KERNEL);
1114 else
1115 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1116 if (urb != NULL) {
1117 clear_bit (EVENT_RX_MEMORY, &dev->flags);
1118 status = usb_autopm_get_interface(dev->intf);
1119 if (status < 0) {
1120 usb_free_urb(urb);
1121 goto fail_lowmem;
1122 }
1123 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
1124 resched = 0;
1125 usb_autopm_put_interface(dev->intf);
1126fail_lowmem:
1127 if (resched)
1128 tasklet_schedule (&dev->bh);
1129 }
1130 }
1131
1132 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
1133 struct driver_info *info = dev->driver_info;
1134 int retval = 0;
1135
1136 clear_bit (EVENT_LINK_RESET, &dev->flags);
1137 status = usb_autopm_get_interface(dev->intf);
1138 if (status < 0)
1139 goto skip_reset;
1140 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1141 usb_autopm_put_interface(dev->intf);
1142skip_reset:
1143 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1144 retval,
1145 dev->udev->bus->bus_name,
1146 dev->udev->devpath,
1147 info->description);
1148 } else {
1149 usb_autopm_put_interface(dev->intf);
1150 }
1151
1152 /* handle link change from link resetting */
1153 __handle_link_change(dev);
1154 }
1155
1156 if (test_bit (EVENT_LINK_CHANGE, &dev->flags))
1157 __handle_link_change(dev);
1158
1159 if (dev->flags)
1160 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1161}
1162
1163/*-------------------------------------------------------------------------*/
1164
1165static void tx_complete (struct urb *urb)
1166{
1167 struct sk_buff *skb = (struct sk_buff *) urb->context;
1168 struct skb_data *entry = (struct skb_data *) skb->cb;
1169 struct usbnet *dev = entry->dev;
1170
1171 if (urb->status == 0) {
1172 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1173 dev->net->stats.tx_packets++;
1174 dev->net->stats.tx_bytes += entry->length;
1175 } else {
1176 dev->net->stats.tx_errors++;
1177
1178 switch (urb->status) {
1179 case -EPIPE:
1180 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1181 break;
1182
1183 /* software-driven interface shutdown */
1184 case -ECONNRESET: // async unlink
1185 case -ESHUTDOWN: // hardware gone
1186 break;
1187
1188 // like rx, tx gets controller i/o faults during khubd delays
1189 // and so it uses the same throttling mechanism.
1190 case -EPROTO:
1191 case -ETIME:
1192 case -EILSEQ:
1193 usb_mark_last_busy(dev->udev);
1194 if (!timer_pending (&dev->delay)) {
1195 mod_timer (&dev->delay,
1196 jiffies + THROTTLE_JIFFIES);
1197 netif_dbg(dev, link, dev->net,
1198 "tx throttle %d\n", urb->status);
1199 }
1200 netif_stop_queue (dev->net);
1201 break;
1202 default:
1203 netif_dbg(dev, tx_err, dev->net,
1204 "tx err %d\n", entry->urb->status);
1205 break;
1206 }
1207 }
1208
1209 usb_autopm_put_interface_async(dev->intf);
1210 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1211}
1212
1213/*-------------------------------------------------------------------------*/
1214
1215void usbnet_tx_timeout (struct net_device *net)
1216{
1217 struct usbnet *dev = netdev_priv(net);
1218
1219 unlink_urbs (dev, &dev->txq);
1220 tasklet_schedule (&dev->bh);
1221
1222 // FIXME: device recovery -- reset?
1223}
1224EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1225
1226/*-------------------------------------------------------------------------*/
1227
1228static int build_dma_sg(const struct sk_buff *skb, struct urb *urb)
1229{
1230 unsigned num_sgs, total_len = 0;
1231 int i, s = 0;
1232
1233 num_sgs = skb_shinfo(skb)->nr_frags + 1;
1234 if (num_sgs == 1)
1235 return 0;
1236
1237 /* reserve one for zero packet */
1238 urb->sg = kmalloc((num_sgs + 1) * sizeof(struct scatterlist),
1239 GFP_ATOMIC);
1240 if (!urb->sg)
1241 return -ENOMEM;
1242
1243 urb->num_sgs = num_sgs;
1244 sg_init_table(urb->sg, urb->num_sgs + 1);
1245
1246 sg_set_buf(&urb->sg[s++], skb->data, skb_headlen(skb));
1247 total_len += skb_headlen(skb);
1248
1249 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
1250 struct skb_frag_struct *f = &skb_shinfo(skb)->frags[i];
1251
1252 total_len += skb_frag_size(f);
1253 sg_set_page(&urb->sg[i + s], f->page.p, f->size,
1254 f->page_offset);
1255 }
1256 urb->transfer_buffer_length = total_len;
1257
1258 return 1;
1259}
1260
1261netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1262 struct net_device *net)
1263{
1264 struct usbnet *dev = netdev_priv(net);
1265 int length;
1266 struct urb *urb = NULL;
1267 struct skb_data *entry;
1268 struct driver_info *info = dev->driver_info;
1269 unsigned long flags;
1270 int retval;
1271
1272 if (skb)
1273 skb_tx_timestamp(skb);
1274
1275 // some devices want funky USB-level framing, for
1276 // win32 driver (usually) and/or hardware quirks
1277 if (info->tx_fixup) {
1278 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1279 if (!skb) {
1280 /* packet collected; minidriver waiting for more */
1281 if (info->flags & FLAG_MULTI_PACKET)
1282 goto not_drop;
1283 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1284 goto drop;
1285 }
1286 }
1287
1288 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1289 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1290 goto drop;
1291 }
1292
1293 entry = (struct skb_data *) skb->cb;
1294 entry->urb = urb;
1295 entry->dev = dev;
1296
1297 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1298 skb->data, skb->len, tx_complete, skb);
1299 if (dev->can_dma_sg) {
1300 if (build_dma_sg(skb, urb) < 0)
1301 goto drop;
1302 }
1303 length = urb->transfer_buffer_length;
1304
1305 /* don't assume the hardware handles USB_ZERO_PACKET
1306 * NOTE: strictly conforming cdc-ether devices should expect
1307 * the ZLP here, but ignore the one-byte packet.
1308 * NOTE2: CDC NCM specification is different from CDC ECM when
1309 * handling ZLP/short packets, so cdc_ncm driver will make short
1310 * packet itself if needed.
1311 */
1312 if (length % dev->maxpacket == 0) {
1313 if (!(info->flags & FLAG_SEND_ZLP)) {
1314 if (!(info->flags & FLAG_MULTI_PACKET)) {
1315 length++;
1316 if (skb_tailroom(skb) && !urb->num_sgs) {
1317 skb->data[skb->len] = 0;
1318 __skb_put(skb, 1);
1319 } else if (urb->num_sgs)
1320 sg_set_buf(&urb->sg[urb->num_sgs++],
1321 dev->padding_pkt, 1);
1322 }
1323 } else
1324 urb->transfer_flags |= URB_ZERO_PACKET;
1325 }
1326 entry->length = urb->transfer_buffer_length = length;
1327
1328 spin_lock_irqsave(&dev->txq.lock, flags);
1329 retval = usb_autopm_get_interface_async(dev->intf);
1330 if (retval < 0) {
1331 spin_unlock_irqrestore(&dev->txq.lock, flags);
1332 goto drop;
1333 }
1334
1335#ifdef CONFIG_PM
1336 /* if this triggers the device is still a sleep */
1337 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1338 /* transmission will be done in resume */
1339 usb_anchor_urb(urb, &dev->deferred);
1340 /* no use to process more packets */
1341 netif_stop_queue(net);
1342 usb_put_urb(urb);
1343 spin_unlock_irqrestore(&dev->txq.lock, flags);
1344 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1345 goto deferred;
1346 }
1347#endif
1348
1349 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1350 case -EPIPE:
1351 netif_stop_queue (net);
1352 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1353 usb_autopm_put_interface_async(dev->intf);
1354 break;
1355 default:
1356 usb_autopm_put_interface_async(dev->intf);
1357 netif_dbg(dev, tx_err, dev->net,
1358 "tx: submit urb err %d\n", retval);
1359 break;
1360 case 0:
1361 net->trans_start = jiffies;
1362 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1363 if (dev->txq.qlen >= TX_QLEN (dev))
1364 netif_stop_queue (net);
1365 }
1366 spin_unlock_irqrestore (&dev->txq.lock, flags);
1367
1368 if (retval) {
1369 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1370drop:
1371 dev->net->stats.tx_dropped++;
1372not_drop:
1373 if (skb)
1374 dev_kfree_skb_any (skb);
1375 if (urb) {
1376 kfree(urb->sg);
1377 usb_free_urb(urb);
1378 }
1379 } else
1380 netif_dbg(dev, tx_queued, dev->net,
1381 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1382#ifdef CONFIG_PM
1383deferred:
1384#endif
1385 return NETDEV_TX_OK;
1386}
1387EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1388
1389static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1390{
1391 struct urb *urb;
1392 int i;
1393 int ret = 0;
1394
1395 /* don't refill the queue all at once */
1396 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1397 urb = usb_alloc_urb(0, flags);
1398 if (urb != NULL) {
1399 ret = rx_submit(dev, urb, flags);
1400 if (ret)
1401 goto err;
1402 } else {
1403 ret = -ENOMEM;
1404 goto err;
1405 }
1406 }
1407err:
1408 return ret;
1409}
1410
1411/*-------------------------------------------------------------------------*/
1412
1413// tasklet (work deferred from completions, in_irq) or timer
1414
1415static void usbnet_bh (unsigned long param)
1416{
1417 struct usbnet *dev = (struct usbnet *) param;
1418 struct sk_buff *skb;
1419 struct skb_data *entry;
1420
1421 while ((skb = skb_dequeue (&dev->done))) {
1422 entry = (struct skb_data *) skb->cb;
1423 switch (entry->state) {
1424 case rx_done:
1425 entry->state = rx_cleanup;
1426 rx_process (dev, skb);
1427 continue;
1428 case tx_done:
1429 kfree(entry->urb->sg);
1430 case rx_cleanup:
1431 usb_free_urb (entry->urb);
1432 dev_kfree_skb (skb);
1433 continue;
1434 default:
1435 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1436 }
1437 }
1438
1439 /* restart RX again after disabling due to high error rate */
1440 clear_bit(EVENT_RX_KILL, &dev->flags);
1441
1442 /* waiting for all pending urbs to complete?
1443 * only then can we forgo submitting anew
1444 */
1445 if (waitqueue_active(&dev->wait)) {
1446 if (dev->txq.qlen + dev->rxq.qlen + dev->done.qlen == 0)
1447 wake_up_all(&dev->wait);
1448
1449 // or are we maybe short a few urbs?
1450 } else if (netif_running (dev->net) &&
1451 netif_device_present (dev->net) &&
1452 netif_carrier_ok(dev->net) &&
1453 !timer_pending (&dev->delay) &&
1454 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1455 int temp = dev->rxq.qlen;
1456
1457 if (temp < RX_QLEN(dev)) {
1458 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1459 return;
1460 if (temp != dev->rxq.qlen)
1461 netif_dbg(dev, link, dev->net,
1462 "rxqlen %d --> %d\n",
1463 temp, dev->rxq.qlen);
1464 if (dev->rxq.qlen < RX_QLEN(dev))
1465 tasklet_schedule (&dev->bh);
1466 }
1467 if (dev->txq.qlen < TX_QLEN (dev))
1468 netif_wake_queue (dev->net);
1469 }
1470}
1471
1472
1473/*-------------------------------------------------------------------------
1474 *
1475 * USB Device Driver support
1476 *
1477 *-------------------------------------------------------------------------*/
1478
1479// precondition: never called in_interrupt
1480
1481void usbnet_disconnect (struct usb_interface *intf)
1482{
1483 struct usbnet *dev;
1484 struct usb_device *xdev;
1485 struct net_device *net;
1486
1487 dev = usb_get_intfdata(intf);
1488 usb_set_intfdata(intf, NULL);
1489 if (!dev)
1490 return;
1491
1492 xdev = interface_to_usbdev (intf);
1493
1494 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1495 intf->dev.driver->name,
1496 xdev->bus->bus_name, xdev->devpath,
1497 dev->driver_info->description);
1498
1499 net = dev->net;
1500 unregister_netdev (net);
1501
1502 cancel_work_sync(&dev->kevent);
1503
1504 usb_scuttle_anchored_urbs(&dev->deferred);
1505
1506 if (dev->driver_info->unbind)
1507 dev->driver_info->unbind (dev, intf);
1508
1509 usb_kill_urb(dev->interrupt);
1510 usb_free_urb(dev->interrupt);
1511 kfree(dev->padding_pkt);
1512
1513 free_netdev(net);
1514}
1515EXPORT_SYMBOL_GPL(usbnet_disconnect);
1516
1517static const struct net_device_ops usbnet_netdev_ops = {
1518 .ndo_open = usbnet_open,
1519 .ndo_stop = usbnet_stop,
1520 .ndo_start_xmit = usbnet_start_xmit,
1521 .ndo_tx_timeout = usbnet_tx_timeout,
1522 .ndo_change_mtu = usbnet_change_mtu,
1523 .ndo_set_mac_address = eth_mac_addr,
1524 .ndo_validate_addr = eth_validate_addr,
1525};
1526
1527/*-------------------------------------------------------------------------*/
1528
1529// precondition: never called in_interrupt
1530
1531static struct device_type wlan_type = {
1532 .name = "wlan",
1533};
1534
1535static struct device_type wwan_type = {
1536 .name = "wwan",
1537};
1538
1539int
1540usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1541{
1542 struct usbnet *dev;
1543 struct net_device *net;
1544 struct usb_host_interface *interface;
1545 struct driver_info *info;
1546 struct usb_device *xdev;
1547 int status;
1548 const char *name;
1549 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1550
1551 /* usbnet already took usb runtime pm, so have to enable the feature
1552 * for usb interface, otherwise usb_autopm_get_interface may return
1553 * failure if RUNTIME_PM is enabled.
1554 */
1555 if (!driver->supports_autosuspend) {
1556 driver->supports_autosuspend = 1;
1557 pm_runtime_enable(&udev->dev);
1558 }
1559
1560 name = udev->dev.driver->name;
1561 info = (struct driver_info *) prod->driver_info;
1562 if (!info) {
1563 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1564 return -ENODEV;
1565 }
1566 xdev = interface_to_usbdev (udev);
1567 interface = udev->cur_altsetting;
1568
1569 status = -ENOMEM;
1570
1571 // set up our own records
1572 net = alloc_etherdev(sizeof(*dev));
1573 if (!net)
1574 goto out;
1575
1576 /* netdev_printk() needs this so do it as early as possible */
1577 SET_NETDEV_DEV(net, &udev->dev);
1578
1579 dev = netdev_priv(net);
1580 dev->udev = xdev;
1581 dev->intf = udev;
1582 dev->driver_info = info;
1583 dev->driver_name = name;
1584 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1585 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1586 init_waitqueue_head(&dev->wait);
1587 skb_queue_head_init (&dev->rxq);
1588 skb_queue_head_init (&dev->txq);
1589 skb_queue_head_init (&dev->done);
1590 skb_queue_head_init(&dev->rxq_pause);
1591 dev->bh.func = usbnet_bh;
1592 dev->bh.data = (unsigned long) dev;
1593 INIT_WORK (&dev->kevent, kevent);
1594 init_usb_anchor(&dev->deferred);
1595 dev->delay.function = usbnet_bh;
1596 dev->delay.data = (unsigned long) dev;
1597 init_timer (&dev->delay);
1598 mutex_init (&dev->phy_mutex);
1599 mutex_init(&dev->interrupt_mutex);
1600 dev->interrupt_count = 0;
1601
1602 dev->net = net;
1603 strcpy (net->name, "usb%d");
1604 memcpy (net->dev_addr, node_id, sizeof node_id);
1605
1606 /* rx and tx sides can use different message sizes;
1607 * bind() should set rx_urb_size in that case.
1608 */
1609 dev->hard_mtu = net->mtu + net->hard_header_len;
1610#if 0
1611// dma_supported() is deeply broken on almost all architectures
1612 // possible with some EHCI controllers
1613 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1614 net->features |= NETIF_F_HIGHDMA;
1615#endif
1616
1617 net->netdev_ops = &usbnet_netdev_ops;
1618 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1619 net->ethtool_ops = &usbnet_ethtool_ops;
1620
1621 // allow device-specific bind/init procedures
1622 // NOTE net->name still not usable ...
1623 if (info->bind) {
1624 status = info->bind (dev, udev);
1625 if (status < 0)
1626 goto out1;
1627
1628 // heuristic: "usb%d" for links we know are two-host,
1629 // else "eth%d" when there's reasonable doubt. userspace
1630 // can rename the link if it knows better.
1631 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1632 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1633 (net->dev_addr [0] & 0x02) == 0))
1634 strcpy (net->name, "eth%d");
1635 /* WLAN devices should always be named "wlan%d" */
1636 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1637 strcpy(net->name, "wlan%d");
1638 /* WWAN devices should always be named "wwan%d" */
1639 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1640 strcpy(net->name, "wwan%d");
1641
1642 /* devices that cannot do ARP */
1643 if ((dev->driver_info->flags & FLAG_NOARP) != 0)
1644 net->flags |= IFF_NOARP;
1645
1646 /* maybe the remote can't receive an Ethernet MTU */
1647 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1648 net->mtu = dev->hard_mtu - net->hard_header_len;
1649 } else if (!info->in || !info->out)
1650 status = usbnet_get_endpoints (dev, udev);
1651 else {
1652 dev->in = usb_rcvbulkpipe (xdev, info->in);
1653 dev->out = usb_sndbulkpipe (xdev, info->out);
1654 if (!(info->flags & FLAG_NO_SETINT))
1655 status = usb_set_interface (xdev,
1656 interface->desc.bInterfaceNumber,
1657 interface->desc.bAlternateSetting);
1658 else
1659 status = 0;
1660
1661 }
1662 if (status >= 0 && dev->status)
1663 status = init_status (dev, udev);
1664 if (status < 0)
1665 goto out3;
1666
1667 if (!dev->rx_urb_size)
1668 dev->rx_urb_size = dev->hard_mtu;
1669 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1670
1671 /* let userspace know we have a random address */
1672 if (ether_addr_equal(net->dev_addr, node_id))
1673 net->addr_assign_type = NET_ADDR_RANDOM;
1674
1675 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1676 SET_NETDEV_DEVTYPE(net, &wlan_type);
1677 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1678 SET_NETDEV_DEVTYPE(net, &wwan_type);
1679
1680 /* initialize max rx_qlen and tx_qlen */
1681 usbnet_update_max_qlen(dev);
1682
1683 if (dev->can_dma_sg && !(info->flags & FLAG_SEND_ZLP) &&
1684 !(info->flags & FLAG_MULTI_PACKET)) {
1685 dev->padding_pkt = kzalloc(1, GFP_KERNEL);
1686 if (!dev->padding_pkt) {
1687 status = -ENOMEM;
1688 goto out4;
1689 }
1690 }
1691
1692 status = register_netdev (net);
1693 if (status)
1694 goto out5;
1695 netif_info(dev, probe, dev->net,
1696 "register '%s' at usb-%s-%s, %s, %pM\n",
1697 udev->dev.driver->name,
1698 xdev->bus->bus_name, xdev->devpath,
1699 dev->driver_info->description,
1700 net->dev_addr);
1701
1702 // ok, it's ready to go.
1703 usb_set_intfdata (udev, dev);
1704
1705 netif_device_attach (net);
1706
1707 if (dev->driver_info->flags & FLAG_LINK_INTR)
1708 usbnet_link_change(dev, 0, 0);
1709
1710 return 0;
1711
1712out5:
1713 kfree(dev->padding_pkt);
1714out4:
1715 usb_free_urb(dev->interrupt);
1716out3:
1717 if (info->unbind)
1718 info->unbind (dev, udev);
1719out1:
1720 free_netdev(net);
1721out:
1722 return status;
1723}
1724EXPORT_SYMBOL_GPL(usbnet_probe);
1725
1726/*-------------------------------------------------------------------------*/
1727
1728/*
1729 * suspend the whole driver as soon as the first interface is suspended
1730 * resume only when the last interface is resumed
1731 */
1732
1733int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1734{
1735 struct usbnet *dev = usb_get_intfdata(intf);
1736
1737 if (!dev->suspend_count++) {
1738 spin_lock_irq(&dev->txq.lock);
1739 /* don't autosuspend while transmitting */
1740 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1741 dev->suspend_count--;
1742 spin_unlock_irq(&dev->txq.lock);
1743 return -EBUSY;
1744 } else {
1745 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1746 spin_unlock_irq(&dev->txq.lock);
1747 }
1748 /*
1749 * accelerate emptying of the rx and queues, to avoid
1750 * having everything error out.
1751 */
1752 netif_device_detach (dev->net);
1753 usbnet_terminate_urbs(dev);
1754 __usbnet_status_stop_force(dev);
1755
1756 /*
1757 * reattach so runtime management can use and
1758 * wake the device
1759 */
1760 netif_device_attach (dev->net);
1761 }
1762 return 0;
1763}
1764EXPORT_SYMBOL_GPL(usbnet_suspend);
1765
1766int usbnet_resume (struct usb_interface *intf)
1767{
1768 struct usbnet *dev = usb_get_intfdata(intf);
1769 struct sk_buff *skb;
1770 struct urb *res;
1771 int retval;
1772
1773 if (!--dev->suspend_count) {
1774 /* resume interrupt URB if it was previously submitted */
1775 __usbnet_status_start_force(dev, GFP_NOIO);
1776
1777 spin_lock_irq(&dev->txq.lock);
1778 while ((res = usb_get_from_anchor(&dev->deferred))) {
1779
1780 skb = (struct sk_buff *)res->context;
1781 retval = usb_submit_urb(res, GFP_ATOMIC);
1782 if (retval < 0) {
1783 dev_kfree_skb_any(skb);
1784 kfree(res->sg);
1785 usb_free_urb(res);
1786 usb_autopm_put_interface_async(dev->intf);
1787 } else {
1788 dev->net->trans_start = jiffies;
1789 __skb_queue_tail(&dev->txq, skb);
1790 }
1791 }
1792
1793 smp_mb();
1794 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1795 spin_unlock_irq(&dev->txq.lock);
1796
1797 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1798 /* handle remote wakeup ASAP
1799 * we cannot race against stop
1800 */
1801 if (netif_device_present(dev->net) &&
1802 !timer_pending(&dev->delay) &&
1803 !test_bit(EVENT_RX_HALT, &dev->flags))
1804 rx_alloc_submit(dev, GFP_NOIO);
1805
1806 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1807 netif_tx_wake_all_queues(dev->net);
1808 tasklet_schedule (&dev->bh);
1809 }
1810 }
1811
1812 if (test_and_clear_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags))
1813 usb_autopm_get_interface_no_resume(intf);
1814
1815 return 0;
1816}
1817EXPORT_SYMBOL_GPL(usbnet_resume);
1818
1819/*
1820 * Either a subdriver implements manage_power, then it is assumed to always
1821 * be ready to be suspended or it reports the readiness to be suspended
1822 * explicitly
1823 */
1824void usbnet_device_suggests_idle(struct usbnet *dev)
1825{
1826 if (!test_and_set_bit(EVENT_DEVICE_REPORT_IDLE, &dev->flags)) {
1827 dev->intf->needs_remote_wakeup = 1;
1828 usb_autopm_put_interface_async(dev->intf);
1829 }
1830}
1831EXPORT_SYMBOL(usbnet_device_suggests_idle);
1832
1833/*
1834 * For devices that can do without special commands
1835 */
1836int usbnet_manage_power(struct usbnet *dev, int on)
1837{
1838 dev->intf->needs_remote_wakeup = on;
1839 return 0;
1840}
1841EXPORT_SYMBOL(usbnet_manage_power);
1842
1843void usbnet_link_change(struct usbnet *dev, bool link, bool need_reset)
1844{
1845 /* update link after link is reseted */
1846 if (link && !need_reset)
1847 netif_carrier_on(dev->net);
1848 else
1849 netif_carrier_off(dev->net);
1850
1851 if (need_reset && link)
1852 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
1853 else
1854 usbnet_defer_kevent(dev, EVENT_LINK_CHANGE);
1855}
1856EXPORT_SYMBOL(usbnet_link_change);
1857
1858/*-------------------------------------------------------------------------*/
1859static int __usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1860 u16 value, u16 index, void *data, u16 size)
1861{
1862 void *buf = NULL;
1863 int err = -ENOMEM;
1864
1865 netdev_dbg(dev->net, "usbnet_read_cmd cmd=0x%02x reqtype=%02x"
1866 " value=0x%04x index=0x%04x size=%d\n",
1867 cmd, reqtype, value, index, size);
1868
1869 if (data) {
1870 buf = kmalloc(size, GFP_KERNEL);
1871 if (!buf)
1872 goto out;
1873 }
1874
1875 err = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
1876 cmd, reqtype, value, index, buf, size,
1877 USB_CTRL_GET_TIMEOUT);
1878 if (err > 0 && err <= size)
1879 memcpy(data, buf, err);
1880 kfree(buf);
1881out:
1882 return err;
1883}
1884
1885static int __usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1886 u16 value, u16 index, const void *data,
1887 u16 size)
1888{
1889 void *buf = NULL;
1890 int err = -ENOMEM;
1891
1892 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1893 " value=0x%04x index=0x%04x size=%d\n",
1894 cmd, reqtype, value, index, size);
1895
1896 if (data) {
1897 buf = kmemdup(data, size, GFP_KERNEL);
1898 if (!buf)
1899 goto out;
1900 }
1901
1902 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
1903 cmd, reqtype, value, index, buf, size,
1904 USB_CTRL_SET_TIMEOUT);
1905 kfree(buf);
1906
1907out:
1908 return err;
1909}
1910
1911/*
1912 * The function can't be called inside suspend/resume callback,
1913 * otherwise deadlock will be caused.
1914 */
1915int usbnet_read_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1916 u16 value, u16 index, void *data, u16 size)
1917{
1918 int ret;
1919
1920 if (usb_autopm_get_interface(dev->intf) < 0)
1921 return -ENODEV;
1922 ret = __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1923 data, size);
1924 usb_autopm_put_interface(dev->intf);
1925 return ret;
1926}
1927EXPORT_SYMBOL_GPL(usbnet_read_cmd);
1928
1929/*
1930 * The function can't be called inside suspend/resume callback,
1931 * otherwise deadlock will be caused.
1932 */
1933int usbnet_write_cmd(struct usbnet *dev, u8 cmd, u8 reqtype,
1934 u16 value, u16 index, const void *data, u16 size)
1935{
1936 int ret;
1937
1938 if (usb_autopm_get_interface(dev->intf) < 0)
1939 return -ENODEV;
1940 ret = __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1941 data, size);
1942 usb_autopm_put_interface(dev->intf);
1943 return ret;
1944}
1945EXPORT_SYMBOL_GPL(usbnet_write_cmd);
1946
1947/*
1948 * The function can be called inside suspend/resume callback safely
1949 * and should only be called by suspend/resume callback generally.
1950 */
1951int usbnet_read_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1952 u16 value, u16 index, void *data, u16 size)
1953{
1954 return __usbnet_read_cmd(dev, cmd, reqtype, value, index,
1955 data, size);
1956}
1957EXPORT_SYMBOL_GPL(usbnet_read_cmd_nopm);
1958
1959/*
1960 * The function can be called inside suspend/resume callback safely
1961 * and should only be called by suspend/resume callback generally.
1962 */
1963int usbnet_write_cmd_nopm(struct usbnet *dev, u8 cmd, u8 reqtype,
1964 u16 value, u16 index, const void *data,
1965 u16 size)
1966{
1967 return __usbnet_write_cmd(dev, cmd, reqtype, value, index,
1968 data, size);
1969}
1970EXPORT_SYMBOL_GPL(usbnet_write_cmd_nopm);
1971
1972static void usbnet_async_cmd_cb(struct urb *urb)
1973{
1974 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
1975 int status = urb->status;
1976
1977 if (status < 0)
1978 dev_dbg(&urb->dev->dev, "%s failed with %d",
1979 __func__, status);
1980
1981 kfree(req);
1982 usb_free_urb(urb);
1983}
1984
1985/*
1986 * The caller must make sure that device can't be put into suspend
1987 * state until the control URB completes.
1988 */
1989int usbnet_write_cmd_async(struct usbnet *dev, u8 cmd, u8 reqtype,
1990 u16 value, u16 index, const void *data, u16 size)
1991{
1992 struct usb_ctrlrequest *req = NULL;
1993 struct urb *urb;
1994 int err = -ENOMEM;
1995 void *buf = NULL;
1996
1997 netdev_dbg(dev->net, "usbnet_write_cmd cmd=0x%02x reqtype=%02x"
1998 " value=0x%04x index=0x%04x size=%d\n",
1999 cmd, reqtype, value, index, size);
2000
2001 urb = usb_alloc_urb(0, GFP_ATOMIC);
2002 if (!urb) {
2003 netdev_err(dev->net, "Error allocating URB in"
2004 " %s!\n", __func__);
2005 goto fail;
2006 }
2007
2008 if (data) {
2009 buf = kmemdup(data, size, GFP_ATOMIC);
2010 if (!buf) {
2011 netdev_err(dev->net, "Error allocating buffer"
2012 " in %s!\n", __func__);
2013 goto fail_free;
2014 }
2015 }
2016
2017 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
2018 if (!req)
2019 goto fail_free_buf;
2020
2021 req->bRequestType = reqtype;
2022 req->bRequest = cmd;
2023 req->wValue = cpu_to_le16(value);
2024 req->wIndex = cpu_to_le16(index);
2025 req->wLength = cpu_to_le16(size);
2026
2027 usb_fill_control_urb(urb, dev->udev,
2028 usb_sndctrlpipe(dev->udev, 0),
2029 (void *)req, buf, size,
2030 usbnet_async_cmd_cb, req);
2031 urb->transfer_flags |= URB_FREE_BUFFER;
2032
2033 err = usb_submit_urb(urb, GFP_ATOMIC);
2034 if (err < 0) {
2035 netdev_err(dev->net, "Error submitting the control"
2036 " message: status=%d\n", err);
2037 goto fail_free;
2038 }
2039 return 0;
2040
2041fail_free_buf:
2042 kfree(buf);
2043fail_free:
2044 kfree(req);
2045 usb_free_urb(urb);
2046fail:
2047 return err;
2048
2049}
2050EXPORT_SYMBOL_GPL(usbnet_write_cmd_async);
2051/*-------------------------------------------------------------------------*/
2052
2053static int __init usbnet_init(void)
2054{
2055 /* Compiler should optimize this out. */
2056 BUILD_BUG_ON(
2057 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
2058
2059 eth_random_addr(node_id);
2060 return 0;
2061}
2062module_init(usbnet_init);
2063
2064static void __exit usbnet_exit(void)
2065{
2066}
2067module_exit(usbnet_exit);
2068
2069MODULE_AUTHOR("David Brownell");
2070MODULE_DESCRIPTION("USB network driver framework");
2071MODULE_LICENSE("GPL");
1/*
2 * USB Network driver infrastructure
3 * Copyright (C) 2000-2005 by David Brownell
4 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21/*
22 * This is a generic "USB networking" framework that works with several
23 * kinds of full and high speed networking devices: host-to-host cables,
24 * smart usb peripherals, and actual Ethernet adapters.
25 *
26 * These devices usually differ in terms of control protocols (if they
27 * even have one!) and sometimes they define new framing to wrap or batch
28 * Ethernet packets. Otherwise, they talk to USB pretty much the same,
29 * so interface (un)binding, endpoint I/O queues, fault handling, and other
30 * issues can usefully be addressed by this framework.
31 */
32
33// #define DEBUG // error path messages, extra info
34// #define VERBOSE // more; success messages
35
36#include <linux/module.h>
37#include <linux/init.h>
38#include <linux/netdevice.h>
39#include <linux/etherdevice.h>
40#include <linux/ctype.h>
41#include <linux/ethtool.h>
42#include <linux/workqueue.h>
43#include <linux/mii.h>
44#include <linux/usb.h>
45#include <linux/usb/usbnet.h>
46#include <linux/slab.h>
47#include <linux/kernel.h>
48#include <linux/pm_runtime.h>
49
50#define DRIVER_VERSION "22-Aug-2005"
51
52
53/*-------------------------------------------------------------------------*/
54
55/*
56 * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
57 * Several dozen bytes of IPv4 data can fit in two such transactions.
58 * One maximum size Ethernet packet takes twenty four of them.
59 * For high speed, each frame comfortably fits almost 36 max size
60 * Ethernet packets (so queues should be bigger).
61 *
62 * REVISIT qlens should be members of 'struct usbnet'; the goal is to
63 * let the USB host controller be busy for 5msec or more before an irq
64 * is required, under load. Jumbograms change the equation.
65 */
66#define RX_MAX_QUEUE_MEMORY (60 * 1518)
67#define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
68 (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
69#define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
70 (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
71
72// reawaken network queue this soon after stopping; else watchdog barks
73#define TX_TIMEOUT_JIFFIES (5*HZ)
74
75// throttle rx/tx briefly after some faults, so khubd might disconnect()
76// us (it polls at HZ/4 usually) before we report too many false errors.
77#define THROTTLE_JIFFIES (HZ/8)
78
79// between wakeups
80#define UNLINK_TIMEOUT_MS 3
81
82/*-------------------------------------------------------------------------*/
83
84// randomly generated ethernet address
85static u8 node_id [ETH_ALEN];
86
87static const char driver_name [] = "usbnet";
88
89/* use ethtool to change the level for any given device */
90static int msg_level = -1;
91module_param (msg_level, int, 0);
92MODULE_PARM_DESC (msg_level, "Override default message level");
93
94/*-------------------------------------------------------------------------*/
95
96/* handles CDC Ethernet and many other network "bulk data" interfaces */
97int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
98{
99 int tmp;
100 struct usb_host_interface *alt = NULL;
101 struct usb_host_endpoint *in = NULL, *out = NULL;
102 struct usb_host_endpoint *status = NULL;
103
104 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
105 unsigned ep;
106
107 in = out = status = NULL;
108 alt = intf->altsetting + tmp;
109
110 /* take the first altsetting with in-bulk + out-bulk;
111 * remember any status endpoint, just in case;
112 * ignore other endpoints and altsettings.
113 */
114 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
115 struct usb_host_endpoint *e;
116 int intr = 0;
117
118 e = alt->endpoint + ep;
119 switch (e->desc.bmAttributes) {
120 case USB_ENDPOINT_XFER_INT:
121 if (!usb_endpoint_dir_in(&e->desc))
122 continue;
123 intr = 1;
124 /* FALLTHROUGH */
125 case USB_ENDPOINT_XFER_BULK:
126 break;
127 default:
128 continue;
129 }
130 if (usb_endpoint_dir_in(&e->desc)) {
131 if (!intr && !in)
132 in = e;
133 else if (intr && !status)
134 status = e;
135 } else {
136 if (!out)
137 out = e;
138 }
139 }
140 if (in && out)
141 break;
142 }
143 if (!alt || !in || !out)
144 return -EINVAL;
145
146 if (alt->desc.bAlternateSetting != 0 ||
147 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
148 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
149 alt->desc.bAlternateSetting);
150 if (tmp < 0)
151 return tmp;
152 }
153
154 dev->in = usb_rcvbulkpipe (dev->udev,
155 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156 dev->out = usb_sndbulkpipe (dev->udev,
157 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
158 dev->status = status;
159 return 0;
160}
161EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
162
163int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
164{
165 int tmp, i;
166 unsigned char buf [13];
167
168 tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
169 if (tmp != 12) {
170 dev_dbg(&dev->udev->dev,
171 "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
172 if (tmp >= 0)
173 tmp = -EINVAL;
174 return tmp;
175 }
176 for (i = tmp = 0; i < 6; i++, tmp += 2)
177 dev->net->dev_addr [i] =
178 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
179 return 0;
180}
181EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
182
183static void intr_complete (struct urb *urb);
184
185static int init_status (struct usbnet *dev, struct usb_interface *intf)
186{
187 char *buf = NULL;
188 unsigned pipe = 0;
189 unsigned maxp;
190 unsigned period;
191
192 if (!dev->driver_info->status)
193 return 0;
194
195 pipe = usb_rcvintpipe (dev->udev,
196 dev->status->desc.bEndpointAddress
197 & USB_ENDPOINT_NUMBER_MASK);
198 maxp = usb_maxpacket (dev->udev, pipe, 0);
199
200 /* avoid 1 msec chatter: min 8 msec poll rate */
201 period = max ((int) dev->status->desc.bInterval,
202 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
203
204 buf = kmalloc (maxp, GFP_KERNEL);
205 if (buf) {
206 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
207 if (!dev->interrupt) {
208 kfree (buf);
209 return -ENOMEM;
210 } else {
211 usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
212 buf, maxp, intr_complete, dev, period);
213 dev->interrupt->transfer_flags |= URB_FREE_BUFFER;
214 dev_dbg(&intf->dev,
215 "status ep%din, %d bytes period %d\n",
216 usb_pipeendpoint(pipe), maxp, period);
217 }
218 }
219 return 0;
220}
221
222/* Passes this packet up the stack, updating its accounting.
223 * Some link protocols batch packets, so their rx_fixup paths
224 * can return clones as well as just modify the original skb.
225 */
226void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
227{
228 int status;
229
230 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
231 skb_queue_tail(&dev->rxq_pause, skb);
232 return;
233 }
234
235 skb->protocol = eth_type_trans (skb, dev->net);
236 dev->net->stats.rx_packets++;
237 dev->net->stats.rx_bytes += skb->len;
238
239 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
240 skb->len + sizeof (struct ethhdr), skb->protocol);
241 memset (skb->cb, 0, sizeof (struct skb_data));
242
243 if (skb_defer_rx_timestamp(skb))
244 return;
245
246 status = netif_rx (skb);
247 if (status != NET_RX_SUCCESS)
248 netif_dbg(dev, rx_err, dev->net,
249 "netif_rx status %d\n", status);
250}
251EXPORT_SYMBOL_GPL(usbnet_skb_return);
252
253
254/*-------------------------------------------------------------------------
255 *
256 * Network Device Driver (peer link to "Host Device", from USB host)
257 *
258 *-------------------------------------------------------------------------*/
259
260int usbnet_change_mtu (struct net_device *net, int new_mtu)
261{
262 struct usbnet *dev = netdev_priv(net);
263 int ll_mtu = new_mtu + net->hard_header_len;
264 int old_hard_mtu = dev->hard_mtu;
265 int old_rx_urb_size = dev->rx_urb_size;
266
267 if (new_mtu <= 0)
268 return -EINVAL;
269 // no second zero-length packet read wanted after mtu-sized packets
270 if ((ll_mtu % dev->maxpacket) == 0)
271 return -EDOM;
272 net->mtu = new_mtu;
273
274 dev->hard_mtu = net->mtu + net->hard_header_len;
275 if (dev->rx_urb_size == old_hard_mtu) {
276 dev->rx_urb_size = dev->hard_mtu;
277 if (dev->rx_urb_size > old_rx_urb_size)
278 usbnet_unlink_rx_urbs(dev);
279 }
280
281 return 0;
282}
283EXPORT_SYMBOL_GPL(usbnet_change_mtu);
284
285/* The caller must hold list->lock */
286static void __usbnet_queue_skb(struct sk_buff_head *list,
287 struct sk_buff *newsk, enum skb_state state)
288{
289 struct skb_data *entry = (struct skb_data *) newsk->cb;
290
291 __skb_queue_tail(list, newsk);
292 entry->state = state;
293}
294
295/*-------------------------------------------------------------------------*/
296
297/* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
298 * completion callbacks. 2.5 should have fixed those bugs...
299 */
300
301static enum skb_state defer_bh(struct usbnet *dev, struct sk_buff *skb,
302 struct sk_buff_head *list, enum skb_state state)
303{
304 unsigned long flags;
305 enum skb_state old_state;
306 struct skb_data *entry = (struct skb_data *) skb->cb;
307
308 spin_lock_irqsave(&list->lock, flags);
309 old_state = entry->state;
310 entry->state = state;
311 __skb_unlink(skb, list);
312 spin_unlock(&list->lock);
313 spin_lock(&dev->done.lock);
314 __skb_queue_tail(&dev->done, skb);
315 if (dev->done.qlen == 1)
316 tasklet_schedule(&dev->bh);
317 spin_unlock_irqrestore(&dev->done.lock, flags);
318 return old_state;
319}
320
321/* some work can't be done in tasklets, so we use keventd
322 *
323 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
324 * but tasklet_schedule() doesn't. hope the failure is rare.
325 */
326void usbnet_defer_kevent (struct usbnet *dev, int work)
327{
328 set_bit (work, &dev->flags);
329 if (!schedule_work (&dev->kevent))
330 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
331 else
332 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
333}
334EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
335
336/*-------------------------------------------------------------------------*/
337
338static void rx_complete (struct urb *urb);
339
340static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
341{
342 struct sk_buff *skb;
343 struct skb_data *entry;
344 int retval = 0;
345 unsigned long lockflags;
346 size_t size = dev->rx_urb_size;
347
348 skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
349 if (!skb) {
350 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
351 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
352 usb_free_urb (urb);
353 return -ENOMEM;
354 }
355
356 entry = (struct skb_data *) skb->cb;
357 entry->urb = urb;
358 entry->dev = dev;
359 entry->length = 0;
360
361 usb_fill_bulk_urb (urb, dev->udev, dev->in,
362 skb->data, size, rx_complete, skb);
363
364 spin_lock_irqsave (&dev->rxq.lock, lockflags);
365
366 if (netif_running (dev->net) &&
367 netif_device_present (dev->net) &&
368 !test_bit (EVENT_RX_HALT, &dev->flags) &&
369 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
370 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
371 case -EPIPE:
372 usbnet_defer_kevent (dev, EVENT_RX_HALT);
373 break;
374 case -ENOMEM:
375 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
376 break;
377 case -ENODEV:
378 netif_dbg(dev, ifdown, dev->net, "device gone\n");
379 netif_device_detach (dev->net);
380 break;
381 case -EHOSTUNREACH:
382 retval = -ENOLINK;
383 break;
384 default:
385 netif_dbg(dev, rx_err, dev->net,
386 "rx submit, %d\n", retval);
387 tasklet_schedule (&dev->bh);
388 break;
389 case 0:
390 __usbnet_queue_skb(&dev->rxq, skb, rx_start);
391 }
392 } else {
393 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
394 retval = -ENOLINK;
395 }
396 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
397 if (retval) {
398 dev_kfree_skb_any (skb);
399 usb_free_urb (urb);
400 }
401 return retval;
402}
403
404
405/*-------------------------------------------------------------------------*/
406
407static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
408{
409 if (dev->driver_info->rx_fixup &&
410 !dev->driver_info->rx_fixup (dev, skb)) {
411 /* With RX_ASSEMBLE, rx_fixup() must update counters */
412 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
413 dev->net->stats.rx_errors++;
414 goto done;
415 }
416 // else network stack removes extra byte if we forced a short packet
417
418 if (skb->len) {
419 /* all data was already cloned from skb inside the driver */
420 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
421 dev_kfree_skb_any(skb);
422 else
423 usbnet_skb_return(dev, skb);
424 return;
425 }
426
427 netif_dbg(dev, rx_err, dev->net, "drop\n");
428 dev->net->stats.rx_errors++;
429done:
430 skb_queue_tail(&dev->done, skb);
431}
432
433/*-------------------------------------------------------------------------*/
434
435static void rx_complete (struct urb *urb)
436{
437 struct sk_buff *skb = (struct sk_buff *) urb->context;
438 struct skb_data *entry = (struct skb_data *) skb->cb;
439 struct usbnet *dev = entry->dev;
440 int urb_status = urb->status;
441 enum skb_state state;
442
443 skb_put (skb, urb->actual_length);
444 state = rx_done;
445 entry->urb = NULL;
446
447 switch (urb_status) {
448 /* success */
449 case 0:
450 if (skb->len < dev->net->hard_header_len) {
451 state = rx_cleanup;
452 dev->net->stats.rx_errors++;
453 dev->net->stats.rx_length_errors++;
454 netif_dbg(dev, rx_err, dev->net,
455 "rx length %d\n", skb->len);
456 }
457 break;
458
459 /* stalls need manual reset. this is rare ... except that
460 * when going through USB 2.0 TTs, unplug appears this way.
461 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
462 * storm, recovering as needed.
463 */
464 case -EPIPE:
465 dev->net->stats.rx_errors++;
466 usbnet_defer_kevent (dev, EVENT_RX_HALT);
467 // FALLTHROUGH
468
469 /* software-driven interface shutdown */
470 case -ECONNRESET: /* async unlink */
471 case -ESHUTDOWN: /* hardware gone */
472 netif_dbg(dev, ifdown, dev->net,
473 "rx shutdown, code %d\n", urb_status);
474 goto block;
475
476 /* we get controller i/o faults during khubd disconnect() delays.
477 * throttle down resubmits, to avoid log floods; just temporarily,
478 * so we still recover when the fault isn't a khubd delay.
479 */
480 case -EPROTO:
481 case -ETIME:
482 case -EILSEQ:
483 dev->net->stats.rx_errors++;
484 if (!timer_pending (&dev->delay)) {
485 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
486 netif_dbg(dev, link, dev->net,
487 "rx throttle %d\n", urb_status);
488 }
489block:
490 state = rx_cleanup;
491 entry->urb = urb;
492 urb = NULL;
493 break;
494
495 /* data overrun ... flush fifo? */
496 case -EOVERFLOW:
497 dev->net->stats.rx_over_errors++;
498 // FALLTHROUGH
499
500 default:
501 state = rx_cleanup;
502 dev->net->stats.rx_errors++;
503 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
504 break;
505 }
506
507 state = defer_bh(dev, skb, &dev->rxq, state);
508
509 if (urb) {
510 if (netif_running (dev->net) &&
511 !test_bit (EVENT_RX_HALT, &dev->flags) &&
512 state != unlink_start) {
513 rx_submit (dev, urb, GFP_ATOMIC);
514 usb_mark_last_busy(dev->udev);
515 return;
516 }
517 usb_free_urb (urb);
518 }
519 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
520}
521
522static void intr_complete (struct urb *urb)
523{
524 struct usbnet *dev = urb->context;
525 int status = urb->status;
526
527 switch (status) {
528 /* success */
529 case 0:
530 dev->driver_info->status(dev, urb);
531 break;
532
533 /* software-driven interface shutdown */
534 case -ENOENT: /* urb killed */
535 case -ESHUTDOWN: /* hardware gone */
536 netif_dbg(dev, ifdown, dev->net,
537 "intr shutdown, code %d\n", status);
538 return;
539
540 /* NOTE: not throttling like RX/TX, since this endpoint
541 * already polls infrequently
542 */
543 default:
544 netdev_dbg(dev->net, "intr status %d\n", status);
545 break;
546 }
547
548 if (!netif_running (dev->net))
549 return;
550
551 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
552 status = usb_submit_urb (urb, GFP_ATOMIC);
553 if (status != 0)
554 netif_err(dev, timer, dev->net,
555 "intr resubmit --> %d\n", status);
556}
557
558/*-------------------------------------------------------------------------*/
559void usbnet_pause_rx(struct usbnet *dev)
560{
561 set_bit(EVENT_RX_PAUSED, &dev->flags);
562
563 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
564}
565EXPORT_SYMBOL_GPL(usbnet_pause_rx);
566
567void usbnet_resume_rx(struct usbnet *dev)
568{
569 struct sk_buff *skb;
570 int num = 0;
571
572 clear_bit(EVENT_RX_PAUSED, &dev->flags);
573
574 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
575 usbnet_skb_return(dev, skb);
576 num++;
577 }
578
579 tasklet_schedule(&dev->bh);
580
581 netif_dbg(dev, rx_status, dev->net,
582 "paused rx queue disabled, %d skbs requeued\n", num);
583}
584EXPORT_SYMBOL_GPL(usbnet_resume_rx);
585
586void usbnet_purge_paused_rxq(struct usbnet *dev)
587{
588 skb_queue_purge(&dev->rxq_pause);
589}
590EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
591
592/*-------------------------------------------------------------------------*/
593
594// unlink pending rx/tx; completion handlers do all other cleanup
595
596static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
597{
598 unsigned long flags;
599 struct sk_buff *skb;
600 int count = 0;
601
602 spin_lock_irqsave (&q->lock, flags);
603 while (!skb_queue_empty(q)) {
604 struct skb_data *entry;
605 struct urb *urb;
606 int retval;
607
608 skb_queue_walk(q, skb) {
609 entry = (struct skb_data *) skb->cb;
610 if (entry->state != unlink_start)
611 goto found;
612 }
613 break;
614found:
615 entry->state = unlink_start;
616 urb = entry->urb;
617
618 /*
619 * Get reference count of the URB to avoid it to be
620 * freed during usb_unlink_urb, which may trigger
621 * use-after-free problem inside usb_unlink_urb since
622 * usb_unlink_urb is always racing with .complete
623 * handler(include defer_bh).
624 */
625 usb_get_urb(urb);
626 spin_unlock_irqrestore(&q->lock, flags);
627 // during some PM-driven resume scenarios,
628 // these (async) unlinks complete immediately
629 retval = usb_unlink_urb (urb);
630 if (retval != -EINPROGRESS && retval != 0)
631 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
632 else
633 count++;
634 usb_put_urb(urb);
635 spin_lock_irqsave(&q->lock, flags);
636 }
637 spin_unlock_irqrestore (&q->lock, flags);
638 return count;
639}
640
641// Flush all pending rx urbs
642// minidrivers may need to do this when the MTU changes
643
644void usbnet_unlink_rx_urbs(struct usbnet *dev)
645{
646 if (netif_running(dev->net)) {
647 (void) unlink_urbs (dev, &dev->rxq);
648 tasklet_schedule(&dev->bh);
649 }
650}
651EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
652
653/*-------------------------------------------------------------------------*/
654
655// precondition: never called in_interrupt
656static void usbnet_terminate_urbs(struct usbnet *dev)
657{
658 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
659 DECLARE_WAITQUEUE(wait, current);
660 int temp;
661
662 /* ensure there are no more active urbs */
663 add_wait_queue(&unlink_wakeup, &wait);
664 set_current_state(TASK_UNINTERRUPTIBLE);
665 dev->wait = &unlink_wakeup;
666 temp = unlink_urbs(dev, &dev->txq) +
667 unlink_urbs(dev, &dev->rxq);
668
669 /* maybe wait for deletions to finish. */
670 while (!skb_queue_empty(&dev->rxq)
671 && !skb_queue_empty(&dev->txq)
672 && !skb_queue_empty(&dev->done)) {
673 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
674 set_current_state(TASK_UNINTERRUPTIBLE);
675 netif_dbg(dev, ifdown, dev->net,
676 "waited for %d urb completions\n", temp);
677 }
678 set_current_state(TASK_RUNNING);
679 dev->wait = NULL;
680 remove_wait_queue(&unlink_wakeup, &wait);
681}
682
683int usbnet_stop (struct net_device *net)
684{
685 struct usbnet *dev = netdev_priv(net);
686 struct driver_info *info = dev->driver_info;
687 int retval;
688
689 clear_bit(EVENT_DEV_OPEN, &dev->flags);
690 netif_stop_queue (net);
691
692 netif_info(dev, ifdown, dev->net,
693 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
694 net->stats.rx_packets, net->stats.tx_packets,
695 net->stats.rx_errors, net->stats.tx_errors);
696
697 /* allow minidriver to stop correctly (wireless devices to turn off
698 * radio etc) */
699 if (info->stop) {
700 retval = info->stop(dev);
701 if (retval < 0)
702 netif_info(dev, ifdown, dev->net,
703 "stop fail (%d) usbnet usb-%s-%s, %s\n",
704 retval,
705 dev->udev->bus->bus_name, dev->udev->devpath,
706 info->description);
707 }
708
709 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
710 usbnet_terminate_urbs(dev);
711
712 usb_kill_urb(dev->interrupt);
713
714 usbnet_purge_paused_rxq(dev);
715
716 /* deferred work (task, timer, softirq) must also stop.
717 * can't flush_scheduled_work() until we drop rtnl (later),
718 * else workers could deadlock; so make workers a NOP.
719 */
720 dev->flags = 0;
721 del_timer_sync (&dev->delay);
722 tasklet_kill (&dev->bh);
723 if (info->manage_power)
724 info->manage_power(dev, 0);
725 else
726 usb_autopm_put_interface(dev->intf);
727
728 return 0;
729}
730EXPORT_SYMBOL_GPL(usbnet_stop);
731
732/*-------------------------------------------------------------------------*/
733
734// posts reads, and enables write queuing
735
736// precondition: never called in_interrupt
737
738int usbnet_open (struct net_device *net)
739{
740 struct usbnet *dev = netdev_priv(net);
741 int retval;
742 struct driver_info *info = dev->driver_info;
743
744 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
745 netif_info(dev, ifup, dev->net,
746 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
747 retval,
748 dev->udev->bus->bus_name,
749 dev->udev->devpath,
750 info->description);
751 goto done_nopm;
752 }
753
754 // put into "known safe" state
755 if (info->reset && (retval = info->reset (dev)) < 0) {
756 netif_info(dev, ifup, dev->net,
757 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
758 retval,
759 dev->udev->bus->bus_name,
760 dev->udev->devpath,
761 info->description);
762 goto done;
763 }
764
765 // insist peer be connected
766 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
767 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
768 goto done;
769 }
770
771 /* start any status interrupt transfer */
772 if (dev->interrupt) {
773 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
774 if (retval < 0) {
775 netif_err(dev, ifup, dev->net,
776 "intr submit %d\n", retval);
777 goto done;
778 }
779 }
780
781 set_bit(EVENT_DEV_OPEN, &dev->flags);
782 netif_start_queue (net);
783 netif_info(dev, ifup, dev->net,
784 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
785 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
786 dev->net->mtu,
787 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
788 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
789 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
790 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
791 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
792 "simple");
793
794 // delay posting reads until we're fully open
795 tasklet_schedule (&dev->bh);
796 if (info->manage_power) {
797 retval = info->manage_power(dev, 1);
798 if (retval < 0)
799 goto done_manage_power_error;
800 usb_autopm_put_interface(dev->intf);
801 }
802 return retval;
803
804done_manage_power_error:
805 clear_bit(EVENT_DEV_OPEN, &dev->flags);
806done:
807 usb_autopm_put_interface(dev->intf);
808done_nopm:
809 return retval;
810}
811EXPORT_SYMBOL_GPL(usbnet_open);
812
813/*-------------------------------------------------------------------------*/
814
815/* ethtool methods; minidrivers may need to add some more, but
816 * they'll probably want to use this base set.
817 */
818
819int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
820{
821 struct usbnet *dev = netdev_priv(net);
822
823 if (!dev->mii.mdio_read)
824 return -EOPNOTSUPP;
825
826 return mii_ethtool_gset(&dev->mii, cmd);
827}
828EXPORT_SYMBOL_GPL(usbnet_get_settings);
829
830int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
831{
832 struct usbnet *dev = netdev_priv(net);
833 int retval;
834
835 if (!dev->mii.mdio_write)
836 return -EOPNOTSUPP;
837
838 retval = mii_ethtool_sset(&dev->mii, cmd);
839
840 /* link speed/duplex might have changed */
841 if (dev->driver_info->link_reset)
842 dev->driver_info->link_reset(dev);
843
844 return retval;
845
846}
847EXPORT_SYMBOL_GPL(usbnet_set_settings);
848
849u32 usbnet_get_link (struct net_device *net)
850{
851 struct usbnet *dev = netdev_priv(net);
852
853 /* If a check_connect is defined, return its result */
854 if (dev->driver_info->check_connect)
855 return dev->driver_info->check_connect (dev) == 0;
856
857 /* if the device has mii operations, use those */
858 if (dev->mii.mdio_read)
859 return mii_link_ok(&dev->mii);
860
861 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
862 return ethtool_op_get_link(net);
863}
864EXPORT_SYMBOL_GPL(usbnet_get_link);
865
866int usbnet_nway_reset(struct net_device *net)
867{
868 struct usbnet *dev = netdev_priv(net);
869
870 if (!dev->mii.mdio_write)
871 return -EOPNOTSUPP;
872
873 return mii_nway_restart(&dev->mii);
874}
875EXPORT_SYMBOL_GPL(usbnet_nway_reset);
876
877void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
878{
879 struct usbnet *dev = netdev_priv(net);
880
881 strlcpy (info->driver, dev->driver_name, sizeof info->driver);
882 strlcpy (info->version, DRIVER_VERSION, sizeof info->version);
883 strlcpy (info->fw_version, dev->driver_info->description,
884 sizeof info->fw_version);
885 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
886}
887EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
888
889u32 usbnet_get_msglevel (struct net_device *net)
890{
891 struct usbnet *dev = netdev_priv(net);
892
893 return dev->msg_enable;
894}
895EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
896
897void usbnet_set_msglevel (struct net_device *net, u32 level)
898{
899 struct usbnet *dev = netdev_priv(net);
900
901 dev->msg_enable = level;
902}
903EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
904
905/* drivers may override default ethtool_ops in their bind() routine */
906static const struct ethtool_ops usbnet_ethtool_ops = {
907 .get_settings = usbnet_get_settings,
908 .set_settings = usbnet_set_settings,
909 .get_link = usbnet_get_link,
910 .nway_reset = usbnet_nway_reset,
911 .get_drvinfo = usbnet_get_drvinfo,
912 .get_msglevel = usbnet_get_msglevel,
913 .set_msglevel = usbnet_set_msglevel,
914 .get_ts_info = ethtool_op_get_ts_info,
915};
916
917/*-------------------------------------------------------------------------*/
918
919/* work that cannot be done in interrupt context uses keventd.
920 *
921 * NOTE: with 2.5 we could do more of this using completion callbacks,
922 * especially now that control transfers can be queued.
923 */
924static void
925kevent (struct work_struct *work)
926{
927 struct usbnet *dev =
928 container_of(work, struct usbnet, kevent);
929 int status;
930
931 /* usb_clear_halt() needs a thread context */
932 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
933 unlink_urbs (dev, &dev->txq);
934 status = usb_autopm_get_interface(dev->intf);
935 if (status < 0)
936 goto fail_pipe;
937 status = usb_clear_halt (dev->udev, dev->out);
938 usb_autopm_put_interface(dev->intf);
939 if (status < 0 &&
940 status != -EPIPE &&
941 status != -ESHUTDOWN) {
942 if (netif_msg_tx_err (dev))
943fail_pipe:
944 netdev_err(dev->net, "can't clear tx halt, status %d\n",
945 status);
946 } else {
947 clear_bit (EVENT_TX_HALT, &dev->flags);
948 if (status != -ESHUTDOWN)
949 netif_wake_queue (dev->net);
950 }
951 }
952 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
953 unlink_urbs (dev, &dev->rxq);
954 status = usb_autopm_get_interface(dev->intf);
955 if (status < 0)
956 goto fail_halt;
957 status = usb_clear_halt (dev->udev, dev->in);
958 usb_autopm_put_interface(dev->intf);
959 if (status < 0 &&
960 status != -EPIPE &&
961 status != -ESHUTDOWN) {
962 if (netif_msg_rx_err (dev))
963fail_halt:
964 netdev_err(dev->net, "can't clear rx halt, status %d\n",
965 status);
966 } else {
967 clear_bit (EVENT_RX_HALT, &dev->flags);
968 tasklet_schedule (&dev->bh);
969 }
970 }
971
972 /* tasklet could resubmit itself forever if memory is tight */
973 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
974 struct urb *urb = NULL;
975 int resched = 1;
976
977 if (netif_running (dev->net))
978 urb = usb_alloc_urb (0, GFP_KERNEL);
979 else
980 clear_bit (EVENT_RX_MEMORY, &dev->flags);
981 if (urb != NULL) {
982 clear_bit (EVENT_RX_MEMORY, &dev->flags);
983 status = usb_autopm_get_interface(dev->intf);
984 if (status < 0) {
985 usb_free_urb(urb);
986 goto fail_lowmem;
987 }
988 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
989 resched = 0;
990 usb_autopm_put_interface(dev->intf);
991fail_lowmem:
992 if (resched)
993 tasklet_schedule (&dev->bh);
994 }
995 }
996
997 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
998 struct driver_info *info = dev->driver_info;
999 int retval = 0;
1000
1001 clear_bit (EVENT_LINK_RESET, &dev->flags);
1002 status = usb_autopm_get_interface(dev->intf);
1003 if (status < 0)
1004 goto skip_reset;
1005 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
1006 usb_autopm_put_interface(dev->intf);
1007skip_reset:
1008 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1009 retval,
1010 dev->udev->bus->bus_name,
1011 dev->udev->devpath,
1012 info->description);
1013 } else {
1014 usb_autopm_put_interface(dev->intf);
1015 }
1016 }
1017
1018 if (dev->flags)
1019 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1020}
1021
1022/*-------------------------------------------------------------------------*/
1023
1024static void tx_complete (struct urb *urb)
1025{
1026 struct sk_buff *skb = (struct sk_buff *) urb->context;
1027 struct skb_data *entry = (struct skb_data *) skb->cb;
1028 struct usbnet *dev = entry->dev;
1029
1030 if (urb->status == 0) {
1031 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1032 dev->net->stats.tx_packets++;
1033 dev->net->stats.tx_bytes += entry->length;
1034 } else {
1035 dev->net->stats.tx_errors++;
1036
1037 switch (urb->status) {
1038 case -EPIPE:
1039 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1040 break;
1041
1042 /* software-driven interface shutdown */
1043 case -ECONNRESET: // async unlink
1044 case -ESHUTDOWN: // hardware gone
1045 break;
1046
1047 // like rx, tx gets controller i/o faults during khubd delays
1048 // and so it uses the same throttling mechanism.
1049 case -EPROTO:
1050 case -ETIME:
1051 case -EILSEQ:
1052 usb_mark_last_busy(dev->udev);
1053 if (!timer_pending (&dev->delay)) {
1054 mod_timer (&dev->delay,
1055 jiffies + THROTTLE_JIFFIES);
1056 netif_dbg(dev, link, dev->net,
1057 "tx throttle %d\n", urb->status);
1058 }
1059 netif_stop_queue (dev->net);
1060 break;
1061 default:
1062 netif_dbg(dev, tx_err, dev->net,
1063 "tx err %d\n", entry->urb->status);
1064 break;
1065 }
1066 }
1067
1068 usb_autopm_put_interface_async(dev->intf);
1069 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1070}
1071
1072/*-------------------------------------------------------------------------*/
1073
1074void usbnet_tx_timeout (struct net_device *net)
1075{
1076 struct usbnet *dev = netdev_priv(net);
1077
1078 unlink_urbs (dev, &dev->txq);
1079 tasklet_schedule (&dev->bh);
1080
1081 // FIXME: device recovery -- reset?
1082}
1083EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1084
1085/*-------------------------------------------------------------------------*/
1086
1087netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1088 struct net_device *net)
1089{
1090 struct usbnet *dev = netdev_priv(net);
1091 int length;
1092 struct urb *urb = NULL;
1093 struct skb_data *entry;
1094 struct driver_info *info = dev->driver_info;
1095 unsigned long flags;
1096 int retval;
1097
1098 if (skb)
1099 skb_tx_timestamp(skb);
1100
1101 // some devices want funky USB-level framing, for
1102 // win32 driver (usually) and/or hardware quirks
1103 if (info->tx_fixup) {
1104 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1105 if (!skb) {
1106 if (netif_msg_tx_err(dev)) {
1107 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1108 goto drop;
1109 } else {
1110 /* cdc_ncm collected packet; waits for more */
1111 goto not_drop;
1112 }
1113 }
1114 }
1115 length = skb->len;
1116
1117 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1118 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1119 goto drop;
1120 }
1121
1122 entry = (struct skb_data *) skb->cb;
1123 entry->urb = urb;
1124 entry->dev = dev;
1125 entry->length = length;
1126
1127 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1128 skb->data, skb->len, tx_complete, skb);
1129
1130 /* don't assume the hardware handles USB_ZERO_PACKET
1131 * NOTE: strictly conforming cdc-ether devices should expect
1132 * the ZLP here, but ignore the one-byte packet.
1133 * NOTE2: CDC NCM specification is different from CDC ECM when
1134 * handling ZLP/short packets, so cdc_ncm driver will make short
1135 * packet itself if needed.
1136 */
1137 if (length % dev->maxpacket == 0) {
1138 if (!(info->flags & FLAG_SEND_ZLP)) {
1139 if (!(info->flags & FLAG_MULTI_PACKET)) {
1140 urb->transfer_buffer_length++;
1141 if (skb_tailroom(skb)) {
1142 skb->data[skb->len] = 0;
1143 __skb_put(skb, 1);
1144 }
1145 }
1146 } else
1147 urb->transfer_flags |= URB_ZERO_PACKET;
1148 }
1149
1150 spin_lock_irqsave(&dev->txq.lock, flags);
1151 retval = usb_autopm_get_interface_async(dev->intf);
1152 if (retval < 0) {
1153 spin_unlock_irqrestore(&dev->txq.lock, flags);
1154 goto drop;
1155 }
1156
1157#ifdef CONFIG_PM
1158 /* if this triggers the device is still a sleep */
1159 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1160 /* transmission will be done in resume */
1161 usb_anchor_urb(urb, &dev->deferred);
1162 /* no use to process more packets */
1163 netif_stop_queue(net);
1164 spin_unlock_irqrestore(&dev->txq.lock, flags);
1165 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1166 goto deferred;
1167 }
1168#endif
1169
1170 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1171 case -EPIPE:
1172 netif_stop_queue (net);
1173 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1174 usb_autopm_put_interface_async(dev->intf);
1175 break;
1176 default:
1177 usb_autopm_put_interface_async(dev->intf);
1178 netif_dbg(dev, tx_err, dev->net,
1179 "tx: submit urb err %d\n", retval);
1180 break;
1181 case 0:
1182 net->trans_start = jiffies;
1183 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1184 if (dev->txq.qlen >= TX_QLEN (dev))
1185 netif_stop_queue (net);
1186 }
1187 spin_unlock_irqrestore (&dev->txq.lock, flags);
1188
1189 if (retval) {
1190 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1191drop:
1192 dev->net->stats.tx_dropped++;
1193not_drop:
1194 if (skb)
1195 dev_kfree_skb_any (skb);
1196 usb_free_urb (urb);
1197 } else
1198 netif_dbg(dev, tx_queued, dev->net,
1199 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1200#ifdef CONFIG_PM
1201deferred:
1202#endif
1203 return NETDEV_TX_OK;
1204}
1205EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1206
1207static int rx_alloc_submit(struct usbnet *dev, gfp_t flags)
1208{
1209 struct urb *urb;
1210 int i;
1211 int ret = 0;
1212
1213 /* don't refill the queue all at once */
1214 for (i = 0; i < 10 && dev->rxq.qlen < RX_QLEN(dev); i++) {
1215 urb = usb_alloc_urb(0, flags);
1216 if (urb != NULL) {
1217 ret = rx_submit(dev, urb, flags);
1218 if (ret)
1219 goto err;
1220 } else {
1221 ret = -ENOMEM;
1222 goto err;
1223 }
1224 }
1225err:
1226 return ret;
1227}
1228
1229/*-------------------------------------------------------------------------*/
1230
1231// tasklet (work deferred from completions, in_irq) or timer
1232
1233static void usbnet_bh (unsigned long param)
1234{
1235 struct usbnet *dev = (struct usbnet *) param;
1236 struct sk_buff *skb;
1237 struct skb_data *entry;
1238
1239 while ((skb = skb_dequeue (&dev->done))) {
1240 entry = (struct skb_data *) skb->cb;
1241 switch (entry->state) {
1242 case rx_done:
1243 entry->state = rx_cleanup;
1244 rx_process (dev, skb);
1245 continue;
1246 case tx_done:
1247 case rx_cleanup:
1248 usb_free_urb (entry->urb);
1249 dev_kfree_skb (skb);
1250 continue;
1251 default:
1252 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1253 }
1254 }
1255
1256 // waiting for all pending urbs to complete?
1257 if (dev->wait) {
1258 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1259 wake_up (dev->wait);
1260 }
1261
1262 // or are we maybe short a few urbs?
1263 } else if (netif_running (dev->net) &&
1264 netif_device_present (dev->net) &&
1265 !timer_pending (&dev->delay) &&
1266 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1267 int temp = dev->rxq.qlen;
1268
1269 if (temp < RX_QLEN(dev)) {
1270 if (rx_alloc_submit(dev, GFP_ATOMIC) == -ENOLINK)
1271 return;
1272 if (temp != dev->rxq.qlen)
1273 netif_dbg(dev, link, dev->net,
1274 "rxqlen %d --> %d\n",
1275 temp, dev->rxq.qlen);
1276 if (dev->rxq.qlen < RX_QLEN(dev))
1277 tasklet_schedule (&dev->bh);
1278 }
1279 if (dev->txq.qlen < TX_QLEN (dev))
1280 netif_wake_queue (dev->net);
1281 }
1282}
1283
1284
1285/*-------------------------------------------------------------------------
1286 *
1287 * USB Device Driver support
1288 *
1289 *-------------------------------------------------------------------------*/
1290
1291// precondition: never called in_interrupt
1292
1293void usbnet_disconnect (struct usb_interface *intf)
1294{
1295 struct usbnet *dev;
1296 struct usb_device *xdev;
1297 struct net_device *net;
1298
1299 dev = usb_get_intfdata(intf);
1300 usb_set_intfdata(intf, NULL);
1301 if (!dev)
1302 return;
1303
1304 xdev = interface_to_usbdev (intf);
1305
1306 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1307 intf->dev.driver->name,
1308 xdev->bus->bus_name, xdev->devpath,
1309 dev->driver_info->description);
1310
1311 net = dev->net;
1312 unregister_netdev (net);
1313
1314 cancel_work_sync(&dev->kevent);
1315
1316 if (dev->driver_info->unbind)
1317 dev->driver_info->unbind (dev, intf);
1318
1319 usb_kill_urb(dev->interrupt);
1320 usb_free_urb(dev->interrupt);
1321
1322 free_netdev(net);
1323 usb_put_dev (xdev);
1324}
1325EXPORT_SYMBOL_GPL(usbnet_disconnect);
1326
1327static const struct net_device_ops usbnet_netdev_ops = {
1328 .ndo_open = usbnet_open,
1329 .ndo_stop = usbnet_stop,
1330 .ndo_start_xmit = usbnet_start_xmit,
1331 .ndo_tx_timeout = usbnet_tx_timeout,
1332 .ndo_change_mtu = usbnet_change_mtu,
1333 .ndo_set_mac_address = eth_mac_addr,
1334 .ndo_validate_addr = eth_validate_addr,
1335};
1336
1337/*-------------------------------------------------------------------------*/
1338
1339// precondition: never called in_interrupt
1340
1341static struct device_type wlan_type = {
1342 .name = "wlan",
1343};
1344
1345static struct device_type wwan_type = {
1346 .name = "wwan",
1347};
1348
1349int
1350usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1351{
1352 struct usbnet *dev;
1353 struct net_device *net;
1354 struct usb_host_interface *interface;
1355 struct driver_info *info;
1356 struct usb_device *xdev;
1357 int status;
1358 const char *name;
1359 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1360
1361 /* usbnet already took usb runtime pm, so have to enable the feature
1362 * for usb interface, otherwise usb_autopm_get_interface may return
1363 * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1364 */
1365 if (!driver->supports_autosuspend) {
1366 driver->supports_autosuspend = 1;
1367 pm_runtime_enable(&udev->dev);
1368 }
1369
1370 name = udev->dev.driver->name;
1371 info = (struct driver_info *) prod->driver_info;
1372 if (!info) {
1373 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1374 return -ENODEV;
1375 }
1376 xdev = interface_to_usbdev (udev);
1377 interface = udev->cur_altsetting;
1378
1379 usb_get_dev (xdev);
1380
1381 status = -ENOMEM;
1382
1383 // set up our own records
1384 net = alloc_etherdev(sizeof(*dev));
1385 if (!net)
1386 goto out;
1387
1388 /* netdev_printk() needs this so do it as early as possible */
1389 SET_NETDEV_DEV(net, &udev->dev);
1390
1391 dev = netdev_priv(net);
1392 dev->udev = xdev;
1393 dev->intf = udev;
1394 dev->driver_info = info;
1395 dev->driver_name = name;
1396 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1397 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1398 skb_queue_head_init (&dev->rxq);
1399 skb_queue_head_init (&dev->txq);
1400 skb_queue_head_init (&dev->done);
1401 skb_queue_head_init(&dev->rxq_pause);
1402 dev->bh.func = usbnet_bh;
1403 dev->bh.data = (unsigned long) dev;
1404 INIT_WORK (&dev->kevent, kevent);
1405 init_usb_anchor(&dev->deferred);
1406 dev->delay.function = usbnet_bh;
1407 dev->delay.data = (unsigned long) dev;
1408 init_timer (&dev->delay);
1409 mutex_init (&dev->phy_mutex);
1410
1411 dev->net = net;
1412 strcpy (net->name, "usb%d");
1413 memcpy (net->dev_addr, node_id, sizeof node_id);
1414
1415 /* rx and tx sides can use different message sizes;
1416 * bind() should set rx_urb_size in that case.
1417 */
1418 dev->hard_mtu = net->mtu + net->hard_header_len;
1419#if 0
1420// dma_supported() is deeply broken on almost all architectures
1421 // possible with some EHCI controllers
1422 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1423 net->features |= NETIF_F_HIGHDMA;
1424#endif
1425
1426 net->netdev_ops = &usbnet_netdev_ops;
1427 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1428 net->ethtool_ops = &usbnet_ethtool_ops;
1429
1430 // allow device-specific bind/init procedures
1431 // NOTE net->name still not usable ...
1432 if (info->bind) {
1433 status = info->bind (dev, udev);
1434 if (status < 0)
1435 goto out1;
1436
1437 // heuristic: "usb%d" for links we know are two-host,
1438 // else "eth%d" when there's reasonable doubt. userspace
1439 // can rename the link if it knows better.
1440 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1441 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1442 (net->dev_addr [0] & 0x02) == 0))
1443 strcpy (net->name, "eth%d");
1444 /* WLAN devices should always be named "wlan%d" */
1445 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1446 strcpy(net->name, "wlan%d");
1447 /* WWAN devices should always be named "wwan%d" */
1448 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1449 strcpy(net->name, "wwan%d");
1450
1451 /* maybe the remote can't receive an Ethernet MTU */
1452 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1453 net->mtu = dev->hard_mtu - net->hard_header_len;
1454 } else if (!info->in || !info->out)
1455 status = usbnet_get_endpoints (dev, udev);
1456 else {
1457 dev->in = usb_rcvbulkpipe (xdev, info->in);
1458 dev->out = usb_sndbulkpipe (xdev, info->out);
1459 if (!(info->flags & FLAG_NO_SETINT))
1460 status = usb_set_interface (xdev,
1461 interface->desc.bInterfaceNumber,
1462 interface->desc.bAlternateSetting);
1463 else
1464 status = 0;
1465
1466 }
1467 if (status >= 0 && dev->status)
1468 status = init_status (dev, udev);
1469 if (status < 0)
1470 goto out3;
1471
1472 if (!dev->rx_urb_size)
1473 dev->rx_urb_size = dev->hard_mtu;
1474 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1475
1476 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1477 SET_NETDEV_DEVTYPE(net, &wlan_type);
1478 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1479 SET_NETDEV_DEVTYPE(net, &wwan_type);
1480
1481 status = register_netdev (net);
1482 if (status)
1483 goto out4;
1484 netif_info(dev, probe, dev->net,
1485 "register '%s' at usb-%s-%s, %s, %pM\n",
1486 udev->dev.driver->name,
1487 xdev->bus->bus_name, xdev->devpath,
1488 dev->driver_info->description,
1489 net->dev_addr);
1490
1491 // ok, it's ready to go.
1492 usb_set_intfdata (udev, dev);
1493
1494 netif_device_attach (net);
1495
1496 if (dev->driver_info->flags & FLAG_LINK_INTR)
1497 netif_carrier_off(net);
1498
1499 return 0;
1500
1501out4:
1502 usb_free_urb(dev->interrupt);
1503out3:
1504 if (info->unbind)
1505 info->unbind (dev, udev);
1506out1:
1507 free_netdev(net);
1508out:
1509 usb_put_dev(xdev);
1510 return status;
1511}
1512EXPORT_SYMBOL_GPL(usbnet_probe);
1513
1514/*-------------------------------------------------------------------------*/
1515
1516/*
1517 * suspend the whole driver as soon as the first interface is suspended
1518 * resume only when the last interface is resumed
1519 */
1520
1521int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1522{
1523 struct usbnet *dev = usb_get_intfdata(intf);
1524
1525 if (!dev->suspend_count++) {
1526 spin_lock_irq(&dev->txq.lock);
1527 /* don't autosuspend while transmitting */
1528 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1529 dev->suspend_count--;
1530 spin_unlock_irq(&dev->txq.lock);
1531 return -EBUSY;
1532 } else {
1533 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1534 spin_unlock_irq(&dev->txq.lock);
1535 }
1536 /*
1537 * accelerate emptying of the rx and queues, to avoid
1538 * having everything error out.
1539 */
1540 netif_device_detach (dev->net);
1541 usbnet_terminate_urbs(dev);
1542 usb_kill_urb(dev->interrupt);
1543
1544 /*
1545 * reattach so runtime management can use and
1546 * wake the device
1547 */
1548 netif_device_attach (dev->net);
1549 }
1550 return 0;
1551}
1552EXPORT_SYMBOL_GPL(usbnet_suspend);
1553
1554int usbnet_resume (struct usb_interface *intf)
1555{
1556 struct usbnet *dev = usb_get_intfdata(intf);
1557 struct sk_buff *skb;
1558 struct urb *res;
1559 int retval;
1560
1561 if (!--dev->suspend_count) {
1562 /* resume interrupt URBs */
1563 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1564 usb_submit_urb(dev->interrupt, GFP_NOIO);
1565
1566 spin_lock_irq(&dev->txq.lock);
1567 while ((res = usb_get_from_anchor(&dev->deferred))) {
1568
1569 skb = (struct sk_buff *)res->context;
1570 retval = usb_submit_urb(res, GFP_ATOMIC);
1571 if (retval < 0) {
1572 dev_kfree_skb_any(skb);
1573 usb_free_urb(res);
1574 usb_autopm_put_interface_async(dev->intf);
1575 } else {
1576 dev->net->trans_start = jiffies;
1577 __skb_queue_tail(&dev->txq, skb);
1578 }
1579 }
1580
1581 smp_mb();
1582 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1583 spin_unlock_irq(&dev->txq.lock);
1584
1585 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1586 /* handle remote wakeup ASAP */
1587 if (!dev->wait &&
1588 netif_device_present(dev->net) &&
1589 !timer_pending(&dev->delay) &&
1590 !test_bit(EVENT_RX_HALT, &dev->flags))
1591 rx_alloc_submit(dev, GFP_NOIO);
1592
1593 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1594 netif_tx_wake_all_queues(dev->net);
1595 tasklet_schedule (&dev->bh);
1596 }
1597 }
1598 return 0;
1599}
1600EXPORT_SYMBOL_GPL(usbnet_resume);
1601
1602
1603/*-------------------------------------------------------------------------*/
1604
1605static int __init usbnet_init(void)
1606{
1607 /* Compiler should optimize this out. */
1608 BUILD_BUG_ON(
1609 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1610
1611 random_ether_addr(node_id);
1612 return 0;
1613}
1614module_init(usbnet_init);
1615
1616static void __exit usbnet_exit(void)
1617{
1618}
1619module_exit(usbnet_exit);
1620
1621MODULE_AUTHOR("David Brownell");
1622MODULE_DESCRIPTION("USB network driver framework");
1623MODULE_LICENSE("GPL");