blob: c3a756d32f30beaa8adb5b3227035d356ab5b3bb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
David Brownell090ffa92005-08-31 09:54:50 -07002 * USB Network driver infrastructure
David Brownellf29fc252005-08-31 09:52:31 -07003 * Copyright (C) 2000-2005 by David Brownell
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * Copyright (C) 2003-2005 David Hollis <dhollis@davehollis.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
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
David Brownell090ffa92005-08-31 09:54:50 -070023 * kinds of full and high speed networking devices: host-to-host cables,
24 * smart usb peripherals, and actual Ethernet adapters.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 *
David Brownell090ffa92005-08-31 09:54:50 -070026 * 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33// #define DEBUG // error path messages, extra info
34// #define VERBOSE // more; success messages
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/init.h>
38#include <linux/netdevice.h>
39#include <linux/etherdevice.h>
Peter Holik03ad0322009-04-18 07:24:17 +000040#include <linux/ctype.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include <linux/ethtool.h>
42#include <linux/workqueue.h>
43#include <linux/mii.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/usb.h>
Jussi Kivilinna3692e942008-01-26 00:51:45 +020045#include <linux/usb/usbnet.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090046#include <linux/slab.h>
Andy Shevchenkofd1f1702010-07-23 03:18:08 +000047#include <linux/kernel.h>
Ming Leib0786b42010-11-01 07:11:54 -070048#include <linux/pm_runtime.h>
David Brownellf29fc252005-08-31 09:52:31 -070049
50#define DRIVER_VERSION "22-Aug-2005"
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
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).
David Brownellf29fc252005-08-31 09:52:31 -070061 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 */
Jamie Paintera99c1942006-07-27 14:17:28 -040066#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Linus Torvalds1da177e2005-04-16 15:20:36 -070072// 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070079// between wakeups
80#define UNLINK_TIMEOUT_MS 3
81
82/*-------------------------------------------------------------------------*/
83
84// randomly generated ethernet address
85static u8 node_id [ETH_ALEN];
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087static const char driver_name [] = "usbnet";
88
89/* use ethtool to change the level for any given device */
90static int msg_level = -1;
91module_param (msg_level, int, 0);
92MODULE_PARM_DESC (msg_level, "Override default message level");
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094/*-------------------------------------------------------------------------*/
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/* handles CDC Ethernet and many other network "bulk data" interfaces */
David Brownell2e55cc72005-08-31 09:53:10 -070097int usbnet_get_endpoints(struct usbnet *dev, struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098{
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;
Justin P. Mattock70f23fd2011-05-10 10:16:21 +0200112 * ignore other endpoints and altsettings.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 */
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:
Luiz Fernando N. Capitulinofc6e2542006-10-26 13:03:01 -0300121 if (!usb_endpoint_dir_in(&e->desc))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 continue;
123 intr = 1;
124 /* FALLTHROUGH */
125 case USB_ENDPOINT_XFER_BULK:
126 break;
127 default:
128 continue;
129 }
Luiz Fernando N. Capitulinofc6e2542006-10-26 13:03:01 -0300130 if (usb_endpoint_dir_in(&e->desc)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 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
Joe Perches8e95a202009-12-03 07:58:21 +0000146 if (alt->desc.bAlternateSetting != 0 ||
147 !(dev->driver_info->flags & FLAG_NO_SETINT)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 tmp = usb_set_interface (dev->udev, alt->desc.bInterfaceNumber,
149 alt->desc.bAlternateSetting);
150 if (tmp < 0)
151 return tmp;
152 }
David Brownellcb1cebb2007-02-15 18:52:30 -0800153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 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}
David Brownell2e55cc72005-08-31 09:53:10 -0700161EXPORT_SYMBOL_GPL(usbnet_get_endpoints);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Peter Holik03ad0322009-04-18 07:24:17 +0000163int 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] =
Andy Shevchenkofd1f1702010-07-23 03:18:08 +0000178 (hex_to_bin(buf[tmp]) << 4) + hex_to_bin(buf[tmp + 1]);
Peter Holik03ad0322009-04-18 07:24:17 +0000179 return 0;
180}
181EXPORT_SYMBOL_GPL(usbnet_get_ethernet_addr);
182
David Howells7d12e782006-10-05 14:55:46 +0100183static void intr_complete (struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185static 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
Christoph Lametere94b1762006-12-06 20:33:17 -0800204 buf = kmalloc (maxp, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 if (buf) {
Christoph Lametere94b1762006-12-06 20:33:17 -0800206 dev->interrupt = usb_alloc_urb (0, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 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 }
David Brownell18ab4582007-05-25 12:31:32 -0700218 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219}
220
David Brownell2e55cc72005-08-31 09:53:10 -0700221/* 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 */
225void usbnet_skb_return (struct usbnet *dev, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 int status;
228
Jussi Kivilinna7834ddb2009-08-11 22:57:16 +0300229 if (test_bit(EVENT_RX_PAUSED, &dev->flags)) {
230 skb_queue_tail(&dev->rxq_pause, skb);
231 return;
232 }
233
Hemant Kumar37c35e42011-09-14 23:44:19 -0700234 if (!skb->protocol)
235 skb->protocol = eth_type_trans(skb, dev->net);
236
Herbert Xu79638372009-06-29 16:53:28 +0000237 dev->net->stats.rx_packets++;
238 dev->net->stats.rx_bytes += skb->len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Joe Perchesa475f602010-02-17 10:30:24 +0000240 netif_dbg(dev, rx_status, dev->net, "< rx, len %zu, type 0x%x\n",
241 skb->len + sizeof (struct ethhdr), skb->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 memset (skb->cb, 0, sizeof (struct skb_data));
243 status = netif_rx (skb);
Joe Perchesa475f602010-02-17 10:30:24 +0000244 if (status != NET_RX_SUCCESS)
245 netif_dbg(dev, rx_err, dev->net,
246 "netif_rx status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247}
David Brownell2e55cc72005-08-31 09:53:10 -0700248EXPORT_SYMBOL_GPL(usbnet_skb_return);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251/*-------------------------------------------------------------------------
252 *
253 * Network Device Driver (peer link to "Host Device", from USB host)
254 *
255 *-------------------------------------------------------------------------*/
256
Stephen Hemminger777baa42009-03-20 19:35:54 +0000257int usbnet_change_mtu (struct net_device *net, int new_mtu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258{
259 struct usbnet *dev = netdev_priv(net);
David Brownellf29fc252005-08-31 09:52:31 -0700260 int ll_mtu = new_mtu + net->hard_header_len;
Jamie Paintera99c1942006-07-27 14:17:28 -0400261 int old_hard_mtu = dev->hard_mtu;
262 int old_rx_urb_size = dev->rx_urb_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Jamie Paintera99c1942006-07-27 14:17:28 -0400264 if (new_mtu <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 // no second zero-length packet read wanted after mtu-sized packets
David Brownellf29fc252005-08-31 09:52:31 -0700267 if ((ll_mtu % dev->maxpacket) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 return -EDOM;
269 net->mtu = new_mtu;
Jamie Paintera99c1942006-07-27 14:17:28 -0400270
271 dev->hard_mtu = net->mtu + net->hard_header_len;
272 if (dev->rx_urb_size == old_hard_mtu) {
273 dev->rx_urb_size = dev->hard_mtu;
274 if (dev->rx_urb_size > old_rx_urb_size)
275 usbnet_unlink_rx_urbs(dev);
276 }
277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 return 0;
279}
Stephen Hemminger777baa42009-03-20 19:35:54 +0000280EXPORT_SYMBOL_GPL(usbnet_change_mtu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282/*-------------------------------------------------------------------------*/
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/* some LK 2.4 HCDs oopsed if we freed or resubmitted urbs from
285 * completion callbacks. 2.5 should have fixed those bugs...
286 */
287
David S. Miller8728b832005-08-09 19:25:21 -0700288static void defer_bh(struct usbnet *dev, struct sk_buff *skb, struct sk_buff_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 unsigned long flags;
291
David S. Miller8728b832005-08-09 19:25:21 -0700292 spin_lock_irqsave(&list->lock, flags);
293 __skb_unlink(skb, list);
294 spin_unlock(&list->lock);
295 spin_lock(&dev->done.lock);
296 __skb_queue_tail(&dev->done, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 if (dev->done.qlen == 1)
David S. Miller8728b832005-08-09 19:25:21 -0700298 tasklet_schedule(&dev->bh);
299 spin_unlock_irqrestore(&dev->done.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300}
301
302/* some work can't be done in tasklets, so we use keventd
303 *
304 * NOTE: annoying asymmetry: if it's active, schedule_work() fails,
305 * but tasklet_schedule() doesn't. hope the failure is rare.
306 */
David Brownell2e55cc72005-08-31 09:53:10 -0700307void usbnet_defer_kevent (struct usbnet *dev, int work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308{
309 set_bit (work, &dev->flags);
310 if (!schedule_work (&dev->kevent))
Joe Perches60b86752010-02-17 10:30:23 +0000311 netdev_err(dev->net, "kevent %d may have been dropped\n", work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 else
Joe Perches60b86752010-02-17 10:30:23 +0000313 netdev_dbg(dev->net, "kevent %d scheduled\n", work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314}
David Brownell2e55cc72005-08-31 09:53:10 -0700315EXPORT_SYMBOL_GPL(usbnet_defer_kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317/*-------------------------------------------------------------------------*/
318
David Howells7d12e782006-10-05 14:55:46 +0100319static void rx_complete (struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
David S. Millerdacb3972010-08-10 02:50:55 -0700321static int rx_submit (struct usbnet *dev, struct urb *urb, gfp_t flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322{
323 struct sk_buff *skb;
324 struct skb_data *entry;
325 int retval = 0;
326 unsigned long lockflags;
David Brownell2e55cc72005-08-31 09:53:10 -0700327 size_t size = dev->rx_urb_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 if ((skb = alloc_skb (size + NET_IP_ALIGN, flags)) == NULL) {
Joe Perchesa475f602010-02-17 10:30:24 +0000330 netif_dbg(dev, rx_err, dev->net, "no rx skb\n");
David Brownell2e55cc72005-08-31 09:53:10 -0700331 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 usb_free_urb (urb);
David S. Millerdacb3972010-08-10 02:50:55 -0700333 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 }
335 skb_reserve (skb, NET_IP_ALIGN);
336
337 entry = (struct skb_data *) skb->cb;
338 entry->urb = urb;
339 entry->dev = dev;
340 entry->state = rx_start;
341 entry->length = 0;
342
343 usb_fill_bulk_urb (urb, dev->udev, dev->in,
344 skb->data, size, rx_complete, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346 spin_lock_irqsave (&dev->rxq.lock, lockflags);
347
Joe Perches8e95a202009-12-03 07:58:21 +0000348 if (netif_running (dev->net) &&
349 netif_device_present (dev->net) &&
Oliver Neukum69ee4722009-12-03 15:31:18 -0800350 !test_bit (EVENT_RX_HALT, &dev->flags) &&
351 !test_bit (EVENT_DEV_ASLEEP, &dev->flags)) {
David Brownell18ab4582007-05-25 12:31:32 -0700352 switch (retval = usb_submit_urb (urb, GFP_ATOMIC)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 case -EPIPE:
David Brownell2e55cc72005-08-31 09:53:10 -0700354 usbnet_defer_kevent (dev, EVENT_RX_HALT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 break;
356 case -ENOMEM:
David Brownell2e55cc72005-08-31 09:53:10 -0700357 usbnet_defer_kevent (dev, EVENT_RX_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 break;
359 case -ENODEV:
Joe Perchesa475f602010-02-17 10:30:24 +0000360 netif_dbg(dev, ifdown, dev->net, "device gone\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 netif_device_detach (dev->net);
362 break;
David S. Millerdacb3972010-08-10 02:50:55 -0700363 case -EHOSTUNREACH:
364 retval = -ENOLINK;
365 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 default:
Joe Perchesa475f602010-02-17 10:30:24 +0000367 netif_dbg(dev, rx_err, dev->net,
368 "rx submit, %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 tasklet_schedule (&dev->bh);
370 break;
371 case 0:
372 __skb_queue_tail (&dev->rxq, skb);
373 }
374 } else {
Joe Perchesa475f602010-02-17 10:30:24 +0000375 netif_dbg(dev, ifdown, dev->net, "rx: stopped\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 retval = -ENOLINK;
377 }
378 spin_unlock_irqrestore (&dev->rxq.lock, lockflags);
379 if (retval) {
380 dev_kfree_skb_any (skb);
381 usb_free_urb (urb);
382 }
David S. Millerdacb3972010-08-10 02:50:55 -0700383 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384}
385
386
387/*-------------------------------------------------------------------------*/
388
389static inline void rx_process (struct usbnet *dev, struct sk_buff *skb)
390{
Joe Perches8e95a202009-12-03 07:58:21 +0000391 if (dev->driver_info->rx_fixup &&
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000392 !dev->driver_info->rx_fixup (dev, skb)) {
393 /* With RX_ASSEMBLE, rx_fixup() must update counters */
394 if (!(dev->driver_info->flags & FLAG_RX_ASSEMBLE))
395 dev->net->stats.rx_errors++;
396 goto done;
397 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 // else network stack removes extra byte if we forced a short packet
399
Alexey Orishko073285f2010-11-29 23:23:27 +0000400 if (skb->len) {
401 /* all data was already cloned from skb inside the driver */
402 if (dev->driver_info->flags & FLAG_MULTI_PACKET)
403 dev_kfree_skb_any(skb);
404 else
405 usbnet_skb_return(dev, skb);
406 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 }
Alexey Orishko073285f2010-11-29 23:23:27 +0000408
409 netif_dbg(dev, rx_err, dev->net, "drop\n");
Alexey Orishko073285f2010-11-29 23:23:27 +0000410 dev->net->stats.rx_errors++;
Andrzej Zaborowski7a635ea2011-03-28 12:56:33 +0000411done:
Alexey Orishko073285f2010-11-29 23:23:27 +0000412 skb_queue_tail(&dev->done, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413}
414
415/*-------------------------------------------------------------------------*/
416
David Howells7d12e782006-10-05 14:55:46 +0100417static void rx_complete (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
419 struct sk_buff *skb = (struct sk_buff *) urb->context;
420 struct skb_data *entry = (struct skb_data *) skb->cb;
421 struct usbnet *dev = entry->dev;
422 int urb_status = urb->status;
423
424 skb_put (skb, urb->actual_length);
425 entry->state = rx_done;
426 entry->urb = NULL;
427
428 switch (urb_status) {
David Brownell18ab4582007-05-25 12:31:32 -0700429 /* success */
430 case 0:
David Brownellf29fc252005-08-31 09:52:31 -0700431 if (skb->len < dev->net->hard_header_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 entry->state = rx_cleanup;
Herbert Xu79638372009-06-29 16:53:28 +0000433 dev->net->stats.rx_errors++;
434 dev->net->stats.rx_length_errors++;
Joe Perchesa475f602010-02-17 10:30:24 +0000435 netif_dbg(dev, rx_err, dev->net,
436 "rx length %d\n", skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 }
438 break;
439
David Brownell18ab4582007-05-25 12:31:32 -0700440 /* stalls need manual reset. this is rare ... except that
441 * when going through USB 2.0 TTs, unplug appears this way.
Jean Delvare3ac49a12009-06-04 16:20:28 +0200442 * we avoid the highspeed version of the ETIMEDOUT/EILSEQ
David Brownell18ab4582007-05-25 12:31:32 -0700443 * storm, recovering as needed.
444 */
445 case -EPIPE:
Herbert Xu79638372009-06-29 16:53:28 +0000446 dev->net->stats.rx_errors++;
David Brownell2e55cc72005-08-31 09:53:10 -0700447 usbnet_defer_kevent (dev, EVENT_RX_HALT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 // FALLTHROUGH
449
David Brownell18ab4582007-05-25 12:31:32 -0700450 /* software-driven interface shutdown */
451 case -ECONNRESET: /* async unlink */
452 case -ESHUTDOWN: /* hardware gone */
Joe Perchesa475f602010-02-17 10:30:24 +0000453 netif_dbg(dev, ifdown, dev->net,
454 "rx shutdown, code %d\n", urb_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 goto block;
456
David Brownell18ab4582007-05-25 12:31:32 -0700457 /* we get controller i/o faults during khubd disconnect() delays.
458 * throttle down resubmits, to avoid log floods; just temporarily,
459 * so we still recover when the fault isn't a khubd delay.
460 */
461 case -EPROTO:
462 case -ETIME:
463 case -EILSEQ:
Herbert Xu79638372009-06-29 16:53:28 +0000464 dev->net->stats.rx_errors++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 if (!timer_pending (&dev->delay)) {
466 mod_timer (&dev->delay, jiffies + THROTTLE_JIFFIES);
Joe Perchesa475f602010-02-17 10:30:24 +0000467 netif_dbg(dev, link, dev->net,
468 "rx throttle %d\n", urb_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 }
470block:
471 entry->state = rx_cleanup;
472 entry->urb = urb;
473 urb = NULL;
474 break;
475
David Brownell18ab4582007-05-25 12:31:32 -0700476 /* data overrun ... flush fifo? */
477 case -EOVERFLOW:
Herbert Xu79638372009-06-29 16:53:28 +0000478 dev->net->stats.rx_over_errors++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 // FALLTHROUGH
David Brownellcb1cebb2007-02-15 18:52:30 -0800480
David Brownell18ab4582007-05-25 12:31:32 -0700481 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 entry->state = rx_cleanup;
Herbert Xu79638372009-06-29 16:53:28 +0000483 dev->net->stats.rx_errors++;
Joe Perchesa475f602010-02-17 10:30:24 +0000484 netif_dbg(dev, rx_err, dev->net, "rx status %d\n", urb_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 break;
486 }
487
David S. Miller8728b832005-08-09 19:25:21 -0700488 defer_bh(dev, skb, &dev->rxq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490 if (urb) {
Joe Perches8e95a202009-12-03 07:58:21 +0000491 if (netif_running (dev->net) &&
492 !test_bit (EVENT_RX_HALT, &dev->flags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 rx_submit (dev, urb, GFP_ATOMIC);
494 return;
495 }
496 usb_free_urb (urb);
497 }
Joe Perchesa475f602010-02-17 10:30:24 +0000498 netif_dbg(dev, rx_err, dev->net, "no read resubmitted\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499}
500
David Howells7d12e782006-10-05 14:55:46 +0100501static void intr_complete (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502{
503 struct usbnet *dev = urb->context;
504 int status = urb->status;
505
506 switch (status) {
David Brownell18ab4582007-05-25 12:31:32 -0700507 /* success */
508 case 0:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 dev->driver_info->status(dev, urb);
510 break;
511
David Brownell18ab4582007-05-25 12:31:32 -0700512 /* software-driven interface shutdown */
513 case -ENOENT: /* urb killed */
514 case -ESHUTDOWN: /* hardware gone */
Joe Perchesa475f602010-02-17 10:30:24 +0000515 netif_dbg(dev, ifdown, dev->net,
516 "intr shutdown, code %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 return;
518
David Brownell18ab4582007-05-25 12:31:32 -0700519 /* NOTE: not throttling like RX/TX, since this endpoint
520 * already polls infrequently
521 */
522 default:
Joe Perches60b86752010-02-17 10:30:23 +0000523 netdev_dbg(dev->net, "intr status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 break;
525 }
526
527 if (!netif_running (dev->net))
528 return;
529
530 memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
531 status = usb_submit_urb (urb, GFP_ATOMIC);
Joe Perchesa475f602010-02-17 10:30:24 +0000532 if (status != 0)
533 netif_err(dev, timer, dev->net,
534 "intr resubmit --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535}
536
537/*-------------------------------------------------------------------------*/
Jussi Kivilinna7834ddb2009-08-11 22:57:16 +0300538void usbnet_pause_rx(struct usbnet *dev)
539{
540 set_bit(EVENT_RX_PAUSED, &dev->flags);
541
Joe Perchesa475f602010-02-17 10:30:24 +0000542 netif_dbg(dev, rx_status, dev->net, "paused rx queue enabled\n");
Jussi Kivilinna7834ddb2009-08-11 22:57:16 +0300543}
544EXPORT_SYMBOL_GPL(usbnet_pause_rx);
545
546void usbnet_resume_rx(struct usbnet *dev)
547{
548 struct sk_buff *skb;
549 int num = 0;
550
551 clear_bit(EVENT_RX_PAUSED, &dev->flags);
552
553 while ((skb = skb_dequeue(&dev->rxq_pause)) != NULL) {
554 usbnet_skb_return(dev, skb);
555 num++;
556 }
557
558 tasklet_schedule(&dev->bh);
559
Joe Perchesa475f602010-02-17 10:30:24 +0000560 netif_dbg(dev, rx_status, dev->net,
561 "paused rx queue disabled, %d skbs requeued\n", num);
Jussi Kivilinna7834ddb2009-08-11 22:57:16 +0300562}
563EXPORT_SYMBOL_GPL(usbnet_resume_rx);
564
565void usbnet_purge_paused_rxq(struct usbnet *dev)
566{
567 skb_queue_purge(&dev->rxq_pause);
568}
569EXPORT_SYMBOL_GPL(usbnet_purge_paused_rxq);
570
571/*-------------------------------------------------------------------------*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
573// unlink pending rx/tx; completion handlers do all other cleanup
574
575static int unlink_urbs (struct usbnet *dev, struct sk_buff_head *q)
576{
577 unsigned long flags;
578 struct sk_buff *skb, *skbnext;
579 int count = 0;
580
581 spin_lock_irqsave (&q->lock, flags);
David S. Miller83bfba52008-09-22 20:18:47 -0700582 skb_queue_walk_safe(q, skb, skbnext) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 struct skb_data *entry;
584 struct urb *urb;
585 int retval;
586
587 entry = (struct skb_data *) skb->cb;
588 urb = entry->urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
590 // during some PM-driven resume scenarios,
591 // these (async) unlinks complete immediately
592 retval = usb_unlink_urb (urb);
593 if (retval != -EINPROGRESS && retval != 0)
Joe Perches60b86752010-02-17 10:30:23 +0000594 netdev_dbg(dev->net, "unlink urb err, %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 else
596 count++;
597 }
598 spin_unlock_irqrestore (&q->lock, flags);
599 return count;
600}
601
Jamie Paintera99c1942006-07-27 14:17:28 -0400602// Flush all pending rx urbs
603// minidrivers may need to do this when the MTU changes
604
605void usbnet_unlink_rx_urbs(struct usbnet *dev)
606{
607 if (netif_running(dev->net)) {
608 (void) unlink_urbs (dev, &dev->rxq);
609 tasklet_schedule(&dev->bh);
610 }
611}
612EXPORT_SYMBOL_GPL(usbnet_unlink_rx_urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
614/*-------------------------------------------------------------------------*/
615
616// precondition: never called in_interrupt
Oliver Neukum69ee4722009-12-03 15:31:18 -0800617static void usbnet_terminate_urbs(struct usbnet *dev)
618{
619 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(unlink_wakeup);
620 DECLARE_WAITQUEUE(wait, current);
621 int temp;
622
623 /* ensure there are no more active urbs */
624 add_wait_queue(&unlink_wakeup, &wait);
625 set_current_state(TASK_UNINTERRUPTIBLE);
626 dev->wait = &unlink_wakeup;
627 temp = unlink_urbs(dev, &dev->txq) +
628 unlink_urbs(dev, &dev->rxq);
629
630 /* maybe wait for deletions to finish. */
631 while (!skb_queue_empty(&dev->rxq)
632 && !skb_queue_empty(&dev->txq)
633 && !skb_queue_empty(&dev->done)) {
Kulikov Vasiliy66cc42a2010-07-25 22:25:42 +0000634 schedule_timeout(msecs_to_jiffies(UNLINK_TIMEOUT_MS));
Oliver Neukum69ee4722009-12-03 15:31:18 -0800635 set_current_state(TASK_UNINTERRUPTIBLE);
Joe Perchesa475f602010-02-17 10:30:24 +0000636 netif_dbg(dev, ifdown, dev->net,
637 "waited for %d urb completions\n", temp);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800638 }
639 set_current_state(TASK_RUNNING);
640 dev->wait = NULL;
641 remove_wait_queue(&unlink_wakeup, &wait);
642}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Stephen Hemminger777baa42009-03-20 19:35:54 +0000644int usbnet_stop (struct net_device *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
646 struct usbnet *dev = netdev_priv(net);
Jussi Kivilinnaa33e9e72009-06-16 17:17:27 +0300647 struct driver_info *info = dev->driver_info;
Jussi Kivilinnaa33e9e72009-06-16 17:17:27 +0300648 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
Ming Lei75bd0cb2011-04-28 22:37:09 +0000650 clear_bit(EVENT_DEV_OPEN, &dev->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 netif_stop_queue (net);
652
Joe Perchesa475f602010-02-17 10:30:24 +0000653 netif_info(dev, ifdown, dev->net,
Ben Hutchings8ccef432010-06-08 08:20:59 +0000654 "stop stats: rx/tx %lu/%lu, errs %lu/%lu\n",
Joe Perchesa475f602010-02-17 10:30:24 +0000655 net->stats.rx_packets, net->stats.tx_packets,
656 net->stats.rx_errors, net->stats.tx_errors);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Jussi Kivilinnaa33e9e72009-06-16 17:17:27 +0300658 /* allow minidriver to stop correctly (wireless devices to turn off
659 * radio etc) */
660 if (info->stop) {
661 retval = info->stop(dev);
Joe Perchesa475f602010-02-17 10:30:24 +0000662 if (retval < 0)
663 netif_info(dev, ifdown, dev->net,
664 "stop fail (%d) usbnet usb-%s-%s, %s\n",
665 retval,
666 dev->udev->bus->bus_name, dev->udev->devpath,
667 info->description);
Jussi Kivilinnaa33e9e72009-06-16 17:17:27 +0300668 }
669
Oliver Neukum69ee4722009-12-03 15:31:18 -0800670 if (!(info->flags & FLAG_AVOID_UNLINK_URBS))
671 usbnet_terminate_urbs(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
673 usb_kill_urb(dev->interrupt);
674
Jussi Kivilinna7834ddb2009-08-11 22:57:16 +0300675 usbnet_purge_paused_rxq(dev);
676
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 /* deferred work (task, timer, softirq) must also stop.
678 * can't flush_scheduled_work() until we drop rtnl (later),
679 * else workers could deadlock; so make workers a NOP.
680 */
681 dev->flags = 0;
682 del_timer_sync (&dev->delay);
683 tasklet_kill (&dev->bh);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800684 if (info->manage_power)
685 info->manage_power(dev, 0);
686 else
687 usb_autopm_put_interface(dev->intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
689 return 0;
690}
Stephen Hemminger777baa42009-03-20 19:35:54 +0000691EXPORT_SYMBOL_GPL(usbnet_stop);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
693/*-------------------------------------------------------------------------*/
694
695// posts reads, and enables write queuing
696
697// precondition: never called in_interrupt
698
Stephen Hemminger777baa42009-03-20 19:35:54 +0000699int usbnet_open (struct net_device *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700{
701 struct usbnet *dev = netdev_priv(net);
Oliver Neukuma11a6542007-08-03 13:52:19 +0200702 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 struct driver_info *info = dev->driver_info;
704
Oliver Neukuma11a6542007-08-03 13:52:19 +0200705 if ((retval = usb_autopm_get_interface(dev->intf)) < 0) {
Joe Perchesa475f602010-02-17 10:30:24 +0000706 netif_info(dev, ifup, dev->net,
707 "resumption fail (%d) usbnet usb-%s-%s, %s\n",
708 retval,
709 dev->udev->bus->bus_name,
710 dev->udev->devpath,
711 info->description);
Oliver Neukuma11a6542007-08-03 13:52:19 +0200712 goto done_nopm;
713 }
714
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 // put into "known safe" state
716 if (info->reset && (retval = info->reset (dev)) < 0) {
Joe Perchesa475f602010-02-17 10:30:24 +0000717 netif_info(dev, ifup, dev->net,
718 "open reset fail (%d) usbnet usb-%s-%s, %s\n",
719 retval,
720 dev->udev->bus->bus_name,
721 dev->udev->devpath,
722 info->description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 goto done;
724 }
725
726 // insist peer be connected
727 if (info->check_connect && (retval = info->check_connect (dev)) < 0) {
Joe Perchesa475f602010-02-17 10:30:24 +0000728 netif_dbg(dev, ifup, dev->net, "can't open; %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 goto done;
730 }
731
732 /* start any status interrupt transfer */
733 if (dev->interrupt) {
734 retval = usb_submit_urb (dev->interrupt, GFP_KERNEL);
735 if (retval < 0) {
Joe Perchesa475f602010-02-17 10:30:24 +0000736 netif_err(dev, ifup, dev->net,
737 "intr submit %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 goto done;
739 }
740 }
741
Paul Stewart68972ef2011-04-28 05:43:37 +0000742 set_bit(EVENT_DEV_OPEN, &dev->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 netif_start_queue (net);
Joe Perchesa475f602010-02-17 10:30:24 +0000744 netif_info(dev, ifup, dev->net,
745 "open: enable queueing (rx %d, tx %d) mtu %d %s framing\n",
746 (int)RX_QLEN(dev), (int)TX_QLEN(dev),
747 dev->net->mtu,
748 (dev->driver_info->flags & FLAG_FRAMING_NC) ? "NetChip" :
749 (dev->driver_info->flags & FLAG_FRAMING_GL) ? "GeneSys" :
750 (dev->driver_info->flags & FLAG_FRAMING_Z) ? "Zaurus" :
751 (dev->driver_info->flags & FLAG_FRAMING_RN) ? "RNDIS" :
752 (dev->driver_info->flags & FLAG_FRAMING_AX) ? "ASIX" :
753 "simple");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
755 // delay posting reads until we're fully open
756 tasklet_schedule (&dev->bh);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800757 if (info->manage_power) {
758 retval = info->manage_power(dev, 1);
759 if (retval < 0)
760 goto done;
761 usb_autopm_put_interface(dev->intf);
762 }
Oliver Neukuma11a6542007-08-03 13:52:19 +0200763 return retval;
Joe Perchesa475f602010-02-17 10:30:24 +0000764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765done:
Oliver Neukuma11a6542007-08-03 13:52:19 +0200766 usb_autopm_put_interface(dev->intf);
767done_nopm:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 return retval;
769}
Stephen Hemminger777baa42009-03-20 19:35:54 +0000770EXPORT_SYMBOL_GPL(usbnet_open);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
772/*-------------------------------------------------------------------------*/
773
David Brownell2e55cc72005-08-31 09:53:10 -0700774/* ethtool methods; minidrivers may need to add some more, but
775 * they'll probably want to use this base set.
776 */
777
Arnd Bergmannc41286f2006-10-09 00:08:01 +0200778int usbnet_get_settings (struct net_device *net, struct ethtool_cmd *cmd)
779{
780 struct usbnet *dev = netdev_priv(net);
781
782 if (!dev->mii.mdio_read)
783 return -EOPNOTSUPP;
784
785 return mii_ethtool_gset(&dev->mii, cmd);
786}
787EXPORT_SYMBOL_GPL(usbnet_get_settings);
788
789int usbnet_set_settings (struct net_device *net, struct ethtool_cmd *cmd)
790{
791 struct usbnet *dev = netdev_priv(net);
792 int retval;
793
794 if (!dev->mii.mdio_write)
795 return -EOPNOTSUPP;
796
797 retval = mii_ethtool_sset(&dev->mii, cmd);
798
799 /* link speed/duplex might have changed */
800 if (dev->driver_info->link_reset)
801 dev->driver_info->link_reset(dev);
802
803 return retval;
804
805}
806EXPORT_SYMBOL_GPL(usbnet_set_settings);
807
Arnd Bergmannc41286f2006-10-09 00:08:01 +0200808u32 usbnet_get_link (struct net_device *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
810 struct usbnet *dev = netdev_priv(net);
811
David Brownellf29fc252005-08-31 09:52:31 -0700812 /* If a check_connect is defined, return its result */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 if (dev->driver_info->check_connect)
814 return dev->driver_info->check_connect (dev) == 0;
815
Arnd Bergmannc41286f2006-10-09 00:08:01 +0200816 /* if the device has mii operations, use those */
817 if (dev->mii.mdio_read)
818 return mii_link_ok(&dev->mii);
819
Bjørn Mork05ffb3e2009-03-01 20:45:40 -0800820 /* Otherwise, dtrt for drivers calling netif_carrier_{on,off} */
821 return ethtool_op_get_link(net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822}
Arnd Bergmannc41286f2006-10-09 00:08:01 +0200823EXPORT_SYMBOL_GPL(usbnet_get_link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
David Brownell18ee91fa2006-11-02 12:29:12 -0800825int usbnet_nway_reset(struct net_device *net)
826{
827 struct usbnet *dev = netdev_priv(net);
828
829 if (!dev->mii.mdio_write)
830 return -EOPNOTSUPP;
831
832 return mii_nway_restart(&dev->mii);
833}
834EXPORT_SYMBOL_GPL(usbnet_nway_reset);
835
David Brownell18ee91fa2006-11-02 12:29:12 -0800836void usbnet_get_drvinfo (struct net_device *net, struct ethtool_drvinfo *info)
837{
838 struct usbnet *dev = netdev_priv(net);
839
David Brownell296c0242007-04-17 16:10:10 -0700840 strncpy (info->driver, dev->driver_name, sizeof info->driver);
David Brownell18ee91fa2006-11-02 12:29:12 -0800841 strncpy (info->version, DRIVER_VERSION, sizeof info->version);
842 strncpy (info->fw_version, dev->driver_info->description,
843 sizeof info->fw_version);
844 usb_make_path (dev->udev, info->bus_info, sizeof info->bus_info);
845}
846EXPORT_SYMBOL_GPL(usbnet_get_drvinfo);
847
David Brownell2e55cc72005-08-31 09:53:10 -0700848u32 usbnet_get_msglevel (struct net_device *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
850 struct usbnet *dev = netdev_priv(net);
851
852 return dev->msg_enable;
853}
David Brownell2e55cc72005-08-31 09:53:10 -0700854EXPORT_SYMBOL_GPL(usbnet_get_msglevel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
David Brownell2e55cc72005-08-31 09:53:10 -0700856void usbnet_set_msglevel (struct net_device *net, u32 level)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857{
858 struct usbnet *dev = netdev_priv(net);
859
860 dev->msg_enable = level;
861}
David Brownell2e55cc72005-08-31 09:53:10 -0700862EXPORT_SYMBOL_GPL(usbnet_set_msglevel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
David Brownell2e55cc72005-08-31 09:53:10 -0700864/* drivers may override default ethtool_ops in their bind() routine */
Stephen Hemminger0fc0b732009-09-02 01:03:33 -0700865static const struct ethtool_ops usbnet_ethtool_ops = {
Arnd Bergmannc41286f2006-10-09 00:08:01 +0200866 .get_settings = usbnet_get_settings,
867 .set_settings = usbnet_set_settings,
David Brownell2e55cc72005-08-31 09:53:10 -0700868 .get_link = usbnet_get_link,
Arnd Bergmannc41286f2006-10-09 00:08:01 +0200869 .nway_reset = usbnet_nway_reset,
David Brownell18ee91fa2006-11-02 12:29:12 -0800870 .get_drvinfo = usbnet_get_drvinfo,
David Brownell2e55cc72005-08-31 09:53:10 -0700871 .get_msglevel = usbnet_get_msglevel,
872 .set_msglevel = usbnet_set_msglevel,
873};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875/*-------------------------------------------------------------------------*/
876
877/* work that cannot be done in interrupt context uses keventd.
878 *
879 * NOTE: with 2.5 we could do more of this using completion callbacks,
880 * especially now that control transfers can be queued.
881 */
882static void
David Howellsc4028952006-11-22 14:57:56 +0000883kevent (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884{
David Howellsc4028952006-11-22 14:57:56 +0000885 struct usbnet *dev =
886 container_of(work, struct usbnet, kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 int status;
888
889 /* usb_clear_halt() needs a thread context */
890 if (test_bit (EVENT_TX_HALT, &dev->flags)) {
891 unlink_urbs (dev, &dev->txq);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800892 status = usb_autopm_get_interface(dev->intf);
893 if (status < 0)
894 goto fail_pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 status = usb_clear_halt (dev->udev, dev->out);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800896 usb_autopm_put_interface(dev->intf);
Joe Perches8e95a202009-12-03 07:58:21 +0000897 if (status < 0 &&
898 status != -EPIPE &&
899 status != -ESHUTDOWN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 if (netif_msg_tx_err (dev))
Oliver Neukum69ee4722009-12-03 15:31:18 -0800901fail_pipe:
Joe Perches60b86752010-02-17 10:30:23 +0000902 netdev_err(dev->net, "can't clear tx halt, status %d\n",
903 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 } else {
905 clear_bit (EVENT_TX_HALT, &dev->flags);
David Brownellf29fc252005-08-31 09:52:31 -0700906 if (status != -ESHUTDOWN)
907 netif_wake_queue (dev->net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 }
909 }
910 if (test_bit (EVENT_RX_HALT, &dev->flags)) {
911 unlink_urbs (dev, &dev->rxq);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800912 status = usb_autopm_get_interface(dev->intf);
913 if (status < 0)
914 goto fail_halt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 status = usb_clear_halt (dev->udev, dev->in);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800916 usb_autopm_put_interface(dev->intf);
Joe Perches8e95a202009-12-03 07:58:21 +0000917 if (status < 0 &&
918 status != -EPIPE &&
919 status != -ESHUTDOWN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 if (netif_msg_rx_err (dev))
Oliver Neukum69ee4722009-12-03 15:31:18 -0800921fail_halt:
Joe Perches60b86752010-02-17 10:30:23 +0000922 netdev_err(dev->net, "can't clear rx halt, status %d\n",
923 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 } else {
925 clear_bit (EVENT_RX_HALT, &dev->flags);
926 tasklet_schedule (&dev->bh);
927 }
928 }
929
930 /* tasklet could resubmit itself forever if memory is tight */
931 if (test_bit (EVENT_RX_MEMORY, &dev->flags)) {
932 struct urb *urb = NULL;
David S. Millerdacb3972010-08-10 02:50:55 -0700933 int resched = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
935 if (netif_running (dev->net))
936 urb = usb_alloc_urb (0, GFP_KERNEL);
937 else
938 clear_bit (EVENT_RX_MEMORY, &dev->flags);
939 if (urb != NULL) {
940 clear_bit (EVENT_RX_MEMORY, &dev->flags);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800941 status = usb_autopm_get_interface(dev->intf);
Jesper Juhlab607072011-02-10 10:58:45 +0000942 if (status < 0) {
943 usb_free_urb(urb);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800944 goto fail_lowmem;
Jesper Juhlab607072011-02-10 10:58:45 +0000945 }
David S. Millerdacb3972010-08-10 02:50:55 -0700946 if (rx_submit (dev, urb, GFP_KERNEL) == -ENOLINK)
947 resched = 0;
Oliver Neukum69ee4722009-12-03 15:31:18 -0800948 usb_autopm_put_interface(dev->intf);
949fail_lowmem:
David S. Millerdacb3972010-08-10 02:50:55 -0700950 if (resched)
951 tasklet_schedule (&dev->bh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 }
953 }
954
David Hollis7ea13c92005-04-22 15:07:02 -0700955 if (test_bit (EVENT_LINK_RESET, &dev->flags)) {
David Brownellcb1cebb2007-02-15 18:52:30 -0800956 struct driver_info *info = dev->driver_info;
David Hollis7ea13c92005-04-22 15:07:02 -0700957 int retval = 0;
958
959 clear_bit (EVENT_LINK_RESET, &dev->flags);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800960 status = usb_autopm_get_interface(dev->intf);
961 if (status < 0)
962 goto skip_reset;
David Hollis7ea13c92005-04-22 15:07:02 -0700963 if(info->link_reset && (retval = info->link_reset(dev)) < 0) {
Oliver Neukum69ee4722009-12-03 15:31:18 -0800964 usb_autopm_put_interface(dev->intf);
965skip_reset:
Joe Perches60b86752010-02-17 10:30:23 +0000966 netdev_info(dev->net, "link reset failed (%d) usbnet usb-%s-%s, %s\n",
967 retval,
968 dev->udev->bus->bus_name,
969 dev->udev->devpath,
970 info->description);
Oliver Neukum69ee4722009-12-03 15:31:18 -0800971 } else {
972 usb_autopm_put_interface(dev->intf);
David Hollis7ea13c92005-04-22 15:07:02 -0700973 }
974 }
975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 if (dev->flags)
Joe Perches60b86752010-02-17 10:30:23 +0000977 netdev_dbg(dev->net, "kevent done, flags = 0x%lx\n", dev->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978}
979
980/*-------------------------------------------------------------------------*/
981
David Howells7d12e782006-10-05 14:55:46 +0100982static void tx_complete (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983{
984 struct sk_buff *skb = (struct sk_buff *) urb->context;
985 struct skb_data *entry = (struct skb_data *) skb->cb;
986 struct usbnet *dev = entry->dev;
987
988 if (urb->status == 0) {
Alexey Orishko073285f2010-11-29 23:23:27 +0000989 if (!(dev->driver_info->flags & FLAG_MULTI_PACKET))
990 dev->net->stats.tx_packets++;
Herbert Xu79638372009-06-29 16:53:28 +0000991 dev->net->stats.tx_bytes += entry->length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 } else {
Herbert Xu79638372009-06-29 16:53:28 +0000993 dev->net->stats.tx_errors++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
995 switch (urb->status) {
996 case -EPIPE:
David Brownell2e55cc72005-08-31 09:53:10 -0700997 usbnet_defer_kevent (dev, EVENT_TX_HALT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 break;
999
1000 /* software-driven interface shutdown */
1001 case -ECONNRESET: // async unlink
1002 case -ESHUTDOWN: // hardware gone
1003 break;
1004
1005 // like rx, tx gets controller i/o faults during khubd delays
1006 // and so it uses the same throttling mechanism.
Pete Zaitcev38e2bfc2006-09-18 22:49:02 -07001007 case -EPROTO:
1008 case -ETIME:
1009 case -EILSEQ:
Oliver Neukum69ee4722009-12-03 15:31:18 -08001010 usb_mark_last_busy(dev->udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 if (!timer_pending (&dev->delay)) {
1012 mod_timer (&dev->delay,
1013 jiffies + THROTTLE_JIFFIES);
Joe Perchesa475f602010-02-17 10:30:24 +00001014 netif_dbg(dev, link, dev->net,
1015 "tx throttle %d\n", urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 }
1017 netif_stop_queue (dev->net);
1018 break;
1019 default:
Joe Perchesa475f602010-02-17 10:30:24 +00001020 netif_dbg(dev, tx_err, dev->net,
1021 "tx err %d\n", entry->urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 break;
1023 }
1024 }
1025
Oliver Neukum69ee4722009-12-03 15:31:18 -08001026 usb_autopm_put_interface_async(dev->intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 urb->dev = NULL;
1028 entry->state = tx_done;
David S. Miller8728b832005-08-09 19:25:21 -07001029 defer_bh(dev, skb, &dev->txq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030}
1031
1032/*-------------------------------------------------------------------------*/
1033
Stephen Hemminger777baa42009-03-20 19:35:54 +00001034void usbnet_tx_timeout (struct net_device *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035{
1036 struct usbnet *dev = netdev_priv(net);
1037
1038 unlink_urbs (dev, &dev->txq);
1039 tasklet_schedule (&dev->bh);
1040
1041 // FIXME: device recovery -- reset?
1042}
Stephen Hemminger777baa42009-03-20 19:35:54 +00001043EXPORT_SYMBOL_GPL(usbnet_tx_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
1045/*-------------------------------------------------------------------------*/
1046
Stephen Hemminger25a79c42009-08-31 19:50:45 +00001047netdev_tx_t usbnet_start_xmit (struct sk_buff *skb,
1048 struct net_device *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049{
1050 struct usbnet *dev = netdev_priv(net);
1051 int length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 struct urb *urb = NULL;
1053 struct skb_data *entry;
1054 struct driver_info *info = dev->driver_info;
1055 unsigned long flags;
Stephen Hemminger25a79c42009-08-31 19:50:45 +00001056 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
1058 // some devices want funky USB-level framing, for
1059 // win32 driver (usually) and/or hardware quirks
1060 if (info->tx_fixup) {
1061 skb = info->tx_fixup (dev, skb, GFP_ATOMIC);
1062 if (!skb) {
Alexey Orishko073285f2010-11-29 23:23:27 +00001063 if (netif_msg_tx_err(dev)) {
1064 netif_dbg(dev, tx_err, dev->net, "can't tx_fixup skb\n");
1065 goto drop;
1066 } else {
1067 /* cdc_ncm collected packet; waits for more */
1068 goto not_drop;
1069 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 }
1071 }
1072 length = skb->len;
1073
1074 if (!(urb = usb_alloc_urb (0, GFP_ATOMIC))) {
Joe Perchesa475f602010-02-17 10:30:24 +00001075 netif_dbg(dev, tx_err, dev->net, "no urb\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 goto drop;
1077 }
1078
1079 entry = (struct skb_data *) skb->cb;
1080 entry->urb = urb;
1081 entry->dev = dev;
1082 entry->state = tx_start;
1083 entry->length = length;
1084
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 usb_fill_bulk_urb (urb, dev->udev, dev->out,
1086 skb->data, skb->len, tx_complete, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087
1088 /* don't assume the hardware handles USB_ZERO_PACKET
1089 * NOTE: strictly conforming cdc-ether devices should expect
1090 * the ZLP here, but ignore the one-byte packet.
Alexey Orishko073285f2010-11-29 23:23:27 +00001091 * NOTE2: CDC NCM specification is different from CDC ECM when
1092 * handling ZLP/short packets, so cdc_ncm driver will make short
1093 * packet itself if needed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 */
Elina Pashevab4d562e2010-04-06 14:23:07 +00001095 if (length % dev->maxpacket == 0) {
1096 if (!(info->flags & FLAG_SEND_ZLP)) {
Alexey Orishko073285f2010-11-29 23:23:27 +00001097 if (!(info->flags & FLAG_MULTI_PACKET)) {
1098 urb->transfer_buffer_length++;
1099 if (skb_tailroom(skb)) {
1100 skb->data[skb->len] = 0;
1101 __skb_put(skb, 1);
1102 }
Elina Pashevab4d562e2010-04-06 14:23:07 +00001103 }
1104 } else
1105 urb->transfer_flags |= URB_ZERO_PACKET;
Peter Korsgaard3e323f32007-06-27 08:48:15 +02001106 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107
Oliver Neukum69ee4722009-12-03 15:31:18 -08001108 spin_lock_irqsave(&dev->txq.lock, flags);
1109 retval = usb_autopm_get_interface_async(dev->intf);
1110 if (retval < 0) {
1111 spin_unlock_irqrestore(&dev->txq.lock, flags);
1112 goto drop;
1113 }
1114
1115#ifdef CONFIG_PM
1116 /* if this triggers the device is still a sleep */
1117 if (test_bit(EVENT_DEV_ASLEEP, &dev->flags)) {
1118 /* transmission will be done in resume */
1119 usb_anchor_urb(urb, &dev->deferred);
1120 /* no use to process more packets */
1121 netif_stop_queue(net);
1122 spin_unlock_irqrestore(&dev->txq.lock, flags);
Joe Perches60b86752010-02-17 10:30:23 +00001123 netdev_dbg(dev->net, "Delaying transmission for resumption\n");
Oliver Neukum69ee4722009-12-03 15:31:18 -08001124 goto deferred;
1125 }
1126#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 switch ((retval = usb_submit_urb (urb, GFP_ATOMIC))) {
1129 case -EPIPE:
1130 netif_stop_queue (net);
David Brownell2e55cc72005-08-31 09:53:10 -07001131 usbnet_defer_kevent (dev, EVENT_TX_HALT);
Oliver Neukum69ee4722009-12-03 15:31:18 -08001132 usb_autopm_put_interface_async(dev->intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 break;
1134 default:
Oliver Neukum69ee4722009-12-03 15:31:18 -08001135 usb_autopm_put_interface_async(dev->intf);
Joe Perchesa475f602010-02-17 10:30:24 +00001136 netif_dbg(dev, tx_err, dev->net,
1137 "tx: submit urb err %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 break;
1139 case 0:
1140 net->trans_start = jiffies;
1141 __skb_queue_tail (&dev->txq, skb);
1142 if (dev->txq.qlen >= TX_QLEN (dev))
1143 netif_stop_queue (net);
1144 }
1145 spin_unlock_irqrestore (&dev->txq.lock, flags);
1146
1147 if (retval) {
Joe Perchesa475f602010-02-17 10:30:24 +00001148 netif_dbg(dev, tx_err, dev->net, "drop, code %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149drop:
Herbert Xu79638372009-06-29 16:53:28 +00001150 dev->net->stats.tx_dropped++;
Alexey Orishko073285f2010-11-29 23:23:27 +00001151not_drop:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 if (skb)
1153 dev_kfree_skb_any (skb);
1154 usb_free_urb (urb);
Joe Perchesa475f602010-02-17 10:30:24 +00001155 } else
1156 netif_dbg(dev, tx_queued, dev->net,
1157 "> tx, len %d, type 0x%x\n", length, skb->protocol);
Oliver Neukum69ee4722009-12-03 15:31:18 -08001158#ifdef CONFIG_PM
1159deferred:
1160#endif
Stephen Hemminger25a79c42009-08-31 19:50:45 +00001161 return NETDEV_TX_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162}
Stephen Hemminger777baa42009-03-20 19:35:54 +00001163EXPORT_SYMBOL_GPL(usbnet_start_xmit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164
1165/*-------------------------------------------------------------------------*/
1166
1167// tasklet (work deferred from completions, in_irq) or timer
1168
1169static void usbnet_bh (unsigned long param)
1170{
1171 struct usbnet *dev = (struct usbnet *) param;
1172 struct sk_buff *skb;
1173 struct skb_data *entry;
1174
1175 while ((skb = skb_dequeue (&dev->done))) {
1176 entry = (struct skb_data *) skb->cb;
1177 switch (entry->state) {
David Brownell18ab4582007-05-25 12:31:32 -07001178 case rx_done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 entry->state = rx_cleanup;
1180 rx_process (dev, skb);
1181 continue;
David Brownell18ab4582007-05-25 12:31:32 -07001182 case tx_done:
1183 case rx_cleanup:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 usb_free_urb (entry->urb);
1185 dev_kfree_skb (skb);
1186 continue;
David Brownell18ab4582007-05-25 12:31:32 -07001187 default:
Joe Perches60b86752010-02-17 10:30:23 +00001188 netdev_dbg(dev->net, "bogus skb state %d\n", entry->state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 }
1190 }
1191
1192 // waiting for all pending urbs to complete?
1193 if (dev->wait) {
1194 if ((dev->txq.qlen + dev->rxq.qlen + dev->done.qlen) == 0) {
1195 wake_up (dev->wait);
1196 }
1197
1198 // or are we maybe short a few urbs?
Joe Perches8e95a202009-12-03 07:58:21 +00001199 } else if (netif_running (dev->net) &&
1200 netif_device_present (dev->net) &&
1201 !timer_pending (&dev->delay) &&
1202 !test_bit (EVENT_RX_HALT, &dev->flags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 int temp = dev->rxq.qlen;
1204 int qlen = RX_QLEN (dev);
1205
1206 if (temp < qlen) {
1207 struct urb *urb;
1208 int i;
1209
1210 // don't refill the queue all at once
1211 for (i = 0; i < 10 && dev->rxq.qlen < qlen; i++) {
1212 urb = usb_alloc_urb (0, GFP_ATOMIC);
David S. Millerdacb3972010-08-10 02:50:55 -07001213 if (urb != NULL) {
1214 if (rx_submit (dev, urb, GFP_ATOMIC) ==
1215 -ENOLINK)
1216 return;
1217 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 }
Joe Perchesa475f602010-02-17 10:30:24 +00001219 if (temp != dev->rxq.qlen)
1220 netif_dbg(dev, link, dev->net,
1221 "rxqlen %d --> %d\n",
1222 temp, dev->rxq.qlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 if (dev->rxq.qlen < qlen)
1224 tasklet_schedule (&dev->bh);
1225 }
1226 if (dev->txq.qlen < TX_QLEN (dev))
1227 netif_wake_queue (dev->net);
1228 }
1229}
1230
1231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232/*-------------------------------------------------------------------------
1233 *
1234 * USB Device Driver support
1235 *
1236 *-------------------------------------------------------------------------*/
David Brownellcb1cebb2007-02-15 18:52:30 -08001237
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238// precondition: never called in_interrupt
1239
David Brownell38bde1d2005-08-31 09:52:45 -07001240void usbnet_disconnect (struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241{
1242 struct usbnet *dev;
1243 struct usb_device *xdev;
1244 struct net_device *net;
1245
1246 dev = usb_get_intfdata(intf);
1247 usb_set_intfdata(intf, NULL);
1248 if (!dev)
1249 return;
1250
1251 xdev = interface_to_usbdev (intf);
1252
Joe Perchesa475f602010-02-17 10:30:24 +00001253 netif_info(dev, probe, dev->net, "unregister '%s' usb-%s-%s, %s\n",
1254 intf->dev.driver->name,
1255 xdev->bus->bus_name, xdev->devpath,
1256 dev->driver_info->description);
David Brownellcb1cebb2007-02-15 18:52:30 -08001257
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 net = dev->net;
1259 unregister_netdev (net);
1260
Tejun Heo23f333a2010-12-12 16:45:14 +01001261 cancel_work_sync(&dev->kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262
1263 if (dev->driver_info->unbind)
1264 dev->driver_info->unbind (dev, intf);
1265
Paul Stewart68972ef2011-04-28 05:43:37 +00001266 usb_kill_urb(dev->interrupt);
1267 usb_free_urb(dev->interrupt);
1268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 free_netdev(net);
1270 usb_put_dev (xdev);
1271}
David Brownell38bde1d2005-08-31 09:52:45 -07001272EXPORT_SYMBOL_GPL(usbnet_disconnect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Stephen Hemminger777baa42009-03-20 19:35:54 +00001274static const struct net_device_ops usbnet_netdev_ops = {
1275 .ndo_open = usbnet_open,
1276 .ndo_stop = usbnet_stop,
1277 .ndo_start_xmit = usbnet_start_xmit,
1278 .ndo_tx_timeout = usbnet_tx_timeout,
1279 .ndo_change_mtu = usbnet_change_mtu,
1280 .ndo_set_mac_address = eth_mac_addr,
1281 .ndo_validate_addr = eth_validate_addr,
1282};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
1284/*-------------------------------------------------------------------------*/
1285
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286// precondition: never called in_interrupt
1287
Marcel Holtmann225794f2009-10-02 05:15:26 +00001288static struct device_type wlan_type = {
1289 .name = "wlan",
1290};
1291
1292static struct device_type wwan_type = {
1293 .name = "wwan",
1294};
1295
David Brownell38bde1d2005-08-31 09:52:45 -07001296int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297usbnet_probe (struct usb_interface *udev, const struct usb_device_id *prod)
1298{
1299 struct usbnet *dev;
David Brownellcb1cebb2007-02-15 18:52:30 -08001300 struct net_device *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 struct usb_host_interface *interface;
1302 struct driver_info *info;
1303 struct usb_device *xdev;
1304 int status;
David Brownell296c0242007-04-17 16:10:10 -07001305 const char *name;
Ming Leib0786b42010-11-01 07:11:54 -07001306 struct usb_driver *driver = to_usb_driver(udev->dev.driver);
1307
1308 /* usbnet already took usb runtime pm, so have to enable the feature
1309 * for usb interface, otherwise usb_autopm_get_interface may return
1310 * failure if USB_SUSPEND(RUNTIME_PM) is enabled.
1311 */
1312 if (!driver->supports_autosuspend) {
1313 driver->supports_autosuspend = 1;
1314 pm_runtime_enable(&udev->dev);
1315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
David Brownell296c0242007-04-17 16:10:10 -07001317 name = udev->dev.driver->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 info = (struct driver_info *) prod->driver_info;
1319 if (!info) {
David Brownell296c0242007-04-17 16:10:10 -07001320 dev_dbg (&udev->dev, "blacklisted by %s\n", name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 return -ENODEV;
1322 }
1323 xdev = interface_to_usbdev (udev);
1324 interface = udev->cur_altsetting;
1325
1326 usb_get_dev (xdev);
1327
1328 status = -ENOMEM;
1329
1330 // set up our own records
1331 net = alloc_etherdev(sizeof(*dev));
1332 if (!net) {
1333 dbg ("can't kmalloc dev");
1334 goto out;
1335 }
1336
Ben Hutchings0dacca72010-07-02 21:49:02 -07001337 /* netdev_printk() needs this so do it as early as possible */
1338 SET_NETDEV_DEV(net, &udev->dev);
1339
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 dev = netdev_priv(net);
1341 dev->udev = xdev;
Oliver Neukuma11a6542007-08-03 13:52:19 +02001342 dev->intf = udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 dev->driver_info = info;
David Brownell296c0242007-04-17 16:10:10 -07001344 dev->driver_name = name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 dev->msg_enable = netif_msg_init (msg_level, NETIF_MSG_DRV
1346 | NETIF_MSG_PROBE | NETIF_MSG_LINK);
1347 skb_queue_head_init (&dev->rxq);
1348 skb_queue_head_init (&dev->txq);
1349 skb_queue_head_init (&dev->done);
Jussi Kivilinna7834ddb2009-08-11 22:57:16 +03001350 skb_queue_head_init(&dev->rxq_pause);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 dev->bh.func = usbnet_bh;
1352 dev->bh.data = (unsigned long) dev;
David Howellsc4028952006-11-22 14:57:56 +00001353 INIT_WORK (&dev->kevent, kevent);
Oliver Neukum69ee4722009-12-03 15:31:18 -08001354 init_usb_anchor(&dev->deferred);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 dev->delay.function = usbnet_bh;
1356 dev->delay.data = (unsigned long) dev;
1357 init_timer (&dev->delay);
Arnd Bergmanna9fc6332006-10-09 00:08:02 +02001358 mutex_init (&dev->phy_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 dev->net = net;
1361 strcpy (net->name, "usb%d");
1362 memcpy (net->dev_addr, node_id, sizeof node_id);
1363
David Brownell2e55cc72005-08-31 09:53:10 -07001364 /* rx and tx sides can use different message sizes;
1365 * bind() should set rx_urb_size in that case.
1366 */
1367 dev->hard_mtu = net->mtu + net->hard_header_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368#if 0
1369// dma_supported() is deeply broken on almost all architectures
1370 // possible with some EHCI controllers
Yang Hongyang6a355282009-04-06 19:01:13 -07001371 if (dma_supported (&udev->dev, DMA_BIT_MASK(64)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 net->features |= NETIF_F_HIGHDMA;
1373#endif
1374
Stephen Hemminger777baa42009-03-20 19:35:54 +00001375 net->netdev_ops = &usbnet_netdev_ops;
Stephen Hemminger777baa42009-03-20 19:35:54 +00001376 net->watchdog_timeo = TX_TIMEOUT_JIFFIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 net->ethtool_ops = &usbnet_ethtool_ops;
1378
1379 // allow device-specific bind/init procedures
1380 // NOTE net->name still not usable ...
1381 if (info->bind) {
1382 status = info->bind (dev, udev);
David Brownellcb1cebb2007-02-15 18:52:30 -08001383 if (status < 0)
1384 goto out1;
1385
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 // heuristic: "usb%d" for links we know are two-host,
1387 // else "eth%d" when there's reasonable doubt. userspace
1388 // can rename the link if it knows better.
Joe Perches8e95a202009-12-03 07:58:21 +00001389 if ((dev->driver_info->flags & FLAG_ETHER) != 0 &&
Arnd Bergmannc2613442011-04-01 20:12:02 -07001390 ((dev->driver_info->flags & FLAG_POINTTOPOINT) == 0 ||
1391 (net->dev_addr [0] & 0x02) == 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 strcpy (net->name, "eth%d");
Jussi Kivilinna6e3bbcc2008-01-26 00:51:06 +02001393 /* WLAN devices should always be named "wlan%d" */
1394 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1395 strcpy(net->name, "wlan%d");
Marcel Holtmanne1e499e2009-10-02 05:15:25 +00001396 /* WWAN devices should always be named "wwan%d" */
1397 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1398 strcpy(net->name, "wwan%d");
David Brownellf29fc252005-08-31 09:52:31 -07001399
1400 /* maybe the remote can't receive an Ethernet MTU */
1401 if (net->mtu > (dev->hard_mtu - net->hard_header_len))
1402 net->mtu = dev->hard_mtu - net->hard_header_len;
David Brownell2e55cc72005-08-31 09:53:10 -07001403 } else if (!info->in || !info->out)
1404 status = usbnet_get_endpoints (dev, udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 else {
1406 dev->in = usb_rcvbulkpipe (xdev, info->in);
1407 dev->out = usb_sndbulkpipe (xdev, info->out);
1408 if (!(info->flags & FLAG_NO_SETINT))
1409 status = usb_set_interface (xdev,
1410 interface->desc.bInterfaceNumber,
1411 interface->desc.bAlternateSetting);
1412 else
1413 status = 0;
1414
1415 }
Peter Korsgaard9514bfe2007-07-03 00:46:42 +02001416 if (status >= 0 && dev->status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 status = init_status (dev, udev);
1418 if (status < 0)
David Brownellcb1cebb2007-02-15 18:52:30 -08001419 goto out3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
David Brownell2e55cc72005-08-31 09:53:10 -07001421 if (!dev->rx_urb_size)
1422 dev->rx_urb_size = dev->hard_mtu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 dev->maxpacket = usb_maxpacket (dev->udev, dev->out, 1);
David Brownellcb1cebb2007-02-15 18:52:30 -08001424
Marcel Holtmann225794f2009-10-02 05:15:26 +00001425 if ((dev->driver_info->flags & FLAG_WLAN) != 0)
1426 SET_NETDEV_DEVTYPE(net, &wlan_type);
1427 if ((dev->driver_info->flags & FLAG_WWAN) != 0)
1428 SET_NETDEV_DEVTYPE(net, &wwan_type);
1429
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 status = register_netdev (net);
1431 if (status)
1432 goto out3;
Joe Perchesa475f602010-02-17 10:30:24 +00001433 netif_info(dev, probe, dev->net,
1434 "register '%s' at usb-%s-%s, %s, %pM\n",
1435 udev->dev.driver->name,
1436 xdev->bus->bus_name, xdev->devpath,
1437 dev->driver_info->description,
1438 net->dev_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
1440 // ok, it's ready to go.
1441 usb_set_intfdata (udev, dev);
1442
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 netif_device_attach (net);
1444
Ben Hutchings37e82732009-11-04 15:29:52 +00001445 if (dev->driver_info->flags & FLAG_LINK_INTR)
1446 netif_carrier_off(net);
1447
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 return 0;
1449
1450out3:
1451 if (info->unbind)
1452 info->unbind (dev, udev);
1453out1:
1454 free_netdev(net);
1455out:
1456 usb_put_dev(xdev);
1457 return status;
1458}
David Brownell38bde1d2005-08-31 09:52:45 -07001459EXPORT_SYMBOL_GPL(usbnet_probe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
1461/*-------------------------------------------------------------------------*/
1462
Oliver Neukum36433122007-04-30 01:37:44 -07001463/*
1464 * suspend the whole driver as soon as the first interface is suspended
1465 * resume only when the last interface is resumed
David Brownell38bde1d2005-08-31 09:52:45 -07001466 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
David Brownell38bde1d2005-08-31 09:52:45 -07001468int usbnet_suspend (struct usb_interface *intf, pm_message_t message)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469{
1470 struct usbnet *dev = usb_get_intfdata(intf);
David Brownellcb1cebb2007-02-15 18:52:30 -08001471
Oliver Neukum36433122007-04-30 01:37:44 -07001472 if (!dev->suspend_count++) {
Oliver Neukum69ee4722009-12-03 15:31:18 -08001473 spin_lock_irq(&dev->txq.lock);
1474 /* don't autosuspend while transmitting */
1475 if (dev->txq.qlen && (message.event & PM_EVENT_AUTO)) {
1476 spin_unlock_irq(&dev->txq.lock);
1477 return -EBUSY;
1478 } else {
1479 set_bit(EVENT_DEV_ASLEEP, &dev->flags);
1480 spin_unlock_irq(&dev->txq.lock);
1481 }
Oliver Neukuma11a6542007-08-03 13:52:19 +02001482 /*
1483 * accelerate emptying of the rx and queues, to avoid
Oliver Neukum36433122007-04-30 01:37:44 -07001484 * having everything error out.
1485 */
1486 netif_device_detach (dev->net);
Oliver Neukum69ee4722009-12-03 15:31:18 -08001487 usbnet_terminate_urbs(dev);
1488 usb_kill_urb(dev->interrupt);
1489
Oliver Neukuma11a6542007-08-03 13:52:19 +02001490 /*
1491 * reattach so runtime management can use and
1492 * wake the device
1493 */
1494 netif_device_attach (dev->net);
Oliver Neukum36433122007-04-30 01:37:44 -07001495 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 return 0;
1497}
David Brownell38bde1d2005-08-31 09:52:45 -07001498EXPORT_SYMBOL_GPL(usbnet_suspend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
David Brownell38bde1d2005-08-31 09:52:45 -07001500int usbnet_resume (struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501{
1502 struct usbnet *dev = usb_get_intfdata(intf);
Oliver Neukum69ee4722009-12-03 15:31:18 -08001503 struct sk_buff *skb;
1504 struct urb *res;
1505 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
Oliver Neukum69ee4722009-12-03 15:31:18 -08001507 if (!--dev->suspend_count) {
Paul Stewart68972ef2011-04-28 05:43:37 +00001508 /* resume interrupt URBs */
1509 if (dev->interrupt && test_bit(EVENT_DEV_OPEN, &dev->flags))
1510 usb_submit_urb(dev->interrupt, GFP_NOIO);
1511
Oliver Neukum69ee4722009-12-03 15:31:18 -08001512 spin_lock_irq(&dev->txq.lock);
1513 while ((res = usb_get_from_anchor(&dev->deferred))) {
1514
Oliver Neukum69ee4722009-12-03 15:31:18 -08001515 skb = (struct sk_buff *)res->context;
1516 retval = usb_submit_urb(res, GFP_ATOMIC);
1517 if (retval < 0) {
1518 dev_kfree_skb_any(skb);
1519 usb_free_urb(res);
1520 usb_autopm_put_interface_async(dev->intf);
1521 } else {
1522 dev->net->trans_start = jiffies;
1523 __skb_queue_tail(&dev->txq, skb);
1524 }
1525 }
1526
1527 smp_mb();
1528 clear_bit(EVENT_DEV_ASLEEP, &dev->flags);
1529 spin_unlock_irq(&dev->txq.lock);
Ming Lei75bd0cb2011-04-28 22:37:09 +00001530
1531 if (test_bit(EVENT_DEV_OPEN, &dev->flags)) {
1532 if (!(dev->txq.qlen >= TX_QLEN(dev)))
1533 netif_start_queue(dev->net);
1534 tasklet_schedule (&dev->bh);
1535 }
Oliver Neukum69ee4722009-12-03 15:31:18 -08001536 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 return 0;
1538}
David Brownell38bde1d2005-08-31 09:52:45 -07001539EXPORT_SYMBOL_GPL(usbnet_resume);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
1542/*-------------------------------------------------------------------------*/
1543
David Brownellf29fc252005-08-31 09:52:31 -07001544static int __init usbnet_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545{
Thiago Farinac582a952011-04-17 17:49:21 -07001546 /* Compiler should optimize this out. */
1547 BUILD_BUG_ON(
1548 FIELD_SIZEOF(struct sk_buff, cb) < sizeof(struct skb_data));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
1550 random_ether_addr(node_id);
David Brownellcb1cebb2007-02-15 18:52:30 -08001551 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552}
David Brownellf29fc252005-08-31 09:52:31 -07001553module_init(usbnet_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
David Brownellf29fc252005-08-31 09:52:31 -07001555static void __exit usbnet_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557}
David Brownellf29fc252005-08-31 09:52:31 -07001558module_exit(usbnet_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
David Brownellf29fc252005-08-31 09:52:31 -07001560MODULE_AUTHOR("David Brownell");
David Brownell090ffa92005-08-31 09:54:50 -07001561MODULE_DESCRIPTION("USB network driver framework");
David Brownellf29fc252005-08-31 09:52:31 -07001562MODULE_LICENSE("GPL");