net/usbnet: reserve headroom on rx skbs
[linux-2.6.git] / drivers / net / usb / usbnet.c
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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 /*
22  * This is a generic "USB networking" framework that works with several
23  * kinds of full and high speed networking devices:  host-to-host cables,
24  * smart usb peripherals, and actual Ethernet adapters.
25  *
26  * These devices usually differ in terms of control protocols (if they
27  * even have one!) and sometimes they define new framing to wrap or batch
28  * Ethernet packets.  Otherwise, they talk to USB pretty much the same,
29  * so interface (un)binding, endpoint I/O queues, fault handling, and other
30  * issues can usefully be addressed by this framework.
31  */
32
33 // #define      DEBUG                   // error path messages, extra info
34 // #define      VERBOSE                 // more; success messages
35
36 #include <linux/module.h>
37 #include <linux/init.h>
38 #include <linux/netdevice.h>
39 #include <linux/etherdevice.h>
40 #include <linux/ctype.h>
41 #include <linux/ethtool.h>
42 #include <linux/workqueue.h>
43 #include <linux/mii.h>
44 #include <linux/usb.h>
45 #include <linux/usb/usbnet.h>
46 #include <linux/slab.h>
47 #include <linux/kernel.h>
48 #include <linux/pm_runtime.h>
49
50 #define DRIVER_VERSION          "22-Aug-2005"
51
52
53 /*-------------------------------------------------------------------------*/
54
55 /*
56  * Nineteen USB 1.1 max size bulk transactions per frame (ms), max.
57  * Several dozen bytes of IPv4 data can fit in two such transactions.
58  * One maximum size Ethernet packet takes twenty four of them.
59  * For high speed, each frame comfortably fits almost 36 max size
60  * Ethernet packets (so queues should be bigger).
61  *
62  * REVISIT qlens should be members of 'struct usbnet'; the goal is to
63  * let the USB host controller be busy for 5msec or more before an irq
64  * is required, under load.  Jumbograms change the equation.
65  */
66 #define RX_MAX_QUEUE_MEMORY (60 * 1518)
67 #define RX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
68                         (RX_MAX_QUEUE_MEMORY/(dev)->rx_urb_size) : 4)
69 #define TX_QLEN(dev) (((dev)->udev->speed == USB_SPEED_HIGH) ? \
70                         (RX_MAX_QUEUE_MEMORY/(dev)->hard_mtu) : 4)
71
72 // reawaken network queue this soon after stopping; else watchdog barks
73 #define TX_TIMEOUT_JIFFIES      (5*HZ)
74
75 // throttle rx/tx briefly after some faults, so khubd might disconnect()
76 // us (it polls at HZ/4 usually) before we report too many false errors.
77 #define THROTTLE_JIFFIES        (HZ/8)
78
79 // between wakeups
80 #define UNLINK_TIMEOUT_MS       3
81
82 /*-------------------------------------------------------------------------*/
83
84 // randomly generated ethernet address
85 static u8       node_id [ETH_ALEN];
86
87 static const char driver_name [] = "usbnet";
88
89 /* use ethtool to change the level for any given device */
90 static int msg_level = -1;
91 module_param (msg_level, int, 0);
92 MODULE_PARM_DESC (msg_level, "Override default message level");
93
94 /*-------------------------------------------------------------------------*/
95
96 /* handles CDC Ethernet and many other network "bulk data" interfaces */
97 int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
98 {
99         int                             tmp;
100         struct usb_host_interface       *alt = NULL;
101         struct usb_host_endpoint        *in = NULL, *out = NULL;
102         struct usb_host_endpoint        *status = NULL;
103
104         for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
105                 unsigned        ep;
106
107                 in = out = status = NULL;
108                 alt = intf->altsetting + tmp;
109
110                 /* take the first altsetting with in-bulk + out-bulk;
111                  * remember any status endpoint, just in case;
112                  * ignore other endpoints and altsettings.
113                  */
114                 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
115                         struct usb_host_endpoint        *e;
116                         int                             intr = 0;
117
118                         e = alt->endpoint + ep;
119                         switch (e->desc.bmAttributes) {
120                         case USB_ENDPOINT_XFER_INT:
121                                 if (!usb_endpoint_dir_in(&e->desc))
122                                         continue;
123                                 intr = 1;
124                                 /* FALLTHROUGH */
125                         case USB_ENDPOINT_XFER_BULK:
126                                 break;
127                         default:
128                                 continue;
129                         }
130                         if (usb_endpoint_dir_in(&e->desc)) {
131                                 if (!intr && !in)
132                                         in = e;
133                                 else if (intr && !status)
134                                         status = e;
135                         } else {
136                                 if (!out)
137                                         out = e;
138                         }
139                 }
140                 if (in && out)
141                         break;
142         }
143         if (!alt || !in || !out)
144                 return -EINVAL;
145
146         if (alt->desc.bAlternateSetting != 0 ||
147             !(dev->driver_info->flags & FLAG_NO_SETINT)) {
148                 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
149                                 alt->desc.bAlternateSetting);
150                 if (tmp < 0)
151                         return tmp;
152         }
153
154         dev->in = usb_rcvbulkpipe (dev->udev,
155                         in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
156         dev->out = usb_sndbulkpipe (dev->udev,
157                         out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
158         dev->status = status;
159         return 0;
160 }
161 EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
162
163 int usbnet_get_ethernet_addr(struct usbnet *dev, int iMACAddress)
164 {
165         int             tmp, i;
166         unsigned char   buf [13];
167
168         tmp = usb_string(dev->udev, iMACAddress, buf, sizeof buf);
169         if (tmp != 12) {
170                 dev_dbg(&dev->udev->dev,
171                         "bad MAC string %d fetch, %d\n", iMACAddress, tmp);
172                 if (tmp >= 0)
173                         tmp = -EINVAL;
174                 return tmp;
175         }
176         for (i = tmp = 0; i < 6; i++, tmp += 2)
177                 dev->net->dev_addr [i] =
178                         (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
179         return 0;
180 }
181 EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
182
183 static void intr_complete (struct urb *urb);
184
185 static int init_status (struct usbnet *dev, struct usb_interface *intf)
186 {
187         char            *buf = NULL;
188         unsigned        pipe = 0;
189         unsigned        maxp;
190         unsigned        period;
191
192         if (!dev->driver_info->status)
193                 return 0;
194
195         pipe = usb_rcvintpipe (dev->udev,
196                         dev->status->desc.bEndpointAddress
197                                 & USB_ENDPOINT_NUMBER_MASK);
198         maxp = usb_maxpacket (dev->udev, pipe, 0);
199
200         /* avoid 1 msec chatter:  min 8 msec poll rate */
201         period = max ((int) dev->status->desc.bInterval,
202                 (dev->udev->speed == USB_SPEED_HIGH) ? 7 : 3);
203
204         buf = kmalloc (maxp, GFP_KERNEL);
205         if (buf) {
206                 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
207                 if (!dev->interrupt) {
208                         kfree (buf);
209                         return -ENOMEM;
210                 } else {
211                         usb_fill_int_urb(dev->interrupt, dev->udev, pipe,
212                                 buf, maxp, intr_complete, dev, period);
213                         dev_dbg(&intf->dev,
214                                 "status ep%din, %d bytes period %d\n",
215                                 usb_pipeendpoint(pipe), maxp, period);
216                 }
217         }
218         return 0;
219 }
220
221 /* Passes this packet up the stack, updating its accounting.
222  * Some link protocols batch packets, so their rx_fixup paths
223  * can return clones as well as just modify the original skb.
224  */
225 void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
226 {
227         int     status;
228
229         if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
230                 skb_queue_tail(&dev->rxq_pause, skb);
231                 return;
232         }
233
234         skb->protocol = eth_type_trans (skb, dev->net);
235         dev->net->stats.rx_packets++;
236         dev->net->stats.rx_bytes += skb->len;
237
238         netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
239                   skb->len + sizeof (struct ethhdr), skb->protocol);
240         memset (skb->cb, 0, sizeof (struct skb_data));
241
242         if (skb_defer_rx_timestamp(skb))
243                 return;
244
245         status = netif_rx (skb);
246         if (status != NET_RX_SUCCESS)
247                 netif_dbg(dev, rx_err, dev->net,
248                           "netif_rx status %d\n", status);
249 }
250 EXPORT_SYMBOL_GPL(usbnet_skb_return);
251
252 \f
253 /*-------------------------------------------------------------------------
254  *
255  * Network Device Driver (peer link to "Host Device", from USB host)
256  *
257  *-------------------------------------------------------------------------*/
258
259 int usbnet_change_mtu (struct net_device *net, int new_mtu)
260 {
261         struct usbnet   *dev = netdev_priv(net);
262         int             ll_mtu = new_mtu + net->hard_header_len;
263         int             old_hard_mtu = dev->hard_mtu;
264         int             old_rx_urb_size = dev->rx_urb_size;
265
266         if (new_mtu <= 0)
267                 return -EINVAL;
268         // no second zero-length packet read wanted after mtu-sized packets
269         if ((ll_mtu % dev->maxpacket) == 0)
270                 return -EDOM;
271         net->mtu = new_mtu;
272
273         dev->hard_mtu = net->mtu + net->hard_header_len;
274         if (dev->rx_urb_size == old_hard_mtu) {
275                 dev->rx_urb_size = dev->hard_mtu;
276                 if (dev->rx_urb_size > old_rx_urb_size)
277                         usbnet_unlink_rx_urbs(dev);
278         }
279
280         return 0;
281 }
282 EXPORT_SYMBOL_GPL(usbnet_change_mtu);
283
284 /*-------------------------------------------------------------------------*/
285
286 /* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
287  * completion callbacks.  2.5 should have fixed those bugs...
288  */
289
290 static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
291 {
292         unsigned long           flags;
293
294         spin_lock_irqsave(&list->lock, flags);
295         __skb_unlink(skb, list);
296         spin_unlock(&list->lock);
297         spin_lock(&dev->done.lock);
298         __skb_queue_tail(&dev->done, skb);
299         if (dev->done.qlen == 1)
300                 tasklet_schedule(&dev->bh);
301         spin_unlock_irqrestore(&dev->done.lock, flags);
302 }
303
304 /* some work can't be done in tasklets, so we use keventd
305  *
306  * NOTE:  annoying asymmetry:  if it's active, schedule_work() fails,
307  * but tasklet_schedule() doesn't.  hope the failure is rare.
308  */
309 void usbnet_defer_kevent (struct usbnet *dev, int work)
310 {
311         set_bit (work, &dev->flags);
312         if (!schedule_work (&dev->kevent))
313                 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
314         else
315                 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
316 }
317 EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
318
319 /*-------------------------------------------------------------------------*/
320
321 static void rx_complete (struct urb *urb);
322
323 static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
324 {
325         struct sk_buff          *skb;
326         struct skb_data         *entry;
327         int                     retval = 0;
328         unsigned long           lockflags;
329         size_t                  size = dev->rx_urb_size;
330
331         skb = __netdev_alloc_skb_ip_align(dev->net, size, flags);
332         if (!skb) {
333                 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
334                 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
335                 usb_free_urb (urb);
336                 return -ENOMEM;
337         }
338
339         entry = (struct skb_data *) skb->cb;
340         entry->urb = urb;
341         entry->dev = dev;
342         entry->state = rx_start;
343         entry->length = 0;
344
345         usb_fill_bulk_urb (urb, dev->udev, dev->in,
346                 skb->data, size, rx_complete, skb);
347
348         spin_lock_irqsave (&dev->rxq.lock, lockflags);
349
350         if (netif_running (dev->net) &&
351             netif_device_present (dev->net) &&
352             !test_bit (EVENT_RX_HALT, &dev->flags) &&
353             !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
354                 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
355                 case -EPIPE:
356                         usbnet_defer_kevent (dev, EVENT_RX_HALT);
357                         break;
358                 case -ENOMEM:
359                         usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
360                         break;
361                 case -ENODEV:
362                         netif_dbg(dev, ifdown, dev->net, "device gone\n");
363                         netif_device_detach (dev->net);
364                         break;
365                 case -EHOSTUNREACH:
366                         retval = -ENOLINK;
367                         break;
368                 default:
369                         netif_dbg(dev, rx_err, dev->net,
370                                   "rx submit, %d\n", retval);
371                         tasklet_schedule (&dev->bh);
372                         break;
373                 case 0:
374                         __skb_queue_tail (&dev->rxq, skb);
375                 }
376         } else {
377                 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
378                 retval = -ENOLINK;
379         }
380         spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
381         if (retval) {
382                 dev_kfree_skb_any (skb);
383                 usb_free_urb (urb);
384         }
385         return retval;
386 }
387
388
389 /*-------------------------------------------------------------------------*/
390
391 static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
392 {
393         if (dev->driver_info->rx_fixup &&
394             !dev->driver_info->rx_fixup (dev, skb)) {
395                 /* With RX_ASSEMBLE, rx_fixup() must update counters */
396                 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
397                         dev->net->stats.rx_errors++;
398                 goto done;
399         }
400         // else network stack removes extra byte if we forced a short packet
401
402         if (skb->len) {
403                 /* all data was already cloned from skb inside the driver */
404                 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
405                         dev_kfree_skb_any(skb);
406                 else
407                         usbnet_skb_return(dev, skb);
408                 return;
409         }
410
411         netif_dbg(dev, rx_err, dev->net, "drop\n");
412         dev->net->stats.rx_errors++;
413 done:
414         skb_queue_tail(&dev->done, skb);
415 }
416
417 /*-------------------------------------------------------------------------*/
418
419 static void rx_complete (struct urb *urb)
420 {
421         struct sk_buff          *skb = (struct sk_buff *) urb->context;
422         struct skb_data         *entry = (struct skb_data *) skb->cb;
423         struct usbnet           *dev = entry->dev;
424         int                     urb_status = urb->status;
425
426         skb_put (skb, urb->actual_length);
427         entry->state = rx_done;
428         entry->urb = NULL;
429
430         switch (urb_status) {
431         /* success */
432         case 0:
433                 if (skb->len < dev->net->hard_header_len) {
434                         entry->state = rx_cleanup;
435                         dev->net->stats.rx_errors++;
436                         dev->net->stats.rx_length_errors++;
437                         netif_dbg(dev, rx_err, dev->net,
438                                   "rx length %d\n", skb->len);
439                 }
440                 break;
441
442         /* stalls need manual reset. this is rare ... except that
443          * when going through USB 2.0 TTs, unplug appears this way.
444          * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
445          * storm, recovering as needed.
446          */
447         case -EPIPE:
448                 dev->net->stats.rx_errors++;
449                 usbnet_defer_kevent (dev, EVENT_RX_HALT);
450                 // FALLTHROUGH
451
452         /* software-driven interface shutdown */
453         case -ECONNRESET:               /* async unlink */
454         case -ESHUTDOWN:                /* hardware gone */
455                 netif_dbg(dev, ifdown, dev->net,
456                           "rx shutdown, code %d\n", urb_status);
457                 goto block;
458
459         /* we get controller i/o faults during khubd disconnect() delays.
460          * throttle down resubmits, to avoid log floods; just temporarily,
461          * so we still recover when the fault isn't a khubd delay.
462          */
463         case -EPROTO:
464         case -ETIME:
465         case -EILSEQ:
466                 dev->net->stats.rx_errors++;
467                 if (!timer_pending (&dev->delay)) {
468                         mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
469                         netif_dbg(dev, link, dev->net,
470                                   "rx throttle %d\n", urb_status);
471                 }
472 block:
473                 entry->state = rx_cleanup;
474                 entry->urb = urb;
475                 urb = NULL;
476                 break;
477
478         /* data overrun ... flush fifo? */
479         case -EOVERFLOW:
480                 dev->net->stats.rx_over_errors++;
481                 // FALLTHROUGH
482
483         default:
484                 entry->state = rx_cleanup;
485                 dev->net->stats.rx_errors++;
486                 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
487                 break;
488         }
489
490         defer_bh(dev, skb, &dev->rxq);
491
492         if (urb) {
493                 if (netif_running (dev->net) &&
494                     !test_bit (EVENT_RX_HALT, &dev->flags)) {
495                         rx_submit (dev, urb, GFP_ATOMIC);
496                         return;
497                 }
498                 usb_free_urb (urb);
499         }
500         netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
501 }
502
503 static void intr_complete (struct urb *urb)
504 {
505         struct usbnet   *dev = urb->context;
506         int             status = urb->status;
507
508         switch (status) {
509         /* success */
510         case 0:
511                 dev->driver_info->status(dev, urb);
512                 break;
513
514         /* software-driven interface shutdown */
515         case -ENOENT:           /* urb killed */
516         case -ESHUTDOWN:        /* hardware gone */
517                 netif_dbg(dev, ifdown, dev->net,
518                           "intr shutdown, code %d\n", status);
519                 return;
520
521         /* NOTE:  not throttling like RX/TX, since this endpoint
522          * already polls infrequently
523          */
524         default:
525                 netdev_dbg(dev->net, "intr status %d\n", status);
526                 break;
527         }
528
529         if (!netif_running (dev->net))
530                 return;
531
532         memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
533         status = usb_submit_urb (urb, GFP_ATOMIC);
534         if (status != 0)
535                 netif_err(dev, timer, dev->net,
536                           "intr resubmit --> %d\n", status);
537 }
538
539 /*-------------------------------------------------------------------------*/
540 void usbnet_pause_rx(struct usbnet *dev)
541 {
542         set_bit(EVENT_RX_PAUSED, &dev->flags);
543
544         netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
545 }
546 EXPORT_SYMBOL_GPL(usbnet_pause_rx);
547
548 void usbnet_resume_rx(struct usbnet *dev)
549 {
550         struct sk_buff *skb;
551         int num = 0;
552
553         clear_bit(EVENT_RX_PAUSED, &dev->flags);
554
555         while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
556                 usbnet_skb_return(dev, skb);
557                 num++;
558         }
559
560         tasklet_schedule(&dev->bh);
561
562         netif_dbg(dev, rx_status, dev->net,
563                   "paused rx queue disabled, %d skbs requeued\n", num);
564 }
565 EXPORT_SYMBOL_GPL(usbnet_resume_rx);
566
567 void usbnet_purge_paused_rxq(struct usbnet *dev)
568 {
569         skb_queue_purge(&dev->rxq_pause);
570 }
571 EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
572
573 /*-------------------------------------------------------------------------*/
574
575 // unlink pending rx/tx; completion handlers do all other cleanup
576
577 static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
578 {
579         unsigned long           flags;
580         struct sk_buff          *skb, *skbnext;
581         int                     count = 0;
582
583         spin_lock_irqsave (&q->lock, flags);
584         skb_queue_walk_safe(q, skb, skbnext) {
585                 struct skb_data         *entry;
586                 struct urb              *urb;
587                 int                     retval;
588
589                 entry = (struct skb_data *) skb->cb;
590                 urb = entry->urb;
591
592                 spin_unlock_irqrestore(&q->lock, flags);
593                 // during some PM-driven resume scenarios,
594                 // these (async) unlinks complete immediately
595                 retval = usb_unlink_urb (urb);
596                 if (retval != -EINPROGRESS && retval != 0)
597                         netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
598                 else
599                         count++;
600                 spin_lock_irqsave(&q->lock, flags);
601         }
602         spin_unlock_irqrestore (&q->lock, flags);
603         return count;
604 }
605
606 // Flush all pending rx urbs
607 // minidrivers may need to do this when the MTU changes
608
609 void usbnet_unlink_rx_urbs(struct usbnet *dev)
610 {
611         if (netif_running(dev->net)) {
612                 (void) unlink_urbs (dev, &dev->rxq);
613                 tasklet_schedule(&dev->bh);
614         }
615 }
616 EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
617
618 /*-------------------------------------------------------------------------*/
619
620 // precondition: never called in_interrupt
621 static void usbnet_terminate_urbs(struct usbnet *dev)
622 {
623         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
624         DECLARE_WAITQUEUE(wait, current);
625         int temp;
626
627         /* ensure there are no more active urbs */
628         add_wait_queue(&unlink_wakeup, &wait);
629         set_current_state(TASK_UNINTERRUPTIBLE);
630         dev->wait = &unlink_wakeup;
631         temp = unlink_urbs(dev, &dev->txq) +
632                 unlink_urbs(dev, &dev->rxq);
633
634         /* maybe wait for deletions to finish. */
635         while (!skb_queue_empty(&dev->rxq)
636                 && !skb_queue_empty(&dev->txq)
637                 && !skb_queue_empty(&dev->done)) {
638                         schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
639                         set_current_state(TASK_UNINTERRUPTIBLE);
640                         netif_dbg(dev, ifdown, dev->net,
641                                   "waited for %d urb completions\n", temp);
642         }
643         set_current_state(TASK_RUNNING);
644         dev->wait = NULL;
645         remove_wait_queue(&unlink_wakeup, &wait);
646 }
647
648 int usbnet_stop (struct net_device *net)
649 {
650         struct usbnet           *dev = netdev_priv(net);
651         struct driver_info      *info = dev->driver_info;
652         int                     retval;
653
654         clear_bit(EVENT_DEV_OPEN, &dev->flags);
655         netif_stop_queue (net);
656
657         netif_info(dev, ifdown, dev->net,
658                    "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
659                    net->stats.rx_packets, net->stats.tx_packets,
660                    net->stats.rx_errors, net->stats.tx_errors);
661
662         /* allow minidriver to stop correctly (wireless devices to turn off
663          * radio etc) */
664         if (info->stop) {
665                 retval = info->stop(dev);
666                 if (retval < 0)
667                         netif_info(dev, ifdown, dev->net,
668                                    "stop fail (%d) usbnet usb-%s-%s, %s\n",
669                                    retval,
670                                    dev->udev->bus->bus_name, dev->udev->devpath,
671                                    info->description);
672         }
673
674         if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
675                 usbnet_terminate_urbs(dev);
676
677         usb_kill_urb(dev->interrupt);
678
679         usbnet_purge_paused_rxq(dev);
680
681         /* deferred work (task, timer, softirq) must also stop.
682          * can't flush_scheduled_work() until we drop rtnl (later),
683          * else workers could deadlock; so make workers a NOP.
684          */
685         dev->flags = 0;
686         del_timer_sync (&dev->delay);
687         tasklet_kill (&dev->bh);
688         if (info->manage_power)
689                 info->manage_power(dev, 0);
690         else
691                 usb_autopm_put_interface(dev->intf);
692
693         return 0;
694 }
695 EXPORT_SYMBOL_GPL(usbnet_stop);
696
697 /*-------------------------------------------------------------------------*/
698
699 // posts reads, and enables write queuing
700
701 // precondition: never called in_interrupt
702
703 int usbnet_open (struct net_device *net)
704 {
705         struct usbnet           *dev = netdev_priv(net);
706         int                     retval;
707         struct driver_info      *info = dev->driver_info;
708
709         if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
710                 netif_info(dev, ifup, dev->net,
711                            "resumption fail (%d) usbnet usb-%s-%s, %s\n",
712                            retval,
713                            dev->udev->bus->bus_name,
714                            dev->udev->devpath,
715                            info->description);
716                 goto done_nopm;
717         }
718
719         // put into "known safe" state
720         if (info->reset && (retval = info->reset (dev)) < 0) {
721                 netif_info(dev, ifup, dev->net,
722                            "open reset fail (%d) usbnet usb-%s-%s, %s\n",
723                            retval,
724                            dev->udev->bus->bus_name,
725                            dev->udev->devpath,
726                            info->description);
727                 goto done;
728         }
729
730         // insist peer be connected
731         if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
732                 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
733                 goto done;
734         }
735
736         /* start any status interrupt transfer */
737         if (dev->interrupt) {
738                 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
739                 if (retval < 0) {
740                         netif_err(dev, ifup, dev->net,
741                                   "intr submit %d\n", retval);
742                         goto done;
743                 }
744         }
745
746         set_bit(EVENT_DEV_OPEN, &dev->flags);
747         netif_start_queue (net);
748         netif_info(dev, ifup, dev->net,
749                    "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
750                    (int)RX_QLEN(dev), (int)TX_QLEN(dev),
751                    dev->net->mtu,
752                    (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
753                    (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
754                    (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
755                    (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
756                    (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
757                    "simple");
758
759         // delay posting reads until we're fully open
760         tasklet_schedule (&dev->bh);
761         if (info->manage_power) {
762                 retval = info->manage_power(dev, 1);
763                 if (retval < 0)
764                         goto done;
765                 usb_autopm_put_interface(dev->intf);
766         }
767         return retval;
768
769 done:
770         usb_autopm_put_interface(dev->intf);
771 done_nopm:
772         return retval;
773 }
774 EXPORT_SYMBOL_GPL(usbnet_open);
775
776 /*-------------------------------------------------------------------------*/
777
778 /* ethtool methods; minidrivers may need to add some more, but
779  * they'll probably want to use this base set.
780  */
781
782 int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
783 {
784         struct usbnet *dev = netdev_priv(net);
785
786         if (!dev->mii.mdio_read)
787                 return -EOPNOTSUPP;
788
789         return mii_ethtool_gset(&dev->mii, cmd);
790 }
791 EXPORT_SYMBOL_GPL(usbnet_get_settings);
792
793 int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
794 {
795         struct usbnet *dev = netdev_priv(net);
796         int retval;
797
798         if (!dev->mii.mdio_write)
799                 return -EOPNOTSUPP;
800
801         retval = mii_ethtool_sset(&dev->mii, cmd);
802
803         /* link speed/duplex might have changed */
804         if (dev->driver_info->link_reset)
805                 dev->driver_info->link_reset(dev);
806
807         return retval;
808
809 }
810 EXPORT_SYMBOL_GPL(usbnet_set_settings);
811
812 u32 usbnet_get_link (struct net_device *net)
813 {
814         struct usbnet *dev = netdev_priv(net);
815
816         /* If a check_connect is defined, return its result */
817         if (dev->driver_info->check_connect)
818                 return dev->driver_info->check_connect (dev) == 0;
819
820         /* if the device has mii operations, use those */
821         if (dev->mii.mdio_read)
822                 return mii_link_ok(&dev->mii);
823
824         /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
825         return ethtool_op_get_link(net);
826 }
827 EXPORT_SYMBOL_GPL(usbnet_get_link);
828
829 int usbnet_nway_reset(struct net_device *net)
830 {
831         struct usbnet *dev = netdev_priv(net);
832
833         if (!dev->mii.mdio_write)
834                 return -EOPNOTSUPP;
835
836         return mii_nway_restart(&dev->mii);
837 }
838 EXPORT_SYMBOL_GPL(usbnet_nway_reset);
839
840 void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
841 {
842         struct usbnet *dev = netdev_priv(net);
843
844         strncpy (info->driver, dev->driver_name, sizeof info->driver);
845         strncpy (info->version, DRIVER_VERSION, sizeof info->version);
846         strncpy (info->fw_version, dev->driver_info->description,
847                 sizeof info->fw_version);
848         usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
849 }
850 EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
851
852 u32 usbnet_get_msglevel (struct net_device *net)
853 {
854         struct usbnet *dev = netdev_priv(net);
855
856         return dev->msg_enable;
857 }
858 EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
859
860 void usbnet_set_msglevel (struct net_device *net, u32 level)
861 {
862         struct usbnet *dev = netdev_priv(net);
863
864         dev->msg_enable = level;
865 }
866 EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
867
868 /* drivers may override default ethtool_ops in their bind() routine */
869 static const struct ethtool_ops usbnet_ethtool_ops = {
870         .get_settings           = usbnet_get_settings,
871         .set_settings           = usbnet_set_settings,
872         .get_link               = usbnet_get_link,
873         .nway_reset             = usbnet_nway_reset,
874         .get_drvinfo            = usbnet_get_drvinfo,
875         .get_msglevel           = usbnet_get_msglevel,
876         .set_msglevel           = usbnet_set_msglevel,
877 };
878
879 /*-------------------------------------------------------------------------*/
880
881 /* work that cannot be done in interrupt context uses keventd.
882  *
883  * NOTE:  with 2.5 we could do more of this using completion callbacks,
884  * especially now that control transfers can be queued.
885  */
886 static void
887 kevent (struct work_struct *work)
888 {
889         struct usbnet           *dev =
890                 container_of(work, struct usbnet, kevent);
891         int                     status;
892
893         /* usb_clear_halt() needs a thread context */
894         if (test_bit (EVENT_TX_HALT, &dev->flags)) {
895                 unlink_urbs (dev, &dev->txq);
896                 status = usb_autopm_get_interface(dev->intf);
897                 if (status < 0)
898                         goto fail_pipe;
899                 status = usb_clear_halt (dev->udev, dev->out);
900                 usb_autopm_put_interface(dev->intf);
901                 if (status < 0 &&
902                     status != -EPIPE &&
903                     status != -ESHUTDOWN) {
904                         if (netif_msg_tx_err (dev))
905 fail_pipe:
906                                 netdev_err(dev->net, "can't clear tx halt, status %d\n",
907                                            status);
908                 } else {
909                         clear_bit (EVENT_TX_HALT, &dev->flags);
910                         if (status != -ESHUTDOWN)
911                                 netif_wake_queue (dev->net);
912                 }
913         }
914         if (test_bit (EVENT_RX_HALT, &dev->flags)) {
915                 unlink_urbs (dev, &dev->rxq);
916                 status = usb_autopm_get_interface(dev->intf);
917                 if (status < 0)
918                         goto fail_halt;
919                 status = usb_clear_halt (dev->udev, dev->in);
920                 usb_autopm_put_interface(dev->intf);
921                 if (status < 0 &&
922                     status != -EPIPE &&
923                     status != -ESHUTDOWN) {
924                         if (netif_msg_rx_err (dev))
925 fail_halt:
926                                 netdev_err(dev->net, "can't clear rx halt, status %d\n",
927                                            status);
928                 } else {
929                         clear_bit (EVENT_RX_HALT, &dev->flags);
930                         tasklet_schedule (&dev->bh);
931                 }
932         }
933
934         /* tasklet could resubmit itself forever if memory is tight */
935         if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
936                 struct urb      *urb = NULL;
937                 int resched = 1;
938
939                 if (netif_running (dev->net))
940                         urb = usb_alloc_urb (0, GFP_KERNEL);
941                 else
942                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
943                 if (urb != NULL) {
944                         clear_bit (EVENT_RX_MEMORY, &dev->flags);
945                         status = usb_autopm_get_interface(dev->intf);
946                         if (status < 0) {
947                                 usb_free_urb(urb);
948                                 goto fail_lowmem;
949                         }
950                         if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
951                                 resched = 0;
952                         usb_autopm_put_interface(dev->intf);
953 fail_lowmem:
954                         if (resched)
955                                 tasklet_schedule (&dev->bh);
956                 }
957         }
958
959         if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
960                 struct driver_info      *info = dev->driver_info;
961                 int                     retval = 0;
962
963                 clear_bit (EVENT_LINK_RESET, &dev->flags);
964                 status = usb_autopm_get_interface(dev->intf);
965                 if (status < 0)
966                         goto skip_reset;
967                 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
968                         usb_autopm_put_interface(dev->intf);
969 skip_reset:
970                         netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
971                                     retval,
972                                     dev->udev->bus->bus_name,
973                                     dev->udev->devpath,
974                                     info->description);
975                 } else {
976                         usb_autopm_put_interface(dev->intf);
977                 }
978         }
979
980         if (dev->flags)
981                 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
982 }
983
984 /*-------------------------------------------------------------------------*/
985
986 static void tx_complete (struct urb *urb)
987 {
988         struct sk_buff          *skb = (struct sk_buff *) urb->context;
989         struct skb_data         *entry = (struct skb_data *) skb->cb;
990         struct usbnet           *dev = entry->dev;
991
992         if (urb->status == 0) {
993                 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
994                         dev->net->stats.tx_packets++;
995                 dev->net->stats.tx_bytes += entry->length;
996         } else {
997                 dev->net->stats.tx_errors++;
998
999                 switch (urb->status) {
1000                 case -EPIPE:
1001                         usbnet_defer_kevent (dev, EVENT_TX_HALT);
1002                         break;
1003
1004                 /* software-driven interface shutdown */
1005                 case -ECONNRESET:               // async unlink
1006                 case -ESHUTDOWN:                // hardware gone
1007                         break;
1008
1009                 // like rx, tx gets controller i/o faults during khubd delays
1010                 // and so it uses the same throttling mechanism.
1011                 case -EPROTO:
1012                 case -ETIME:
1013                 case -EILSEQ:
1014                         usb_mark_last_busy(dev->udev);
1015                         if (!timer_pending (&dev->delay)) {
1016                                 mod_timer (&dev->delay,
1017                                         jiffies + THROTTLE_JIFFIES);
1018                                 netif_dbg(dev, link, dev->net,
1019                                           "tx throttle %d\n", urb->status);
1020                         }
1021                         netif_stop_queue (dev->net);
1022                         break;
1023                 default:
1024                         netif_dbg(dev, tx_err, dev->net,
1025                                   "tx err %d\n", entry->urb->status);
1026                         break;
1027                 }
1028         }
1029
1030         usb_autopm_put_interface_async(dev->intf);
1031         urb->dev = NULL;
1032         entry->state = tx_done;
1033         defer_bh(dev, skb, &dev->txq);
1034 }
1035
1036 /*-------------------------------------------------------------------------*/
1037
1038 void usbnet_tx_timeout (struct net_device *net)
1039 {
1040         struct usbnet           *dev = netdev_priv(net);
1041
1042         unlink_urbs (dev, &dev->txq);
1043         tasklet_schedule (&dev->bh);
1044
1045         // FIXME: device recovery -- reset?
1046 }
1047 EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
1048
1049 /*-------------------------------------------------------------------------*/
1050
1051 netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1052                                      struct net_device *net)
1053 {
1054         struct usbnet           *dev = netdev_priv(net);
1055         int                     length;
1056         struct urb              *urb = NULL;
1057         struct skb_data         *entry;
1058         struct driver_info      *info = dev->driver_info;
1059         unsigned long           flags;
1060         int retval;
1061
1062         if (skb)
1063                 skb_tx_timestamp(skb);
1064
1065         // some devices want funky USB-level framing, for
1066         // win32 driver (usually) and/or hardware quirks
1067         if (info->tx_fixup) {
1068                 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1069                 if (!skb) {
1070                         if (netif_msg_tx_err(dev)) {
1071                                 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1072                                 goto drop;
1073                         } else {
1074                                 /* cdc_ncm collected packet; waits for more */
1075                                 goto not_drop;
1076                         }
1077                 }
1078         }
1079         length = skb->len;
1080
1081         if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
1082                 netif_dbg(dev, tx_err, dev->net, "no urb\n");
1083                 goto drop;
1084         }
1085
1086         entry = (struct skb_data *) skb->cb;
1087         entry->urb = urb;
1088         entry->dev = dev;
1089         entry->state = tx_start;
1090         entry->length = length;
1091
1092         usb_fill_bulk_urb (urb, dev->udev, dev->out,
1093                         skb->data, skb->len, tx_complete, skb);
1094
1095         /* don't assume the hardware handles USB_ZERO_PACKET
1096          * NOTE:  strictly conforming cdc-ether devices should expect
1097          * the ZLP here, but ignore the one-byte packet.
1098          * NOTE2: CDC NCM specification is different from CDC ECM when
1099          * handling ZLP/short packets, so cdc_ncm driver will make short
1100          * packet itself if needed.
1101          */
1102         if (length % dev->maxpacket == 0) {
1103                 if (!(info->flags & FLAG_SEND_ZLP)) {
1104                         if (!(info->flags & FLAG_MULTI_PACKET)) {
1105                                 urb->transfer_buffer_length++;
1106                                 if (skb_tailroom(skb)) {
1107                                         skb->data[skb->len] = 0;
1108                                         __skb_put(skb, 1);
1109                                 }
1110                         }
1111                 } else
1112                         urb->transfer_flags |= URB_ZERO_PACKET;
1113         }
1114
1115         spin_lock_irqsave(&dev->txq.lock, flags);
1116         retval = usb_autopm_get_interface_async(dev->intf);
1117         if (retval < 0) {
1118                 spin_unlock_irqrestore(&dev->txq.lock, flags);
1119                 goto drop;
1120         }
1121
1122 #ifdef CONFIG_PM
1123         /* if this triggers the device is still a sleep */
1124         if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1125                 /* transmission will be done in resume */
1126                 usb_anchor_urb(urb, &dev->deferred);
1127                 /* no use to process more packets */
1128                 netif_stop_queue(net);
1129                 spin_unlock_irqrestore(&dev->txq.lock, flags);
1130                 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
1131                 goto deferred;
1132         }
1133 #endif
1134
1135         switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1136         case -EPIPE:
1137                 netif_stop_queue (net);
1138                 usbnet_defer_kevent (dev, EVENT_TX_HALT);
1139                 usb_autopm_put_interface_async(dev->intf);
1140                 break;
1141         default:
1142                 usb_autopm_put_interface_async(dev->intf);
1143                 netif_dbg(dev, tx_err, dev->net,
1144                           "tx: submit urb err %d\n", retval);
1145                 break;
1146         case 0:
1147                 net->trans_start = jiffies;
1148                 __skb_queue_tail (&dev->txq, skb);
1149                 if (dev->txq.qlen >= TX_QLEN (dev))
1150                         netif_stop_queue (net);
1151         }
1152         spin_unlock_irqrestore (&dev->txq.lock, flags);
1153
1154         if (retval) {
1155                 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
1156 drop:
1157                 dev->net->stats.tx_dropped++;
1158 not_drop:
1159                 if (skb)
1160                         dev_kfree_skb_any (skb);
1161                 usb_free_urb (urb);
1162         } else
1163                 netif_dbg(dev, tx_queued, dev->net,
1164                           "> tx, len %d, type 0x%x\n", length, skb->protocol);
1165 #ifdef CONFIG_PM
1166 deferred:
1167 #endif
1168         return NETDEV_TX_OK;
1169 }
1170 EXPORT_SYMBOL_GPL(usbnet_start_xmit);
1171
1172 /*-------------------------------------------------------------------------*/
1173
1174 // tasklet (work deferred from completions, in_irq) or timer
1175
1176 static void usbnet_bh (unsigned long param)
1177 {
1178         struct usbnet           *dev = (struct usbnet *) param;
1179         struct sk_buff          *skb;
1180         struct skb_data         *entry;
1181
1182         while ((skb = skb_dequeue (&dev->done))) {
1183                 entry = (struct skb_data *) skb->cb;
1184                 switch (entry->state) {
1185                 case rx_done:
1186                         entry->state = rx_cleanup;
1187                         rx_process (dev, skb);
1188                         continue;
1189                 case tx_done:
1190                 case rx_cleanup:
1191                         usb_free_urb (entry->urb);
1192                         dev_kfree_skb (skb);
1193                         continue;
1194                 default:
1195                         netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
1196                 }
1197         }
1198
1199         // waiting for all pending urbs to complete?
1200         if (dev->wait) {
1201                 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1202                         wake_up (dev->wait);
1203                 }
1204
1205         // or are we maybe short a few urbs?
1206         } else if (netif_running (dev->net) &&
1207                    netif_device_present (dev->net) &&
1208                    !timer_pending (&dev->delay) &&
1209                    !test_bit (EVENT_RX_HALT, &dev->flags)) {
1210                 int     temp = dev->rxq.qlen;
1211                 int     qlen = RX_QLEN (dev);
1212
1213                 if (temp < qlen) {
1214                         struct urb      *urb;
1215                         int             i;
1216
1217                         // don't refill the queue all at once
1218                         for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1219                                 urb = usb_alloc_urb (0, GFP_ATOMIC);
1220                                 if (urb != NULL) {
1221                                         if (rx_submit (dev, urb, GFP_ATOMIC) ==
1222                                             -ENOLINK)
1223                                                 return;
1224                                 }
1225                         }
1226                         if (temp != dev->rxq.qlen)
1227                                 netif_dbg(dev, link, dev->net,
1228                                           "rxqlen %d --> %d\n",
1229                                           temp, dev->rxq.qlen);
1230                         if (dev->rxq.qlen < qlen)
1231                                 tasklet_schedule (&dev->bh);
1232                 }
1233                 if (dev->txq.qlen < TX_QLEN (dev))
1234                         netif_wake_queue (dev->net);
1235         }
1236 }
1237
1238
1239 /*-------------------------------------------------------------------------
1240  *
1241  * USB Device Driver support
1242  *
1243  *-------------------------------------------------------------------------*/
1244
1245 // precondition: never called in_interrupt
1246
1247 void usbnet_disconnect (struct usb_interface *intf)
1248 {
1249         struct usbnet           *dev;
1250         struct usb_device       *xdev;
1251         struct net_device       *net;
1252
1253         dev = usb_get_intfdata(intf);
1254         usb_set_intfdata(intf, NULL);
1255         if (!dev)
1256                 return;
1257
1258         xdev = interface_to_usbdev (intf);
1259
1260         netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1261                    intf->dev.driver->name,
1262                    xdev->bus->bus_name, xdev->devpath,
1263                    dev->driver_info->description);
1264
1265         net = dev->net;
1266         unregister_netdev (net);
1267
1268         cancel_work_sync(&dev->kevent);
1269
1270         if (dev->driver_info->unbind)
1271                 dev->driver_info->unbind (dev, intf);
1272
1273         usb_kill_urb(dev->interrupt);
1274         usb_free_urb(dev->interrupt);
1275
1276         free_netdev(net);
1277         usb_put_dev (xdev);
1278 }
1279 EXPORT_SYMBOL_GPL(usbnet_disconnect);
1280
1281 static const struct net_device_ops usbnet_netdev_ops = {
1282         .ndo_open               = usbnet_open,
1283         .ndo_stop               = usbnet_stop,
1284         .ndo_start_xmit         = usbnet_start_xmit,
1285         .ndo_tx_timeout         = usbnet_tx_timeout,
1286         .ndo_change_mtu         = usbnet_change_mtu,
1287         .ndo_set_mac_address    = eth_mac_addr,
1288         .ndo_validate_addr      = eth_validate_addr,
1289 };
1290
1291 /*-------------------------------------------------------------------------*/
1292
1293 // precondition: never called in_interrupt
1294
1295 static struct device_type wlan_type = {
1296         .name   = "wlan",
1297 };
1298
1299 static struct device_type wwan_type = {
1300         .name   = "wwan",
1301 };
1302
1303 int
1304 usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1305 {
1306         struct usbnet                   *dev;
1307         struct net_device               *net;
1308         struct usb_host_interface       *interface;
1309         struct driver_info              *info;
1310         struct usb_device               *xdev;
1311         int                             status;
1312         const char                      *name;
1313         struct usb_driver       *driver = to_usb_driver(udev->dev.driver);
1314
1315         /* usbnet already took usb runtime pm, so have to enable the feature
1316          * for usb interface, otherwise usb_autopm_get_interface may return
1317          * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1318          */
1319         if (!driver->supports_autosuspend) {
1320                 driver->supports_autosuspend = 1;
1321                 pm_runtime_enable(&udev->dev);
1322         }
1323
1324         name = udev->dev.driver->name;
1325         info = (struct driver_info *) prod->driver_info;
1326         if (!info) {
1327                 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
1328                 return -ENODEV;
1329         }
1330         xdev = interface_to_usbdev (udev);
1331         interface = udev->cur_altsetting;
1332
1333         usb_get_dev (xdev);
1334
1335         status = -ENOMEM;
1336
1337         // set up our own records
1338         net = alloc_etherdev(sizeof(*dev));
1339         if (!net) {
1340                 dbg ("can't kmalloc dev");
1341                 goto out;
1342         }
1343
1344         /* netdev_printk() needs this so do it as early as possible */
1345         SET_NETDEV_DEV(net, &udev->dev);
1346
1347         dev = netdev_priv(net);
1348         dev->udev = xdev;
1349         dev->intf = udev;
1350         dev->driver_info = info;
1351         dev->driver_name = name;
1352         dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1353                                 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1354         skb_queue_head_init (&dev->rxq);
1355         skb_queue_head_init (&dev->txq);
1356         skb_queue_head_init (&dev->done);
1357         skb_queue_head_init(&dev->rxq_pause);
1358         dev->bh.func = usbnet_bh;
1359         dev->bh.data = (unsigned long) dev;
1360         INIT_WORK (&dev->kevent, kevent);
1361         init_usb_anchor(&dev->deferred);
1362         dev->delay.function = usbnet_bh;
1363         dev->delay.data = (unsigned long) dev;
1364         init_timer (&dev->delay);
1365         mutex_init (&dev->phy_mutex);
1366
1367         dev->net = net;
1368         strcpy (net->name, "usb%d");
1369         memcpy (net->dev_addr, node_id, sizeof node_id);
1370
1371         /* rx and tx sides can use different message sizes;
1372          * bind() should set rx_urb_size in that case.
1373          */
1374         dev->hard_mtu = net->mtu + net->hard_header_len;
1375 #if 0
1376 // dma_supported() is deeply broken on almost all architectures
1377         // possible with some EHCI controllers
1378         if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
1379                 net->features |= NETIF_F_HIGHDMA;
1380 #endif
1381
1382         net->netdev_ops = &usbnet_netdev_ops;
1383         net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
1384         net->ethtool_ops = &usbnet_ethtool_ops;
1385
1386         // allow device-specific bind/init procedures
1387         // NOTE net->name still not usable ...
1388         if (info->bind) {
1389                 status = info->bind (dev, udev);
1390                 if (status < 0)
1391                         goto out1;
1392
1393                 // heuristic:  "usb%d" for links we know are two-host,
1394                 // else "eth%d" when there's reasonable doubt.  userspace
1395                 // can rename the link if it knows better.
1396                 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
1397                     ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1398                      (net->dev_addr [0] & 0x02) == 0))
1399                         strcpy (net->name, "eth%d");
1400                 /* WLAN devices should always be named "wlan%d" */
1401                 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1402                         strcpy(net->name, "wlan%d");
1403                 /* WWAN devices should always be named "wwan%d" */
1404                 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1405                         strcpy(net->name, "wwan%d");
1406
1407                 /* maybe the remote can't receive an Ethernet MTU */
1408                 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1409                         net->mtu = dev->hard_mtu - net->hard_header_len;
1410         } else if (!info->in || !info->out)
1411                 status = usbnet_get_endpoints (dev, udev);
1412         else {
1413                 dev->in = usb_rcvbulkpipe (xdev, info->in);
1414                 dev->out = usb_sndbulkpipe (xdev, info->out);
1415                 if (!(info->flags & FLAG_NO_SETINT))
1416                         status = usb_set_interface (xdev,
1417                                 interface->desc.bInterfaceNumber,
1418                                 interface->desc.bAlternateSetting);
1419                 else
1420                         status = 0;
1421
1422         }
1423         if (status >= 0 && dev->status)
1424                 status = init_status (dev, udev);
1425         if (status < 0)
1426                 goto out3;
1427
1428         if (!dev->rx_urb_size)
1429                 dev->rx_urb_size = dev->hard_mtu;
1430         dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
1431
1432         if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1433                 SET_NETDEV_DEVTYPE(net, &wlan_type);
1434         if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1435                 SET_NETDEV_DEVTYPE(net, &wwan_type);
1436
1437         status = register_netdev (net);
1438         if (status)
1439                 goto out3;
1440         netif_info(dev, probe, dev->net,
1441                    "register '%s' at usb-%s-%s, %s, %pM\n",
1442                    udev->dev.driver->name,
1443                    xdev->bus->bus_name, xdev->devpath,
1444                    dev->driver_info->description,
1445                    net->dev_addr);
1446
1447         // ok, it's ready to go.
1448         usb_set_intfdata (udev, dev);
1449
1450         netif_device_attach (net);
1451
1452         if (dev->driver_info->flags & FLAG_LINK_INTR)
1453                 netif_carrier_off(net);
1454
1455         return 0;
1456
1457 out3:
1458         if (info->unbind)
1459                 info->unbind (dev, udev);
1460 out1:
1461         free_netdev(net);
1462 out:
1463         usb_put_dev(xdev);
1464         return status;
1465 }
1466 EXPORT_SYMBOL_GPL(usbnet_probe);
1467
1468 /*-------------------------------------------------------------------------*/
1469
1470 /*
1471  * suspend the whole driver as soon as the first interface is suspended
1472  * resume only when the last interface is resumed
1473  */
1474
1475 int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
1476 {
1477         struct usbnet           *dev = usb_get_intfdata(intf);
1478
1479         if (!dev->suspend_count++) {
1480                 spin_lock_irq(&dev->txq.lock);
1481                 /* don't autosuspend while transmitting */
1482                 if (dev->txq.qlen && PMSG_IS_AUTO(message)) {
1483                         spin_unlock_irq(&dev->txq.lock);
1484                         return -EBUSY;
1485                 } else {
1486                         set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1487                         spin_unlock_irq(&dev->txq.lock);
1488                 }
1489                 /*
1490                  * accelerate emptying of the rx and queues, to avoid
1491                  * having everything error out.
1492                  */
1493                 netif_device_detach (dev->net);
1494                 usbnet_terminate_urbs(dev);
1495                 usb_kill_urb(dev->interrupt);
1496
1497                 /*
1498                  * reattach so runtime management can use and
1499                  * wake the device
1500                  */
1501                 netif_device_attach (dev->net);
1502         }
1503         return 0;
1504 }
1505 EXPORT_SYMBOL_GPL(usbnet_suspend);
1506
1507 int usbnet_resume (struct usb_interface *intf)
1508 {
1509         struct usbnet           *dev = usb_get_intfdata(intf);
1510         struct sk_buff          *skb;
1511         struct urb              *res;
1512         int                     retval;
1513
1514         if (!--dev->suspend_count) {
1515                 /* resume interrupt URBs */
1516                 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1517                         usb_submit_urb(dev->interrupt, GFP_NOIO);
1518
1519                 spin_lock_irq(&dev->txq.lock);
1520                 while ((res = usb_get_from_anchor(&dev->deferred))) {
1521
1522                         skb = (struct sk_buff *)res->context;
1523                         retval = usb_submit_urb(res, GFP_ATOMIC);
1524                         if (retval < 0) {
1525                                 dev_kfree_skb_any(skb);
1526                                 usb_free_urb(res);
1527                                 usb_autopm_put_interface_async(dev->intf);
1528                         } else {
1529                                 dev->net->trans_start = jiffies;
1530                                 __skb_queue_tail(&dev->txq, skb);
1531                         }
1532                 }
1533
1534                 smp_mb();
1535                 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1536                 spin_unlock_irq(&dev->txq.lock);
1537
1538                 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1539                         if (!(dev->txq.qlen >= TX_QLEN(dev)))
1540                                 netif_start_queue(dev->net);
1541                         tasklet_schedule (&dev->bh);
1542                 }
1543         }
1544         return 0;
1545 }
1546 EXPORT_SYMBOL_GPL(usbnet_resume);
1547
1548
1549 /*-------------------------------------------------------------------------*/
1550
1551 static int __init usbnet_init(void)
1552 {
1553         /* Compiler should optimize this out. */
1554         BUILD_BUG_ON(
1555                 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
1556
1557         random_ether_addr(node_id);
1558         return 0;
1559 }
1560 module_init(usbnet_init);
1561
1562 static void __exit usbnet_exit(void)
1563 {
1564 }
1565 module_exit(usbnet_exit);
1566
1567 MODULE_AUTHOR("David Brownell");
1568 MODULE_DESCRIPTION("USB network driver framework");
1569 MODULE_LICENSE("GPL");