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