Commit | Line | Data |
---|---|---|
2b3d942c DB |
1 | /* |
2 | * u_ether.c -- Ethernet-over-USB link layer utilities for Gadget stack | |
3 | * | |
4 | * Copyright (C) 2003-2005,2008 David Brownell | |
5 | * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger | |
6 | * Copyright (C) 2008 Nokia Corporation | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2 of the License, or | |
11 | * (at your option) any later version. | |
2b3d942c DB |
12 | */ |
13 | ||
14 | /* #define VERBOSE_DEBUG */ | |
15 | ||
16 | #include <linux/kernel.h> | |
5a0e3ad6 | 17 | #include <linux/gfp.h> |
2b3d942c DB |
18 | #include <linux/device.h> |
19 | #include <linux/ctype.h> | |
20 | #include <linux/etherdevice.h> | |
21 | #include <linux/ethtool.h> | |
22 | ||
23 | #include "u_ether.h" | |
24 | ||
25 | ||
26 | /* | |
27 | * This component encapsulates the Ethernet link glue needed to provide | |
28 | * one (!) network link through the USB gadget stack, normally "usb0". | |
29 | * | |
30 | * The control and data models are handled by the function driver which | |
9b39e9dd BN |
31 | * connects to this code; such as CDC Ethernet (ECM or EEM), |
32 | * "CDC Subset", or RNDIS. That includes all descriptor and endpoint | |
33 | * management. | |
2b3d942c DB |
34 | * |
35 | * Link level addressing is handled by this component using module | |
36 | * parameters; if no such parameters are provided, random link level | |
37 | * addresses are used. Each end of the link uses one address. The | |
38 | * host end address is exported in various ways, and is often recorded | |
39 | * in configuration databases. | |
40 | * | |
41 | * The driver which assembles each configuration using such a link is | |
42 | * responsible for ensuring that each configuration includes at most one | |
43 | * instance of is network link. (The network layer provides ways for | |
44 | * this single "physical" link to be used by multiple virtual links.) | |
45 | */ | |
46 | ||
8a1ce2c0 | 47 | #define UETH__VERSION "29-May-2008" |
2b3d942c DB |
48 | |
49 | struct eth_dev { | |
50 | /* lock is held while accessing port_usb | |
51 | * or updating its backlink port_usb->ioport | |
52 | */ | |
53 | spinlock_t lock; | |
54 | struct gether *port_usb; | |
55 | ||
56 | struct net_device *net; | |
57 | struct usb_gadget *gadget; | |
58 | ||
59 | spinlock_t req_lock; /* guard {rx,tx}_reqs */ | |
60 | struct list_head tx_reqs, rx_reqs; | |
61 | atomic_t tx_qlen; | |
62 | ||
9b39e9dd BN |
63 | struct sk_buff_head rx_frames; |
64 | ||
2b3d942c | 65 | unsigned header_len; |
9b39e9dd BN |
66 | struct sk_buff *(*wrap)(struct gether *, struct sk_buff *skb); |
67 | int (*unwrap)(struct gether *, | |
68 | struct sk_buff *skb, | |
69 | struct sk_buff_head *list); | |
2b3d942c DB |
70 | |
71 | struct work_struct work; | |
72 | ||
73 | unsigned long todo; | |
74 | #define WORK_RX_MEMORY 0 | |
75 | ||
76 | bool zlp; | |
77 | u8 host_mac[ETH_ALEN]; | |
78 | }; | |
79 | ||
80 | /*-------------------------------------------------------------------------*/ | |
81 | ||
82 | #define RX_EXTRA 20 /* bytes guarding against rx overflows */ | |
83 | ||
84 | #define DEFAULT_QLEN 2 /* double buffering by default */ | |
85 | ||
86 | ||
87 | #ifdef CONFIG_USB_GADGET_DUALSPEED | |
88 | ||
89 | static unsigned qmult = 5; | |
90 | module_param(qmult, uint, S_IRUGO|S_IWUSR); | |
04617db7 | 91 | MODULE_PARM_DESC(qmult, "queue length multiplier at high/super speed"); |
2b3d942c DB |
92 | |
93 | #else /* full speed (low speed doesn't do bulk) */ | |
94 | #define qmult 1 | |
95 | #endif | |
96 | ||
04617db7 | 97 | /* for dual-speed hardware, use deeper queues at high/super speed */ |
2b3d942c DB |
98 | static inline int qlen(struct usb_gadget *gadget) |
99 | { | |
04617db7 PZ |
100 | if (gadget_is_dualspeed(gadget) && (gadget->speed == USB_SPEED_HIGH || |
101 | gadget->speed == USB_SPEED_SUPER)) | |
2b3d942c DB |
102 | return qmult * DEFAULT_QLEN; |
103 | else | |
104 | return DEFAULT_QLEN; | |
105 | } | |
106 | ||
107 | /*-------------------------------------------------------------------------*/ | |
108 | ||
109 | /* REVISIT there must be a better way than having two sets | |
110 | * of debug calls ... | |
111 | */ | |
112 | ||
113 | #undef DBG | |
114 | #undef VDBG | |
115 | #undef ERROR | |
2b3d942c DB |
116 | #undef INFO |
117 | ||
118 | #define xprintk(d, level, fmt, args...) \ | |
119 | printk(level "%s: " fmt , (d)->net->name , ## args) | |
120 | ||
121 | #ifdef DEBUG | |
122 | #undef DEBUG | |
123 | #define DBG(dev, fmt, args...) \ | |
124 | xprintk(dev , KERN_DEBUG , fmt , ## args) | |
125 | #else | |
126 | #define DBG(dev, fmt, args...) \ | |
127 | do { } while (0) | |
128 | #endif /* DEBUG */ | |
129 | ||
130 | #ifdef VERBOSE_DEBUG | |
131 | #define VDBG DBG | |
132 | #else | |
133 | #define VDBG(dev, fmt, args...) \ | |
134 | do { } while (0) | |
135 | #endif /* DEBUG */ | |
136 | ||
137 | #define ERROR(dev, fmt, args...) \ | |
138 | xprintk(dev , KERN_ERR , fmt , ## args) | |
2b3d942c DB |
139 | #define INFO(dev, fmt, args...) \ |
140 | xprintk(dev , KERN_INFO , fmt , ## args) | |
141 | ||
142 | /*-------------------------------------------------------------------------*/ | |
143 | ||
144 | /* NETWORK DRIVER HOOKUP (to the layer above this driver) */ | |
145 | ||
ccad637b | 146 | static int ueth_change_mtu(struct net_device *net, int new_mtu) |
2b3d942c DB |
147 | { |
148 | struct eth_dev *dev = netdev_priv(net); | |
149 | unsigned long flags; | |
150 | int status = 0; | |
151 | ||
152 | /* don't change MTU on "live" link (peer won't know) */ | |
153 | spin_lock_irqsave(&dev->lock, flags); | |
154 | if (dev->port_usb) | |
155 | status = -EBUSY; | |
156 | else if (new_mtu <= ETH_HLEN || new_mtu > ETH_FRAME_LEN) | |
157 | status = -ERANGE; | |
158 | else | |
159 | net->mtu = new_mtu; | |
160 | spin_unlock_irqrestore(&dev->lock, flags); | |
161 | ||
162 | return status; | |
163 | } | |
164 | ||
165 | static void eth_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *p) | |
166 | { | |
167 | struct eth_dev *dev = netdev_priv(net); | |
168 | ||
169 | strlcpy(p->driver, "g_ether", sizeof p->driver); | |
8a1ce2c0 | 170 | strlcpy(p->version, UETH__VERSION, sizeof p->version); |
2b3d942c DB |
171 | strlcpy(p->fw_version, dev->gadget->name, sizeof p->fw_version); |
172 | strlcpy(p->bus_info, dev_name(&dev->gadget->dev), sizeof p->bus_info); | |
173 | } | |
174 | ||
2b3d942c DB |
175 | /* REVISIT can also support: |
176 | * - WOL (by tracking suspends and issuing remote wakeup) | |
177 | * - msglevel (implies updated messaging) | |
178 | * - ... probably more ethtool ops | |
179 | */ | |
180 | ||
0fc0b732 | 181 | static const struct ethtool_ops ops = { |
2b3d942c | 182 | .get_drvinfo = eth_get_drvinfo, |
237e75bf | 183 | .get_link = ethtool_op_get_link, |
2b3d942c DB |
184 | }; |
185 | ||
186 | static void defer_kevent(struct eth_dev *dev, int flag) | |
187 | { | |
188 | if (test_and_set_bit(flag, &dev->todo)) | |
189 | return; | |
190 | if (!schedule_work(&dev->work)) | |
191 | ERROR(dev, "kevent %d may have been dropped\n", flag); | |
192 | else | |
193 | DBG(dev, "kevent %d scheduled\n", flag); | |
194 | } | |
195 | ||
196 | static void rx_complete(struct usb_ep *ep, struct usb_request *req); | |
197 | ||
198 | static int | |
199 | rx_submit(struct eth_dev *dev, struct usb_request *req, gfp_t gfp_flags) | |
200 | { | |
201 | struct sk_buff *skb; | |
202 | int retval = -ENOMEM; | |
203 | size_t size = 0; | |
204 | struct usb_ep *out; | |
205 | unsigned long flags; | |
206 | ||
207 | spin_lock_irqsave(&dev->lock, flags); | |
208 | if (dev->port_usb) | |
209 | out = dev->port_usb->out_ep; | |
210 | else | |
211 | out = NULL; | |
212 | spin_unlock_irqrestore(&dev->lock, flags); | |
213 | ||
214 | if (!out) | |
215 | return -ENOTCONN; | |
216 | ||
217 | ||
218 | /* Padding up to RX_EXTRA handles minor disagreements with host. | |
219 | * Normally we use the USB "terminate on short read" convention; | |
220 | * so allow up to (N*maxpacket), since that memory is normally | |
221 | * already allocated. Some hardware doesn't deal well with short | |
222 | * reads (e.g. DMA must be N*maxpacket), so for now don't trim a | |
223 | * byte off the end (to force hardware errors on overflow). | |
224 | * | |
225 | * RNDIS uses internal framing, and explicitly allows senders to | |
226 | * pad to end-of-packet. That's potentially nice for speed, but | |
227 | * means receivers can't recover lost synch on their own (because | |
228 | * new packets don't only start after a short RX). | |
229 | */ | |
230 | size += sizeof(struct ethhdr) + dev->net->mtu + RX_EXTRA; | |
231 | size += dev->port_usb->header_len; | |
232 | size += out->maxpacket - 1; | |
233 | size -= size % out->maxpacket; | |
234 | ||
5c1168db | 235 | if (dev->port_usb->is_fixed) |
45d1b7ae | 236 | size = max_t(size_t, size, dev->port_usb->fixed_out_len); |
5c1168db | 237 | |
2b3d942c DB |
238 | skb = alloc_skb(size + NET_IP_ALIGN, gfp_flags); |
239 | if (skb == NULL) { | |
240 | DBG(dev, "no rx skb\n"); | |
241 | goto enomem; | |
242 | } | |
243 | ||
244 | /* Some platforms perform better when IP packets are aligned, | |
245 | * but on at least one, checksumming fails otherwise. Note: | |
246 | * RNDIS headers involve variable numbers of LE32 values. | |
247 | */ | |
248 | skb_reserve(skb, NET_IP_ALIGN); | |
249 | ||
250 | req->buf = skb->data; | |
251 | req->length = size; | |
252 | req->complete = rx_complete; | |
253 | req->context = skb; | |
254 | ||
255 | retval = usb_ep_queue(out, req, gfp_flags); | |
256 | if (retval == -ENOMEM) | |
257 | enomem: | |
258 | defer_kevent(dev, WORK_RX_MEMORY); | |
259 | if (retval) { | |
260 | DBG(dev, "rx submit --> %d\n", retval); | |
261 | if (skb) | |
262 | dev_kfree_skb_any(skb); | |
263 | spin_lock_irqsave(&dev->req_lock, flags); | |
264 | list_add(&req->list, &dev->rx_reqs); | |
265 | spin_unlock_irqrestore(&dev->req_lock, flags); | |
266 | } | |
267 | return retval; | |
268 | } | |
269 | ||
270 | static void rx_complete(struct usb_ep *ep, struct usb_request *req) | |
271 | { | |
9b39e9dd | 272 | struct sk_buff *skb = req->context, *skb2; |
2b3d942c DB |
273 | struct eth_dev *dev = ep->driver_data; |
274 | int status = req->status; | |
275 | ||
276 | switch (status) { | |
277 | ||
278 | /* normal completion */ | |
279 | case 0: | |
280 | skb_put(skb, req->actual); | |
2b3d942c | 281 | |
9b39e9dd BN |
282 | if (dev->unwrap) { |
283 | unsigned long flags; | |
2b3d942c | 284 | |
9b39e9dd BN |
285 | spin_lock_irqsave(&dev->lock, flags); |
286 | if (dev->port_usb) { | |
287 | status = dev->unwrap(dev->port_usb, | |
288 | skb, | |
289 | &dev->rx_frames); | |
290 | } else { | |
291 | dev_kfree_skb_any(skb); | |
292 | status = -ENOTCONN; | |
293 | } | |
294 | spin_unlock_irqrestore(&dev->lock, flags); | |
295 | } else { | |
296 | skb_queue_tail(&dev->rx_frames, skb); | |
297 | } | |
2b3d942c | 298 | skb = NULL; |
9b39e9dd BN |
299 | |
300 | skb2 = skb_dequeue(&dev->rx_frames); | |
301 | while (skb2) { | |
302 | if (status < 0 | |
303 | || ETH_HLEN > skb2->len | |
304 | || skb2->len > ETH_FRAME_LEN) { | |
305 | dev->net->stats.rx_errors++; | |
306 | dev->net->stats.rx_length_errors++; | |
307 | DBG(dev, "rx length %d\n", skb2->len); | |
308 | dev_kfree_skb_any(skb2); | |
309 | goto next_frame; | |
310 | } | |
311 | skb2->protocol = eth_type_trans(skb2, dev->net); | |
312 | dev->net->stats.rx_packets++; | |
313 | dev->net->stats.rx_bytes += skb2->len; | |
314 | ||
315 | /* no buffer copies needed, unless hardware can't | |
316 | * use skb buffers. | |
317 | */ | |
318 | status = netif_rx(skb2); | |
319 | next_frame: | |
320 | skb2 = skb_dequeue(&dev->rx_frames); | |
321 | } | |
2b3d942c DB |
322 | break; |
323 | ||
324 | /* software-driven interface shutdown */ | |
325 | case -ECONNRESET: /* unlink */ | |
326 | case -ESHUTDOWN: /* disconnect etc */ | |
327 | VDBG(dev, "rx shutdown, code %d\n", status); | |
328 | goto quiesce; | |
329 | ||
330 | /* for hardware automagic (such as pxa) */ | |
331 | case -ECONNABORTED: /* endpoint reset */ | |
332 | DBG(dev, "rx %s reset\n", ep->name); | |
333 | defer_kevent(dev, WORK_RX_MEMORY); | |
334 | quiesce: | |
335 | dev_kfree_skb_any(skb); | |
336 | goto clean; | |
337 | ||
338 | /* data overrun */ | |
339 | case -EOVERFLOW: | |
340 | dev->net->stats.rx_over_errors++; | |
341 | /* FALLTHROUGH */ | |
342 | ||
343 | default: | |
344 | dev->net->stats.rx_errors++; | |
345 | DBG(dev, "rx status %d\n", status); | |
346 | break; | |
347 | } | |
348 | ||
349 | if (skb) | |
350 | dev_kfree_skb_any(skb); | |
351 | if (!netif_running(dev->net)) { | |
352 | clean: | |
353 | spin_lock(&dev->req_lock); | |
354 | list_add(&req->list, &dev->rx_reqs); | |
355 | spin_unlock(&dev->req_lock); | |
356 | req = NULL; | |
357 | } | |
358 | if (req) | |
359 | rx_submit(dev, req, GFP_ATOMIC); | |
360 | } | |
361 | ||
362 | static int prealloc(struct list_head *list, struct usb_ep *ep, unsigned n) | |
363 | { | |
364 | unsigned i; | |
365 | struct usb_request *req; | |
366 | ||
367 | if (!n) | |
368 | return -ENOMEM; | |
369 | ||
370 | /* queue/recycle up to N requests */ | |
371 | i = n; | |
372 | list_for_each_entry(req, list, list) { | |
373 | if (i-- == 0) | |
374 | goto extra; | |
375 | } | |
376 | while (i--) { | |
377 | req = usb_ep_alloc_request(ep, GFP_ATOMIC); | |
378 | if (!req) | |
379 | return list_empty(list) ? -ENOMEM : 0; | |
380 | list_add(&req->list, list); | |
381 | } | |
382 | return 0; | |
383 | ||
384 | extra: | |
385 | /* free extras */ | |
386 | for (;;) { | |
387 | struct list_head *next; | |
388 | ||
389 | next = req->list.next; | |
390 | list_del(&req->list); | |
391 | usb_ep_free_request(ep, req); | |
392 | ||
393 | if (next == list) | |
394 | break; | |
395 | ||
396 | req = container_of(next, struct usb_request, list); | |
397 | } | |
398 | return 0; | |
399 | } | |
400 | ||
401 | static int alloc_requests(struct eth_dev *dev, struct gether *link, unsigned n) | |
402 | { | |
403 | int status; | |
404 | ||
405 | spin_lock(&dev->req_lock); | |
406 | status = prealloc(&dev->tx_reqs, link->in_ep, n); | |
407 | if (status < 0) | |
408 | goto fail; | |
409 | status = prealloc(&dev->rx_reqs, link->out_ep, n); | |
410 | if (status < 0) | |
411 | goto fail; | |
412 | goto done; | |
413 | fail: | |
414 | DBG(dev, "can't alloc requests\n"); | |
415 | done: | |
416 | spin_unlock(&dev->req_lock); | |
417 | return status; | |
418 | } | |
419 | ||
420 | static void rx_fill(struct eth_dev *dev, gfp_t gfp_flags) | |
421 | { | |
422 | struct usb_request *req; | |
423 | unsigned long flags; | |
424 | ||
425 | /* fill unused rxq slots with some skb */ | |
426 | spin_lock_irqsave(&dev->req_lock, flags); | |
427 | while (!list_empty(&dev->rx_reqs)) { | |
428 | req = container_of(dev->rx_reqs.next, | |
429 | struct usb_request, list); | |
430 | list_del_init(&req->list); | |
431 | spin_unlock_irqrestore(&dev->req_lock, flags); | |
432 | ||
433 | if (rx_submit(dev, req, gfp_flags) < 0) { | |
434 | defer_kevent(dev, WORK_RX_MEMORY); | |
435 | return; | |
436 | } | |
437 | ||
438 | spin_lock_irqsave(&dev->req_lock, flags); | |
439 | } | |
440 | spin_unlock_irqrestore(&dev->req_lock, flags); | |
441 | } | |
442 | ||
443 | static void eth_work(struct work_struct *work) | |
444 | { | |
445 | struct eth_dev *dev = container_of(work, struct eth_dev, work); | |
446 | ||
447 | if (test_and_clear_bit(WORK_RX_MEMORY, &dev->todo)) { | |
448 | if (netif_running(dev->net)) | |
449 | rx_fill(dev, GFP_KERNEL); | |
450 | } | |
451 | ||
452 | if (dev->todo) | |
453 | DBG(dev, "work done, flags = 0x%lx\n", dev->todo); | |
454 | } | |
455 | ||
456 | static void tx_complete(struct usb_ep *ep, struct usb_request *req) | |
457 | { | |
458 | struct sk_buff *skb = req->context; | |
459 | struct eth_dev *dev = ep->driver_data; | |
460 | ||
461 | switch (req->status) { | |
462 | default: | |
463 | dev->net->stats.tx_errors++; | |
464 | VDBG(dev, "tx err %d\n", req->status); | |
465 | /* FALLTHROUGH */ | |
466 | case -ECONNRESET: /* unlink */ | |
467 | case -ESHUTDOWN: /* disconnect etc */ | |
468 | break; | |
469 | case 0: | |
470 | dev->net->stats.tx_bytes += skb->len; | |
471 | } | |
472 | dev->net->stats.tx_packets++; | |
473 | ||
474 | spin_lock(&dev->req_lock); | |
475 | list_add(&req->list, &dev->tx_reqs); | |
476 | spin_unlock(&dev->req_lock); | |
477 | dev_kfree_skb_any(skb); | |
478 | ||
479 | atomic_dec(&dev->tx_qlen); | |
480 | if (netif_carrier_ok(dev->net)) | |
481 | netif_wake_queue(dev->net); | |
482 | } | |
483 | ||
484 | static inline int is_promisc(u16 cdc_filter) | |
485 | { | |
486 | return cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS; | |
487 | } | |
488 | ||
25a79c41 SH |
489 | static netdev_tx_t eth_start_xmit(struct sk_buff *skb, |
490 | struct net_device *net) | |
2b3d942c DB |
491 | { |
492 | struct eth_dev *dev = netdev_priv(net); | |
493 | int length = skb->len; | |
494 | int retval; | |
495 | struct usb_request *req = NULL; | |
496 | unsigned long flags; | |
497 | struct usb_ep *in; | |
498 | u16 cdc_filter; | |
499 | ||
500 | spin_lock_irqsave(&dev->lock, flags); | |
501 | if (dev->port_usb) { | |
502 | in = dev->port_usb->in_ep; | |
503 | cdc_filter = dev->port_usb->cdc_filter; | |
504 | } else { | |
505 | in = NULL; | |
506 | cdc_filter = 0; | |
507 | } | |
508 | spin_unlock_irqrestore(&dev->lock, flags); | |
509 | ||
510 | if (!in) { | |
511 | dev_kfree_skb_any(skb); | |
6ed10654 | 512 | return NETDEV_TX_OK; |
2b3d942c DB |
513 | } |
514 | ||
515 | /* apply outgoing CDC or RNDIS filters */ | |
516 | if (!is_promisc(cdc_filter)) { | |
517 | u8 *dest = skb->data; | |
518 | ||
519 | if (is_multicast_ether_addr(dest)) { | |
520 | u16 type; | |
521 | ||
522 | /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host | |
523 | * SET_ETHERNET_MULTICAST_FILTERS requests | |
524 | */ | |
525 | if (is_broadcast_ether_addr(dest)) | |
526 | type = USB_CDC_PACKET_TYPE_BROADCAST; | |
527 | else | |
528 | type = USB_CDC_PACKET_TYPE_ALL_MULTICAST; | |
529 | if (!(cdc_filter & type)) { | |
530 | dev_kfree_skb_any(skb); | |
6ed10654 | 531 | return NETDEV_TX_OK; |
2b3d942c DB |
532 | } |
533 | } | |
534 | /* ignores USB_CDC_PACKET_TYPE_DIRECTED */ | |
535 | } | |
536 | ||
537 | spin_lock_irqsave(&dev->req_lock, flags); | |
538 | /* | |
539 | * this freelist can be empty if an interrupt triggered disconnect() | |
540 | * and reconfigured the gadget (shutting down this queue) after the | |
541 | * network stack decided to xmit but before we got the spinlock. | |
542 | */ | |
543 | if (list_empty(&dev->tx_reqs)) { | |
544 | spin_unlock_irqrestore(&dev->req_lock, flags); | |
5b548140 | 545 | return NETDEV_TX_BUSY; |
2b3d942c DB |
546 | } |
547 | ||
548 | req = container_of(dev->tx_reqs.next, struct usb_request, list); | |
549 | list_del(&req->list); | |
550 | ||
551 | /* temporarily stop TX queue when the freelist empties */ | |
552 | if (list_empty(&dev->tx_reqs)) | |
553 | netif_stop_queue(net); | |
554 | spin_unlock_irqrestore(&dev->req_lock, flags); | |
555 | ||
556 | /* no buffer copies needed, unless the network stack did it | |
557 | * or the hardware can't use skb buffers. | |
558 | * or there's not enough space for extra headers we need | |
559 | */ | |
560 | if (dev->wrap) { | |
9b39e9dd | 561 | unsigned long flags; |
2b3d942c | 562 | |
9b39e9dd BN |
563 | spin_lock_irqsave(&dev->lock, flags); |
564 | if (dev->port_usb) | |
565 | skb = dev->wrap(dev->port_usb, skb); | |
566 | spin_unlock_irqrestore(&dev->lock, flags); | |
567 | if (!skb) | |
2b3d942c DB |
568 | goto drop; |
569 | ||
2b3d942c DB |
570 | length = skb->len; |
571 | } | |
572 | req->buf = skb->data; | |
573 | req->context = skb; | |
574 | req->complete = tx_complete; | |
575 | ||
5c1168db YK |
576 | /* NCM requires no zlp if transfer is dwNtbInMaxSize */ |
577 | if (dev->port_usb->is_fixed && | |
578 | length == dev->port_usb->fixed_in_len && | |
579 | (length % in->maxpacket) == 0) | |
580 | req->zero = 0; | |
581 | else | |
582 | req->zero = 1; | |
583 | ||
2b3d942c DB |
584 | /* use zlp framing on tx for strict CDC-Ether conformance, |
585 | * though any robust network rx path ignores extra padding. | |
586 | * and some hardware doesn't like to write zlps. | |
587 | */ | |
5c1168db | 588 | if (req->zero && !dev->zlp && (length % in->maxpacket) == 0) |
2b3d942c DB |
589 | length++; |
590 | ||
591 | req->length = length; | |
592 | ||
04617db7 | 593 | /* throttle high/super speed IRQ rate back slightly */ |
2b3d942c | 594 | if (gadget_is_dualspeed(dev->gadget)) |
04617db7 PZ |
595 | req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH || |
596 | dev->gadget->speed == USB_SPEED_SUPER) | |
2b3d942c DB |
597 | ? ((atomic_read(&dev->tx_qlen) % qmult) != 0) |
598 | : 0; | |
599 | ||
600 | retval = usb_ep_queue(in, req, GFP_ATOMIC); | |
601 | switch (retval) { | |
602 | default: | |
603 | DBG(dev, "tx queue err %d\n", retval); | |
604 | break; | |
605 | case 0: | |
606 | net->trans_start = jiffies; | |
607 | atomic_inc(&dev->tx_qlen); | |
608 | } | |
609 | ||
610 | if (retval) { | |
9b39e9dd | 611 | dev_kfree_skb_any(skb); |
2b3d942c DB |
612 | drop: |
613 | dev->net->stats.tx_dropped++; | |
2b3d942c DB |
614 | spin_lock_irqsave(&dev->req_lock, flags); |
615 | if (list_empty(&dev->tx_reqs)) | |
616 | netif_start_queue(net); | |
617 | list_add(&req->list, &dev->tx_reqs); | |
618 | spin_unlock_irqrestore(&dev->req_lock, flags); | |
619 | } | |
6ed10654 | 620 | return NETDEV_TX_OK; |
2b3d942c DB |
621 | } |
622 | ||
623 | /*-------------------------------------------------------------------------*/ | |
624 | ||
625 | static void eth_start(struct eth_dev *dev, gfp_t gfp_flags) | |
626 | { | |
627 | DBG(dev, "%s\n", __func__); | |
628 | ||
629 | /* fill the rx queue */ | |
630 | rx_fill(dev, gfp_flags); | |
631 | ||
632 | /* and open the tx floodgates */ | |
633 | atomic_set(&dev->tx_qlen, 0); | |
634 | netif_wake_queue(dev->net); | |
635 | } | |
636 | ||
637 | static int eth_open(struct net_device *net) | |
638 | { | |
639 | struct eth_dev *dev = netdev_priv(net); | |
640 | struct gether *link; | |
641 | ||
642 | DBG(dev, "%s\n", __func__); | |
643 | if (netif_carrier_ok(dev->net)) | |
644 | eth_start(dev, GFP_KERNEL); | |
645 | ||
646 | spin_lock_irq(&dev->lock); | |
647 | link = dev->port_usb; | |
648 | if (link && link->open) | |
649 | link->open(link); | |
650 | spin_unlock_irq(&dev->lock); | |
651 | ||
652 | return 0; | |
653 | } | |
654 | ||
655 | static int eth_stop(struct net_device *net) | |
656 | { | |
657 | struct eth_dev *dev = netdev_priv(net); | |
658 | unsigned long flags; | |
659 | ||
660 | VDBG(dev, "%s\n", __func__); | |
661 | netif_stop_queue(net); | |
662 | ||
663 | DBG(dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n", | |
664 | dev->net->stats.rx_packets, dev->net->stats.tx_packets, | |
665 | dev->net->stats.rx_errors, dev->net->stats.tx_errors | |
666 | ); | |
667 | ||
668 | /* ensure there are no more active requests */ | |
669 | spin_lock_irqsave(&dev->lock, flags); | |
670 | if (dev->port_usb) { | |
671 | struct gether *link = dev->port_usb; | |
672 | ||
673 | if (link->close) | |
674 | link->close(link); | |
675 | ||
676 | /* NOTE: we have no abort-queue primitive we could use | |
677 | * to cancel all pending I/O. Instead, we disable then | |
678 | * reenable the endpoints ... this idiom may leave toggle | |
679 | * wrong, but that's a self-correcting error. | |
680 | * | |
681 | * REVISIT: we *COULD* just let the transfers complete at | |
682 | * their own pace; the network stack can handle old packets. | |
683 | * For the moment we leave this here, since it works. | |
684 | */ | |
685 | usb_ep_disable(link->in_ep); | |
686 | usb_ep_disable(link->out_ep); | |
687 | if (netif_carrier_ok(net)) { | |
688 | DBG(dev, "host still using in/out endpoints\n"); | |
72c973dd TB |
689 | usb_ep_enable(link->in_ep); |
690 | usb_ep_enable(link->out_ep); | |
2b3d942c DB |
691 | } |
692 | } | |
693 | spin_unlock_irqrestore(&dev->lock, flags); | |
694 | ||
695 | return 0; | |
696 | } | |
697 | ||
698 | /*-------------------------------------------------------------------------*/ | |
699 | ||
700 | /* initial value, changed by "ifconfig usb0 hw ether xx:xx:xx:xx:xx:xx" */ | |
701 | static char *dev_addr; | |
702 | module_param(dev_addr, charp, S_IRUGO); | |
703 | MODULE_PARM_DESC(dev_addr, "Device Ethernet Address"); | |
704 | ||
705 | /* this address is invisible to ifconfig */ | |
706 | static char *host_addr; | |
707 | module_param(host_addr, charp, S_IRUGO); | |
708 | MODULE_PARM_DESC(host_addr, "Host Ethernet Address"); | |
709 | ||
28824b18 | 710 | static int get_ether_addr(const char *str, u8 *dev_addr) |
2b3d942c DB |
711 | { |
712 | if (str) { | |
713 | unsigned i; | |
714 | ||
715 | for (i = 0; i < 6; i++) { | |
716 | unsigned char num; | |
717 | ||
718 | if ((*str == '.') || (*str == ':')) | |
719 | str++; | |
e644814a AS |
720 | num = hex_to_bin(*str++) << 4; |
721 | num |= hex_to_bin(*str++); | |
2b3d942c DB |
722 | dev_addr [i] = num; |
723 | } | |
724 | if (is_valid_ether_addr(dev_addr)) | |
725 | return 0; | |
726 | } | |
006c9139 | 727 | eth_random_addr(dev_addr); |
2b3d942c DB |
728 | return 1; |
729 | } | |
730 | ||
731 | static struct eth_dev *the_dev; | |
732 | ||
5ec38f30 SH |
733 | static const struct net_device_ops eth_netdev_ops = { |
734 | .ndo_open = eth_open, | |
735 | .ndo_stop = eth_stop, | |
736 | .ndo_start_xmit = eth_start_xmit, | |
737 | .ndo_change_mtu = ueth_change_mtu, | |
738 | .ndo_set_mac_address = eth_mac_addr, | |
739 | .ndo_validate_addr = eth_validate_addr, | |
740 | }; | |
2b3d942c | 741 | |
aa790740 MH |
742 | static struct device_type gadget_type = { |
743 | .name = "gadget", | |
744 | }; | |
745 | ||
2b3d942c | 746 | /** |
036e98b2 | 747 | * gether_setup_name - initialize one ethernet-over-usb link |
2b3d942c DB |
748 | * @g: gadget to associated with these links |
749 | * @ethaddr: NULL, or a buffer in which the ethernet address of the | |
750 | * host side of the link is recorded | |
036e98b2 | 751 | * @netname: name for network device (for example, "usb") |
2b3d942c DB |
752 | * Context: may sleep |
753 | * | |
754 | * This sets up the single network link that may be exported by a | |
755 | * gadget driver using this framework. The link layer addresses are | |
756 | * set up using module parameters. | |
757 | * | |
758 | * Returns negative errno, or zero on success | |
759 | */ | |
036e98b2 ML |
760 | int gether_setup_name(struct usb_gadget *g, u8 ethaddr[ETH_ALEN], |
761 | const char *netname) | |
2b3d942c DB |
762 | { |
763 | struct eth_dev *dev; | |
764 | struct net_device *net; | |
765 | int status; | |
766 | ||
767 | if (the_dev) | |
768 | return -EBUSY; | |
769 | ||
770 | net = alloc_etherdev(sizeof *dev); | |
771 | if (!net) | |
772 | return -ENOMEM; | |
773 | ||
774 | dev = netdev_priv(net); | |
775 | spin_lock_init(&dev->lock); | |
776 | spin_lock_init(&dev->req_lock); | |
777 | INIT_WORK(&dev->work, eth_work); | |
778 | INIT_LIST_HEAD(&dev->tx_reqs); | |
779 | INIT_LIST_HEAD(&dev->rx_reqs); | |
780 | ||
9b39e9dd BN |
781 | skb_queue_head_init(&dev->rx_frames); |
782 | ||
2b3d942c DB |
783 | /* network device setup */ |
784 | dev->net = net; | |
036e98b2 | 785 | snprintf(net->name, sizeof(net->name), "%s%%d", netname); |
2b3d942c DB |
786 | |
787 | if (get_ether_addr(dev_addr, net->dev_addr)) | |
788 | dev_warn(&g->dev, | |
789 | "using random %s ethernet address\n", "self"); | |
790 | if (get_ether_addr(host_addr, dev->host_mac)) | |
791 | dev_warn(&g->dev, | |
792 | "using random %s ethernet address\n", "host"); | |
793 | ||
794 | if (ethaddr) | |
795 | memcpy(ethaddr, dev->host_mac, ETH_ALEN); | |
796 | ||
5ec38f30 SH |
797 | net->netdev_ops = ð_netdev_ops; |
798 | ||
2b3d942c DB |
799 | SET_ETHTOOL_OPS(net, &ops); |
800 | ||
2b3d942c DB |
801 | dev->gadget = g; |
802 | SET_NETDEV_DEV(net, &g->dev); | |
aa790740 | 803 | SET_NETDEV_DEVTYPE(net, &gadget_type); |
2b3d942c DB |
804 | |
805 | status = register_netdev(net); | |
806 | if (status < 0) { | |
807 | dev_dbg(&g->dev, "register_netdev failed, %d\n", status); | |
808 | free_netdev(net); | |
809 | } else { | |
e174961c JB |
810 | INFO(dev, "MAC %pM\n", net->dev_addr); |
811 | INFO(dev, "HOST MAC %pM\n", dev->host_mac); | |
2b3d942c DB |
812 | |
813 | the_dev = dev; | |
31bde1ce KC |
814 | |
815 | /* two kinds of host-initiated state changes: | |
816 | * - iff DATA transfer is active, carrier is "on" | |
817 | * - tx queueing enabled if open *and* carrier is "on" | |
818 | */ | |
819 | netif_carrier_off(net); | |
2b3d942c DB |
820 | } |
821 | ||
822 | return status; | |
823 | } | |
824 | ||
825 | /** | |
826 | * gether_cleanup - remove Ethernet-over-USB device | |
827 | * Context: may sleep | |
828 | * | |
829 | * This is called to free all resources allocated by @gether_setup(). | |
830 | */ | |
831 | void gether_cleanup(void) | |
832 | { | |
833 | if (!the_dev) | |
834 | return; | |
835 | ||
836 | unregister_netdev(the_dev->net); | |
43829731 | 837 | flush_work(&the_dev->work); |
2b3d942c DB |
838 | free_netdev(the_dev->net); |
839 | ||
2b3d942c DB |
840 | the_dev = NULL; |
841 | } | |
842 | ||
843 | ||
844 | /** | |
845 | * gether_connect - notify network layer that USB link is active | |
846 | * @link: the USB link, set up with endpoints, descriptors matching | |
847 | * current device speed, and any framing wrapper(s) set up. | |
848 | * Context: irqs blocked | |
849 | * | |
850 | * This is called to activate endpoints and let the network layer know | |
851 | * the connection is active ("carrier detect"). It may cause the I/O | |
852 | * queues to open and start letting network packets flow, but will in | |
853 | * any case activate the endpoints so that they respond properly to the | |
854 | * USB host. | |
855 | * | |
856 | * Verify net_device pointer returned using IS_ERR(). If it doesn't | |
857 | * indicate some error code (negative errno), ep->driver_data values | |
858 | * have been overwritten. | |
859 | */ | |
860 | struct net_device *gether_connect(struct gether *link) | |
861 | { | |
862 | struct eth_dev *dev = the_dev; | |
863 | int result = 0; | |
864 | ||
865 | if (!dev) | |
866 | return ERR_PTR(-EINVAL); | |
867 | ||
868 | link->in_ep->driver_data = dev; | |
72c973dd | 869 | result = usb_ep_enable(link->in_ep); |
2b3d942c DB |
870 | if (result != 0) { |
871 | DBG(dev, "enable %s --> %d\n", | |
872 | link->in_ep->name, result); | |
873 | goto fail0; | |
874 | } | |
875 | ||
876 | link->out_ep->driver_data = dev; | |
72c973dd | 877 | result = usb_ep_enable(link->out_ep); |
2b3d942c DB |
878 | if (result != 0) { |
879 | DBG(dev, "enable %s --> %d\n", | |
880 | link->out_ep->name, result); | |
881 | goto fail1; | |
882 | } | |
883 | ||
884 | if (result == 0) | |
885 | result = alloc_requests(dev, link, qlen(dev->gadget)); | |
886 | ||
887 | if (result == 0) { | |
888 | dev->zlp = link->is_zlp_ok; | |
889 | DBG(dev, "qlen %d\n", qlen(dev->gadget)); | |
890 | ||
891 | dev->header_len = link->header_len; | |
892 | dev->unwrap = link->unwrap; | |
893 | dev->wrap = link->wrap; | |
894 | ||
895 | spin_lock(&dev->lock); | |
896 | dev->port_usb = link; | |
897 | link->ioport = dev; | |
29bac7b7 DB |
898 | if (netif_running(dev->net)) { |
899 | if (link->open) | |
900 | link->open(link); | |
901 | } else { | |
902 | if (link->close) | |
903 | link->close(link); | |
904 | } | |
2b3d942c DB |
905 | spin_unlock(&dev->lock); |
906 | ||
907 | netif_carrier_on(dev->net); | |
908 | if (netif_running(dev->net)) | |
909 | eth_start(dev, GFP_ATOMIC); | |
910 | ||
911 | /* on error, disable any endpoints */ | |
912 | } else { | |
913 | (void) usb_ep_disable(link->out_ep); | |
914 | fail1: | |
915 | (void) usb_ep_disable(link->in_ep); | |
916 | } | |
917 | fail0: | |
918 | /* caller is responsible for cleanup on error */ | |
919 | if (result < 0) | |
920 | return ERR_PTR(result); | |
921 | return dev->net; | |
922 | } | |
923 | ||
924 | /** | |
925 | * gether_disconnect - notify network layer that USB link is inactive | |
926 | * @link: the USB link, on which gether_connect() was called | |
927 | * Context: irqs blocked | |
928 | * | |
929 | * This is called to deactivate endpoints and let the network layer know | |
930 | * the connection went inactive ("no carrier"). | |
931 | * | |
932 | * On return, the state is as if gether_connect() had never been called. | |
933 | * The endpoints are inactive, and accordingly without active USB I/O. | |
934 | * Pointers to endpoint descriptors and endpoint private data are nulled. | |
935 | */ | |
936 | void gether_disconnect(struct gether *link) | |
937 | { | |
938 | struct eth_dev *dev = link->ioport; | |
939 | struct usb_request *req; | |
940 | ||
941 | WARN_ON(!dev); | |
942 | if (!dev) | |
943 | return; | |
944 | ||
945 | DBG(dev, "%s\n", __func__); | |
946 | ||
947 | netif_stop_queue(dev->net); | |
948 | netif_carrier_off(dev->net); | |
949 | ||
950 | /* disable endpoints, forcing (synchronous) completion | |
951 | * of all pending i/o. then free the request objects | |
952 | * and forget about the endpoints. | |
953 | */ | |
954 | usb_ep_disable(link->in_ep); | |
955 | spin_lock(&dev->req_lock); | |
956 | while (!list_empty(&dev->tx_reqs)) { | |
957 | req = container_of(dev->tx_reqs.next, | |
958 | struct usb_request, list); | |
959 | list_del(&req->list); | |
960 | ||
961 | spin_unlock(&dev->req_lock); | |
962 | usb_ep_free_request(link->in_ep, req); | |
963 | spin_lock(&dev->req_lock); | |
964 | } | |
965 | spin_unlock(&dev->req_lock); | |
966 | link->in_ep->driver_data = NULL; | |
72c973dd | 967 | link->in_ep->desc = NULL; |
2b3d942c DB |
968 | |
969 | usb_ep_disable(link->out_ep); | |
970 | spin_lock(&dev->req_lock); | |
971 | while (!list_empty(&dev->rx_reqs)) { | |
972 | req = container_of(dev->rx_reqs.next, | |
973 | struct usb_request, list); | |
974 | list_del(&req->list); | |
975 | ||
976 | spin_unlock(&dev->req_lock); | |
977 | usb_ep_free_request(link->out_ep, req); | |
978 | spin_lock(&dev->req_lock); | |
979 | } | |
980 | spin_unlock(&dev->req_lock); | |
981 | link->out_ep->driver_data = NULL; | |
72c973dd | 982 | link->out_ep->desc = NULL; |
2b3d942c DB |
983 | |
984 | /* finish forgetting about this USB link episode */ | |
985 | dev->header_len = 0; | |
986 | dev->unwrap = NULL; | |
987 | dev->wrap = NULL; | |
988 | ||
989 | spin_lock(&dev->lock); | |
990 | dev->port_usb = NULL; | |
991 | link->ioport = NULL; | |
992 | spin_unlock(&dev->lock); | |
993 | } |