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