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
85 static u8 node_id [ETH_ALEN];
86
87 static const char driver_name [] = "usbnet";
88
89 /* use ethtool to change the level for any given device */
90 static int msg_level = -1;
91 module_param (msg_level, int, 0);
92 MODULE_PARM_DESC (msg_level, "Override default message level");
93
94 /*-------------------------------------------------------------------------*/
95
96 /* handles CDC Ethernet and many other network "bulk data" interfaces */
usbnet_get_endpoints(struct usbnet * dev,struct usb_interface * intf)97 int 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 }
161 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
162
usbnet_get_ethernet_addr(struct usbnet * dev,int iMACAddress)163 int 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 }
181 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
182
183 static void intr_complete (struct urb *urb);
184
init_status(struct usbnet * dev,struct usb_interface * intf)185 static 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 */
usbnet_skb_return(struct usbnet * dev,struct sk_buff * skb)226 void 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 }
251 EXPORT_SYMBOL_GPL(usbnet_skb_return);
252
253
254 /*-------------------------------------------------------------------------
255 *
256 * Network Device Driver (peer link to "Host Device", from USB host)
257 *
258 *-------------------------------------------------------------------------*/
259
usbnet_change_mtu(struct net_device * net,int new_mtu)260 int 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 }
283 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
284
285 /* The caller must hold list->lock */
__usbnet_queue_skb(struct sk_buff_head * list,struct sk_buff * newsk,enum skb_state state)286 static 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
defer_bh(struct usbnet * dev,struct sk_buff * skb,struct sk_buff_head * list,enum skb_state state)301 static 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 */
usbnet_defer_kevent(struct usbnet * dev,int work)326 void 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 }
334 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
335
336 /*-------------------------------------------------------------------------*/
337
338 static void rx_complete (struct urb *urb);
339
rx_submit(struct usbnet * dev,struct urb * urb,gfp_t flags)340 static 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
rx_process(struct usbnet * dev,struct sk_buff * skb)407 static 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 /* all data was already cloned from skb inside the driver */
419 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
420 goto done;
421
422 if (skb->len < ETH_HLEN) {
423 dev->net->stats.rx_errors++;
424 dev->net->stats.rx_length_errors++;
425 netif_dbg(dev, rx_err, dev->net, "rx length %d\n", skb->len);
426 } else {
427 usbnet_skb_return(dev, skb);
428 return;
429 }
430
431 done:
432 skb_queue_tail(&dev->done, skb);
433 }
434
435 /*-------------------------------------------------------------------------*/
436
rx_complete(struct urb * urb)437 static void rx_complete (struct urb *urb)
438 {
439 struct sk_buff *skb = (struct sk_buff *) urb->context;
440 struct skb_data *entry = (struct skb_data *) skb->cb;
441 struct usbnet *dev = entry->dev;
442 int urb_status = urb->status;
443 enum skb_state state;
444
445 skb_put (skb, urb->actual_length);
446 state = rx_done;
447 entry->urb = NULL;
448
449 switch (urb_status) {
450 /* success */
451 case 0:
452 break;
453
454 /* stalls need manual reset. this is rare ... except that
455 * when going through USB 2.0 TTs, unplug appears this way.
456 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
457 * storm, recovering as needed.
458 */
459 case -EPIPE:
460 dev->net->stats.rx_errors++;
461 usbnet_defer_kevent (dev, EVENT_RX_HALT);
462 // FALLTHROUGH
463
464 /* software-driven interface shutdown */
465 case -ECONNRESET: /* async unlink */
466 case -ESHUTDOWN: /* hardware gone */
467 netif_dbg(dev, ifdown, dev->net,
468 "rx shutdown, code %d\n", urb_status);
469 goto block;
470
471 /* we get controller i/o faults during khubd disconnect() delays.
472 * throttle down resubmits, to avoid log floods; just temporarily,
473 * so we still recover when the fault isn't a khubd delay.
474 */
475 case -EPROTO:
476 case -ETIME:
477 case -EILSEQ:
478 dev->net->stats.rx_errors++;
479 if (!timer_pending (&dev->delay)) {
480 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
481 netif_dbg(dev, link, dev->net,
482 "rx throttle %d\n", urb_status);
483 }
484 block:
485 state = rx_cleanup;
486 entry->urb = urb;
487 urb = NULL;
488 break;
489
490 /* data overrun ... flush fifo? */
491 case -EOVERFLOW:
492 dev->net->stats.rx_over_errors++;
493 // FALLTHROUGH
494
495 default:
496 state = rx_cleanup;
497 dev->net->stats.rx_errors++;
498 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
499 break;
500 }
501
502 state = defer_bh(dev, skb, &dev->rxq, state);
503
504 if (urb) {
505 if (netif_running (dev->net) &&
506 !test_bit (EVENT_RX_HALT, &dev->flags) &&
507 state != unlink_start) {
508 rx_submit (dev, urb, GFP_ATOMIC);
509 usb_mark_last_busy(dev->udev);
510 return;
511 }
512 usb_free_urb (urb);
513 }
514 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
515 }
516
intr_complete(struct urb * urb)517 static void intr_complete (struct urb *urb)
518 {
519 struct usbnet *dev = urb->context;
520 int status = urb->status;
521
522 switch (status) {
523 /* success */
524 case 0:
525 dev->driver_info->status(dev, urb);
526 break;
527
528 /* software-driven interface shutdown */
529 case -ENOENT: /* urb killed */
530 case -ESHUTDOWN: /* hardware gone */
531 netif_dbg(dev, ifdown, dev->net,
532 "intr shutdown, code %d\n", status);
533 return;
534
535 /* NOTE: not throttling like RX/TX, since this endpoint
536 * already polls infrequently
537 */
538 default:
539 netdev_dbg(dev->net, "intr status %d\n", status);
540 break;
541 }
542
543 if (!netif_running (dev->net))
544 return;
545
546 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
547 status = usb_submit_urb (urb, GFP_ATOMIC);
548 if (status != 0)
549 netif_err(dev, timer, dev->net,
550 "intr resubmit --> %d\n", status);
551 }
552
553 /*-------------------------------------------------------------------------*/
usbnet_pause_rx(struct usbnet * dev)554 void usbnet_pause_rx(struct usbnet *dev)
555 {
556 set_bit(EVENT_RX_PAUSED, &dev->flags);
557
558 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
559 }
560 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
561
usbnet_resume_rx(struct usbnet * dev)562 void usbnet_resume_rx(struct usbnet *dev)
563 {
564 struct sk_buff *skb;
565 int num = 0;
566
567 clear_bit(EVENT_RX_PAUSED, &dev->flags);
568
569 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
570 usbnet_skb_return(dev, skb);
571 num++;
572 }
573
574 tasklet_schedule(&dev->bh);
575
576 netif_dbg(dev, rx_status, dev->net,
577 "paused rx queue disabled, %d skbs requeued\n", num);
578 }
579 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
580
usbnet_purge_paused_rxq(struct usbnet * dev)581 void usbnet_purge_paused_rxq(struct usbnet *dev)
582 {
583 skb_queue_purge(&dev->rxq_pause);
584 }
585 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
586
587 /*-------------------------------------------------------------------------*/
588
589 // unlink pending rx/tx; completion handlers do all other cleanup
590
unlink_urbs(struct usbnet * dev,struct sk_buff_head * q)591 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
592 {
593 unsigned long flags;
594 struct sk_buff *skb;
595 int count = 0;
596
597 spin_lock_irqsave (&q->lock, flags);
598 while (!skb_queue_empty(q)) {
599 struct skb_data *entry;
600 struct urb *urb;
601 int retval;
602
603 skb_queue_walk(q, skb) {
604 entry = (struct skb_data *) skb->cb;
605 if (entry->state != unlink_start)
606 goto found;
607 }
608 break;
609 found:
610 entry->state = unlink_start;
611 urb = entry->urb;
612
613 /*
614 * Get reference count of the URB to avoid it to be
615 * freed during usb_unlink_urb, which may trigger
616 * use-after-free problem inside usb_unlink_urb since
617 * usb_unlink_urb is always racing with .complete
618 * handler(include defer_bh).
619 */
620 usb_get_urb(urb);
621 spin_unlock_irqrestore(&q->lock, flags);
622 // during some PM-driven resume scenarios,
623 // these (async) unlinks complete immediately
624 retval = usb_unlink_urb (urb);
625 if (retval != -EINPROGRESS && retval != 0)
626 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
627 else
628 count++;
629 usb_put_urb(urb);
630 spin_lock_irqsave(&q->lock, flags);
631 }
632 spin_unlock_irqrestore (&q->lock, flags);
633 return count;
634 }
635
636 // Flush all pending rx urbs
637 // minidrivers may need to do this when the MTU changes
638
usbnet_unlink_rx_urbs(struct usbnet * dev)639 void usbnet_unlink_rx_urbs(struct usbnet *dev)
640 {
641 if (netif_running(dev->net)) {
642 (void) unlink_urbs (dev, &dev->rxq);
643 tasklet_schedule(&dev->bh);
644 }
645 }
646 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
647
648 /*-------------------------------------------------------------------------*/
649
650 // precondition: never called in_interrupt
usbnet_terminate_urbs(struct usbnet * dev)651 static void usbnet_terminate_urbs(struct usbnet *dev)
652 {
653 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
654 DECLARE_WAITQUEUE(wait, current);
655 int temp;
656
657 /* ensure there are no more active urbs */
658 add_wait_queue(&unlink_wakeup, &wait);
659 set_current_state(TASK_UNINTERRUPTIBLE);
660 dev->wait = &unlink_wakeup;
661 temp = unlink_urbs(dev, &dev->txq) +
662 unlink_urbs(dev, &dev->rxq);
663
664 /* maybe wait for deletions to finish. */
665 while (!skb_queue_empty(&dev->rxq)
666 && !skb_queue_empty(&dev->txq)
667 && !skb_queue_empty(&dev->done)) {
668 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
669 set_current_state(TASK_UNINTERRUPTIBLE);
670 netif_dbg(dev, ifdown, dev->net,
671 "waited for %d urb completions\n", temp);
672 }
673 set_current_state(TASK_RUNNING);
674 dev->wait = NULL;
675 remove_wait_queue(&unlink_wakeup, &wait);
676 }
677
usbnet_stop(struct net_device * net)678 int usbnet_stop (struct net_device *net)
679 {
680 struct usbnet *dev = netdev_priv(net);
681 struct driver_info *info = dev->driver_info;
682 int retval;
683
684 clear_bit(EVENT_DEV_OPEN, &dev->flags);
685 netif_stop_queue (net);
686
687 netif_info(dev, ifdown, dev->net,
688 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
689 net->stats.rx_packets, net->stats.tx_packets,
690 net->stats.rx_errors, net->stats.tx_errors);
691
692 /* allow minidriver to stop correctly (wireless devices to turn off
693 * radio etc) */
694 if (info->stop) {
695 retval = info->stop(dev);
696 if (retval < 0)
697 netif_info(dev, ifdown, dev->net,
698 "stop fail (%d) usbnet usb-%s-%s, %s\n",
699 retval,
700 dev->udev->bus->bus_name, dev->udev->devpath,
701 info->description);
702 }
703
704 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
705 usbnet_terminate_urbs(dev);
706
707 usb_kill_urb(dev->interrupt);
708
709 usbnet_purge_paused_rxq(dev);
710
711 /* deferred work (task, timer, softirq) must also stop.
712 * can't flush_scheduled_work() until we drop rtnl (later),
713 * else workers could deadlock; so make workers a NOP.
714 */
715 dev->flags = 0;
716 del_timer_sync (&dev->delay);
717 tasklet_kill (&dev->bh);
718 if (info->manage_power)
719 info->manage_power(dev, 0);
720 else
721 usb_autopm_put_interface(dev->intf);
722
723 return 0;
724 }
725 EXPORT_SYMBOL_GPL(usbnet_stop);
726
727 /*-------------------------------------------------------------------------*/
728
729 // posts reads, and enables write queuing
730
731 // precondition: never called in_interrupt
732
usbnet_open(struct net_device * net)733 int usbnet_open (struct net_device *net)
734 {
735 struct usbnet *dev = netdev_priv(net);
736 int retval;
737 struct driver_info *info = dev->driver_info;
738
739 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
740 netif_info(dev, ifup, dev->net,
741 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
742 retval,
743 dev->udev->bus->bus_name,
744 dev->udev->devpath,
745 info->description);
746 goto done_nopm;
747 }
748
749 // put into "known safe" state
750 if (info->reset && (retval = info->reset (dev)) < 0) {
751 netif_info(dev, ifup, dev->net,
752 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
753 retval,
754 dev->udev->bus->bus_name,
755 dev->udev->devpath,
756 info->description);
757 goto done;
758 }
759
760 // insist peer be connected
761 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
762 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
763 goto done;
764 }
765
766 /* start any status interrupt transfer */
767 if (dev->interrupt) {
768 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
769 if (retval < 0) {
770 netif_err(dev, ifup, dev->net,
771 "intr submit %d\n", retval);
772 goto done;
773 }
774 }
775
776 set_bit(EVENT_DEV_OPEN, &dev->flags);
777 netif_start_queue (net);
778 netif_info(dev, ifup, dev->net,
779 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
780 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
781 dev->net->mtu,
782 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
783 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
784 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
785 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
786 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
787 "simple");
788
789 // delay posting reads until we're fully open
790 tasklet_schedule (&dev->bh);
791 if (info->manage_power) {
792 retval = info->manage_power(dev, 1);
793 if (retval < 0)
794 goto done;
795 usb_autopm_put_interface(dev->intf);
796 }
797 return retval;
798
799 done:
800 usb_autopm_put_interface(dev->intf);
801 done_nopm:
802 return retval;
803 }
804 EXPORT_SYMBOL_GPL(usbnet_open);
805
806 /*-------------------------------------------------------------------------*/
807
808 /* ethtool methods; minidrivers may need to add some more, but
809 * they'll probably want to use this base set.
810 */
811
usbnet_get_settings(struct net_device * net,struct ethtool_cmd * cmd)812 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
813 {
814 struct usbnet *dev = netdev_priv(net);
815
816 if (!dev->mii.mdio_read)
817 return -EOPNOTSUPP;
818
819 return mii_ethtool_gset(&dev->mii, cmd);
820 }
821 EXPORT_SYMBOL_GPL(usbnet_get_settings);
822
usbnet_set_settings(struct net_device * net,struct ethtool_cmd * cmd)823 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
824 {
825 struct usbnet *dev = netdev_priv(net);
826 int retval;
827
828 if (!dev->mii.mdio_write)
829 return -EOPNOTSUPP;
830
831 retval = mii_ethtool_sset(&dev->mii, cmd);
832
833 /* link speed/duplex might have changed */
834 if (dev->driver_info->link_reset)
835 dev->driver_info->link_reset(dev);
836
837 return retval;
838
839 }
840 EXPORT_SYMBOL_GPL(usbnet_set_settings);
841
usbnet_get_link(struct net_device * net)842 u32 usbnet_get_link (struct net_device *net)
843 {
844 struct usbnet *dev = netdev_priv(net);
845
846 /* If a check_connect is defined, return its result */
847 if (dev->driver_info->check_connect)
848 return dev->driver_info->check_connect (dev) == 0;
849
850 /* if the device has mii operations, use those */
851 if (dev->mii.mdio_read)
852 return mii_link_ok(&dev->mii);
853
854 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
855 return ethtool_op_get_link(net);
856 }
857 EXPORT_SYMBOL_GPL(usbnet_get_link);
858
usbnet_nway_reset(struct net_device * net)859 int usbnet_nway_reset(struct net_device *net)
860 {
861 struct usbnet *dev = netdev_priv(net);
862
863 if (!dev->mii.mdio_write)
864 return -EOPNOTSUPP;
865
866 return mii_nway_restart(&dev->mii);
867 }
868 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
869
usbnet_get_drvinfo(struct net_device * net,struct ethtool_drvinfo * info)870 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
871 {
872 struct usbnet *dev = netdev_priv(net);
873
874 strncpy (info->driver, dev->driver_name, sizeof info->driver);
875 strncpy (info->version, DRIVER_VERSION, sizeof info->version);
876 strncpy (info->fw_version, dev->driver_info->description,
877 sizeof info->fw_version);
878 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
879 }
880 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
881
usbnet_get_msglevel(struct net_device * net)882 u32 usbnet_get_msglevel (struct net_device *net)
883 {
884 struct usbnet *dev = netdev_priv(net);
885
886 return dev->msg_enable;
887 }
888 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
889
usbnet_set_msglevel(struct net_device * net,u32 level)890 void usbnet_set_msglevel (struct net_device *net, u32 level)
891 {
892 struct usbnet *dev = netdev_priv(net);
893
894 dev->msg_enable = level;
895 }
896 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
897
898 /* drivers may override default ethtool_ops in their bind() routine */
899 static const struct ethtool_ops usbnet_ethtool_ops = {
900 .get_settings = usbnet_get_settings,
901 .set_settings = usbnet_set_settings,
902 .get_link = usbnet_get_link,
903 .nway_reset = usbnet_nway_reset,
904 .get_drvinfo = usbnet_get_drvinfo,
905 .get_msglevel = usbnet_get_msglevel,
906 .set_msglevel = usbnet_set_msglevel,
907 };
908
909 /*-------------------------------------------------------------------------*/
910
911 /* work that cannot be done in interrupt context uses keventd.
912 *
913 * NOTE: with 2.5 we could do more of this using completion callbacks,
914 * especially now that control transfers can be queued.
915 */
916 static void
kevent(struct work_struct * work)917 kevent (struct work_struct *work)
918 {
919 struct usbnet *dev =
920 container_of(work, struct usbnet, kevent);
921 int status;
922
923 /* usb_clear_halt() needs a thread context */
924 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
925 unlink_urbs (dev, &dev->txq);
926 status = usb_autopm_get_interface(dev->intf);
927 if (status < 0)
928 goto fail_pipe;
929 status = usb_clear_halt (dev->udev, dev->out);
930 usb_autopm_put_interface(dev->intf);
931 if (status < 0 &&
932 status != -EPIPE &&
933 status != -ESHUTDOWN) {
934 if (netif_msg_tx_err (dev))
935 fail_pipe:
936 netdev_err(dev->net, "can't clear tx halt, status %d\n",
937 status);
938 } else {
939 clear_bit (EVENT_TX_HALT, &dev->flags);
940 if (status != -ESHUTDOWN)
941 netif_wake_queue (dev->net);
942 }
943 }
944 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
945 unlink_urbs (dev, &dev->rxq);
946 status = usb_autopm_get_interface(dev->intf);
947 if (status < 0)
948 goto fail_halt;
949 status = usb_clear_halt (dev->udev, dev->in);
950 usb_autopm_put_interface(dev->intf);
951 if (status < 0 &&
952 status != -EPIPE &&
953 status != -ESHUTDOWN) {
954 if (netif_msg_rx_err (dev))
955 fail_halt:
956 netdev_err(dev->net, "can't clear rx halt, status %d\n",
957 status);
958 } else {
959 clear_bit (EVENT_RX_HALT, &dev->flags);
960 tasklet_schedule (&dev->bh);
961 }
962 }
963
964 /* tasklet could resubmit itself forever if memory is tight */
965 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
966 struct urb *urb = NULL;
967 int resched = 1;
968
969 if (netif_running (dev->net))
970 urb = usb_alloc_urb (0, GFP_KERNEL);
971 else
972 clear_bit (EVENT_RX_MEMORY, &dev->flags);
973 if (urb != NULL) {
974 clear_bit (EVENT_RX_MEMORY, &dev->flags);
975 status = usb_autopm_get_interface(dev->intf);
976 if (status < 0) {
977 usb_free_urb(urb);
978 goto fail_lowmem;
979 }
980 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
981 resched = 0;
982 usb_autopm_put_interface(dev->intf);
983 fail_lowmem:
984 if (resched)
985 tasklet_schedule (&dev->bh);
986 }
987 }
988
989 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
990 struct driver_info *info = dev->driver_info;
991 int retval = 0;
992
993 clear_bit (EVENT_LINK_RESET, &dev->flags);
994 status = usb_autopm_get_interface(dev->intf);
995 if (status < 0)
996 goto skip_reset;
997 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
998 usb_autopm_put_interface(dev->intf);
999 skip_reset:
1000 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
1001 retval,
1002 dev->udev->bus->bus_name,
1003 dev->udev->devpath,
1004 info->description);
1005 } else {
1006 usb_autopm_put_interface(dev->intf);
1007 }
1008 }
1009
1010 if (dev->flags)
1011 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
1012 }
1013
1014 /*-------------------------------------------------------------------------*/
1015
tx_complete(struct urb * urb)1016 static void tx_complete (struct urb *urb)
1017 {
1018 struct sk_buff *skb = (struct sk_buff *) urb->context;
1019 struct skb_data *entry = (struct skb_data *) skb->cb;
1020 struct usbnet *dev = entry->dev;
1021
1022 if (urb->status == 0) {
1023 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
1024 dev->net->stats.tx_packets++;
1025 dev->net->stats.tx_bytes += entry->length;
1026 } else {
1027 dev->net->stats.tx_errors++;
1028
1029 switch (urb->status) {
1030 case -EPIPE:
1031 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1032 break;
1033
1034 /* software-driven interface shutdown */
1035 case -ECONNRESET: // async unlink
1036 case -ESHUTDOWN: // hardware gone
1037 break;
1038
1039 // like rx, tx gets controller i/o faults during khubd delays
1040 // and so it uses the same throttling mechanism.
1041 case -EPROTO:
1042 case -ETIME:
1043 case -EILSEQ:
1044 usb_mark_last_busy(dev->udev);
1045 if (!timer_pending (&dev->delay)) {
1046 mod_timer (&dev->delay,
1047 jiffies + THROTTLE_JIFFIES);
1048 netif_dbg(dev, link, dev->net,
1049 "tx throttle %d\n", urb->status);
1050 }
1051 netif_stop_queue (dev->net);
1052 break;
1053 default:
1054 netif_dbg(dev, tx_err, dev->net,
1055 "tx err %d\n", entry->urb->status);
1056 break;
1057 }
1058 }
1059
1060 usb_autopm_put_interface_async(dev->intf);
1061 (void) defer_bh(dev, skb, &dev->txq, tx_done);
1062 }
1063
1064 /*-------------------------------------------------------------------------*/
1065
usbnet_tx_timeout(struct net_device * net)1066 void usbnet_tx_timeout (struct net_device *net)
1067 {
1068 struct usbnet *dev = netdev_priv(net);
1069
1070 unlink_urbs (dev, &dev->txq);
1071 tasklet_schedule (&dev->bh);
1072
1073 // FIXME: device recovery -- reset?
1074 }
1075 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1076
1077 /*-------------------------------------------------------------------------*/
1078
usbnet_start_xmit(struct sk_buff * skb,struct net_device * net)1079 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1080 struct net_device *net)
1081 {
1082 struct usbnet *dev = netdev_priv(net);
1083 int length;
1084 struct urb *urb = NULL;
1085 struct skb_data *entry;
1086 struct driver_info *info = dev->driver_info;
1087 unsigned long flags;
1088 int retval;
1089
1090 if (skb)
1091 skb_tx_timestamp(skb);
1092
1093 // some devices want funky USB-level framing, for
1094 // win32 driver (usually) and/or hardware quirks
1095 if (info->tx_fixup) {
1096 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1097 if (!skb) {
1098 if (netif_msg_tx_err(dev)) {
1099 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1100 goto drop;
1101 } else {
1102 /* cdc_ncm collected packet; waits for more */
1103 goto not_drop;
1104 }
1105 }
1106 }
1107 length = skb->len;
1108
1109 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1110 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1111 goto drop;
1112 }
1113
1114 entry = (struct skb_data *) skb->cb;
1115 entry->urb = urb;
1116 entry->dev = dev;
1117 entry->length = length;
1118
1119 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1120 skb->data, skb->len, tx_complete, skb);
1121
1122 /* don't assume the hardware handles USB_ZERO_PACKET
1123 * NOTE: strictly conforming cdc-ether devices should expect
1124 * the ZLP here, but ignore the one-byte packet.
1125 * NOTE2: CDC NCM specification is different from CDC ECM when
1126 * handling ZLP/short packets, so cdc_ncm driver will make short
1127 * packet itself if needed.
1128 */
1129 if (length % dev->maxpacket == 0) {
1130 if (!(info->flags & FLAG_SEND_ZLP)) {
1131 if (!(info->flags & FLAG_MULTI_PACKET)) {
1132 urb->transfer_buffer_length++;
1133 if (skb_tailroom(skb)) {
1134 skb->data[skb->len] = 0;
1135 __skb_put(skb, 1);
1136 }
1137 }
1138 } else
1139 urb->transfer_flags |= URB_ZERO_PACKET;
1140 }
1141
1142 spin_lock_irqsave(&dev->txq.lock, flags);
1143 retval = usb_autopm_get_interface_async(dev->intf);
1144 if (retval < 0) {
1145 spin_unlock_irqrestore(&dev->txq.lock, flags);
1146 goto drop;
1147 }
1148
1149 #ifdef CONFIG_PM
1150 /* if this triggers the device is still a sleep */
1151 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1152 /* transmission will be done in resume */
1153 usb_anchor_urb(urb, &dev->deferred);
1154 /* no use to process more packets */
1155 netif_stop_queue(net);
1156 usb_put_urb(urb);
1157 spin_unlock_irqrestore(&dev->txq.lock, flags);
1158 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1159 goto deferred;
1160 }
1161 #endif
1162
1163 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1164 case -EPIPE:
1165 netif_stop_queue (net);
1166 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1167 usb_autopm_put_interface_async(dev->intf);
1168 break;
1169 default:
1170 usb_autopm_put_interface_async(dev->intf);
1171 netif_dbg(dev, tx_err, dev->net,
1172 "tx: submit urb err %d\n", retval);
1173 break;
1174 case 0:
1175 net->trans_start = jiffies;
1176 __usbnet_queue_skb(&dev->txq, skb, tx_start);
1177 if (dev->txq.qlen >= TX_QLEN (dev))
1178 netif_stop_queue (net);
1179 }
1180 spin_unlock_irqrestore (&dev->txq.lock, flags);
1181
1182 if (retval) {
1183 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1184 drop:
1185 dev->net->stats.tx_dropped++;
1186 not_drop:
1187 if (skb)
1188 dev_kfree_skb_any (skb);
1189 usb_free_urb (urb);
1190 } else
1191 netif_dbg(dev, tx_queued, dev->net,
1192 "> tx, len %d, type 0x%x\n", length, skb->protocol);
1193 #ifdef CONFIG_PM
1194 deferred:
1195 #endif
1196 return NETDEV_TX_OK;
1197 }
1198 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1199
1200 /*-------------------------------------------------------------------------*/
1201
1202 // tasklet (work deferred from completions, in_irq) or timer
1203
usbnet_bh(unsigned long param)1204 static void usbnet_bh (unsigned long param)
1205 {
1206 struct usbnet *dev = (struct usbnet *) param;
1207 struct sk_buff *skb;
1208 struct skb_data *entry;
1209
1210 while ((skb = skb_dequeue (&dev->done))) {
1211 entry = (struct skb_data *) skb->cb;
1212 switch (entry->state) {
1213 case rx_done:
1214 entry->state = rx_cleanup;
1215 rx_process (dev, skb);
1216 continue;
1217 case tx_done:
1218 case rx_cleanup:
1219 usb_free_urb (entry->urb);
1220 dev_kfree_skb (skb);
1221 continue;
1222 default:
1223 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1224 }
1225 }
1226
1227 // waiting for all pending urbs to complete?
1228 if (dev->wait) {
1229 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1230 wake_up (dev->wait);
1231 }
1232
1233 // or are we maybe short a few urbs?
1234 } else if (netif_running (dev->net) &&
1235 netif_device_present (dev->net) &&
1236 !timer_pending (&dev->delay) &&
1237 !test_bit (EVENT_RX_HALT, &dev->flags)) {
1238 int temp = dev->rxq.qlen;
1239 int qlen = RX_QLEN (dev);
1240
1241 if (temp < qlen) {
1242 struct urb *urb;
1243 int i;
1244
1245 // don't refill the queue all at once
1246 for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1247 urb = usb_alloc_urb (0, GFP_ATOMIC);
1248 if (urb != NULL) {
1249 if (rx_submit (dev, urb, GFP_ATOMIC) ==
1250 -ENOLINK)
1251 return;
1252 }
1253 }
1254 if (temp != dev->rxq.qlen)
1255 netif_dbg(dev, link, dev->net,
1256 "rxqlen %d --> %d\n",
1257 temp, dev->rxq.qlen);
1258 if (dev->rxq.qlen < qlen)
1259 tasklet_schedule (&dev->bh);
1260 }
1261 if (dev->txq.qlen < TX_QLEN (dev))
1262 netif_wake_queue (dev->net);
1263 }
1264 }
1265
1266
1267 /*-------------------------------------------------------------------------
1268 *
1269 * USB Device Driver support
1270 *
1271 *-------------------------------------------------------------------------*/
1272
1273 // precondition: never called in_interrupt
1274
usbnet_disconnect(struct usb_interface * intf)1275 void usbnet_disconnect (struct usb_interface *intf)
1276 {
1277 struct usbnet *dev;
1278 struct usb_device *xdev;
1279 struct net_device *net;
1280
1281 dev = usb_get_intfdata(intf);
1282 usb_set_intfdata(intf, NULL);
1283 if (!dev)
1284 return;
1285
1286 xdev = interface_to_usbdev (intf);
1287
1288 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1289 intf->dev.driver->name,
1290 xdev->bus->bus_name, xdev->devpath,
1291 dev->driver_info->description);
1292
1293 net = dev->net;
1294 unregister_netdev (net);
1295
1296 cancel_work_sync(&dev->kevent);
1297
1298 usb_scuttle_anchored_urbs(&dev->deferred);
1299
1300 if (dev->driver_info->unbind)
1301 dev->driver_info->unbind (dev, intf);
1302
1303 usb_kill_urb(dev->interrupt);
1304 usb_free_urb(dev->interrupt);
1305
1306 free_netdev(net);
1307 usb_put_dev (xdev);
1308 }
1309 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1310
1311 static const struct net_device_ops usbnet_netdev_ops = {
1312 .ndo_open = usbnet_open,
1313 .ndo_stop = usbnet_stop,
1314 .ndo_start_xmit = usbnet_start_xmit,
1315 .ndo_tx_timeout = usbnet_tx_timeout,
1316 .ndo_change_mtu = usbnet_change_mtu,
1317 .ndo_set_mac_address = eth_mac_addr,
1318 .ndo_validate_addr = eth_validate_addr,
1319 };
1320
1321 /*-------------------------------------------------------------------------*/
1322
1323 // precondition: never called in_interrupt
1324
1325 static struct device_type wlan_type = {
1326 .name = "wlan",
1327 };
1328
1329 static struct device_type wwan_type = {
1330 .name = "wwan",
1331 };
1332
1333 int
usbnet_probe(struct usb_interface * udev,const struct usb_device_id * prod)1334 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1335 {
1336 struct usbnet *dev;
1337 struct net_device *net;
1338 struct usb_host_interface *interface;
1339 struct driver_info *info;
1340 struct usb_device *xdev;
1341 int status;
1342 const char *name;
1343 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1344
1345 /* usbnet already took usb runtime pm, so have to enable the feature
1346 * for usb interface, otherwise usb_autopm_get_interface may return
1347 * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1348 */
1349 if (!driver->supports_autosuspend) {
1350 driver->supports_autosuspend = 1;
1351 pm_runtime_enable(&udev->dev);
1352 }
1353
1354 name = udev->dev.driver->name;
1355 info = (struct driver_info *) prod->driver_info;
1356 if (!info) {
1357 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1358 return -ENODEV;
1359 }
1360 xdev = interface_to_usbdev (udev);
1361 interface = udev->cur_altsetting;
1362
1363 usb_get_dev (xdev);
1364
1365 status = -ENOMEM;
1366
1367 // set up our own records
1368 net = alloc_etherdev(sizeof(*dev));
1369 if (!net)
1370 goto out;
1371
1372 /* netdev_printk() needs this so do it as early as possible */
1373 SET_NETDEV_DEV(net, &udev->dev);
1374
1375 dev = netdev_priv(net);
1376 dev->udev = xdev;
1377 dev->intf = udev;
1378 dev->driver_info = info;
1379 dev->driver_name = name;
1380 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1381 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1382 skb_queue_head_init (&dev->rxq);
1383 skb_queue_head_init (&dev->txq);
1384 skb_queue_head_init (&dev->done);
1385 skb_queue_head_init(&dev->rxq_pause);
1386 dev->bh.func = usbnet_bh;
1387 dev->bh.data = (unsigned long) dev;
1388 INIT_WORK (&dev->kevent, kevent);
1389 init_usb_anchor(&dev->deferred);
1390 dev->delay.function = usbnet_bh;
1391 dev->delay.data = (unsigned long) dev;
1392 init_timer (&dev->delay);
1393 mutex_init (&dev->phy_mutex);
1394
1395 dev->net = net;
1396 strcpy (net->name, "usb%d");
1397 memcpy (net->dev_addr, node_id, sizeof node_id);
1398
1399 /* rx and tx sides can use different message sizes;
1400 * bind() should set rx_urb_size in that case.
1401 */
1402 dev->hard_mtu = net->mtu + net->hard_header_len;
1403 #if 0
1404 // dma_supported() is deeply broken on almost all architectures
1405 // possible with some EHCI controllers
1406 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1407 net->features |= NETIF_F_HIGHDMA;
1408 #endif
1409
1410 net->netdev_ops = &usbnet_netdev_ops;
1411 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1412 net->ethtool_ops = &usbnet_ethtool_ops;
1413
1414 // allow device-specific bind/init procedures
1415 // NOTE net->name still not usable ...
1416 if (info->bind) {
1417 status = info->bind (dev, udev);
1418 if (status < 0)
1419 goto out1;
1420
1421 // heuristic: "usb%d" for links we know are two-host,
1422 // else "eth%d" when there's reasonable doubt. userspace
1423 // can rename the link if it knows better.
1424 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1425 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1426 (net->dev_addr [0] & 0x02) == 0))
1427 strcpy (net->name, "eth%d");
1428 /* WLAN devices should always be named "wlan%d" */
1429 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1430 strcpy(net->name, "wlan%d");
1431 /* WWAN devices should always be named "wwan%d" */
1432 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1433 strcpy(net->name, "wwan%d");
1434
1435 /* maybe the remote can't receive an Ethernet MTU */
1436 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1437 net->mtu = dev->hard_mtu - net->hard_header_len;
1438 } else if (!info->in || !info->out)
1439 status = usbnet_get_endpoints (dev, udev);
1440 else {
1441 dev->in = usb_rcvbulkpipe (xdev, info->in);
1442 dev->out = usb_sndbulkpipe (xdev, info->out);
1443 if (!(info->flags & FLAG_NO_SETINT))
1444 status = usb_set_interface (xdev,
1445 interface->desc.bInterfaceNumber,
1446 interface->desc.bAlternateSetting);
1447 else
1448 status = 0;
1449
1450 }
1451 if (status >= 0 && dev->status)
1452 status = init_status (dev, udev);
1453 if (status < 0)
1454 goto out3;
1455
1456 if (!dev->rx_urb_size)
1457 dev->rx_urb_size = dev->hard_mtu;
1458 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1459
1460 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1461 SET_NETDEV_DEVTYPE(net, &wlan_type);
1462 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1463 SET_NETDEV_DEVTYPE(net, &wwan_type);
1464
1465 status = register_netdev (net);
1466 if (status)
1467 goto out4;
1468 netif_info(dev, probe, dev->net,
1469 "register '%s' at usb-%s-%s, %s, %pM\n",
1470 udev->dev.driver->name,
1471 xdev->bus->bus_name, xdev->devpath,
1472 dev->driver_info->description,
1473 net->dev_addr);
1474
1475 // ok, it's ready to go.
1476 usb_set_intfdata (udev, dev);
1477
1478 netif_device_attach (net);
1479
1480 if (dev->driver_info->flags & FLAG_LINK_INTR)
1481 netif_carrier_off(net);
1482
1483 return 0;
1484
1485 out4:
1486 usb_free_urb(dev->interrupt);
1487 out3:
1488 if (info->unbind)
1489 info->unbind (dev, udev);
1490 out1:
1491 free_netdev(net);
1492 out:
1493 usb_put_dev(xdev);
1494 return status;
1495 }
1496 EXPORT_SYMBOL_GPL(usbnet_probe);
1497
1498 /*-------------------------------------------------------------------------*/
1499
1500 /*
1501 * suspend the whole driver as soon as the first interface is suspended
1502 * resume only when the last interface is resumed
1503 */
1504
usbnet_suspend(struct usb_interface * intf,pm_message_t message)1505 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1506 {
1507 struct usbnet *dev = usb_get_intfdata(intf);
1508
1509 if (!dev->suspend_count++) {
1510 spin_lock_irq(&dev->txq.lock);
1511 /* don't autosuspend while transmitting */
1512 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1513 spin_unlock_irq(&dev->txq.lock);
1514 return -EBUSY;
1515 } else {
1516 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1517 spin_unlock_irq(&dev->txq.lock);
1518 }
1519 /*
1520 * accelerate emptying of the rx and queues, to avoid
1521 * having everything error out.
1522 */
1523 netif_device_detach (dev->net);
1524 usbnet_terminate_urbs(dev);
1525 usb_kill_urb(dev->interrupt);
1526
1527 /*
1528 * reattach so runtime management can use and
1529 * wake the device
1530 */
1531 netif_device_attach (dev->net);
1532 }
1533 return 0;
1534 }
1535 EXPORT_SYMBOL_GPL(usbnet_suspend);
1536
usbnet_resume(struct usb_interface * intf)1537 int usbnet_resume (struct usb_interface *intf)
1538 {
1539 struct usbnet *dev = usb_get_intfdata(intf);
1540 struct sk_buff *skb;
1541 struct urb *res;
1542 int retval;
1543
1544 if (!--dev->suspend_count) {
1545 /* resume interrupt URBs */
1546 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1547 usb_submit_urb(dev->interrupt, GFP_NOIO);
1548
1549 spin_lock_irq(&dev->txq.lock);
1550 while ((res = usb_get_from_anchor(&dev->deferred))) {
1551
1552 skb = (struct sk_buff *)res->context;
1553 retval = usb_submit_urb(res, GFP_ATOMIC);
1554 if (retval < 0) {
1555 dev_kfree_skb_any(skb);
1556 usb_free_urb(res);
1557 usb_autopm_put_interface_async(dev->intf);
1558 } else {
1559 dev->net->trans_start = jiffies;
1560 __skb_queue_tail(&dev->txq, skb);
1561 }
1562 }
1563
1564 smp_mb();
1565 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1566 spin_unlock_irq(&dev->txq.lock);
1567
1568 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1569 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1570 netif_tx_wake_all_queues(dev->net);
1571 tasklet_schedule (&dev->bh);
1572 }
1573 }
1574 return 0;
1575 }
1576 EXPORT_SYMBOL_GPL(usbnet_resume);
1577
1578
1579 /*-------------------------------------------------------------------------*/
1580
usbnet_init(void)1581 static int __init usbnet_init(void)
1582 {
1583 /* Compiler should optimize this out. */
1584 BUILD_BUG_ON(
1585 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1586
1587 random_ether_addr(node_id);
1588 return 0;
1589 }
1590 module_init(usbnet_init);
1591
usbnet_exit(void)1592 static void __exit usbnet_exit(void)
1593 {
1594 }
1595 module_exit(usbnet_exit);
1596
1597 MODULE_AUTHOR("David Brownell");
1598 MODULE_DESCRIPTION("USB network driver framework");
1599 MODULE_LICENSE("GPL");
1600