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
85 u8 host_mac[ETH_ALEN];
89 /*-------------------------------------------------------------------------*/
91 #define RX_EXTRA 20 /* bytes guarding against rx overflows */
93 #define DEFAULT_QLEN 2 /* double buffering by default */
95 /* for dual-speed hardware, use deeper queues at high/super speed */
96 static inline int qlen(struct usb_gadget *gadget, unsigned qmult)
98 if (gadget_is_dualspeed(gadget) && (gadget->speed == USB_SPEED_HIGH ||
99 gadget->speed == USB_SPEED_SUPER))
100 return qmult * DEFAULT_QLEN;
105 /*-------------------------------------------------------------------------*/
107 /* REVISIT there must be a better way than having two sets
116 #define xprintk(d, level, fmt, args...) \
117 printk(level "%s: " fmt , (d)->net->name , ## args)
121 #define DBG(dev, fmt, args...) \
122 xprintk(dev , KERN_DEBUG , fmt , ## args)
124 #define DBG(dev, fmt, args...) \
131 #define VDBG(dev, fmt, args...) \
135 #define ERROR(dev, fmt, args...) \
136 xprintk(dev , KERN_ERR , fmt , ## args)
137 #define INFO(dev, fmt, args...) \
138 xprintk(dev , KERN_INFO , fmt , ## args)
140 /*-------------------------------------------------------------------------*/
142 /* NETWORK DRIVER HOOKUP (to the layer above this driver) */
144 static int ueth_change_mtu(struct net_device *net, int new_mtu)
146 struct eth_dev *dev = netdev_priv(net);
150 /* don't change MTU on "live" link (peer won't know) */
151 spin_lock_irqsave(&dev->lock, flags);
154 else if (new_mtu <= ETH_HLEN || new_mtu > GETHER_MAX_ETH_FRAME_LEN)
158 spin_unlock_irqrestore(&dev->lock, flags);
163 static void eth_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *p)
165 struct eth_dev *dev = netdev_priv(net);
167 strlcpy(p->driver, "g_ether", sizeof(p->driver));
168 strlcpy(p->version, UETH__VERSION, sizeof(p->version));
169 strlcpy(p->fw_version, dev->gadget->name, sizeof(p->fw_version));
170 strlcpy(p->bus_info, dev_name(&dev->gadget->dev), sizeof(p->bus_info));
173 /* REVISIT can also support:
174 * - WOL (by tracking suspends and issuing remote wakeup)
175 * - msglevel (implies updated messaging)
176 * - ... probably more ethtool ops
179 static const struct ethtool_ops ops = {
180 .get_drvinfo = eth_get_drvinfo,
181 .get_link = ethtool_op_get_link,
184 static void defer_kevent(struct eth_dev *dev, int flag)
186 if (test_and_set_bit(flag, &dev->todo))
188 if (!schedule_work(&dev->work))
189 ERROR(dev, "kevent %d may have been dropped\n", flag);
191 DBG(dev, "kevent %d scheduled\n", flag);
194 static void rx_complete(struct usb_ep *ep, struct usb_request *req);
197 rx_submit(struct eth_dev *dev, struct usb_request *req, gfp_t gfp_flags)
200 int retval = -ENOMEM;
205 spin_lock_irqsave(&dev->lock, flags);
207 out = dev->port_usb->out_ep;
210 spin_unlock_irqrestore(&dev->lock, flags);
216 /* Padding up to RX_EXTRA handles minor disagreements with host.
217 * Normally we use the USB "terminate on short read" convention;
218 * so allow up to (N*maxpacket), since that memory is normally
219 * already allocated. Some hardware doesn't deal well with short
220 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
221 * byte off the end (to force hardware errors on overflow).
223 * RNDIS uses internal framing, and explicitly allows senders to
224 * pad to end-of-packet. That's potentially nice for speed, but
225 * means receivers can't recover lost synch on their own (because
226 * new packets don't only start after a short RX).
228 size += sizeof(struct ethhdr) + dev->net->mtu + RX_EXTRA;
229 size += dev->port_usb->header_len;
230 size += out->maxpacket - 1;
231 size -= size % out->maxpacket;
233 if (dev->port_usb->is_fixed)
234 size = max_t(size_t, size, dev->port_usb->fixed_out_len);
236 skb = alloc_skb(size + NET_IP_ALIGN, gfp_flags);
238 DBG(dev, "no rx skb\n");
242 /* Some platforms perform better when IP packets are aligned,
243 * but on at least one, checksumming fails otherwise. Note:
244 * RNDIS headers involve variable numbers of LE32 values.
246 skb_reserve(skb, NET_IP_ALIGN);
248 req->buf = skb->data;
250 req->complete = rx_complete;
253 retval = usb_ep_queue(out, req, gfp_flags);
254 if (retval == -ENOMEM)
256 defer_kevent(dev, WORK_RX_MEMORY);
258 DBG(dev, "rx submit --> %d\n", retval);
260 dev_kfree_skb_any(skb);
261 spin_lock_irqsave(&dev->req_lock, flags);
262 list_add(&req->list, &dev->rx_reqs);
263 spin_unlock_irqrestore(&dev->req_lock, flags);
268 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
270 struct sk_buff *skb = req->context, *skb2;
271 struct eth_dev *dev = ep->driver_data;
272 int status = req->status;
276 /* normal completion */
278 skb_put(skb, req->actual);
283 spin_lock_irqsave(&dev->lock, flags);
285 status = dev->unwrap(dev->port_usb,
289 dev_kfree_skb_any(skb);
292 spin_unlock_irqrestore(&dev->lock, flags);
294 skb_queue_tail(&dev->rx_frames, skb);
298 skb2 = skb_dequeue(&dev->rx_frames);
301 || ETH_HLEN > skb2->len
302 || skb2->len > GETHER_MAX_ETH_FRAME_LEN) {
303 dev->net->stats.rx_errors++;
304 dev->net->stats.rx_length_errors++;
305 DBG(dev, "rx length %d\n", skb2->len);
306 dev_kfree_skb_any(skb2);
309 skb2->protocol = eth_type_trans(skb2, dev->net);
310 dev->net->stats.rx_packets++;
311 dev->net->stats.rx_bytes += skb2->len;
313 /* no buffer copies needed, unless hardware can't
316 status = netif_rx(skb2);
318 skb2 = skb_dequeue(&dev->rx_frames);
322 /* software-driven interface shutdown */
323 case -ECONNRESET: /* unlink */
324 case -ESHUTDOWN: /* disconnect etc */
325 VDBG(dev, "rx shutdown, code %d\n", status);
328 /* for hardware automagic (such as pxa) */
329 case -ECONNABORTED: /* endpoint reset */
330 DBG(dev, "rx %s reset\n", ep->name);
331 defer_kevent(dev, WORK_RX_MEMORY);
333 dev_kfree_skb_any(skb);
338 dev->net->stats.rx_over_errors++;
342 dev->net->stats.rx_errors++;
343 DBG(dev, "rx status %d\n", status);
348 dev_kfree_skb_any(skb);
349 if (!netif_running(dev->net)) {
351 spin_lock(&dev->req_lock);
352 list_add(&req->list, &dev->rx_reqs);
353 spin_unlock(&dev->req_lock);
357 rx_submit(dev, req, GFP_ATOMIC);
360 static int prealloc(struct list_head *list, struct usb_ep *ep, unsigned n)
363 struct usb_request *req;
368 /* queue/recycle up to N requests */
370 list_for_each_entry(req, list, list) {
375 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
377 return list_empty(list) ? -ENOMEM : 0;
378 list_add(&req->list, list);
385 struct list_head *next;
387 next = req->list.next;
388 list_del(&req->list);
389 usb_ep_free_request(ep, req);
394 req = container_of(next, struct usb_request, list);
399 static int alloc_requests(struct eth_dev *dev, struct gether *link, unsigned n)
403 spin_lock(&dev->req_lock);
404 status = prealloc(&dev->tx_reqs, link->in_ep, n);
407 status = prealloc(&dev->rx_reqs, link->out_ep, n);
412 DBG(dev, "can't alloc requests\n");
414 spin_unlock(&dev->req_lock);
418 static void rx_fill(struct eth_dev *dev, gfp_t gfp_flags)
420 struct usb_request *req;
423 /* fill unused rxq slots with some skb */
424 spin_lock_irqsave(&dev->req_lock, flags);
425 while (!list_empty(&dev->rx_reqs)) {
426 req = container_of(dev->rx_reqs.next,
427 struct usb_request, list);
428 list_del_init(&req->list);
429 spin_unlock_irqrestore(&dev->req_lock, flags);
431 if (rx_submit(dev, req, gfp_flags) < 0) {
432 defer_kevent(dev, WORK_RX_MEMORY);
436 spin_lock_irqsave(&dev->req_lock, flags);
438 spin_unlock_irqrestore(&dev->req_lock, flags);
441 static void eth_work(struct work_struct *work)
443 struct eth_dev *dev = container_of(work, struct eth_dev, work);
445 if (test_and_clear_bit(WORK_RX_MEMORY, &dev->todo)) {
446 if (netif_running(dev->net))
447 rx_fill(dev, GFP_KERNEL);
451 DBG(dev, "work done, flags = 0x%lx\n", dev->todo);
454 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
456 struct sk_buff *skb = req->context;
457 struct eth_dev *dev = ep->driver_data;
459 switch (req->status) {
461 dev->net->stats.tx_errors++;
462 VDBG(dev, "tx err %d\n", req->status);
464 case -ECONNRESET: /* unlink */
465 case -ESHUTDOWN: /* disconnect etc */
468 dev->net->stats.tx_bytes += skb->len;
470 dev->net->stats.tx_packets++;
472 spin_lock(&dev->req_lock);
473 list_add(&req->list, &dev->tx_reqs);
474 spin_unlock(&dev->req_lock);
475 dev_kfree_skb_any(skb);
477 atomic_dec(&dev->tx_qlen);
478 if (netif_carrier_ok(dev->net))
479 netif_wake_queue(dev->net);
482 static inline int is_promisc(u16 cdc_filter)
484 return cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
487 static netdev_tx_t eth_start_xmit(struct sk_buff *skb,
488 struct net_device *net)
490 struct eth_dev *dev = netdev_priv(net);
493 struct usb_request *req = NULL;
498 spin_lock_irqsave(&dev->lock, flags);
500 in = dev->port_usb->in_ep;
501 cdc_filter = dev->port_usb->cdc_filter;
506 spin_unlock_irqrestore(&dev->lock, flags);
509 dev_kfree_skb_any(skb);
513 /* apply outgoing CDC or RNDIS filters */
514 if (skb && !is_promisc(cdc_filter)) {
515 u8 *dest = skb->data;
517 if (is_multicast_ether_addr(dest)) {
520 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
521 * SET_ETHERNET_MULTICAST_FILTERS requests
523 if (is_broadcast_ether_addr(dest))
524 type = USB_CDC_PACKET_TYPE_BROADCAST;
526 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
527 if (!(cdc_filter & type)) {
528 dev_kfree_skb_any(skb);
532 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
535 spin_lock_irqsave(&dev->req_lock, flags);
537 * this freelist can be empty if an interrupt triggered disconnect()
538 * and reconfigured the gadget (shutting down this queue) after the
539 * network stack decided to xmit but before we got the spinlock.
541 if (list_empty(&dev->tx_reqs)) {
542 spin_unlock_irqrestore(&dev->req_lock, flags);
543 return NETDEV_TX_BUSY;
546 req = container_of(dev->tx_reqs.next, struct usb_request, list);
547 list_del(&req->list);
549 /* temporarily stop TX queue when the freelist empties */
550 if (list_empty(&dev->tx_reqs))
551 netif_stop_queue(net);
552 spin_unlock_irqrestore(&dev->req_lock, flags);
554 /* no buffer copies needed, unless the network stack did it
555 * or the hardware can't use skb buffers.
556 * or there's not enough space for extra headers we need
561 spin_lock_irqsave(&dev->lock, flags);
563 skb = dev->wrap(dev->port_usb, skb);
564 spin_unlock_irqrestore(&dev->lock, flags);
566 /* Multi frame CDC protocols may store the frame for
567 * later which is not a dropped frame.
569 if (dev->port_usb->supports_multi_frame)
576 req->buf = skb->data;
578 req->complete = tx_complete;
580 /* NCM requires no zlp if transfer is dwNtbInMaxSize */
581 if (dev->port_usb->is_fixed &&
582 length == dev->port_usb->fixed_in_len &&
583 (length % in->maxpacket) == 0)
588 /* use zlp framing on tx for strict CDC-Ether conformance,
589 * though any robust network rx path ignores extra padding.
590 * and some hardware doesn't like to write zlps.
592 if (req->zero && !dev->zlp && (length % in->maxpacket) == 0)
595 req->length = length;
597 /* throttle high/super speed IRQ rate back slightly */
598 if (gadget_is_dualspeed(dev->gadget))
599 req->no_interrupt = (((dev->gadget->speed == USB_SPEED_HIGH ||
600 dev->gadget->speed == USB_SPEED_SUPER)) &&
601 !list_empty(&dev->tx_reqs))
602 ? ((atomic_read(&dev->tx_qlen) % dev->qmult) != 0)
605 retval = usb_ep_queue(in, req, GFP_ATOMIC);
608 DBG(dev, "tx queue err %d\n", retval);
611 net->trans_start = jiffies;
612 atomic_inc(&dev->tx_qlen);
616 dev_kfree_skb_any(skb);
618 dev->net->stats.tx_dropped++;
620 spin_lock_irqsave(&dev->req_lock, flags);
621 if (list_empty(&dev->tx_reqs))
622 netif_start_queue(net);
623 list_add(&req->list, &dev->tx_reqs);
624 spin_unlock_irqrestore(&dev->req_lock, flags);
629 /*-------------------------------------------------------------------------*/
631 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
633 DBG(dev, "%s\n", __func__);
635 /* fill the rx queue */
636 rx_fill(dev, gfp_flags);
638 /* and open the tx floodgates */
639 atomic_set(&dev->tx_qlen, 0);
640 netif_wake_queue(dev->net);
643 static int eth_open(struct net_device *net)
645 struct eth_dev *dev = netdev_priv(net);
648 DBG(dev, "%s\n", __func__);
649 if (netif_carrier_ok(dev->net))
650 eth_start(dev, GFP_KERNEL);
652 spin_lock_irq(&dev->lock);
653 link = dev->port_usb;
654 if (link && link->open)
656 spin_unlock_irq(&dev->lock);
661 static int eth_stop(struct net_device *net)
663 struct eth_dev *dev = netdev_priv(net);
666 VDBG(dev, "%s\n", __func__);
667 netif_stop_queue(net);
669 DBG(dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n",
670 dev->net->stats.rx_packets, dev->net->stats.tx_packets,
671 dev->net->stats.rx_errors, dev->net->stats.tx_errors
674 /* ensure there are no more active requests */
675 spin_lock_irqsave(&dev->lock, flags);
677 struct gether *link = dev->port_usb;
678 const struct usb_endpoint_descriptor *in;
679 const struct usb_endpoint_descriptor *out;
684 /* NOTE: we have no abort-queue primitive we could use
685 * to cancel all pending I/O. Instead, we disable then
686 * reenable the endpoints ... this idiom may leave toggle
687 * wrong, but that's a self-correcting error.
689 * REVISIT: we *COULD* just let the transfers complete at
690 * their own pace; the network stack can handle old packets.
691 * For the moment we leave this here, since it works.
693 in = link->in_ep->desc;
694 out = link->out_ep->desc;
695 usb_ep_disable(link->in_ep);
696 usb_ep_disable(link->out_ep);
697 if (netif_carrier_ok(net)) {
698 DBG(dev, "host still using in/out endpoints\n");
699 link->in_ep->desc = in;
700 link->out_ep->desc = out;
701 usb_ep_enable(link->in_ep);
702 usb_ep_enable(link->out_ep);
705 spin_unlock_irqrestore(&dev->lock, flags);
710 /*-------------------------------------------------------------------------*/
712 static int get_ether_addr(const char *str, u8 *dev_addr)
717 for (i = 0; i < 6; i++) {
720 if ((*str == '.') || (*str == ':'))
722 num = hex_to_bin(*str++) << 4;
723 num |= hex_to_bin(*str++);
726 if (is_valid_ether_addr(dev_addr))
729 eth_random_addr(dev_addr);
733 static int get_ether_addr_str(u8 dev_addr[ETH_ALEN], char *str, int len)
738 snprintf(str, len, "%pM", dev_addr);
742 static const struct net_device_ops eth_netdev_ops = {
743 .ndo_open = eth_open,
744 .ndo_stop = eth_stop,
745 .ndo_start_xmit = eth_start_xmit,
746 .ndo_change_mtu = ueth_change_mtu,
747 .ndo_set_mac_address = eth_mac_addr,
748 .ndo_validate_addr = eth_validate_addr,
751 static struct device_type gadget_type = {
756 * gether_setup_name - initialize one ethernet-over-usb link
757 * @g: gadget to associated with these links
758 * @ethaddr: NULL, or a buffer in which the ethernet address of the
759 * host side of the link is recorded
760 * @netname: name for network device (for example, "usb")
763 * This sets up the single network link that may be exported by a
764 * gadget driver using this framework. The link layer addresses are
765 * set up using module parameters.
767 * Returns an eth_dev pointer on success, or an ERR_PTR on failure.
769 struct eth_dev *gether_setup_name(struct usb_gadget *g,
770 const char *dev_addr, const char *host_addr,
771 u8 ethaddr[ETH_ALEN], unsigned qmult, const char *netname)
774 struct net_device *net;
777 net = alloc_etherdev(sizeof *dev);
779 return ERR_PTR(-ENOMEM);
781 dev = netdev_priv(net);
782 spin_lock_init(&dev->lock);
783 spin_lock_init(&dev->req_lock);
784 INIT_WORK(&dev->work, eth_work);
785 INIT_LIST_HEAD(&dev->tx_reqs);
786 INIT_LIST_HEAD(&dev->rx_reqs);
788 skb_queue_head_init(&dev->rx_frames);
790 /* network device setup */
793 snprintf(net->name, sizeof(net->name), "%s%%d", netname);
795 if (get_ether_addr(dev_addr, net->dev_addr))
797 "using random %s ethernet address\n", "self");
798 if (get_ether_addr(host_addr, dev->host_mac))
800 "using random %s ethernet address\n", "host");
803 memcpy(ethaddr, dev->host_mac, ETH_ALEN);
805 net->netdev_ops = ð_netdev_ops;
807 net->ethtool_ops = &ops;
810 SET_NETDEV_DEV(net, &g->dev);
811 SET_NETDEV_DEVTYPE(net, &gadget_type);
813 status = register_netdev(net);
815 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
817 dev = ERR_PTR(status);
819 INFO(dev, "MAC %pM\n", net->dev_addr);
820 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
823 * two kinds of host-initiated state changes:
824 * - iff DATA transfer is active, carrier is "on"
825 * - tx queueing enabled if open *and* carrier is "on"
827 netif_carrier_off(net);
832 EXPORT_SYMBOL_GPL(gether_setup_name);
834 struct net_device *gether_setup_name_default(const char *netname)
836 struct net_device *net;
839 net = alloc_etherdev(sizeof(*dev));
841 return ERR_PTR(-ENOMEM);
843 dev = netdev_priv(net);
844 spin_lock_init(&dev->lock);
845 spin_lock_init(&dev->req_lock);
846 INIT_WORK(&dev->work, eth_work);
847 INIT_LIST_HEAD(&dev->tx_reqs);
848 INIT_LIST_HEAD(&dev->rx_reqs);
850 skb_queue_head_init(&dev->rx_frames);
852 /* network device setup */
854 dev->qmult = QMULT_DEFAULT;
855 snprintf(net->name, sizeof(net->name), "%s%%d", netname);
857 eth_random_addr(dev->dev_mac);
858 pr_warn("using random %s ethernet address\n", "self");
859 eth_random_addr(dev->host_mac);
860 pr_warn("using random %s ethernet address\n", "host");
862 net->netdev_ops = ð_netdev_ops;
864 net->ethtool_ops = &ops;
865 SET_NETDEV_DEVTYPE(net, &gadget_type);
869 EXPORT_SYMBOL_GPL(gether_setup_name_default);
871 int gether_register_netdev(struct net_device *net)
874 struct usb_gadget *g;
878 if (!net->dev.parent)
880 dev = netdev_priv(net);
882 status = register_netdev(net);
884 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
887 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
889 /* two kinds of host-initiated state changes:
890 * - iff DATA transfer is active, carrier is "on"
891 * - tx queueing enabled if open *and* carrier is "on"
893 netif_carrier_off(net);
895 sa.sa_family = net->type;
896 memcpy(sa.sa_data, dev->dev_mac, ETH_ALEN);
898 status = dev_set_mac_address(net, &sa);
901 pr_warn("cannot set self ethernet address: %d\n", status);
903 INFO(dev, "MAC %pM\n", dev->dev_mac);
907 EXPORT_SYMBOL_GPL(gether_register_netdev);
909 void gether_set_gadget(struct net_device *net, struct usb_gadget *g)
913 dev = netdev_priv(net);
915 SET_NETDEV_DEV(net, &g->dev);
917 EXPORT_SYMBOL_GPL(gether_set_gadget);
919 int gether_set_dev_addr(struct net_device *net, const char *dev_addr)
922 u8 new_addr[ETH_ALEN];
924 dev = netdev_priv(net);
925 if (get_ether_addr(dev_addr, new_addr))
927 memcpy(dev->dev_mac, new_addr, ETH_ALEN);
930 EXPORT_SYMBOL_GPL(gether_set_dev_addr);
932 int gether_get_dev_addr(struct net_device *net, char *dev_addr, int len)
936 dev = netdev_priv(net);
937 return get_ether_addr_str(dev->dev_mac, dev_addr, len);
939 EXPORT_SYMBOL_GPL(gether_get_dev_addr);
941 int gether_set_host_addr(struct net_device *net, const char *host_addr)
944 u8 new_addr[ETH_ALEN];
946 dev = netdev_priv(net);
947 if (get_ether_addr(host_addr, new_addr))
949 memcpy(dev->host_mac, new_addr, ETH_ALEN);
952 EXPORT_SYMBOL_GPL(gether_set_host_addr);
954 int gether_get_host_addr(struct net_device *net, char *host_addr, int len)
958 dev = netdev_priv(net);
959 return get_ether_addr_str(dev->host_mac, host_addr, len);
961 EXPORT_SYMBOL_GPL(gether_get_host_addr);
963 int gether_get_host_addr_cdc(struct net_device *net, char *host_addr, int len)
970 dev = netdev_priv(net);
971 snprintf(host_addr, len, "%pm", dev->host_mac);
973 return strlen(host_addr);
975 EXPORT_SYMBOL_GPL(gether_get_host_addr_cdc);
977 void gether_get_host_addr_u8(struct net_device *net, u8 host_mac[ETH_ALEN])
981 dev = netdev_priv(net);
982 memcpy(host_mac, dev->host_mac, ETH_ALEN);
984 EXPORT_SYMBOL_GPL(gether_get_host_addr_u8);
986 void gether_set_qmult(struct net_device *net, unsigned qmult)
990 dev = netdev_priv(net);
993 EXPORT_SYMBOL_GPL(gether_set_qmult);
995 unsigned gether_get_qmult(struct net_device *net)
999 dev = netdev_priv(net);
1002 EXPORT_SYMBOL_GPL(gether_get_qmult);
1004 int gether_get_ifname(struct net_device *net, char *name, int len)
1007 strlcpy(name, netdev_name(net), len);
1009 return strlen(name);
1011 EXPORT_SYMBOL_GPL(gether_get_ifname);
1014 * gether_cleanup - remove Ethernet-over-USB device
1015 * Context: may sleep
1017 * This is called to free all resources allocated by @gether_setup().
1019 void gether_cleanup(struct eth_dev *dev)
1024 unregister_netdev(dev->net);
1025 flush_work(&dev->work);
1026 free_netdev(dev->net);
1028 EXPORT_SYMBOL_GPL(gether_cleanup);
1031 * gether_connect - notify network layer that USB link is active
1032 * @link: the USB link, set up with endpoints, descriptors matching
1033 * current device speed, and any framing wrapper(s) set up.
1034 * Context: irqs blocked
1036 * This is called to activate endpoints and let the network layer know
1037 * the connection is active ("carrier detect"). It may cause the I/O
1038 * queues to open and start letting network packets flow, but will in
1039 * any case activate the endpoints so that they respond properly to the
1042 * Verify net_device pointer returned using IS_ERR(). If it doesn't
1043 * indicate some error code (negative errno), ep->driver_data values
1044 * have been overwritten.
1046 struct net_device *gether_connect(struct gether *link)
1048 struct eth_dev *dev = link->ioport;
1052 return ERR_PTR(-EINVAL);
1054 link->in_ep->driver_data = dev;
1055 result = usb_ep_enable(link->in_ep);
1057 DBG(dev, "enable %s --> %d\n",
1058 link->in_ep->name, result);
1062 link->out_ep->driver_data = dev;
1063 result = usb_ep_enable(link->out_ep);
1065 DBG(dev, "enable %s --> %d\n",
1066 link->out_ep->name, result);
1071 result = alloc_requests(dev, link, qlen(dev->gadget,
1075 dev->zlp = link->is_zlp_ok;
1076 DBG(dev, "qlen %d\n", qlen(dev->gadget, dev->qmult));
1078 dev->header_len = link->header_len;
1079 dev->unwrap = link->unwrap;
1080 dev->wrap = link->wrap;
1082 spin_lock(&dev->lock);
1083 dev->port_usb = link;
1084 if (netif_running(dev->net)) {
1091 spin_unlock(&dev->lock);
1093 netif_carrier_on(dev->net);
1094 if (netif_running(dev->net))
1095 eth_start(dev, GFP_ATOMIC);
1097 /* on error, disable any endpoints */
1099 (void) usb_ep_disable(link->out_ep);
1101 (void) usb_ep_disable(link->in_ep);
1104 /* caller is responsible for cleanup on error */
1106 return ERR_PTR(result);
1109 EXPORT_SYMBOL_GPL(gether_connect);
1112 * gether_disconnect - notify network layer that USB link is inactive
1113 * @link: the USB link, on which gether_connect() was called
1114 * Context: irqs blocked
1116 * This is called to deactivate endpoints and let the network layer know
1117 * the connection went inactive ("no carrier").
1119 * On return, the state is as if gether_connect() had never been called.
1120 * The endpoints are inactive, and accordingly without active USB I/O.
1121 * Pointers to endpoint descriptors and endpoint private data are nulled.
1123 void gether_disconnect(struct gether *link)
1125 struct eth_dev *dev = link->ioport;
1126 struct usb_request *req;
1132 DBG(dev, "%s\n", __func__);
1134 netif_stop_queue(dev->net);
1135 netif_carrier_off(dev->net);
1137 /* disable endpoints, forcing (synchronous) completion
1138 * of all pending i/o. then free the request objects
1139 * and forget about the endpoints.
1141 usb_ep_disable(link->in_ep);
1142 spin_lock(&dev->req_lock);
1143 while (!list_empty(&dev->tx_reqs)) {
1144 req = container_of(dev->tx_reqs.next,
1145 struct usb_request, list);
1146 list_del(&req->list);
1148 spin_unlock(&dev->req_lock);
1149 usb_ep_free_request(link->in_ep, req);
1150 spin_lock(&dev->req_lock);
1152 spin_unlock(&dev->req_lock);
1153 link->in_ep->desc = NULL;
1155 usb_ep_disable(link->out_ep);
1156 spin_lock(&dev->req_lock);
1157 while (!list_empty(&dev->rx_reqs)) {
1158 req = container_of(dev->rx_reqs.next,
1159 struct usb_request, list);
1160 list_del(&req->list);
1162 spin_unlock(&dev->req_lock);
1163 usb_ep_free_request(link->out_ep, req);
1164 spin_lock(&dev->req_lock);
1166 spin_unlock(&dev->req_lock);
1167 link->out_ep->desc = NULL;
1169 /* finish forgetting about this USB link episode */
1170 dev->header_len = 0;
1174 spin_lock(&dev->lock);
1175 dev->port_usb = NULL;
1176 spin_unlock(&dev->lock);
1178 EXPORT_SYMBOL_GPL(gether_disconnect);
1180 MODULE_LICENSE("GPL");
1181 MODULE_AUTHOR("David Brownell");