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         bool                    no_skb_reserve;
  86         u8                      host_mac[ETH_ALEN];
  87         u8                      dev_mac[ETH_ALEN];
  88 };
  89
  90 /*-------------------------------------------------------------------------*/
  91
  92 #define RX_EXTRA        20      /* bytes guarding against rx overflows */
  93
  94 #define DEFAULT_QLEN    2       /* double buffering by default */
  95
  96 /* for dual-speed hardware, use deeper queues at high/super speed */
  97 static inline int qlen(struct usb_gadget *gadget, unsigned qmult)
  98 {
  99         if (gadget_is_dualspeed(gadget) && (gadget->speed == USB_SPEED_HIGH ||
 100                                             gadget->speed >= USB_SPEED_SUPER))
 101                 return qmult * DEFAULT_QLEN;
 102         else
 103                 return DEFAULT_QLEN;
 104 }
 105
 106 /*-------------------------------------------------------------------------*/
 107
 108 /* REVISIT there must be a better way than having two sets
 109  * of debug calls ...
 110  */
 111
 112 #undef DBG
 113 #undef VDBG
 114 #undef ERROR
 115 #undef INFO
 116
 117 #define xprintk(d, level, fmt, args...) \
 118         printk(level "%s: " fmt , (d)->net->name , ## args)
 119
 120 #ifdef DEBUG
 121 #undef DEBUG
 122 #define DBG(dev, fmt, args...) \
 123         xprintk(dev , KERN_DEBUG , fmt , ## args)
 124 #else
 125 #define DBG(dev, fmt, args...) \
 126         do { } while (0)
 127 #endif /* DEBUG */
 128
 129 #ifdef VERBOSE_DEBUG
 130 #define VDBG    DBG
 131 #else
 132 #define VDBG(dev, fmt, args...) \
 133         do { } while (0)
 134 #endif /* DEBUG */
 135
 136 #define ERROR(dev, fmt, args...) \
 137         xprintk(dev , KERN_ERR , fmt , ## args)
 138 #define INFO(dev, fmt, args...) \
 139         xprintk(dev , KERN_INFO , fmt , ## args)
 140
 141 /*-------------------------------------------------------------------------*/
 142
 143 /* NETWORK DRIVER HOOKUP (to the layer above this driver) */
 144
 145 static int ueth_change_mtu(struct net_device *net, int new_mtu)
 146 {
 147         if (new_mtu <= ETH_HLEN || new_mtu > GETHER_MAX_ETH_FRAME_LEN)
 148                 return -ERANGE;
 149         net->mtu = new_mtu;
 150
 151         return 0;
 152 }
 153
 154 static void eth_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *p)
 155 {
 156         struct eth_dev *dev = netdev_priv(net);
 157
 158         strlcpy(p->driver, "g_ether", sizeof(p->driver));
 159         strlcpy(p->version, UETH__VERSION, sizeof(p->version));
 160         strlcpy(p->fw_version, dev->gadget->name, sizeof(p->fw_version));
 161         strlcpy(p->bus_info, dev_name(&dev->gadget->dev), sizeof(p->bus_info));
 162 }
 163
 164 /* REVISIT can also support:
 165  *   - WOL (by tracking suspends and issuing remote wakeup)
 166  *   - msglevel (implies updated messaging)
 167  *   - ... probably more ethtool ops
 168  */
 169
 170 static const struct ethtool_ops ops = {
 171         .get_drvinfo = eth_get_drvinfo,
 172         .get_link = ethtool_op_get_link,
 173 };
 174
 175 static void defer_kevent(struct eth_dev *dev, int flag)
 176 {
 177         if (test_and_set_bit(flag, &dev->todo))
 178                 return;
 179         if (!schedule_work(&dev->work))
 180                 ERROR(dev, "kevent %d may have been dropped\n", flag);
 181         else
 182                 DBG(dev, "kevent %d scheduled\n", flag);
 183 }
 184
 185 static void rx_complete(struct usb_ep *ep, struct usb_request *req);
 186
 187 static int
 188 rx_submit(struct eth_dev *dev, struct usb_request *req, gfp_t gfp_flags)
 189 {
 190         struct sk_buff  *skb;
 191         int             retval = -ENOMEM;
 192         size_t          size = 0;
 193         struct usb_ep   *out;
 194         unsigned long   flags;
 195
 196         spin_lock_irqsave(&dev->lock, flags);
 197         if (dev->port_usb)
 198                 out = dev->port_usb->out_ep;
 199         else
 200                 out = NULL;
 201
 202         if (!out)
 203         {
 204                 spin_unlock_irqrestore(&dev->lock, flags);
 205                 return -ENOTCONN;
 206         }
 207
 208         /* Padding up to RX_EXTRA handles minor disagreements with host.
 209          * Normally we use the USB "terminate on short read" convention;
 210          * so allow up to (N*maxpacket), since that memory is normally
 211          * already allocated.  Some hardware doesn't deal well with short
 212          * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
 213          * byte off the end (to force hardware errors on overflow).
 214          *
 215          * RNDIS uses internal framing, and explicitly allows senders to
 216          * pad to end-of-packet.  That's potentially nice for speed, but
 217          * means receivers can't recover lost synch on their own (because
 218          * new packets don't only start after a short RX).
 219          */
 220         size += sizeof(struct ethhdr) + dev->net->mtu + RX_EXTRA;
 221         size += dev->port_usb->header_len;
 222         size += out->maxpacket - 1;
 223         size -= size % out->maxpacket;
 224
 225         if (dev->port_usb->is_fixed)
 226                 size = max_t(size_t, size, dev->port_usb->fixed_out_len);
 227         spin_unlock_irqrestore(&dev->lock, flags);
 228
 229         skb = alloc_skb(size + NET_IP_ALIGN, gfp_flags);
 230         if (skb == NULL) {
 231                 DBG(dev, "no rx skb\n");
 232                 goto enomem;
 233         }
 234
 235         /* Some platforms perform better when IP packets are aligned,
 236          * but on at least one, checksumming fails otherwise.  Note:
 237          * RNDIS headers involve variable numbers of LE32 values.
 238          */
 239         if (likely(!dev->no_skb_reserve))
 240                 skb_reserve(skb, NET_IP_ALIGN);
 241
 242         req->buf = skb->data;
 243         req->length = size;
 244         req->complete = rx_complete;
 245         req->context = skb;
 246
 247         retval = usb_ep_queue(out, req, gfp_flags);
 248         if (retval == -ENOMEM)
 249 enomem:
 250                 defer_kevent(dev, WORK_RX_MEMORY);
 251         if (retval) {
 252                 DBG(dev, "rx submit --> %d\n", retval);
 253                 if (skb)
 254                         dev_kfree_skb_any(skb);
 255                 spin_lock_irqsave(&dev->req_lock, flags);
 256                 list_add(&req->list, &dev->rx_reqs);
 257                 spin_unlock_irqrestore(&dev->req_lock, flags);
 258         }
 259         return retval;
 260 }
 261
 262 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
 263 {
 264         struct sk_buff  *skb = req->context, *skb2;
 265         struct eth_dev  *dev = ep->driver_data;
 266         int             status = req->status;
 267
 268         switch (status) {
 269
 270         /* normal completion */
 271         case 0:
 272                 skb_put(skb, req->actual);
 273
 274                 if (dev->unwrap) {
 275                         unsigned long   flags;
 276
 277                         spin_lock_irqsave(&dev->lock, flags);
 278                         if (dev->port_usb) {
 279                                 status = dev->unwrap(dev->port_usb,
 280                                                         skb,
 281                                                         &dev->rx_frames);
 282                         } else {
 283                                 dev_kfree_skb_any(skb);
 284                                 status = -ENOTCONN;
 285                         }
 286                         spin_unlock_irqrestore(&dev->lock, flags);
 287                 } else {
 288                         skb_queue_tail(&dev->rx_frames, skb);
 289                 }
 290                 skb = NULL;
 291
 292                 skb2 = skb_dequeue(&dev->rx_frames);
 293                 while (skb2) {
 294                         if (status < 0
 295                                         || ETH_HLEN > skb2->len
 296                                         || skb2->len > GETHER_MAX_ETH_FRAME_LEN) {
 297                                 dev->net->stats.rx_errors++;
 298                                 dev->net->stats.rx_length_errors++;
 299                                 DBG(dev, "rx length %d\n", skb2->len);
 300                                 dev_kfree_skb_any(skb2);
 301                                 goto next_frame;
 302                         }
 303                         skb2->protocol = eth_type_trans(skb2, dev->net);
 304                         dev->net->stats.rx_packets++;
 305                         dev->net->stats.rx_bytes += skb2->len;
 306
 307                         /* no buffer copies needed, unless hardware can't
 308                          * use skb buffers.
 309                          */
 310                         status = netif_rx(skb2);
 311 next_frame:
 312                         skb2 = skb_dequeue(&dev->rx_frames);
 313                 }
 314                 break;
 315
 316         /* software-driven interface shutdown */
 317         case -ECONNRESET:               /* unlink */
 318         case -ESHUTDOWN:                /* disconnect etc */
 319                 VDBG(dev, "rx shutdown, code %d\n", status);
 320                 goto quiesce;
 321
 322         /* for hardware automagic (such as pxa) */
 323         case -ECONNABORTED:             /* endpoint reset */
 324                 DBG(dev, "rx %s reset\n", ep->name);
 325                 defer_kevent(dev, WORK_RX_MEMORY);
 326 quiesce:
 327                 dev_kfree_skb_any(skb);
 328                 goto clean;
 329
 330         /* data overrun */
 331         case -EOVERFLOW:
 332                 dev->net->stats.rx_over_errors++;
 333                 /* FALLTHROUGH */
 334
 335         default:
 336                 dev->net->stats.rx_errors++;
 337                 DBG(dev, "rx status %d\n", status);
 338                 break;
 339         }
 340
 341         if (skb)
 342                 dev_kfree_skb_any(skb);
 343         if (!netif_running(dev->net)) {
 344 clean:
 345                 spin_lock(&dev->req_lock);
 346                 list_add(&req->list, &dev->rx_reqs);
 347                 spin_unlock(&dev->req_lock);
 348                 req = NULL;
 349         }
 350         if (req)
 351                 rx_submit(dev, req, GFP_ATOMIC);
 352 }
 353
 354 static int prealloc(struct list_head *list, struct usb_ep *ep, unsigned n)
 355 {
 356         unsigned                i;
 357         struct usb_request      *req;
 358
 359         if (!n)
 360                 return -ENOMEM;
 361
 362         /* queue/recycle up to N requests */
 363         i = n;
 364         list_for_each_entry(req, list, list) {
 365                 if (i-- == 0)
 366                         goto extra;
 367         }
 368         while (i--) {
 369                 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
 370                 if (!req)
 371                         return list_empty(list) ? -ENOMEM : 0;
 372                 list_add(&req->list, list);
 373         }
 374         return 0;
 375
 376 extra:
 377         /* free extras */
 378         for (;;) {
 379                 struct list_head        *next;
 380
 381                 next = req->list.next;
 382                 list_del(&req->list);
 383                 usb_ep_free_request(ep, req);
 384
 385                 if (next == list)
 386                         break;
 387
 388                 req = container_of(next, struct usb_request, list);
 389         }
 390         return 0;
 391 }
 392
 393 static int alloc_requests(struct eth_dev *dev, struct gether *link, unsigned n)
 394 {
 395         int     status;
 396
 397         spin_lock(&dev->req_lock);
 398         status = prealloc(&dev->tx_reqs, link->in_ep, n);
 399         if (status < 0)
 400                 goto fail;
 401         status = prealloc(&dev->rx_reqs, link->out_ep, n);
 402         if (status < 0)
 403                 goto fail;
 404         goto done;
 405 fail:
 406         DBG(dev, "can't alloc requests\n");
 407 done:
 408         spin_unlock(&dev->req_lock);
 409         return status;
 410 }
 411
 412 static void rx_fill(struct eth_dev *dev, gfp_t gfp_flags)
 413 {
 414         struct usb_request      *req;
 415         unsigned long           flags;
 416
 417         /* fill unused rxq slots with some skb */
 418         spin_lock_irqsave(&dev->req_lock, flags);
 419         while (!list_empty(&dev->rx_reqs)) {
 420                 req = container_of(dev->rx_reqs.next,
 421                                 struct usb_request, list);
 422                 list_del_init(&req->list);
 423                 spin_unlock_irqrestore(&dev->req_lock, flags);
 424
 425                 if (rx_submit(dev, req, gfp_flags) < 0) {
 426                         defer_kevent(dev, WORK_RX_MEMORY);
 427                         return;
 428                 }
 429
 430                 spin_lock_irqsave(&dev->req_lock, flags);
 431         }
 432         spin_unlock_irqrestore(&dev->req_lock, flags);
 433 }
 434
 435 static void eth_work(struct work_struct *work)
 436 {
 437         struct eth_dev  *dev = container_of(work, struct eth_dev, work);
 438
 439         if (test_and_clear_bit(WORK_RX_MEMORY, &dev->todo)) {
 440                 if (netif_running(dev->net))
 441                         rx_fill(dev, GFP_KERNEL);
 442         }
 443
 444         if (dev->todo)
 445                 DBG(dev, "work done, flags = 0x%lx\n", dev->todo);
 446 }
 447
 448 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
 449 {
 450         struct sk_buff  *skb = req->context;
 451         struct eth_dev  *dev = ep->driver_data;
 452
 453         switch (req->status) {
 454         default:
 455                 dev->net->stats.tx_errors++;
 456                 VDBG(dev, "tx err %d\n", req->status);
 457                 /* FALLTHROUGH */
 458         case -ECONNRESET:               /* unlink */
 459         case -ESHUTDOWN:                /* disconnect etc */
 460                 break;
 461         case 0:
 462                 dev->net->stats.tx_bytes += skb->len;
 463         }
 464         dev->net->stats.tx_packets++;
 465
 466         spin_lock(&dev->req_lock);
 467         list_add(&req->list, &dev->tx_reqs);
 468         spin_unlock(&dev->req_lock);
 469         dev_kfree_skb_any(skb);
 470
 471         atomic_dec(&dev->tx_qlen);
 472         if (netif_carrier_ok(dev->net))
 473                 netif_wake_queue(dev->net);
 474 }
 475
 476 static inline int is_promisc(u16 cdc_filter)
 477 {
 478         return cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
 479 }
 480
 481 static netdev_tx_t eth_start_xmit(struct sk_buff *skb,
 482                                         struct net_device *net)
 483 {
 484         struct eth_dev          *dev = netdev_priv(net);
 485         int                     length = 0;
 486         int                     retval;
 487         struct usb_request      *req = NULL;
 488         unsigned long           flags;
 489         struct usb_ep           *in;
 490         u16                     cdc_filter;
 491
 492         spin_lock_irqsave(&dev->lock, flags);
 493         if (dev->port_usb) {
 494                 in = dev->port_usb->in_ep;
 495                 cdc_filter = dev->port_usb->cdc_filter;
 496         } else {
 497                 in = NULL;
 498                 cdc_filter = 0;
 499         }
 500         spin_unlock_irqrestore(&dev->lock, flags);
 501
 502         if (!in) {
 503                 if (skb)
 504                         dev_kfree_skb_any(skb);
 505                 return NETDEV_TX_OK;
 506         }
 507
 508         /* apply outgoing CDC or RNDIS filters */
 509         if (skb && !is_promisc(cdc_filter)) {
 510                 u8              *dest = skb->data;
 511
 512                 if (is_multicast_ether_addr(dest)) {
 513                         u16     type;
 514
 515                         /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
 516                          * SET_ETHERNET_MULTICAST_FILTERS requests
 517                          */
 518                         if (is_broadcast_ether_addr(dest))
 519                                 type = USB_CDC_PACKET_TYPE_BROADCAST;
 520                         else
 521                                 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
 522                         if (!(cdc_filter & type)) {
 523                                 dev_kfree_skb_any(skb);
 524                                 return NETDEV_TX_OK;
 525                         }
 526                 }
 527                 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
 528         }
 529
 530         spin_lock_irqsave(&dev->req_lock, flags);
 531         /*
 532          * this freelist can be empty if an interrupt triggered disconnect()
 533          * and reconfigured the gadget (shutting down this queue) after the
 534          * network stack decided to xmit but before we got the spinlock.
 535          */
 536         if (list_empty(&dev->tx_reqs)) {
 537                 spin_unlock_irqrestore(&dev->req_lock, flags);
 538                 return NETDEV_TX_BUSY;
 539         }
 540
 541         req = container_of(dev->tx_reqs.next, struct usb_request, list);
 542         list_del(&req->list);
 543
 544         /* temporarily stop TX queue when the freelist empties */
 545         if (list_empty(&dev->tx_reqs))
 546                 netif_stop_queue(net);
 547         spin_unlock_irqrestore(&dev->req_lock, flags);
 548
 549         /* no buffer copies needed, unless the network stack did it
 550          * or the hardware can't use skb buffers.
 551          * or there's not enough space for extra headers we need
 552          */
 553         if (dev->wrap) {
 554                 unsigned long   flags;
 555
 556                 spin_lock_irqsave(&dev->lock, flags);
 557                 if (dev->port_usb)
 558                         skb = dev->wrap(dev->port_usb, skb);
 559                 spin_unlock_irqrestore(&dev->lock, flags);
 560                 if (!skb) {
 561                         /* Multi frame CDC protocols may store the frame for
 562                          * later which is not a dropped frame.
 563                          */
 564                         if (dev->port_usb &&
 565                                         dev->port_usb->supports_multi_frame)
 566                                 goto multiframe;
 567                         goto drop;
 568                 }
 569         }
 570
 571         length = skb->len;
 572         req->buf = skb->data;
 573         req->context = skb;
 574         req->complete = tx_complete;
 575
 576         /* NCM requires no zlp if transfer is dwNtbInMaxSize */
 577         if (dev->port_usb &&
 578             dev->port_usb->is_fixed &&
 579             length == dev->port_usb->fixed_in_len &&
 580             (length % in->maxpacket) == 0)
 581                 req->zero = 0;
 582         else
 583                 req->zero = 1;
 584
 585         /* use zlp framing on tx for strict CDC-Ether conformance,
 586          * though any robust network rx path ignores extra padding.
 587          * and some hardware doesn't like to write zlps.
 588          */
 589         if (req->zero && !dev->zlp && (length % in->maxpacket) == 0)
 590                 length++;
 591
 592         req->length = length;
 593
 594         retval = usb_ep_queue(in, req, GFP_ATOMIC);
 595         switch (retval) {
 596         default:
 597                 DBG(dev, "tx queue err %d\n", retval);
 598                 break;
 599         case 0:
 600                 netif_trans_update(net);
 601                 atomic_inc(&dev->tx_qlen);
 602         }
 603
 604         if (retval) {
 605                 dev_kfree_skb_any(skb);
 606 drop:
 607                 dev->net->stats.tx_dropped++;
 608 multiframe:
 609                 spin_lock_irqsave(&dev->req_lock, flags);
 610                 if (list_empty(&dev->tx_reqs))
 611                         netif_start_queue(net);
 612                 list_add(&req->list, &dev->tx_reqs);
 613                 spin_unlock_irqrestore(&dev->req_lock, flags);
 614         }
 615         return NETDEV_TX_OK;
 616 }
 617
 618 /*-------------------------------------------------------------------------*/
 619
 620 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
 621 {
 622         DBG(dev, "%s\n", __func__);
 623
 624         /* fill the rx queue */
 625         rx_fill(dev, gfp_flags);
 626
 627         /* and open the tx floodgates */
 628         atomic_set(&dev->tx_qlen, 0);
 629         netif_wake_queue(dev->net);
 630 }
 631
 632 static int eth_open(struct net_device *net)
 633 {
 634         struct eth_dev  *dev = netdev_priv(net);
 635         struct gether   *link;
 636
 637         DBG(dev, "%s\n", __func__);
 638         if (netif_carrier_ok(dev->net))
 639                 eth_start(dev, GFP_KERNEL);
 640
 641         spin_lock_irq(&dev->lock);
 642         link = dev->port_usb;
 643         if (link && link->open)
 644                 link->open(link);
 645         spin_unlock_irq(&dev->lock);
 646
 647         return 0;
 648 }
 649
 650 static int eth_stop(struct net_device *net)
 651 {
 652         struct eth_dev  *dev = netdev_priv(net);
 653         unsigned long   flags;
 654
 655         VDBG(dev, "%s\n", __func__);
 656         netif_stop_queue(net);
 657
 658         DBG(dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n",
 659                 dev->net->stats.rx_packets, dev->net->stats.tx_packets,
 660                 dev->net->stats.rx_errors, dev->net->stats.tx_errors
 661                 );
 662
 663         /* ensure there are no more active requests */
 664         spin_lock_irqsave(&dev->lock, flags);
 665         if (dev->port_usb) {
 666                 struct gether   *link = dev->port_usb;
 667                 const struct usb_endpoint_descriptor *in;
 668                 const struct usb_endpoint_descriptor *out;
 669
 670                 if (link->close)
 671                         link->close(link);
 672
 673                 /* NOTE:  we have no abort-queue primitive we could use
 674                  * to cancel all pending I/O.  Instead, we disable then
 675                  * reenable the endpoints ... this idiom may leave toggle
 676                  * wrong, but that's a self-correcting error.
 677                  *
 678                  * REVISIT:  we *COULD* just let the transfers complete at
 679                  * their own pace; the network stack can handle old packets.
 680                  * For the moment we leave this here, since it works.
 681                  */
 682                 in = link->in_ep->desc;
 683                 out = link->out_ep->desc;
 684                 usb_ep_disable(link->in_ep);
 685                 usb_ep_disable(link->out_ep);
 686                 if (netif_carrier_ok(net)) {
 687                         DBG(dev, "host still using in/out endpoints\n");
 688                         link->in_ep->desc = in;
 689                         link->out_ep->desc = out;
 690                         usb_ep_enable(link->in_ep);
 691                         usb_ep_enable(link->out_ep);
 692                 }
 693         }
 694         spin_unlock_irqrestore(&dev->lock, flags);
 695
 696         return 0;
 697 }
 698
 699 /*-------------------------------------------------------------------------*/
 700
 701 static int get_ether_addr(const char *str, u8 *dev_addr)
 702 {
 703         if (str) {
 704                 unsigned        i;
 705
 706                 for (i = 0; i < 6; i++) {
 707                         unsigned char num;
 708
 709                         if ((*str == '.') || (*str == ':'))
 710                                 str++;
 711                         num = hex_to_bin(*str++) << 4;
 712                         num |= hex_to_bin(*str++);
 713                         dev_addr [i] = num;
 714                 }
 715                 if (is_valid_ether_addr(dev_addr))
 716                         return 0;
 717         }
 718         eth_random_addr(dev_addr);
 719         return 1;
 720 }
 721
 722 static int get_ether_addr_str(u8 dev_addr[ETH_ALEN], char *str, int len)
 723 {
 724         if (len < 18)
 725                 return -EINVAL;
 726
 727         snprintf(str, len, "%pM", dev_addr);
 728         return 18;
 729 }
 730
 731 static const struct net_device_ops eth_netdev_ops = {
 732         .ndo_open               = eth_open,
 733         .ndo_stop               = eth_stop,
 734         .ndo_start_xmit         = eth_start_xmit,
 735         .ndo_change_mtu         = ueth_change_mtu,
 736         .ndo_set_mac_address    = eth_mac_addr,
 737         .ndo_validate_addr      = eth_validate_addr,
 738 };
 739
 740 static struct device_type gadget_type = {
 741         .name   = "gadget",
 742 };
 743
 744 /**
 745  * gether_setup_name - initialize one ethernet-over-usb link
 746  * @g: gadget to associated with these links
 747  * @ethaddr: NULL, or a buffer in which the ethernet address of the
 748  *      host side of the link is recorded
 749  * @netname: name for network device (for example, "usb")
 750  * Context: may sleep
 751  *
 752  * This sets up the single network link that may be exported by a
 753  * gadget driver using this framework.  The link layer addresses are
 754  * set up using module parameters.
 755  *
 756  * Returns an eth_dev pointer on success, or an ERR_PTR on failure.
 757  */
 758 struct eth_dev *gether_setup_name(struct usb_gadget *g,
 759                 const char *dev_addr, const char *host_addr,
 760                 u8 ethaddr[ETH_ALEN], unsigned qmult, const char *netname)
 761 {
 762         struct eth_dev          *dev;
 763         struct net_device       *net;
 764         int                     status;
 765
 766         net = alloc_etherdev(sizeof *dev);
 767         if (!net)
 768                 return ERR_PTR(-ENOMEM);
 769
 770         dev = netdev_priv(net);
 771         spin_lock_init(&dev->lock);
 772         spin_lock_init(&dev->req_lock);
 773         INIT_WORK(&dev->work, eth_work);
 774         INIT_LIST_HEAD(&dev->tx_reqs);
 775         INIT_LIST_HEAD(&dev->rx_reqs);
 776
 777         skb_queue_head_init(&dev->rx_frames);
 778
 779         /* network device setup */
 780         dev->net = net;
 781         dev->qmult = qmult;
 782         snprintf(net->name, sizeof(net->name), "%s%%d", netname);
 783
 784         if (get_ether_addr(dev_addr, net->dev_addr))
 785                 dev_warn(&g->dev,
 786                         "using random %s ethernet address\n", "self");
 787         if (get_ether_addr(host_addr, dev->host_mac))
 788                 dev_warn(&g->dev,
 789                         "using random %s ethernet address\n", "host");
 790
 791         if (ethaddr)
 792                 memcpy(ethaddr, dev->host_mac, ETH_ALEN);
 793
 794         net->netdev_ops = &eth_netdev_ops;
 795
 796         net->ethtool_ops = &ops;
 797
 798         dev->gadget = g;
 799         SET_NETDEV_DEV(net, &g->dev);
 800         SET_NETDEV_DEVTYPE(net, &gadget_type);
 801
 802         status = register_netdev(net);
 803         if (status < 0) {
 804                 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
 805                 free_netdev(net);
 806                 dev = ERR_PTR(status);
 807         } else {
 808                 INFO(dev, "MAC %pM\n", net->dev_addr);
 809                 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
 810
 811                 /*
 812                  * two kinds of host-initiated state changes:
 813                  *  - iff DATA transfer is active, carrier is "on"
 814                  *  - tx queueing enabled if open *and* carrier is "on"
 815                  */
 816                 netif_carrier_off(net);
 817         }
 818
 819         return dev;
 820 }
 821 EXPORT_SYMBOL_GPL(gether_setup_name);
 822
 823 struct net_device *gether_setup_name_default(const char *netname)
 824 {
 825         struct net_device       *net;
 826         struct eth_dev          *dev;
 827
 828         net = alloc_etherdev(sizeof(*dev));
 829         if (!net)
 830                 return ERR_PTR(-ENOMEM);
 831
 832         dev = netdev_priv(net);
 833         spin_lock_init(&dev->lock);
 834         spin_lock_init(&dev->req_lock);
 835         INIT_WORK(&dev->work, eth_work);
 836         INIT_LIST_HEAD(&dev->tx_reqs);
 837         INIT_LIST_HEAD(&dev->rx_reqs);
 838
 839         skb_queue_head_init(&dev->rx_frames);
 840
 841         /* network device setup */
 842         dev->net = net;
 843         dev->qmult = QMULT_DEFAULT;
 844         snprintf(net->name, sizeof(net->name), "%s%%d", netname);
 845
 846         eth_random_addr(dev->dev_mac);
 847         pr_warn("using random %s ethernet address\n", "self");
 848         eth_random_addr(dev->host_mac);
 849         pr_warn("using random %s ethernet address\n", "host");
 850
 851         net->netdev_ops = &eth_netdev_ops;
 852
 853         net->ethtool_ops = &ops;
 854         SET_NETDEV_DEVTYPE(net, &gadget_type);
 855
 856         return net;
 857 }
 858 EXPORT_SYMBOL_GPL(gether_setup_name_default);
 859
 860 int gether_register_netdev(struct net_device *net)
 861 {
 862         struct eth_dev *dev;
 863         struct usb_gadget *g;
 864         struct sockaddr sa;
 865         int status;
 866
 867         if (!net->dev.parent)
 868                 return -EINVAL;
 869         dev = netdev_priv(net);
 870         g = dev->gadget;
 871         status = register_netdev(net);
 872         if (status < 0) {
 873                 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
 874                 return status;
 875         } else {
 876                 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
 877
 878                 /* two kinds of host-initiated state changes:
 879                  *  - iff DATA transfer is active, carrier is "on"
 880                  *  - tx queueing enabled if open *and* carrier is "on"
 881                  */
 882                 netif_carrier_off(net);
 883         }
 884         sa.sa_family = net->type;
 885         memcpy(sa.sa_data, dev->dev_mac, ETH_ALEN);
 886         rtnl_lock();
 887         status = dev_set_mac_address(net, &sa);
 888         rtnl_unlock();
 889         if (status)
 890                 pr_warn("cannot set self ethernet address: %d\n", status);
 891         else
 892                 INFO(dev, "MAC %pM\n", dev->dev_mac);
 893
 894         return status;
 895 }
 896 EXPORT_SYMBOL_GPL(gether_register_netdev);
 897
 898 void gether_set_gadget(struct net_device *net, struct usb_gadget *g)
 899 {
 900         struct eth_dev *dev;
 901
 902         dev = netdev_priv(net);
 903         dev->gadget = g;
 904         SET_NETDEV_DEV(net, &g->dev);
 905 }
 906 EXPORT_SYMBOL_GPL(gether_set_gadget);
 907
 908 int gether_set_dev_addr(struct net_device *net, const char *dev_addr)
 909 {
 910         struct eth_dev *dev;
 911         u8 new_addr[ETH_ALEN];
 912
 913         dev = netdev_priv(net);
 914         if (get_ether_addr(dev_addr, new_addr))
 915                 return -EINVAL;
 916         memcpy(dev->dev_mac, new_addr, ETH_ALEN);
 917         return 0;
 918 }
 919 EXPORT_SYMBOL_GPL(gether_set_dev_addr);
 920
 921 int gether_get_dev_addr(struct net_device *net, char *dev_addr, int len)
 922 {
 923         struct eth_dev *dev;
 924
 925         dev = netdev_priv(net);
 926         return get_ether_addr_str(dev->dev_mac, dev_addr, len);
 927 }
 928 EXPORT_SYMBOL_GPL(gether_get_dev_addr);
 929
 930 int gether_set_host_addr(struct net_device *net, const char *host_addr)
 931 {
 932         struct eth_dev *dev;
 933         u8 new_addr[ETH_ALEN];
 934
 935         dev = netdev_priv(net);
 936         if (get_ether_addr(host_addr, new_addr))
 937                 return -EINVAL;
 938         memcpy(dev->host_mac, new_addr, ETH_ALEN);
 939         return 0;
 940 }
 941 EXPORT_SYMBOL_GPL(gether_set_host_addr);
 942
 943 int gether_get_host_addr(struct net_device *net, char *host_addr, int len)
 944 {
 945         struct eth_dev *dev;
 946
 947         dev = netdev_priv(net);
 948         return get_ether_addr_str(dev->host_mac, host_addr, len);
 949 }
 950 EXPORT_SYMBOL_GPL(gether_get_host_addr);
 951
 952 int gether_get_host_addr_cdc(struct net_device *net, char *host_addr, int len)
 953 {
 954         struct eth_dev *dev;
 955
 956         if (len < 13)
 957                 return -EINVAL;
 958
 959         dev = netdev_priv(net);
 960         snprintf(host_addr, len, "%pm", dev->host_mac);
 961
 962         return strlen(host_addr);
 963 }
 964 EXPORT_SYMBOL_GPL(gether_get_host_addr_cdc);
 965
 966 void gether_get_host_addr_u8(struct net_device *net, u8 host_mac[ETH_ALEN])
 967 {
 968         struct eth_dev *dev;
 969
 970         dev = netdev_priv(net);
 971         memcpy(host_mac, dev->host_mac, ETH_ALEN);
 972 }
 973 EXPORT_SYMBOL_GPL(gether_get_host_addr_u8);
 974
 975 void gether_set_qmult(struct net_device *net, unsigned qmult)
 976 {
 977         struct eth_dev *dev;
 978
 979         dev = netdev_priv(net);
 980         dev->qmult = qmult;
 981 }
 982 EXPORT_SYMBOL_GPL(gether_set_qmult);
 983
 984 unsigned gether_get_qmult(struct net_device *net)
 985 {
 986         struct eth_dev *dev;
 987
 988         dev = netdev_priv(net);
 989         return dev->qmult;
 990 }
 991 EXPORT_SYMBOL_GPL(gether_get_qmult);
 992
 993 int gether_get_ifname(struct net_device *net, char *name, int len)
 994 {
 995         rtnl_lock();
 996         strlcpy(name, netdev_name(net), len);
 997         rtnl_unlock();
 998         return strlen(name);
 999 }
1000 EXPORT_SYMBOL_GPL(gether_get_ifname);
1001
1002 /**
1003  * gether_cleanup - remove Ethernet-over-USB device
1004  * Context: may sleep
1005  *
1006  * This is called to free all resources allocated by @gether_setup().
1007  */
1008 void gether_cleanup(struct eth_dev *dev)
1009 {
1010         if (!dev)
1011                 return;
1012
1013         unregister_netdev(dev->net);
1014         flush_work(&dev->work);
1015         free_netdev(dev->net);
1016 }
1017 EXPORT_SYMBOL_GPL(gether_cleanup);
1018
1019 /**
1020  * gether_connect - notify network layer that USB link is active
1021  * @link: the USB link, set up with endpoints, descriptors matching
1022  *      current device speed, and any framing wrapper(s) set up.
1023  * Context: irqs blocked
1024  *
1025  * This is called to activate endpoints and let the network layer know
1026  * the connection is active ("carrier detect").  It may cause the I/O
1027  * queues to open and start letting network packets flow, but will in
1028  * any case activate the endpoints so that they respond properly to the
1029  * USB host.
1030  *
1031  * Verify net_device pointer returned using IS_ERR().  If it doesn't
1032  * indicate some error code (negative errno), ep->driver_data values
1033  * have been overwritten.
1034  */
1035 struct net_device *gether_connect(struct gether *link)
1036 {
1037         struct eth_dev          *dev = link->ioport;
1038         int                     result = 0;
1039
1040         if (!dev)
1041                 return ERR_PTR(-EINVAL);
1042
1043         link->in_ep->driver_data = dev;
1044         result = usb_ep_enable(link->in_ep);
1045         if (result != 0) {
1046                 DBG(dev, "enable %s --> %d\n",
1047                         link->in_ep->name, result);
1048                 goto fail0;
1049         }
1050
1051         link->out_ep->driver_data = dev;
1052         result = usb_ep_enable(link->out_ep);
1053         if (result != 0) {
1054                 DBG(dev, "enable %s --> %d\n",
1055                         link->out_ep->name, result);
1056                 goto fail1;
1057         }
1058
1059         if (result == 0)
1060                 result = alloc_requests(dev, link, qlen(dev->gadget,
1061                                         dev->qmult));
1062
1063         if (result == 0) {
1064                 dev->zlp = link->is_zlp_ok;
1065                 dev->no_skb_reserve = link->no_skb_reserve;
1066                 DBG(dev, "qlen %d\n", qlen(dev->gadget, dev->qmult));
1067
1068                 dev->header_len = link->header_len;
1069                 dev->unwrap = link->unwrap;
1070                 dev->wrap = link->wrap;
1071
1072                 spin_lock(&dev->lock);
1073                 dev->port_usb = link;
1074                 if (netif_running(dev->net)) {
1075                         if (link->open)
1076                                 link->open(link);
1077                 } else {
1078                         if (link->close)
1079                                 link->close(link);
1080                 }
1081                 spin_unlock(&dev->lock);
1082
1083                 netif_carrier_on(dev->net);
1084                 if (netif_running(dev->net))
1085                         eth_start(dev, GFP_ATOMIC);
1086
1087         /* on error, disable any endpoints  */
1088         } else {
1089                 (void) usb_ep_disable(link->out_ep);
1090 fail1:
1091                 (void) usb_ep_disable(link->in_ep);
1092         }
1093 fail0:
1094         /* caller is responsible for cleanup on error */
1095         if (result < 0)
1096                 return ERR_PTR(result);
1097         return dev->net;
1098 }
1099 EXPORT_SYMBOL_GPL(gether_connect);
1100
1101 /**
1102  * gether_disconnect - notify network layer that USB link is inactive
1103  * @link: the USB link, on which gether_connect() was called
1104  * Context: irqs blocked
1105  *
1106  * This is called to deactivate endpoints and let the network layer know
1107  * the connection went inactive ("no carrier").
1108  *
1109  * On return, the state is as if gether_connect() had never been called.
1110  * The endpoints are inactive, and accordingly without active USB I/O.
1111  * Pointers to endpoint descriptors and endpoint private data are nulled.
1112  */
1113 void gether_disconnect(struct gether *link)
1114 {
1115         struct eth_dev          *dev = link->ioport;
1116         struct usb_request      *req;
1117
1118         WARN_ON(!dev);
1119         if (!dev)
1120                 return;
1121
1122         DBG(dev, "%s\n", __func__);
1123
1124         netif_stop_queue(dev->net);
1125         netif_carrier_off(dev->net);
1126
1127         /* disable endpoints, forcing (synchronous) completion
1128          * of all pending i/o.  then free the request objects
1129          * and forget about the endpoints.
1130          */
1131         usb_ep_disable(link->in_ep);
1132         spin_lock(&dev->req_lock);
1133         while (!list_empty(&dev->tx_reqs)) {
1134                 req = container_of(dev->tx_reqs.next,
1135                                         struct usb_request, list);
1136                 list_del(&req->list);
1137
1138                 spin_unlock(&dev->req_lock);
1139                 usb_ep_free_request(link->in_ep, req);
1140                 spin_lock(&dev->req_lock);
1141         }
1142         spin_unlock(&dev->req_lock);
1143         link->in_ep->desc = NULL;
1144
1145         usb_ep_disable(link->out_ep);
1146         spin_lock(&dev->req_lock);
1147         while (!list_empty(&dev->rx_reqs)) {
1148                 req = container_of(dev->rx_reqs.next,
1149                                         struct usb_request, list);
1150                 list_del(&req->list);
1151
1152                 spin_unlock(&dev->req_lock);
1153                 usb_ep_free_request(link->out_ep, req);
1154                 spin_lock(&dev->req_lock);
1155         }
1156         spin_unlock(&dev->req_lock);
1157         link->out_ep->desc = NULL;
1158
1159         /* finish forgetting about this USB link episode */
1160         dev->header_len = 0;
1161         dev->unwrap = NULL;
1162         dev->wrap = NULL;
1163
1164         spin_lock(&dev->lock);
1165         dev->port_usb = NULL;
1166         spin_unlock(&dev->lock);
1167 }
1168 EXPORT_SYMBOL_GPL(gether_disconnect);
1169
1170 MODULE_LICENSE("GPL");
1171 MODULE_AUTHOR("David Brownell");