drivers/usb/gadget/function/u_ether.c

   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.
  12  */
  13
  14 /* #define VERBOSE_DEBUG */
  15
  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>
  24
  25 #include "u_ether.h"
  26
  27
  28 /*
  29  * This component encapsulates the Ethernet link glue needed to provide
  30  * one (!) network link through the USB gadget stack, normally "usb0".
  31  *
  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
  35  * management.
  36  *
  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.
  42  *
  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.)
  47  */
  48
  49 #define UETH__VERSION   "29-May-2008"
  50
  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
  55
  56 struct eth_dev {
  57         /* lock is held while accessing port_usb
  58          */
  59         spinlock_t              lock;
  60         struct gether           *port_usb;
  61
  62         struct net_device       *net;
  63         struct usb_gadget       *gadget;
  64
  65         spinlock_t              req_lock;       /* guard {rx,tx}_reqs */
  66         struct list_head        tx_reqs, rx_reqs;
  67         atomic_t                tx_qlen;
  68
  69         struct sk_buff_head     rx_frames;
  70
  71         unsigned                qmult;
  72
  73         unsigned                header_len;
  74         struct sk_buff          *(*wrap)(struct gether *, struct sk_buff *skb);
  75         int                     (*unwrap)(struct gether *,
  76                                                 struct sk_buff *skb,
  77                                                 struct sk_buff_head *list);
  78
  79         struct work_struct      work;
  80
  81         unsigned long           todo;
  82 #define WORK_RX_MEMORY          0
  83
  84         bool                    zlp;
  85         u8                      host_mac[ETH_ALEN];
  86         u8                      dev_mac[ETH_ALEN];
  87 };
  88
  89 /*-------------------------------------------------------------------------*/
  90
  91 #define RX_EXTRA        20      /* bytes guarding against rx overflows */
  92
  93 #define DEFAULT_QLEN    2       /* double buffering by default */
  94
  95 /* for dual-speed hardware, use deeper queues at high/super speed */
  96 static inline int qlen(struct usb_gadget *gadget, unsigned qmult)
  97 {
  98         if (gadget_is_dualspeed(gadget) && (gadget->speed == USB_SPEED_HIGH ||
  99                                             gadget->speed >= USB_SPEED_SUPER))
 100                 return qmult * DEFAULT_QLEN;
 101         else
 102                 return DEFAULT_QLEN;
 103 }
 104
 105 /*-------------------------------------------------------------------------*/
 106
 107 /* REVISIT there must be a better way than having two sets
 108  * of debug calls ...
 109  */
 110
 111 #undef DBG
 112 #undef VDBG
 113 #undef ERROR
 114 #undef INFO
 115
 116 #define xprintk(d, level, fmt, args...) \
 117         printk(level "%s: " fmt , (d)->net->name , ## args)
 118
 119 #ifdef DEBUG
 120 #undef DEBUG
 121 #define DBG(dev, fmt, args...) \
 122         xprintk(dev , KERN_DEBUG , fmt , ## args)
 123 #else
 124 #define DBG(dev, fmt, args...) \
 125         do { } while (0)
 126 #endif /* DEBUG */
 127
 128 #ifdef VERBOSE_DEBUG
 129 #define VDBG    DBG
 130 #else
 131 #define VDBG(dev, fmt, args...) \
 132         do { } while (0)
 133 #endif /* DEBUG */
 134
 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)
 139
 140 /*-------------------------------------------------------------------------*/
 141
 142 /* NETWORK DRIVER HOOKUP (to the layer above this driver) */
 143
 144 static int ueth_change_mtu(struct net_device *net, int new_mtu)
 145 {
 146         struct eth_dev  *dev = netdev_priv(net);
 147         unsigned long   flags;
 148         int             status = 0;
 149
 150         /* don't change MTU on "live" link (peer won't know) */
 151         spin_lock_irqsave(&dev->lock, flags);
 152         if (dev->port_usb)
 153                 status = -EBUSY;
 154         else if (new_mtu <= ETH_HLEN || new_mtu > GETHER_MAX_ETH_FRAME_LEN)
 155                 status = -ERANGE;
 156         else
 157                 net->mtu = new_mtu;
 158         spin_unlock_irqrestore(&dev->lock, flags);
 159
 160         return status;
 161 }
 162
 163 static void eth_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *p)
 164 {
 165         struct eth_dev *dev = netdev_priv(net);
 166
 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));
 171 }
 172
 173 /* REVISIT can also support:
 174  *   - WOL (by tracking suspends and issuing remote wakeup)
 175  *   - msglevel (implies updated messaging)
 176  *   - ... probably more ethtool ops
 177  */
 178
 179 static const struct ethtool_ops ops = {
 180         .get_drvinfo = eth_get_drvinfo,
 181         .get_link = ethtool_op_get_link,
 182 };
 183
 184 static void defer_kevent(struct eth_dev *dev, int flag)
 185 {
 186         if (test_and_set_bit(flag, &dev->todo))
 187                 return;
 188         if (!schedule_work(&dev->work))
 189                 ERROR(dev, "kevent %d may have been dropped\n", flag);
 190         else
 191                 DBG(dev, "kevent %d scheduled\n", flag);
 192 }
 193
 194 static void rx_complete(struct usb_ep *ep, struct usb_request *req);
 195
 196 static int
 197 rx_submit(struct eth_dev *dev, struct usb_request *req, gfp_t gfp_flags)
 198 {
 199         struct sk_buff  *skb;
 200         int             retval = -ENOMEM;
 201         size_t          size = 0;
 202         struct usb_ep   *out;
 203         unsigned long   flags;
 204
 205         spin_lock_irqsave(&dev->lock, flags);
 206         if (dev->port_usb)
 207                 out = dev->port_usb->out_ep;
 208         else
 209                 out = NULL;
 210
 211         if (!out)
 212         {
 213                 spin_unlock_irqrestore(&dev->lock, flags);
 214                 return -ENOTCONN;
 215         }
 216
 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).
 223          *
 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).
 228          */
 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;
 233
 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);
 237
 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 {
 272         struct sk_buff  *skb = req->context, *skb2;
 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);
 281
 282                 if (dev->unwrap) {
 283                         unsigned long   flags;
 284
 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                 }
 298                 skb = NULL;
 299
 300                 skb2 = skb_dequeue(&dev->rx_frames);
 301                 while (skb2) {
 302                         if (status < 0
 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);
 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                 }
 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
 489 static netdev_tx_t eth_start_xmit(struct sk_buff *skb,
 490                                         struct net_device *net)
 491 {
 492         struct eth_dev          *dev = netdev_priv(net);
 493         int                     length = 0;
 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                 if (skb)
 512                         dev_kfree_skb_any(skb);
 513                 return NETDEV_TX_OK;
 514         }
 515
 516         /* apply outgoing CDC or RNDIS filters */
 517         if (skb && !is_promisc(cdc_filter)) {
 518                 u8              *dest = skb->data;
 519
 520                 if (is_multicast_ether_addr(dest)) {
 521                         u16     type;
 522
 523                         /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
 524                          * SET_ETHERNET_MULTICAST_FILTERS requests
 525                          */
 526                         if (is_broadcast_ether_addr(dest))
 527                                 type = USB_CDC_PACKET_TYPE_BROADCAST;
 528                         else
 529                                 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
 530                         if (!(cdc_filter & type)) {
 531                                 dev_kfree_skb_any(skb);
 532                                 return NETDEV_TX_OK;
 533                         }
 534                 }
 535                 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
 536         }
 537
 538         spin_lock_irqsave(&dev->req_lock, flags);
 539         /*
 540          * this freelist can be empty if an interrupt triggered disconnect()
 541          * and reconfigured the gadget (shutting down this queue) after the
 542          * network stack decided to xmit but before we got the spinlock.
 543          */
 544         if (list_empty(&dev->tx_reqs)) {
 545                 spin_unlock_irqrestore(&dev->req_lock, flags);
 546                 return NETDEV_TX_BUSY;
 547         }
 548
 549         req = container_of(dev->tx_reqs.next, struct usb_request, list);
 550         list_del(&req->list);
 551
 552         /* temporarily stop TX queue when the freelist empties */
 553         if (list_empty(&dev->tx_reqs))
 554                 netif_stop_queue(net);
 555         spin_unlock_irqrestore(&dev->req_lock, flags);
 556
 557         /* no buffer copies needed, unless the network stack did it
 558          * or the hardware can't use skb buffers.
 559          * or there's not enough space for extra headers we need
 560          */
 561         if (dev->wrap) {
 562                 unsigned long   flags;
 563
 564                 spin_lock_irqsave(&dev->lock, flags);
 565                 if (dev->port_usb)
 566                         skb = dev->wrap(dev->port_usb, skb);
 567                 spin_unlock_irqrestore(&dev->lock, flags);
 568                 if (!skb) {
 569                         /* Multi frame CDC protocols may store the frame for
 570                          * later which is not a dropped frame.
 571                          */
 572                         if (dev->port_usb->supports_multi_frame)
 573                                 goto multiframe;
 574                         goto drop;
 575                 }
 576         }
 577
 578         length = skb->len;
 579         req->buf = skb->data;
 580         req->context = skb;
 581         req->complete = tx_complete;
 582
 583         /* NCM requires no zlp if transfer is dwNtbInMaxSize */
 584         if (dev->port_usb->is_fixed &&
 585             length == dev->port_usb->fixed_in_len &&
 586             (length % in->maxpacket) == 0)
 587                 req->zero = 0;
 588         else
 589                 req->zero = 1;
 590
 591         /* use zlp framing on tx for strict CDC-Ether conformance,
 592          * though any robust network rx path ignores extra padding.
 593          * and some hardware doesn't like to write zlps.
 594          */
 595         if (req->zero && !dev->zlp && (length % in->maxpacket) == 0)
 596                 length++;
 597
 598         req->length = length;
 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) {
 611                 dev_kfree_skb_any(skb);
 612 drop:
 613                 dev->net->stats.tx_dropped++;
 614 multiframe:
 615                 spin_lock_irqsave(&dev->req_lock, flags);
 616                 if (list_empty(&dev->tx_reqs))
 617                         netif_start_queue(net);
 618                 list_add(&req->list, &dev->tx_reqs);
 619                 spin_unlock_irqrestore(&dev->req_lock, flags);
 620         }
 621         return NETDEV_TX_OK;
 622 }
 623
 624 /*-------------------------------------------------------------------------*/
 625
 626 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
 627 {
 628         DBG(dev, "%s\n", __func__);
 629
 630         /* fill the rx queue */
 631         rx_fill(dev, gfp_flags);
 632
 633         /* and open the tx floodgates */
 634         atomic_set(&dev->tx_qlen, 0);
 635         netif_wake_queue(dev->net);
 636 }
 637
 638 static int eth_open(struct net_device *net)
 639 {
 640         struct eth_dev  *dev = netdev_priv(net);
 641         struct gether   *link;
 642
 643         DBG(dev, "%s\n", __func__);
 644         if (netif_carrier_ok(dev->net))
 645                 eth_start(dev, GFP_KERNEL);
 646
 647         spin_lock_irq(&dev->lock);
 648         link = dev->port_usb;
 649         if (link && link->open)
 650                 link->open(link);
 651         spin_unlock_irq(&dev->lock);
 652
 653         return 0;
 654 }
 655
 656 static int eth_stop(struct net_device *net)
 657 {
 658         struct eth_dev  *dev = netdev_priv(net);
 659         unsigned long   flags;
 660
 661         VDBG(dev, "%s\n", __func__);
 662         netif_stop_queue(net);
 663
 664         DBG(dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n",
 665                 dev->net->stats.rx_packets, dev->net->stats.tx_packets,
 666                 dev->net->stats.rx_errors, dev->net->stats.tx_errors
 667                 );
 668
 669         /* ensure there are no more active requests */
 670         spin_lock_irqsave(&dev->lock, flags);
 671         if (dev->port_usb) {
 672                 struct gether   *link = dev->port_usb;
 673                 const struct usb_endpoint_descriptor *in;
 674                 const struct usb_endpoint_descriptor *out;
 675
 676                 if (link->close)
 677                         link->close(link);
 678
 679                 /* NOTE:  we have no abort-queue primitive we could use
 680                  * to cancel all pending I/O.  Instead, we disable then
 681                  * reenable the endpoints ... this idiom may leave toggle
 682                  * wrong, but that's a self-correcting error.
 683                  *
 684                  * REVISIT:  we *COULD* just let the transfers complete at
 685                  * their own pace; the network stack can handle old packets.
 686                  * For the moment we leave this here, since it works.
 687                  */
 688                 in = link->in_ep->desc;
 689                 out = link->out_ep->desc;
 690                 usb_ep_disable(link->in_ep);
 691                 usb_ep_disable(link->out_ep);
 692                 if (netif_carrier_ok(net)) {
 693                         DBG(dev, "host still using in/out endpoints\n");
 694                         link->in_ep->desc = in;
 695                         link->out_ep->desc = out;
 696                         usb_ep_enable(link->in_ep);
 697                         usb_ep_enable(link->out_ep);
 698                 }
 699         }
 700         spin_unlock_irqrestore(&dev->lock, flags);
 701
 702         return 0;
 703 }
 704
 705 /*-------------------------------------------------------------------------*/
 706
 707 static int get_ether_addr(const char *str, u8 *dev_addr)
 708 {
 709         if (str) {
 710                 unsigned        i;
 711
 712                 for (i = 0; i < 6; i++) {
 713                         unsigned char num;
 714
 715                         if ((*str == '.') || (*str == ':'))
 716                                 str++;
 717                         num = hex_to_bin(*str++) << 4;
 718                         num |= hex_to_bin(*str++);
 719                         dev_addr [i] = num;
 720                 }
 721                 if (is_valid_ether_addr(dev_addr))
 722                         return 0;
 723         }
 724         eth_random_addr(dev_addr);
 725         return 1;
 726 }
 727
 728 static int get_ether_addr_str(u8 dev_addr[ETH_ALEN], char *str, int len)
 729 {
 730         if (len < 18)
 731                 return -EINVAL;
 732
 733         snprintf(str, len, "%pM", dev_addr);
 734         return 18;
 735 }
 736
 737 static const struct net_device_ops eth_netdev_ops = {
 738         .ndo_open               = eth_open,
 739         .ndo_stop               = eth_stop,
 740         .ndo_start_xmit         = eth_start_xmit,
 741         .ndo_change_mtu         = ueth_change_mtu,
 742         .ndo_set_mac_address    = eth_mac_addr,
 743         .ndo_validate_addr      = eth_validate_addr,
 744 };
 745
 746 static struct device_type gadget_type = {
 747         .name   = "gadget",
 748 };
 749
 750 /**
 751  * gether_setup_name - initialize one ethernet-over-usb link
 752  * @g: gadget to associated with these links
 753  * @ethaddr: NULL, or a buffer in which the ethernet address of the
 754  *      host side of the link is recorded
 755  * @netname: name for network device (for example, "usb")
 756  * Context: may sleep
 757  *
 758  * This sets up the single network link that may be exported by a
 759  * gadget driver using this framework.  The link layer addresses are
 760  * set up using module parameters.
 761  *
 762  * Returns an eth_dev pointer on success, or an ERR_PTR on failure.
 763  */
 764 struct eth_dev *gether_setup_name(struct usb_gadget *g,
 765                 const char *dev_addr, const char *host_addr,
 766                 u8 ethaddr[ETH_ALEN], unsigned qmult, const char *netname)
 767 {
 768         struct eth_dev          *dev;
 769         struct net_device       *net;
 770         int                     status;
 771
 772         net = alloc_etherdev(sizeof *dev);
 773         if (!net)
 774                 return ERR_PTR(-ENOMEM);
 775
 776         dev = netdev_priv(net);
 777         spin_lock_init(&dev->lock);
 778         spin_lock_init(&dev->req_lock);
 779         INIT_WORK(&dev->work, eth_work);
 780         INIT_LIST_HEAD(&dev->tx_reqs);
 781         INIT_LIST_HEAD(&dev->rx_reqs);
 782
 783         skb_queue_head_init(&dev->rx_frames);
 784
 785         /* network device setup */
 786         dev->net = net;
 787         dev->qmult = qmult;
 788         snprintf(net->name, sizeof(net->name), "%s%%d", netname);
 789
 790         if (get_ether_addr(dev_addr, net->dev_addr))
 791                 dev_warn(&g->dev,
 792                         "using random %s ethernet address\n", "self");
 793         if (get_ether_addr(host_addr, dev->host_mac))
 794                 dev_warn(&g->dev,
 795                         "using random %s ethernet address\n", "host");
 796
 797         if (ethaddr)
 798                 memcpy(ethaddr, dev->host_mac, ETH_ALEN);
 799
 800         net->netdev_ops = &eth_netdev_ops;
 801
 802         net->ethtool_ops = &ops;
 803
 804         dev->gadget = g;
 805         SET_NETDEV_DEV(net, &g->dev);
 806         SET_NETDEV_DEVTYPE(net, &gadget_type);
 807
 808         status = register_netdev(net);
 809         if (status < 0) {
 810                 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
 811                 free_netdev(net);
 812                 dev = ERR_PTR(status);
 813         } else {
 814                 INFO(dev, "MAC %pM\n", net->dev_addr);
 815                 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
 816
 817                 /*
 818                  * two kinds of host-initiated state changes:
 819                  *  - iff DATA transfer is active, carrier is "on"
 820                  *  - tx queueing enabled if open *and* carrier is "on"
 821                  */
 822                 netif_carrier_off(net);
 823         }
 824
 825         return dev;
 826 }
 827 EXPORT_SYMBOL_GPL(gether_setup_name);
 828
 829 struct net_device *gether_setup_name_default(const char *netname)
 830 {
 831         struct net_device       *net;
 832         struct eth_dev          *dev;
 833
 834         net = alloc_etherdev(sizeof(*dev));
 835         if (!net)
 836                 return ERR_PTR(-ENOMEM);
 837
 838         dev = netdev_priv(net);
 839         spin_lock_init(&dev->lock);
 840         spin_lock_init(&dev->req_lock);
 841         INIT_WORK(&dev->work, eth_work);
 842         INIT_LIST_HEAD(&dev->tx_reqs);
 843         INIT_LIST_HEAD(&dev->rx_reqs);
 844
 845         skb_queue_head_init(&dev->rx_frames);
 846
 847         /* network device setup */
 848         dev->net = net;
 849         dev->qmult = QMULT_DEFAULT;
 850         snprintf(net->name, sizeof(net->name), "%s%%d", netname);
 851
 852         eth_random_addr(dev->dev_mac);
 853         pr_warn("using random %s ethernet address\n", "self");
 854         eth_random_addr(dev->host_mac);
 855         pr_warn("using random %s ethernet address\n", "host");
 856
 857         net->netdev_ops = &eth_netdev_ops;
 858
 859         net->ethtool_ops = &ops;
 860         SET_NETDEV_DEVTYPE(net, &gadget_type);
 861
 862         return net;
 863 }
 864 EXPORT_SYMBOL_GPL(gether_setup_name_default);
 865
 866 int gether_register_netdev(struct net_device *net)
 867 {
 868         struct eth_dev *dev;
 869         struct usb_gadget *g;
 870         struct sockaddr sa;
 871         int status;
 872
 873         if (!net->dev.parent)
 874                 return -EINVAL;
 875         dev = netdev_priv(net);
 876         g = dev->gadget;
 877         status = register_netdev(net);
 878         if (status < 0) {
 879                 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
 880                 return status;
 881         } else {
 882                 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
 883
 884                 /* two kinds of host-initiated state changes:
 885                  *  - iff DATA transfer is active, carrier is "on"
 886                  *  - tx queueing enabled if open *and* carrier is "on"
 887                  */
 888                 netif_carrier_off(net);
 889         }
 890         sa.sa_family = net->type;
 891         memcpy(sa.sa_data, dev->dev_mac, ETH_ALEN);
 892         rtnl_lock();
 893         status = dev_set_mac_address(net, &sa);
 894         rtnl_unlock();
 895         if (status)
 896                 pr_warn("cannot set self ethernet address: %d\n", status);
 897         else
 898                 INFO(dev, "MAC %pM\n", dev->dev_mac);
 899
 900         return status;
 901 }
 902 EXPORT_SYMBOL_GPL(gether_register_netdev);
 903
 904 void gether_set_gadget(struct net_device *net, struct usb_gadget *g)
 905 {
 906         struct eth_dev *dev;
 907
 908         dev = netdev_priv(net);
 909         dev->gadget = g;
 910         SET_NETDEV_DEV(net, &g->dev);
 911 }
 912 EXPORT_SYMBOL_GPL(gether_set_gadget);
 913
 914 int gether_set_dev_addr(struct net_device *net, const char *dev_addr)
 915 {
 916         struct eth_dev *dev;
 917         u8 new_addr[ETH_ALEN];
 918
 919         dev = netdev_priv(net);
 920         if (get_ether_addr(dev_addr, new_addr))
 921                 return -EINVAL;
 922         memcpy(dev->dev_mac, new_addr, ETH_ALEN);
 923         return 0;
 924 }
 925 EXPORT_SYMBOL_GPL(gether_set_dev_addr);
 926
 927 int gether_get_dev_addr(struct net_device *net, char *dev_addr, int len)
 928 {
 929         struct eth_dev *dev;
 930
 931         dev = netdev_priv(net);
 932         return get_ether_addr_str(dev->dev_mac, dev_addr, len);
 933 }
 934 EXPORT_SYMBOL_GPL(gether_get_dev_addr);
 935
 936 int gether_set_host_addr(struct net_device *net, const char *host_addr)
 937 {
 938         struct eth_dev *dev;
 939         u8 new_addr[ETH_ALEN];
 940
 941         dev = netdev_priv(net);
 942         if (get_ether_addr(host_addr, new_addr))
 943                 return -EINVAL;
 944         memcpy(dev->host_mac, new_addr, ETH_ALEN);
 945         return 0;
 946 }
 947 EXPORT_SYMBOL_GPL(gether_set_host_addr);
 948
 949 int gether_get_host_addr(struct net_device *net, char *host_addr, int len)
 950 {
 951         struct eth_dev *dev;
 952
 953         dev = netdev_priv(net);
 954         return get_ether_addr_str(dev->host_mac, host_addr, len);
 955 }
 956 EXPORT_SYMBOL_GPL(gether_get_host_addr);
 957
 958 int gether_get_host_addr_cdc(struct net_device *net, char *host_addr, int len)
 959 {
 960         struct eth_dev *dev;
 961
 962         if (len < 13)
 963                 return -EINVAL;
 964
 965         dev = netdev_priv(net);
 966         snprintf(host_addr, len, "%pm", dev->host_mac);
 967
 968         return strlen(host_addr);
 969 }
 970 EXPORT_SYMBOL_GPL(gether_get_host_addr_cdc);
 971
 972 void gether_get_host_addr_u8(struct net_device *net, u8 host_mac[ETH_ALEN])
 973 {
 974         struct eth_dev *dev;
 975
 976         dev = netdev_priv(net);
 977         memcpy(host_mac, dev->host_mac, ETH_ALEN);
 978 }
 979 EXPORT_SYMBOL_GPL(gether_get_host_addr_u8);
 980
 981 void gether_set_qmult(struct net_device *net, unsigned qmult)
 982 {
 983         struct eth_dev *dev;
 984
 985         dev = netdev_priv(net);
 986         dev->qmult = qmult;
 987 }
 988 EXPORT_SYMBOL_GPL(gether_set_qmult);
 989
 990 unsigned gether_get_qmult(struct net_device *net)
 991 {
 992         struct eth_dev *dev;
 993
 994         dev = netdev_priv(net);
 995         return dev->qmult;
 996 }
 997 EXPORT_SYMBOL_GPL(gether_get_qmult);
 998
 999 int gether_get_ifname(struct net_device *net, char *name, int len)
1000 {
1001         rtnl_lock();
1002         strlcpy(name, netdev_name(net), len);
1003         rtnl_unlock();
1004         return strlen(name);
1005 }
1006 EXPORT_SYMBOL_GPL(gether_get_ifname);
1007
1008 /**
1009  * gether_cleanup - remove Ethernet-over-USB device
1010  * Context: may sleep
1011  *
1012  * This is called to free all resources allocated by @gether_setup().
1013  */
1014 void gether_cleanup(struct eth_dev *dev)
1015 {
1016         if (!dev)
1017                 return;
1018
1019         unregister_netdev(dev->net);
1020         flush_work(&dev->work);
1021         free_netdev(dev->net);
1022 }
1023 EXPORT_SYMBOL_GPL(gether_cleanup);
1024
1025 /**
1026  * gether_connect - notify network layer that USB link is active
1027  * @link: the USB link, set up with endpoints, descriptors matching
1028  *      current device speed, and any framing wrapper(s) set up.
1029  * Context: irqs blocked
1030  *
1031  * This is called to activate endpoints and let the network layer know
1032  * the connection is active ("carrier detect").  It may cause the I/O
1033  * queues to open and start letting network packets flow, but will in
1034  * any case activate the endpoints so that they respond properly to the
1035  * USB host.
1036  *
1037  * Verify net_device pointer returned using IS_ERR().  If it doesn't
1038  * indicate some error code (negative errno), ep->driver_data values
1039  * have been overwritten.
1040  */
1041 struct net_device *gether_connect(struct gether *link)
1042 {
1043         struct eth_dev          *dev = link->ioport;
1044         int                     result = 0;
1045
1046         if (!dev)
1047                 return ERR_PTR(-EINVAL);
1048
1049         link->in_ep->driver_data = dev;
1050         result = usb_ep_enable(link->in_ep);
1051         if (result != 0) {
1052                 DBG(dev, "enable %s --> %d\n",
1053                         link->in_ep->name, result);
1054                 goto fail0;
1055         }
1056
1057         link->out_ep->driver_data = dev;
1058         result = usb_ep_enable(link->out_ep);
1059         if (result != 0) {
1060                 DBG(dev, "enable %s --> %d\n",
1061                         link->out_ep->name, result);
1062                 goto fail1;
1063         }
1064
1065         if (result == 0)
1066                 result = alloc_requests(dev, link, qlen(dev->gadget,
1067                                         dev->qmult));
1068
1069         if (result == 0) {
1070                 dev->zlp = link->is_zlp_ok;
1071                 DBG(dev, "qlen %d\n", qlen(dev->gadget, dev->qmult));
1072
1073                 dev->header_len = link->header_len;
1074                 dev->unwrap = link->unwrap;
1075                 dev->wrap = link->wrap;
1076
1077                 spin_lock(&dev->lock);
1078                 dev->port_usb = link;
1079                 if (netif_running(dev->net)) {
1080                         if (link->open)
1081                                 link->open(link);
1082                 } else {
1083                         if (link->close)
1084                                 link->close(link);
1085                 }
1086                 spin_unlock(&dev->lock);
1087
1088                 netif_carrier_on(dev->net);
1089                 if (netif_running(dev->net))
1090                         eth_start(dev, GFP_ATOMIC);
1091
1092         /* on error, disable any endpoints  */
1093         } else {
1094                 (void) usb_ep_disable(link->out_ep);
1095 fail1:
1096                 (void) usb_ep_disable(link->in_ep);
1097         }
1098 fail0:
1099         /* caller is responsible for cleanup on error */
1100         if (result < 0)
1101                 return ERR_PTR(result);
1102         return dev->net;
1103 }
1104 EXPORT_SYMBOL_GPL(gether_connect);
1105
1106 /**
1107  * gether_disconnect - notify network layer that USB link is inactive
1108  * @link: the USB link, on which gether_connect() was called
1109  * Context: irqs blocked
1110  *
1111  * This is called to deactivate endpoints and let the network layer know
1112  * the connection went inactive ("no carrier").
1113  *
1114  * On return, the state is as if gether_connect() had never been called.
1115  * The endpoints are inactive, and accordingly without active USB I/O.
1116  * Pointers to endpoint descriptors and endpoint private data are nulled.
1117  */
1118 void gether_disconnect(struct gether *link)
1119 {
1120         struct eth_dev          *dev = link->ioport;
1121         struct usb_request      *req;
1122
1123         WARN_ON(!dev);
1124         if (!dev)
1125                 return;
1126
1127         DBG(dev, "%s\n", __func__);
1128
1129         netif_stop_queue(dev->net);
1130         netif_carrier_off(dev->net);
1131
1132         /* disable endpoints, forcing (synchronous) completion
1133          * of all pending i/o.  then free the request objects
1134          * and forget about the endpoints.
1135          */
1136         usb_ep_disable(link->in_ep);
1137         spin_lock(&dev->req_lock);
1138         while (!list_empty(&dev->tx_reqs)) {
1139                 req = container_of(dev->tx_reqs.next,
1140                                         struct usb_request, list);
1141                 list_del(&req->list);
1142
1143                 spin_unlock(&dev->req_lock);
1144                 usb_ep_free_request(link->in_ep, req);
1145                 spin_lock(&dev->req_lock);
1146         }
1147         spin_unlock(&dev->req_lock);
1148         link->in_ep->desc = NULL;
1149
1150         usb_ep_disable(link->out_ep);
1151         spin_lock(&dev->req_lock);
1152         while (!list_empty(&dev->rx_reqs)) {
1153                 req = container_of(dev->rx_reqs.next,
1154                                         struct usb_request, list);
1155                 list_del(&req->list);
1156
1157                 spin_unlock(&dev->req_lock);
1158                 usb_ep_free_request(link->out_ep, req);
1159                 spin_lock(&dev->req_lock);
1160         }
1161         spin_unlock(&dev->req_lock);
1162         link->out_ep->desc = NULL;
1163
1164         /* finish forgetting about this USB link episode */
1165         dev->header_len = 0;
1166         dev->unwrap = NULL;
1167         dev->wrap = NULL;
1168
1169         spin_lock(&dev->lock);
1170         dev->port_usb = NULL;
1171         spin_unlock(&dev->lock);
1172 }
1173 EXPORT_SYMBOL_GPL(gether_disconnect);
1174
1175 MODULE_LICENSE("GPL");
1176 MODULE_AUTHOR("David Brownell");