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;
213 spin_unlock_irqrestore(&dev->lock, flags);
217 /* Padding up to RX_EXTRA handles minor disagreements with host.
218 * Normally we use the USB "terminate on short read" convention;
219 * so allow up to (N*maxpacket), since that memory is normally
220 * already allocated. Some hardware doesn't deal well with short
221 * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
222 * byte off the end (to force hardware errors on overflow).
224 * RNDIS uses internal framing, and explicitly allows senders to
225 * pad to end-of-packet. That's potentially nice for speed, but
226 * means receivers can't recover lost synch on their own (because
227 * new packets don't only start after a short RX).
229 size += sizeof(struct ethhdr) + dev->net->mtu + RX_EXTRA;
230 size += dev->port_usb->header_len;
231 size += out->maxpacket - 1;
232 size -= size % out->maxpacket;
234 if (dev->port_usb->is_fixed)
235 size = max_t(size_t, size, dev->port_usb->fixed_out_len);
236 spin_unlock_irqrestore(&dev->lock, flags);
238 skb = alloc_skb(size + NET_IP_ALIGN, gfp_flags);
240 DBG(dev, "no rx skb\n");
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.
248 skb_reserve(skb, NET_IP_ALIGN);
250 req->buf = skb->data;
252 req->complete = rx_complete;
255 retval = usb_ep_queue(out, req, gfp_flags);
256 if (retval == -ENOMEM)
258 defer_kevent(dev, WORK_RX_MEMORY);
260 DBG(dev, "rx submit --> %d\n", retval);
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);
270 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
272 struct sk_buff *skb = req->context, *skb2;
273 struct eth_dev *dev = ep->driver_data;
274 int status = req->status;
278 /* normal completion */
280 skb_put(skb, req->actual);
285 spin_lock_irqsave(&dev->lock, flags);
287 status = dev->unwrap(dev->port_usb,
291 dev_kfree_skb_any(skb);
294 spin_unlock_irqrestore(&dev->lock, flags);
296 skb_queue_tail(&dev->rx_frames, skb);
300 skb2 = skb_dequeue(&dev->rx_frames);
303 || ETH_HLEN > skb2->len
304 || skb2->len > GETHER_MAX_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);
311 skb2->protocol = eth_type_trans(skb2, dev->net);
312 dev->net->stats.rx_packets++;
313 dev->net->stats.rx_bytes += skb2->len;
315 /* no buffer copies needed, unless hardware can't
318 status = netif_rx(skb2);
320 skb2 = skb_dequeue(&dev->rx_frames);
324 /* software-driven interface shutdown */
325 case -ECONNRESET: /* unlink */
326 case -ESHUTDOWN: /* disconnect etc */
327 VDBG(dev, "rx shutdown, code %d\n", status);
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);
335 dev_kfree_skb_any(skb);
340 dev->net->stats.rx_over_errors++;
344 dev->net->stats.rx_errors++;
345 DBG(dev, "rx status %d\n", status);
350 dev_kfree_skb_any(skb);
351 if (!netif_running(dev->net)) {
353 spin_lock(&dev->req_lock);
354 list_add(&req->list, &dev->rx_reqs);
355 spin_unlock(&dev->req_lock);
359 rx_submit(dev, req, GFP_ATOMIC);
362 static int prealloc(struct list_head *list, struct usb_ep *ep, unsigned n)
365 struct usb_request *req;
370 /* queue/recycle up to N requests */
372 list_for_each_entry(req, list, list) {
377 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
379 return list_empty(list) ? -ENOMEM : 0;
380 list_add(&req->list, list);
387 struct list_head *next;
389 next = req->list.next;
390 list_del(&req->list);
391 usb_ep_free_request(ep, req);
396 req = container_of(next, struct usb_request, list);
401 static int alloc_requests(struct eth_dev *dev, struct gether *link, unsigned n)
405 spin_lock(&dev->req_lock);
406 status = prealloc(&dev->tx_reqs, link->in_ep, n);
409 status = prealloc(&dev->rx_reqs, link->out_ep, n);
414 DBG(dev, "can't alloc requests\n");
416 spin_unlock(&dev->req_lock);
420 static void rx_fill(struct eth_dev *dev, gfp_t gfp_flags)
422 struct usb_request *req;
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);
433 if (rx_submit(dev, req, gfp_flags) < 0) {
434 defer_kevent(dev, WORK_RX_MEMORY);
438 spin_lock_irqsave(&dev->req_lock, flags);
440 spin_unlock_irqrestore(&dev->req_lock, flags);
443 static void eth_work(struct work_struct *work)
445 struct eth_dev *dev = container_of(work, struct eth_dev, work);
447 if (test_and_clear_bit(WORK_RX_MEMORY, &dev->todo)) {
448 if (netif_running(dev->net))
449 rx_fill(dev, GFP_KERNEL);
453 DBG(dev, "work done, flags = 0x%lx\n", dev->todo);
456 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
458 struct sk_buff *skb = req->context;
459 struct eth_dev *dev = ep->driver_data;
461 switch (req->status) {
463 dev->net->stats.tx_errors++;
464 VDBG(dev, "tx err %d\n", req->status);
466 case -ECONNRESET: /* unlink */
467 case -ESHUTDOWN: /* disconnect etc */
470 dev->net->stats.tx_bytes += skb->len;
472 dev->net->stats.tx_packets++;
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);
479 atomic_dec(&dev->tx_qlen);
480 if (netif_carrier_ok(dev->net))
481 netif_wake_queue(dev->net);
484 static inline int is_promisc(u16 cdc_filter)
486 return cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
489 static netdev_tx_t eth_start_xmit(struct sk_buff *skb,
490 struct net_device *net)
492 struct eth_dev *dev = netdev_priv(net);
495 struct usb_request *req = NULL;
500 spin_lock_irqsave(&dev->lock, flags);
502 in = dev->port_usb->in_ep;
503 cdc_filter = dev->port_usb->cdc_filter;
508 spin_unlock_irqrestore(&dev->lock, flags);
511 dev_kfree_skb_any(skb);
515 /* apply outgoing CDC or RNDIS filters */
516 if (skb && !is_promisc(cdc_filter)) {
517 u8 *dest = skb->data;
519 if (is_multicast_ether_addr(dest)) {
522 /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
523 * SET_ETHERNET_MULTICAST_FILTERS requests
525 if (is_broadcast_ether_addr(dest))
526 type = USB_CDC_PACKET_TYPE_BROADCAST;
528 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
529 if (!(cdc_filter & type)) {
530 dev_kfree_skb_any(skb);
534 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
537 spin_lock_irqsave(&dev->req_lock, flags);
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.
543 if (list_empty(&dev->tx_reqs)) {
544 spin_unlock_irqrestore(&dev->req_lock, flags);
545 return NETDEV_TX_BUSY;
548 req = container_of(dev->tx_reqs.next, struct usb_request, list);
549 list_del(&req->list);
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);
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
563 spin_lock_irqsave(&dev->lock, flags);
565 skb = dev->wrap(dev->port_usb, skb);
566 spin_unlock_irqrestore(&dev->lock, flags);
568 /* Multi frame CDC protocols may store the frame for
569 * later which is not a dropped frame.
571 if (dev->port_usb->supports_multi_frame)
578 req->buf = skb->data;
580 req->complete = tx_complete;
582 /* NCM requires no zlp if transfer is dwNtbInMaxSize */
583 if (dev->port_usb->is_fixed &&
584 length == dev->port_usb->fixed_in_len &&
585 (length % in->maxpacket) == 0)
590 /* use zlp framing on tx for strict CDC-Ether conformance,
591 * though any robust network rx path ignores extra padding.
592 * and some hardware doesn't like to write zlps.
594 if (req->zero && !dev->zlp && (length % in->maxpacket) == 0)
597 req->length = length;
599 retval = usb_ep_queue(in, req, GFP_ATOMIC);
602 DBG(dev, "tx queue err %d\n", retval);
605 net->trans_start = jiffies;
606 atomic_inc(&dev->tx_qlen);
610 dev_kfree_skb_any(skb);
612 dev->net->stats.tx_dropped++;
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);
623 /*-------------------------------------------------------------------------*/
625 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
627 DBG(dev, "%s\n", __func__);
629 /* fill the rx queue */
630 rx_fill(dev, gfp_flags);
632 /* and open the tx floodgates */
633 atomic_set(&dev->tx_qlen, 0);
634 netif_wake_queue(dev->net);
637 static int eth_open(struct net_device *net)
639 struct eth_dev *dev = netdev_priv(net);
642 DBG(dev, "%s\n", __func__);
643 if (netif_carrier_ok(dev->net))
644 eth_start(dev, GFP_KERNEL);
646 spin_lock_irq(&dev->lock);
647 link = dev->port_usb;
648 if (link && link->open)
650 spin_unlock_irq(&dev->lock);
655 static int eth_stop(struct net_device *net)
657 struct eth_dev *dev = netdev_priv(net);
660 VDBG(dev, "%s\n", __func__);
661 netif_stop_queue(net);
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
668 /* ensure there are no more active requests */
669 spin_lock_irqsave(&dev->lock, flags);
671 struct gether *link = dev->port_usb;
672 const struct usb_endpoint_descriptor *in;
673 const struct usb_endpoint_descriptor *out;
678 /* NOTE: we have no abort-queue primitive we could use
679 * to cancel all pending I/O. Instead, we disable then
680 * reenable the endpoints ... this idiom may leave toggle
681 * wrong, but that's a self-correcting error.
683 * REVISIT: we *COULD* just let the transfers complete at
684 * their own pace; the network stack can handle old packets.
685 * For the moment we leave this here, since it works.
687 in = link->in_ep->desc;
688 out = link->out_ep->desc;
689 usb_ep_disable(link->in_ep);
690 usb_ep_disable(link->out_ep);
691 if (netif_carrier_ok(net)) {
692 DBG(dev, "host still using in/out endpoints\n");
693 link->in_ep->desc = in;
694 link->out_ep->desc = out;
695 usb_ep_enable(link->in_ep);
696 usb_ep_enable(link->out_ep);
699 spin_unlock_irqrestore(&dev->lock, flags);
704 /*-------------------------------------------------------------------------*/
706 static int get_ether_addr(const char *str, u8 *dev_addr)
711 for (i = 0; i < 6; i++) {
714 if ((*str == '.') || (*str == ':'))
716 num = hex_to_bin(*str++) << 4;
717 num |= hex_to_bin(*str++);
720 if (is_valid_ether_addr(dev_addr))
723 eth_random_addr(dev_addr);
727 static int get_ether_addr_str(u8 dev_addr[ETH_ALEN], char *str, int len)
732 snprintf(str, len, "%pM", dev_addr);
736 static const struct net_device_ops eth_netdev_ops = {
737 .ndo_open = eth_open,
738 .ndo_stop = eth_stop,
739 .ndo_start_xmit = eth_start_xmit,
740 .ndo_change_mtu = ueth_change_mtu,
741 .ndo_set_mac_address = eth_mac_addr,
742 .ndo_validate_addr = eth_validate_addr,
745 static struct device_type gadget_type = {
750 * gether_setup_name - initialize one ethernet-over-usb link
751 * @g: gadget to associated with these links
752 * @ethaddr: NULL, or a buffer in which the ethernet address of the
753 * host side of the link is recorded
754 * @netname: name for network device (for example, "usb")
757 * This sets up the single network link that may be exported by a
758 * gadget driver using this framework. The link layer addresses are
759 * set up using module parameters.
761 * Returns an eth_dev pointer on success, or an ERR_PTR on failure.
763 struct eth_dev *gether_setup_name(struct usb_gadget *g,
764 const char *dev_addr, const char *host_addr,
765 u8 ethaddr[ETH_ALEN], unsigned qmult, const char *netname)
768 struct net_device *net;
771 net = alloc_etherdev(sizeof *dev);
773 return ERR_PTR(-ENOMEM);
775 dev = netdev_priv(net);
776 spin_lock_init(&dev->lock);
777 spin_lock_init(&dev->req_lock);
778 INIT_WORK(&dev->work, eth_work);
779 INIT_LIST_HEAD(&dev->tx_reqs);
780 INIT_LIST_HEAD(&dev->rx_reqs);
782 skb_queue_head_init(&dev->rx_frames);
784 /* network device setup */
787 snprintf(net->name, sizeof(net->name), "%s%%d", netname);
789 if (get_ether_addr(dev_addr, net->dev_addr))
791 "using random %s ethernet address\n", "self");
792 if (get_ether_addr(host_addr, dev->host_mac))
794 "using random %s ethernet address\n", "host");
797 memcpy(ethaddr, dev->host_mac, ETH_ALEN);
799 net->netdev_ops = ð_netdev_ops;
801 net->ethtool_ops = &ops;
804 SET_NETDEV_DEV(net, &g->dev);
805 SET_NETDEV_DEVTYPE(net, &gadget_type);
807 status = register_netdev(net);
809 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
811 dev = ERR_PTR(status);
813 INFO(dev, "MAC %pM\n", net->dev_addr);
814 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
817 * two kinds of host-initiated state changes:
818 * - iff DATA transfer is active, carrier is "on"
819 * - tx queueing enabled if open *and* carrier is "on"
821 netif_carrier_off(net);
826 EXPORT_SYMBOL_GPL(gether_setup_name);
828 struct net_device *gether_setup_name_default(const char *netname)
830 struct net_device *net;
833 net = alloc_etherdev(sizeof(*dev));
835 return ERR_PTR(-ENOMEM);
837 dev = netdev_priv(net);
838 spin_lock_init(&dev->lock);
839 spin_lock_init(&dev->req_lock);
840 INIT_WORK(&dev->work, eth_work);
841 INIT_LIST_HEAD(&dev->tx_reqs);
842 INIT_LIST_HEAD(&dev->rx_reqs);
844 skb_queue_head_init(&dev->rx_frames);
846 /* network device setup */
848 dev->qmult = QMULT_DEFAULT;
849 snprintf(net->name, sizeof(net->name), "%s%%d", netname);
851 eth_random_addr(dev->dev_mac);
852 pr_warn("using random %s ethernet address\n", "self");
853 eth_random_addr(dev->host_mac);
854 pr_warn("using random %s ethernet address\n", "host");
856 net->netdev_ops = ð_netdev_ops;
858 net->ethtool_ops = &ops;
859 SET_NETDEV_DEVTYPE(net, &gadget_type);
863 EXPORT_SYMBOL_GPL(gether_setup_name_default);
865 int gether_register_netdev(struct net_device *net)
868 struct usb_gadget *g;
872 if (!net->dev.parent)
874 dev = netdev_priv(net);
876 status = register_netdev(net);
878 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
881 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
883 /* two kinds of host-initiated state changes:
884 * - iff DATA transfer is active, carrier is "on"
885 * - tx queueing enabled if open *and* carrier is "on"
887 netif_carrier_off(net);
889 sa.sa_family = net->type;
890 memcpy(sa.sa_data, dev->dev_mac, ETH_ALEN);
892 status = dev_set_mac_address(net, &sa);
895 pr_warn("cannot set self ethernet address: %d\n", status);
897 INFO(dev, "MAC %pM\n", dev->dev_mac);
901 EXPORT_SYMBOL_GPL(gether_register_netdev);
903 void gether_set_gadget(struct net_device *net, struct usb_gadget *g)
907 dev = netdev_priv(net);
909 SET_NETDEV_DEV(net, &g->dev);
911 EXPORT_SYMBOL_GPL(gether_set_gadget);
913 int gether_set_dev_addr(struct net_device *net, const char *dev_addr)
916 u8 new_addr[ETH_ALEN];
918 dev = netdev_priv(net);
919 if (get_ether_addr(dev_addr, new_addr))
921 memcpy(dev->dev_mac, new_addr, ETH_ALEN);
924 EXPORT_SYMBOL_GPL(gether_set_dev_addr);
926 int gether_get_dev_addr(struct net_device *net, char *dev_addr, int len)
930 dev = netdev_priv(net);
931 return get_ether_addr_str(dev->dev_mac, dev_addr, len);
933 EXPORT_SYMBOL_GPL(gether_get_dev_addr);
935 int gether_set_host_addr(struct net_device *net, const char *host_addr)
938 u8 new_addr[ETH_ALEN];
940 dev = netdev_priv(net);
941 if (get_ether_addr(host_addr, new_addr))
943 memcpy(dev->host_mac, new_addr, ETH_ALEN);
946 EXPORT_SYMBOL_GPL(gether_set_host_addr);
948 int gether_get_host_addr(struct net_device *net, char *host_addr, int len)
952 dev = netdev_priv(net);
953 return get_ether_addr_str(dev->host_mac, host_addr, len);
955 EXPORT_SYMBOL_GPL(gether_get_host_addr);
957 int gether_get_host_addr_cdc(struct net_device *net, char *host_addr, int len)
964 dev = netdev_priv(net);
965 snprintf(host_addr, len, "%pm", dev->host_mac);
967 return strlen(host_addr);
969 EXPORT_SYMBOL_GPL(gether_get_host_addr_cdc);
971 void gether_get_host_addr_u8(struct net_device *net, u8 host_mac[ETH_ALEN])
975 dev = netdev_priv(net);
976 memcpy(host_mac, dev->host_mac, ETH_ALEN);
978 EXPORT_SYMBOL_GPL(gether_get_host_addr_u8);
980 void gether_set_qmult(struct net_device *net, unsigned qmult)
984 dev = netdev_priv(net);
987 EXPORT_SYMBOL_GPL(gether_set_qmult);
989 unsigned gether_get_qmult(struct net_device *net)
993 dev = netdev_priv(net);
996 EXPORT_SYMBOL_GPL(gether_get_qmult);
998 int gether_get_ifname(struct net_device *net, char *name, int len)
1001 strlcpy(name, netdev_name(net), len);
1003 return strlen(name);
1005 EXPORT_SYMBOL_GPL(gether_get_ifname);
1008 * gether_cleanup - remove Ethernet-over-USB device
1009 * Context: may sleep
1011 * This is called to free all resources allocated by @gether_setup().
1013 void gether_cleanup(struct eth_dev *dev)
1018 unregister_netdev(dev->net);
1019 flush_work(&dev->work);
1020 free_netdev(dev->net);
1022 EXPORT_SYMBOL_GPL(gether_cleanup);
1025 * gether_connect - notify network layer that USB link is active
1026 * @link: the USB link, set up with endpoints, descriptors matching
1027 * current device speed, and any framing wrapper(s) set up.
1028 * Context: irqs blocked
1030 * This is called to activate endpoints and let the network layer know
1031 * the connection is active ("carrier detect"). It may cause the I/O
1032 * queues to open and start letting network packets flow, but will in
1033 * any case activate the endpoints so that they respond properly to the
1036 * Verify net_device pointer returned using IS_ERR(). If it doesn't
1037 * indicate some error code (negative errno), ep->driver_data values
1038 * have been overwritten.
1040 struct net_device *gether_connect(struct gether *link)
1042 struct eth_dev *dev = link->ioport;
1046 return ERR_PTR(-EINVAL);
1048 link->in_ep->driver_data = dev;
1049 result = usb_ep_enable(link->in_ep);
1051 DBG(dev, "enable %s --> %d\n",
1052 link->in_ep->name, result);
1056 link->out_ep->driver_data = dev;
1057 result = usb_ep_enable(link->out_ep);
1059 DBG(dev, "enable %s --> %d\n",
1060 link->out_ep->name, result);
1065 result = alloc_requests(dev, link, qlen(dev->gadget,
1069 dev->zlp = link->is_zlp_ok;
1070 DBG(dev, "qlen %d\n", qlen(dev->gadget, dev->qmult));
1072 dev->header_len = link->header_len;
1073 dev->unwrap = link->unwrap;
1074 dev->wrap = link->wrap;
1076 spin_lock(&dev->lock);
1077 dev->port_usb = link;
1078 if (netif_running(dev->net)) {
1085 spin_unlock(&dev->lock);
1087 netif_carrier_on(dev->net);
1088 if (netif_running(dev->net))
1089 eth_start(dev, GFP_ATOMIC);
1091 /* on error, disable any endpoints */
1093 (void) usb_ep_disable(link->out_ep);
1095 (void) usb_ep_disable(link->in_ep);
1098 /* caller is responsible for cleanup on error */
1100 return ERR_PTR(result);
1103 EXPORT_SYMBOL_GPL(gether_connect);
1106 * gether_disconnect - notify network layer that USB link is inactive
1107 * @link: the USB link, on which gether_connect() was called
1108 * Context: irqs blocked
1110 * This is called to deactivate endpoints and let the network layer know
1111 * the connection went inactive ("no carrier").
1113 * On return, the state is as if gether_connect() had never been called.
1114 * The endpoints are inactive, and accordingly without active USB I/O.
1115 * Pointers to endpoint descriptors and endpoint private data are nulled.
1117 void gether_disconnect(struct gether *link)
1119 struct eth_dev *dev = link->ioport;
1120 struct usb_request *req;
1126 DBG(dev, "%s\n", __func__);
1128 netif_stop_queue(dev->net);
1129 netif_carrier_off(dev->net);
1131 /* disable endpoints, forcing (synchronous) completion
1132 * of all pending i/o. then free the request objects
1133 * and forget about the endpoints.
1135 usb_ep_disable(link->in_ep);
1136 spin_lock(&dev->req_lock);
1137 while (!list_empty(&dev->tx_reqs)) {
1138 req = container_of(dev->tx_reqs.next,
1139 struct usb_request, list);
1140 list_del(&req->list);
1142 spin_unlock(&dev->req_lock);
1143 usb_ep_free_request(link->in_ep, req);
1144 spin_lock(&dev->req_lock);
1146 spin_unlock(&dev->req_lock);
1147 link->in_ep->desc = NULL;
1149 usb_ep_disable(link->out_ep);
1150 spin_lock(&dev->req_lock);
1151 while (!list_empty(&dev->rx_reqs)) {
1152 req = container_of(dev->rx_reqs.next,
1153 struct usb_request, list);
1154 list_del(&req->list);
1156 spin_unlock(&dev->req_lock);
1157 usb_ep_free_request(link->out_ep, req);
1158 spin_lock(&dev->req_lock);
1160 spin_unlock(&dev->req_lock);
1161 link->out_ep->desc = NULL;
1163 /* finish forgetting about this USB link episode */
1164 dev->header_len = 0;
1168 spin_lock(&dev->lock);
1169 dev->port_usb = NULL;
1170 spin_unlock(&dev->lock);
1172 EXPORT_SYMBOL_GPL(gether_disconnect);
1174 MODULE_LICENSE("GPL");
1175 MODULE_AUTHOR("David Brownell");