Linux Audio

Check our new training course

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