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