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