2 * u_ether.c -- Ethernet-over-USB link layer utilities for Gadget stack
4 * Copyright (C) 2003-2005,2008 David Brownell
5 * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
6 * Copyright (C) 2008 Nokia Corporation
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.
14 /* #define VERBOSE_DEBUG */
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/gfp.h>
19 #include <linux/device.h>
20 #include <linux/ctype.h>
21 #include <linux/etherdevice.h>
22 #include <linux/ethtool.h>
23 #include <linux/if_vlan.h>
29 * This component encapsulates the Ethernet link glue needed to provide
30 * one (!) network link through the USB gadget stack, normally "usb0".
32 * The control and data models are handled by the function driver which
33 * connects to this code; such as CDC Ethernet (ECM or EEM),
34 * "CDC Subset", or RNDIS. That includes all descriptor and endpoint
37 * Link level addressing is handled by this component using module
38 * parameters; if no such parameters are provided, random link level
39 * addresses are used. Each end of the link uses one address. The
40 * host end address is exported in various ways, and is often recorded
41 * in configuration databases.
43 * The driver which assembles each configuration using such a link is
44 * responsible for ensuring that each configuration includes at most one
45 * instance of is network link. (The network layer provides ways for
46 * this single "physical" link to be used by multiple virtual links.)
49 #define UETH__VERSION "29-May-2008"
51 /* Experiments show that both Linux and Windows hosts allow up to 16k
52 * frame sizes. Set the max size to 15k+52 to prevent allocating 32k
53 * blocks and still have efficient handling. */
54 #define GETHER_MAX_ETH_FRAME_LEN 15412
57 /* lock is held while accessing port_usb
60 struct gether *port_usb;
62 struct net_device *net;
63 struct usb_gadget *gadget;
65 spinlock_t req_lock; /* guard {rx,tx}_reqs */
66 struct list_head tx_reqs, rx_reqs;
69 struct sk_buff_head rx_frames;
74 struct sk_buff *(*wrap)(struct gether *, struct sk_buff *skb);
75 int (*unwrap)(struct gether *,
77 struct sk_buff_head *list);
79 struct work_struct work;
82 #define WORK_RX_MEMORY 0
86 u8 host_mac[ETH_ALEN];
90 /*-------------------------------------------------------------------------*/
92 #define RX_EXTRA 20 /* bytes guarding against rx overflows */
94 #define DEFAULT_QLEN 2 /* double buffering by default */
96 /* for dual-speed hardware, use deeper queues at high/super speed */
97 static inline int qlen(struct usb_gadget *gadget, unsigned qmult)
99 if (gadget_is_dualspeed(gadget) && (gadget->speed == USB_SPEED_HIGH ||
100 gadget->speed >= USB_SPEED_SUPER))
101 return qmult * DEFAULT_QLEN;
106 /*-------------------------------------------------------------------------*/
108 /* REVISIT there must be a better way than having two sets
117 #define xprintk(d, level, fmt, args...) \
118 printk(level "%s: " fmt , (d)->net->name , ## args)
122 #define DBG(dev, fmt, args...) \
123 xprintk(dev , KERN_DEBUG , fmt , ## args)
125 #define DBG(dev, fmt, args...) \
132 #define VDBG(dev, fmt, args...) \
136 #define ERROR(dev, fmt, args...) \
137 xprintk(dev , KERN_ERR , fmt , ## args)
138 #define INFO(dev, fmt, args...) \
139 xprintk(dev , KERN_INFO , fmt , ## args)
141 /*-------------------------------------------------------------------------*/
143 /* NETWORK DRIVER HOOKUP (to the layer above this driver) */
145 static int ueth_change_mtu(struct net_device *net, int new_mtu)
147 if (new_mtu <= ETH_HLEN || new_mtu > GETHER_MAX_ETH_FRAME_LEN)
154 static void eth_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *p)
156 struct eth_dev *dev = netdev_priv(net);
158 strlcpy(p->driver, "g_ether", sizeof(p->driver));
159 strlcpy(p->version, UETH__VERSION, sizeof(p->version));
160 strlcpy(p->fw_version, dev->gadget->name, sizeof(p->fw_version));
161 strlcpy(p->bus_info, dev_name(&dev->gadget->dev), sizeof(p->bus_info));
164 /* REVISIT can also support:
165 * - WOL (by tracking suspends and issuing remote wakeup)
166 * - msglevel (implies updated messaging)
167 * - ... probably more ethtool ops
170 static const struct ethtool_ops ops = {
171 .get_drvinfo = eth_get_drvinfo,
172 .get_link = ethtool_op_get_link,
175 static void defer_kevent(struct eth_dev *dev, int flag)
177 if (test_and_set_bit(flag, &dev->todo))
179 if (!schedule_work(&dev->work))
180 ERROR(dev, "kevent %d may have been dropped\n", flag);
182 DBG(dev, "kevent %d scheduled\n", flag);
185 static void rx_complete(struct usb_ep *ep, struct usb_request *req);
188 rx_submit(struct eth_dev *dev, struct usb_request *req, gfp_t gfp_flags)
191 int retval = -ENOMEM;
196 spin_lock_irqsave(&dev->lock, flags);
198 out = dev->port_usb->out_ep;
204 spin_unlock_irqrestore(&dev->lock, flags);
208 /* Padding up to RX_EXTRA handles minor disagreements with host.
209 * Normally we use the USB "terminate on short read" convention;
210 * so allow up to (N*maxpacket), since that memory is normally
211 * already allocated. Some hardware doesn't deal well with short
212 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
213 * byte off the end (to force hardware errors on overflow).
215 * RNDIS uses internal framing, and explicitly allows senders to
216 * pad to end-of-packet. That's potentially nice for speed, but
217 * means receivers can't recover lost synch on their own (because
218 * new packets don't only start after a short RX).
220 size += sizeof(struct ethhdr) + dev->net->mtu + RX_EXTRA;
221 size += dev->port_usb->header_len;
222 size += out->maxpacket - 1;
223 size -= size % out->maxpacket;
225 if (dev->port_usb->is_fixed)
226 size = max_t(size_t, size, dev->port_usb->fixed_out_len);
227 spin_unlock_irqrestore(&dev->lock, flags);
229 skb = alloc_skb(size + NET_IP_ALIGN, gfp_flags);
231 DBG(dev, "no rx skb\n");
235 /* Some platforms perform better when IP packets are aligned,
236 * but on at least one, checksumming fails otherwise. Note:
237 * RNDIS headers involve variable numbers of LE32 values.
239 if (likely(!dev->no_skb_reserve))
240 skb_reserve(skb, NET_IP_ALIGN);
242 req->buf = skb->data;
244 req->complete = rx_complete;
247 retval = usb_ep_queue(out, req, gfp_flags);
248 if (retval == -ENOMEM)
250 defer_kevent(dev, WORK_RX_MEMORY);
252 DBG(dev, "rx submit --> %d\n", retval);
254 dev_kfree_skb_any(skb);
255 spin_lock_irqsave(&dev->req_lock, flags);
256 list_add(&req->list, &dev->rx_reqs);
257 spin_unlock_irqrestore(&dev->req_lock, flags);
262 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
264 struct sk_buff *skb = req->context, *skb2;
265 struct eth_dev *dev = ep->driver_data;
266 int status = req->status;
270 /* normal completion */
272 skb_put(skb, req->actual);
277 spin_lock_irqsave(&dev->lock, flags);
279 status = dev->unwrap(dev->port_usb,
283 dev_kfree_skb_any(skb);
286 spin_unlock_irqrestore(&dev->lock, flags);
288 skb_queue_tail(&dev->rx_frames, skb);
292 skb2 = skb_dequeue(&dev->rx_frames);
295 || ETH_HLEN > skb2->len
296 || skb2->len > GETHER_MAX_ETH_FRAME_LEN) {
297 dev->net->stats.rx_errors++;
298 dev->net->stats.rx_length_errors++;
299 DBG(dev, "rx length %d\n", skb2->len);
300 dev_kfree_skb_any(skb2);
303 skb2->protocol = eth_type_trans(skb2, dev->net);
304 dev->net->stats.rx_packets++;
305 dev->net->stats.rx_bytes += skb2->len;
307 /* no buffer copies needed, unless hardware can't
310 status = netif_rx(skb2);
312 skb2 = skb_dequeue(&dev->rx_frames);
316 /* software-driven interface shutdown */
317 case -ECONNRESET: /* unlink */
318 case -ESHUTDOWN: /* disconnect etc */
319 VDBG(dev, "rx shutdown, code %d\n", status);
322 /* for hardware automagic (such as pxa) */
323 case -ECONNABORTED: /* endpoint reset */
324 DBG(dev, "rx %s reset\n", ep->name);
325 defer_kevent(dev, WORK_RX_MEMORY);
327 dev_kfree_skb_any(skb);
332 dev->net->stats.rx_over_errors++;
336 dev->net->stats.rx_errors++;
337 DBG(dev, "rx status %d\n", status);
342 dev_kfree_skb_any(skb);
343 if (!netif_running(dev->net)) {
345 spin_lock(&dev->req_lock);
346 list_add(&req->list, &dev->rx_reqs);
347 spin_unlock(&dev->req_lock);
351 rx_submit(dev, req, GFP_ATOMIC);
354 static int prealloc(struct list_head *list, struct usb_ep *ep, unsigned n)
357 struct usb_request *req;
362 /* queue/recycle up to N requests */
364 list_for_each_entry(req, list, list) {
369 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
371 return list_empty(list) ? -ENOMEM : 0;
372 list_add(&req->list, list);
379 struct list_head *next;
381 next = req->list.next;
382 list_del(&req->list);
383 usb_ep_free_request(ep, req);
388 req = container_of(next, struct usb_request, list);
393 static int alloc_requests(struct eth_dev *dev, struct gether *link, unsigned n)
397 spin_lock(&dev->req_lock);
398 status = prealloc(&dev->tx_reqs, link->in_ep, n);
401 status = prealloc(&dev->rx_reqs, link->out_ep, n);
406 DBG(dev, "can't alloc requests\n");
408 spin_unlock(&dev->req_lock);
412 static void rx_fill(struct eth_dev *dev, gfp_t gfp_flags)
414 struct usb_request *req;
417 /* fill unused rxq slots with some skb */
418 spin_lock_irqsave(&dev->req_lock, flags);
419 while (!list_empty(&dev->rx_reqs)) {
420 req = container_of(dev->rx_reqs.next,
421 struct usb_request, list);
422 list_del_init(&req->list);
423 spin_unlock_irqrestore(&dev->req_lock, flags);
425 if (rx_submit(dev, req, gfp_flags) < 0) {
426 defer_kevent(dev, WORK_RX_MEMORY);
430 spin_lock_irqsave(&dev->req_lock, flags);
432 spin_unlock_irqrestore(&dev->req_lock, flags);
435 static void eth_work(struct work_struct *work)
437 struct eth_dev *dev = container_of(work, struct eth_dev, work);
439 if (test_and_clear_bit(WORK_RX_MEMORY, &dev->todo)) {
440 if (netif_running(dev->net))
441 rx_fill(dev, GFP_KERNEL);
445 DBG(dev, "work done, flags = 0x%lx\n", dev->todo);
448 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
450 struct sk_buff *skb = req->context;
451 struct eth_dev *dev = ep->driver_data;
453 switch (req->status) {
455 dev->net->stats.tx_errors++;
456 VDBG(dev, "tx err %d\n", req->status);
458 case -ECONNRESET: /* unlink */
459 case -ESHUTDOWN: /* disconnect etc */
462 dev->net->stats.tx_bytes += skb->len;
464 dev->net->stats.tx_packets++;
466 spin_lock(&dev->req_lock);
467 list_add(&req->list, &dev->tx_reqs);
468 spin_unlock(&dev->req_lock);
469 dev_kfree_skb_any(skb);
471 atomic_dec(&dev->tx_qlen);
472 if (netif_carrier_ok(dev->net))
473 netif_wake_queue(dev->net);
476 static inline int is_promisc(u16 cdc_filter)
478 return cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
481 static netdev_tx_t eth_start_xmit(struct sk_buff *skb,
482 struct net_device *net)
484 struct eth_dev *dev = netdev_priv(net);
487 struct usb_request *req = NULL;
492 spin_lock_irqsave(&dev->lock, flags);
494 in = dev->port_usb->in_ep;
495 cdc_filter = dev->port_usb->cdc_filter;
500 spin_unlock_irqrestore(&dev->lock, flags);
504 dev_kfree_skb_any(skb);
508 /* apply outgoing CDC or RNDIS filters */
509 if (skb && !is_promisc(cdc_filter)) {
510 u8 *dest = skb->data;
512 if (is_multicast_ether_addr(dest)) {
515 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
516 * SET_ETHERNET_MULTICAST_FILTERS requests
518 if (is_broadcast_ether_addr(dest))
519 type = USB_CDC_PACKET_TYPE_BROADCAST;
521 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
522 if (!(cdc_filter & type)) {
523 dev_kfree_skb_any(skb);
527 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
530 spin_lock_irqsave(&dev->req_lock, flags);
532 * this freelist can be empty if an interrupt triggered disconnect()
533 * and reconfigured the gadget (shutting down this queue) after the
534 * network stack decided to xmit but before we got the spinlock.
536 if (list_empty(&dev->tx_reqs)) {
537 spin_unlock_irqrestore(&dev->req_lock, flags);
538 return NETDEV_TX_BUSY;
541 req = container_of(dev->tx_reqs.next, struct usb_request, list);
542 list_del(&req->list);
544 /* temporarily stop TX queue when the freelist empties */
545 if (list_empty(&dev->tx_reqs))
546 netif_stop_queue(net);
547 spin_unlock_irqrestore(&dev->req_lock, flags);
549 /* no buffer copies needed, unless the network stack did it
550 * or the hardware can't use skb buffers.
551 * or there's not enough space for extra headers we need
556 spin_lock_irqsave(&dev->lock, flags);
558 skb = dev->wrap(dev->port_usb, skb);
559 spin_unlock_irqrestore(&dev->lock, flags);
561 /* Multi frame CDC protocols may store the frame for
562 * later which is not a dropped frame.
565 dev->port_usb->supports_multi_frame)
572 req->buf = skb->data;
574 req->complete = tx_complete;
576 /* NCM requires no zlp if transfer is dwNtbInMaxSize */
578 dev->port_usb->is_fixed &&
579 length == dev->port_usb->fixed_in_len &&
580 (length % in->maxpacket) == 0)
585 /* use zlp framing on tx for strict CDC-Ether conformance,
586 * though any robust network rx path ignores extra padding.
587 * and some hardware doesn't like to write zlps.
589 if (req->zero && !dev->zlp && (length % in->maxpacket) == 0)
592 req->length = length;
594 retval = usb_ep_queue(in, req, GFP_ATOMIC);
597 DBG(dev, "tx queue err %d\n", retval);
600 netif_trans_update(net);
601 atomic_inc(&dev->tx_qlen);
605 dev_kfree_skb_any(skb);
607 dev->net->stats.tx_dropped++;
609 spin_lock_irqsave(&dev->req_lock, flags);
610 if (list_empty(&dev->tx_reqs))
611 netif_start_queue(net);
612 list_add(&req->list, &dev->tx_reqs);
613 spin_unlock_irqrestore(&dev->req_lock, flags);
618 /*-------------------------------------------------------------------------*/
620 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
622 DBG(dev, "%s\n", __func__);
624 /* fill the rx queue */
625 rx_fill(dev, gfp_flags);
627 /* and open the tx floodgates */
628 atomic_set(&dev->tx_qlen, 0);
629 netif_wake_queue(dev->net);
632 static int eth_open(struct net_device *net)
634 struct eth_dev *dev = netdev_priv(net);
637 DBG(dev, "%s\n", __func__);
638 if (netif_carrier_ok(dev->net))
639 eth_start(dev, GFP_KERNEL);
641 spin_lock_irq(&dev->lock);
642 link = dev->port_usb;
643 if (link && link->open)
645 spin_unlock_irq(&dev->lock);
650 static int eth_stop(struct net_device *net)
652 struct eth_dev *dev = netdev_priv(net);
655 VDBG(dev, "%s\n", __func__);
656 netif_stop_queue(net);
658 DBG(dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n",
659 dev->net->stats.rx_packets, dev->net->stats.tx_packets,
660 dev->net->stats.rx_errors, dev->net->stats.tx_errors
663 /* ensure there are no more active requests */
664 spin_lock_irqsave(&dev->lock, flags);
666 struct gether *link = dev->port_usb;
667 const struct usb_endpoint_descriptor *in;
668 const struct usb_endpoint_descriptor *out;
673 /* NOTE: we have no abort-queue primitive we could use
674 * to cancel all pending I/O. Instead, we disable then
675 * reenable the endpoints ... this idiom may leave toggle
676 * wrong, but that's a self-correcting error.
678 * REVISIT: we *COULD* just let the transfers complete at
679 * their own pace; the network stack can handle old packets.
680 * For the moment we leave this here, since it works.
682 in = link->in_ep->desc;
683 out = link->out_ep->desc;
684 usb_ep_disable(link->in_ep);
685 usb_ep_disable(link->out_ep);
686 if (netif_carrier_ok(net)) {
687 DBG(dev, "host still using in/out endpoints\n");
688 link->in_ep->desc = in;
689 link->out_ep->desc = out;
690 usb_ep_enable(link->in_ep);
691 usb_ep_enable(link->out_ep);
694 spin_unlock_irqrestore(&dev->lock, flags);
699 /*-------------------------------------------------------------------------*/
701 static int get_ether_addr(const char *str, u8 *dev_addr)
706 for (i = 0; i < 6; i++) {
709 if ((*str == '.') || (*str == ':'))
711 num = hex_to_bin(*str++) << 4;
712 num |= hex_to_bin(*str++);
715 if (is_valid_ether_addr(dev_addr))
718 eth_random_addr(dev_addr);
722 static int get_ether_addr_str(u8 dev_addr[ETH_ALEN], char *str, int len)
727 snprintf(str, len, "%pM", dev_addr);
731 static const struct net_device_ops eth_netdev_ops = {
732 .ndo_open = eth_open,
733 .ndo_stop = eth_stop,
734 .ndo_start_xmit = eth_start_xmit,
735 .ndo_change_mtu = ueth_change_mtu,
736 .ndo_set_mac_address = eth_mac_addr,
737 .ndo_validate_addr = eth_validate_addr,
740 static struct device_type gadget_type = {
745 * gether_setup_name - initialize one ethernet-over-usb link
746 * @g: gadget to associated with these links
747 * @ethaddr: NULL, or a buffer in which the ethernet address of the
748 * host side of the link is recorded
749 * @netname: name for network device (for example, "usb")
752 * This sets up the single network link that may be exported by a
753 * gadget driver using this framework. The link layer addresses are
754 * set up using module parameters.
756 * Returns an eth_dev pointer on success, or an ERR_PTR on failure.
758 struct eth_dev *gether_setup_name(struct usb_gadget *g,
759 const char *dev_addr, const char *host_addr,
760 u8 ethaddr[ETH_ALEN], unsigned qmult, const char *netname)
763 struct net_device *net;
766 net = alloc_etherdev(sizeof *dev);
768 return ERR_PTR(-ENOMEM);
770 dev = netdev_priv(net);
771 spin_lock_init(&dev->lock);
772 spin_lock_init(&dev->req_lock);
773 INIT_WORK(&dev->work, eth_work);
774 INIT_LIST_HEAD(&dev->tx_reqs);
775 INIT_LIST_HEAD(&dev->rx_reqs);
777 skb_queue_head_init(&dev->rx_frames);
779 /* network device setup */
782 snprintf(net->name, sizeof(net->name), "%s%%d", netname);
784 if (get_ether_addr(dev_addr, net->dev_addr))
786 "using random %s ethernet address\n", "self");
787 if (get_ether_addr(host_addr, dev->host_mac))
789 "using random %s ethernet address\n", "host");
792 memcpy(ethaddr, dev->host_mac, ETH_ALEN);
794 net->netdev_ops = ð_netdev_ops;
796 net->ethtool_ops = &ops;
799 SET_NETDEV_DEV(net, &g->dev);
800 SET_NETDEV_DEVTYPE(net, &gadget_type);
802 status = register_netdev(net);
804 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
806 dev = ERR_PTR(status);
808 INFO(dev, "MAC %pM\n", net->dev_addr);
809 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
812 * two kinds of host-initiated state changes:
813 * - iff DATA transfer is active, carrier is "on"
814 * - tx queueing enabled if open *and* carrier is "on"
816 netif_carrier_off(net);
821 EXPORT_SYMBOL_GPL(gether_setup_name);
823 struct net_device *gether_setup_name_default(const char *netname)
825 struct net_device *net;
828 net = alloc_etherdev(sizeof(*dev));
830 return ERR_PTR(-ENOMEM);
832 dev = netdev_priv(net);
833 spin_lock_init(&dev->lock);
834 spin_lock_init(&dev->req_lock);
835 INIT_WORK(&dev->work, eth_work);
836 INIT_LIST_HEAD(&dev->tx_reqs);
837 INIT_LIST_HEAD(&dev->rx_reqs);
839 skb_queue_head_init(&dev->rx_frames);
841 /* network device setup */
843 dev->qmult = QMULT_DEFAULT;
844 snprintf(net->name, sizeof(net->name), "%s%%d", netname);
846 eth_random_addr(dev->dev_mac);
847 pr_warn("using random %s ethernet address\n", "self");
848 eth_random_addr(dev->host_mac);
849 pr_warn("using random %s ethernet address\n", "host");
851 net->netdev_ops = ð_netdev_ops;
853 net->ethtool_ops = &ops;
854 SET_NETDEV_DEVTYPE(net, &gadget_type);
858 EXPORT_SYMBOL_GPL(gether_setup_name_default);
860 int gether_register_netdev(struct net_device *net)
863 struct usb_gadget *g;
867 if (!net->dev.parent)
869 dev = netdev_priv(net);
871 status = register_netdev(net);
873 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
876 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
878 /* two kinds of host-initiated state changes:
879 * - iff DATA transfer is active, carrier is "on"
880 * - tx queueing enabled if open *and* carrier is "on"
882 netif_carrier_off(net);
884 sa.sa_family = net->type;
885 memcpy(sa.sa_data, dev->dev_mac, ETH_ALEN);
887 status = dev_set_mac_address(net, &sa);
890 pr_warn("cannot set self ethernet address: %d\n", status);
892 INFO(dev, "MAC %pM\n", dev->dev_mac);
896 EXPORT_SYMBOL_GPL(gether_register_netdev);
898 void gether_set_gadget(struct net_device *net, struct usb_gadget *g)
902 dev = netdev_priv(net);
904 SET_NETDEV_DEV(net, &g->dev);
906 EXPORT_SYMBOL_GPL(gether_set_gadget);
908 int gether_set_dev_addr(struct net_device *net, const char *dev_addr)
911 u8 new_addr[ETH_ALEN];
913 dev = netdev_priv(net);
914 if (get_ether_addr(dev_addr, new_addr))
916 memcpy(dev->dev_mac, new_addr, ETH_ALEN);
919 EXPORT_SYMBOL_GPL(gether_set_dev_addr);
921 int gether_get_dev_addr(struct net_device *net, char *dev_addr, int len)
925 dev = netdev_priv(net);
926 return get_ether_addr_str(dev->dev_mac, dev_addr, len);
928 EXPORT_SYMBOL_GPL(gether_get_dev_addr);
930 int gether_set_host_addr(struct net_device *net, const char *host_addr)
933 u8 new_addr[ETH_ALEN];
935 dev = netdev_priv(net);
936 if (get_ether_addr(host_addr, new_addr))
938 memcpy(dev->host_mac, new_addr, ETH_ALEN);
941 EXPORT_SYMBOL_GPL(gether_set_host_addr);
943 int gether_get_host_addr(struct net_device *net, char *host_addr, int len)
947 dev = netdev_priv(net);
948 return get_ether_addr_str(dev->host_mac, host_addr, len);
950 EXPORT_SYMBOL_GPL(gether_get_host_addr);
952 int gether_get_host_addr_cdc(struct net_device *net, char *host_addr, int len)
959 dev = netdev_priv(net);
960 snprintf(host_addr, len, "%pm", dev->host_mac);
962 return strlen(host_addr);
964 EXPORT_SYMBOL_GPL(gether_get_host_addr_cdc);
966 void gether_get_host_addr_u8(struct net_device *net, u8 host_mac[ETH_ALEN])
970 dev = netdev_priv(net);
971 memcpy(host_mac, dev->host_mac, ETH_ALEN);
973 EXPORT_SYMBOL_GPL(gether_get_host_addr_u8);
975 void gether_set_qmult(struct net_device *net, unsigned qmult)
979 dev = netdev_priv(net);
982 EXPORT_SYMBOL_GPL(gether_set_qmult);
984 unsigned gether_get_qmult(struct net_device *net)
988 dev = netdev_priv(net);
991 EXPORT_SYMBOL_GPL(gether_get_qmult);
993 int gether_get_ifname(struct net_device *net, char *name, int len)
996 strlcpy(name, netdev_name(net), len);
1000 EXPORT_SYMBOL_GPL(gether_get_ifname);
1003 * gether_cleanup - remove Ethernet-over-USB device
1004 * Context: may sleep
1006 * This is called to free all resources allocated by @gether_setup().
1008 void gether_cleanup(struct eth_dev *dev)
1013 unregister_netdev(dev->net);
1014 flush_work(&dev->work);
1015 free_netdev(dev->net);
1017 EXPORT_SYMBOL_GPL(gether_cleanup);
1020 * gether_connect - notify network layer that USB link is active
1021 * @link: the USB link, set up with endpoints, descriptors matching
1022 * current device speed, and any framing wrapper(s) set up.
1023 * Context: irqs blocked
1025 * This is called to activate endpoints and let the network layer know
1026 * the connection is active ("carrier detect"). It may cause the I/O
1027 * queues to open and start letting network packets flow, but will in
1028 * any case activate the endpoints so that they respond properly to the
1031 * Verify net_device pointer returned using IS_ERR(). If it doesn't
1032 * indicate some error code (negative errno), ep->driver_data values
1033 * have been overwritten.
1035 struct net_device *gether_connect(struct gether *link)
1037 struct eth_dev *dev = link->ioport;
1041 return ERR_PTR(-EINVAL);
1043 link->in_ep->driver_data = dev;
1044 result = usb_ep_enable(link->in_ep);
1046 DBG(dev, "enable %s --> %d\n",
1047 link->in_ep->name, result);
1051 link->out_ep->driver_data = dev;
1052 result = usb_ep_enable(link->out_ep);
1054 DBG(dev, "enable %s --> %d\n",
1055 link->out_ep->name, result);
1060 result = alloc_requests(dev, link, qlen(dev->gadget,
1064 dev->zlp = link->is_zlp_ok;
1065 dev->no_skb_reserve = link->no_skb_reserve;
1066 DBG(dev, "qlen %d\n", qlen(dev->gadget, dev->qmult));
1068 dev->header_len = link->header_len;
1069 dev->unwrap = link->unwrap;
1070 dev->wrap = link->wrap;
1072 spin_lock(&dev->lock);
1073 dev->port_usb = link;
1074 if (netif_running(dev->net)) {
1081 spin_unlock(&dev->lock);
1083 netif_carrier_on(dev->net);
1084 if (netif_running(dev->net))
1085 eth_start(dev, GFP_ATOMIC);
1087 /* on error, disable any endpoints */
1089 (void) usb_ep_disable(link->out_ep);
1091 (void) usb_ep_disable(link->in_ep);
1094 /* caller is responsible for cleanup on error */
1096 return ERR_PTR(result);
1099 EXPORT_SYMBOL_GPL(gether_connect);
1102 * gether_disconnect - notify network layer that USB link is inactive
1103 * @link: the USB link, on which gether_connect() was called
1104 * Context: irqs blocked
1106 * This is called to deactivate endpoints and let the network layer know
1107 * the connection went inactive ("no carrier").
1109 * On return, the state is as if gether_connect() had never been called.
1110 * The endpoints are inactive, and accordingly without active USB I/O.
1111 * Pointers to endpoint descriptors and endpoint private data are nulled.
1113 void gether_disconnect(struct gether *link)
1115 struct eth_dev *dev = link->ioport;
1116 struct usb_request *req;
1122 DBG(dev, "%s\n", __func__);
1124 netif_stop_queue(dev->net);
1125 netif_carrier_off(dev->net);
1127 /* disable endpoints, forcing (synchronous) completion
1128 * of all pending i/o. then free the request objects
1129 * and forget about the endpoints.
1131 usb_ep_disable(link->in_ep);
1132 spin_lock(&dev->req_lock);
1133 while (!list_empty(&dev->tx_reqs)) {
1134 req = container_of(dev->tx_reqs.next,
1135 struct usb_request, list);
1136 list_del(&req->list);
1138 spin_unlock(&dev->req_lock);
1139 usb_ep_free_request(link->in_ep, req);
1140 spin_lock(&dev->req_lock);
1142 spin_unlock(&dev->req_lock);
1143 link->in_ep->desc = NULL;
1145 usb_ep_disable(link->out_ep);
1146 spin_lock(&dev->req_lock);
1147 while (!list_empty(&dev->rx_reqs)) {
1148 req = container_of(dev->rx_reqs.next,
1149 struct usb_request, list);
1150 list_del(&req->list);
1152 spin_unlock(&dev->req_lock);
1153 usb_ep_free_request(link->out_ep, req);
1154 spin_lock(&dev->req_lock);
1156 spin_unlock(&dev->req_lock);
1157 link->out_ep->desc = NULL;
1159 /* finish forgetting about this USB link episode */
1160 dev->header_len = 0;
1164 spin_lock(&dev->lock);
1165 dev->port_usb = NULL;
1166 spin_unlock(&dev->lock);
1168 EXPORT_SYMBOL_GPL(gether_disconnect);
1170 MODULE_LICENSE("GPL");
1171 MODULE_AUTHOR("David Brownell");