drivers/usb/gadget/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  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /* #define VERBOSE_DEBUG */
  24
  25 #include <linux/kernel.h>
  26 #include <linux/gfp.h>
  27 #include <linux/device.h>
  28 #include <linux/ctype.h>
  29 #include <linux/etherdevice.h>
  30 #include <linux/ethtool.h>
  31
  32 #include "u_ether.h"
  33
  34
  35 /*
  36  * This component encapsulates the Ethernet link glue needed to provide
  37  * one (!) network link through the USB gadget stack, normally "usb0".
  38  *
  39  * The control and data models are handled by the function driver which
  40  * connects to this code; such as CDC Ethernet (ECM or EEM),
  41  * "CDC Subset", or RNDIS.  That includes all descriptor and endpoint
  42  * management.
  43  *
  44  * Link level addressing is handled by this component using module
  45  * parameters; if no such parameters are provided, random link level
  46  * addresses are used.  Each end of the link uses one address.  The
  47  * host end address is exported in various ways, and is often recorded
  48  * in configuration databases.
  49  *
  50  * The driver which assembles each configuration using such a link is
  51  * responsible for ensuring that each configuration includes at most one
  52  * instance of is network link.  (The network layer provides ways for
  53  * this single "physical" link to be used by multiple virtual links.)
  54  */
  55
  56 #define UETH__VERSION   "29-May-2008"
  57
  58 struct eth_dev {
  59         /* lock is held while accessing port_usb
  60          * or updating its backlink port_usb->ioport
  61          */
  62         spinlock_t              lock;
  63         struct gether           *port_usb;
  64
  65         struct net_device       *net;
  66         struct usb_gadget       *gadget;
  67
  68         spinlock_t              req_lock;       /* guard {rx,tx}_reqs */
  69         struct list_head        tx_reqs, rx_reqs;
  70         atomic_t                tx_qlen;
  71
  72         struct sk_buff_head     rx_frames;
  73
  74         unsigned                header_len;
  75         struct sk_buff          *(*wrap)(struct gether *, struct sk_buff *skb);
  76         int                     (*unwrap)(struct gether *,
  77                                                 struct sk_buff *skb,
  78                                                 struct sk_buff_head *list);
  79
  80         struct work_struct      work;
  81
  82         unsigned long           todo;
  83 #define WORK_RX_MEMORY          0
  84
  85         bool                    zlp;
  86         u8                      host_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
  96 #ifdef CONFIG_USB_GADGET_DUALSPEED
  97
  98 static unsigned qmult = 5;
  99 module_param(qmult, uint, S_IRUGO|S_IWUSR);
 100 MODULE_PARM_DESC(qmult, "queue length multiplier at high speed");
 101
 102 #else   /* full speed (low speed doesn't do bulk) */
 103 #define qmult           1
 104 #endif
 105
 106 /* for dual-speed hardware, use deeper queues at highspeed */
 107 static inline int qlen(struct usb_gadget *gadget)
 108 {
 109         if (gadget_is_dualspeed(gadget) && gadget->speed == USB_SPEED_HIGH)
 110                 return qmult * DEFAULT_QLEN;
 111         else
 112                 return DEFAULT_QLEN;
 113 }
 114
 115 /*-------------------------------------------------------------------------*/
 116
 117 /* REVISIT there must be a better way than having two sets
 118  * of debug calls ...
 119  */
 120
 121 #undef DBG
 122 #undef VDBG
 123 #undef ERROR
 124 #undef INFO
 125
 126 #define xprintk(d, level, fmt, args...) \
 127         printk(level "%s: " fmt , (d)->net->name , ## args)
 128
 129 #ifdef DEBUG
 130 #undef DEBUG
 131 #define DBG(dev, fmt, args...) \
 132         xprintk(dev , KERN_DEBUG , fmt , ## args)
 133 #else
 134 #define DBG(dev, fmt, args...) \
 135         do { } while (0)
 136 #endif /* DEBUG */
 137
 138 #ifdef VERBOSE_DEBUG
 139 #define VDBG    DBG
 140 #else
 141 #define VDBG(dev, fmt, args...) \
 142         do { } while (0)
 143 #endif /* DEBUG */
 144
 145 #define ERROR(dev, fmt, args...) \
 146         xprintk(dev , KERN_ERR , fmt , ## args)
 147 #define INFO(dev, fmt, args...) \
 148         xprintk(dev , KERN_INFO , fmt , ## args)
 149
 150 /*-------------------------------------------------------------------------*/
 151
 152 /* NETWORK DRIVER HOOKUP (to the layer above this driver) */
 153
 154 static int ueth_change_mtu(struct net_device *net, int new_mtu)
 155 {
 156         struct eth_dev  *dev = netdev_priv(net);
 157         unsigned long   flags;
 158         int             status = 0;
 159
 160         /* don't change MTU on "live" link (peer won't know) */
 161         spin_lock_irqsave(&dev->lock, flags);
 162         if (dev->port_usb)
 163                 status = -EBUSY;
 164         else if (new_mtu <= ETH_HLEN || new_mtu > ETH_FRAME_LEN)
 165                 status = -ERANGE;
 166         else
 167                 net->mtu = new_mtu;
 168         spin_unlock_irqrestore(&dev->lock, flags);
 169
 170         return status;
 171 }
 172
 173 static void eth_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *p)
 174 {
 175         struct eth_dev  *dev = netdev_priv(net);
 176
 177         strlcpy(p->driver, "g_ether", sizeof p->driver);
 178         strlcpy(p->version, UETH__VERSION, sizeof p->version);
 179         strlcpy(p->fw_version, dev->gadget->name, sizeof p->fw_version);
 180         strlcpy(p->bus_info, dev_name(&dev->gadget->dev), sizeof p->bus_info);
 181 }
 182
 183 /* REVISIT can also support:
 184  *   - WOL (by tracking suspends and issuing remote wakeup)
 185  *   - msglevel (implies updated messaging)
 186  *   - ... probably more ethtool ops
 187  */
 188
 189 static const struct ethtool_ops ops = {
 190         .get_drvinfo = eth_get_drvinfo,
 191         .get_link = ethtool_op_get_link,
 192 };
 193
 194 static void defer_kevent(struct eth_dev *dev, int flag)
 195 {
 196         if (test_and_set_bit(flag, &dev->todo))
 197                 return;
 198         if (!schedule_work(&dev->work))
 199                 ERROR(dev, "kevent %d may have been dropped\n", flag);
 200         else
 201                 DBG(dev, "kevent %d scheduled\n", flag);
 202 }
 203
 204 static void rx_complete(struct usb_ep *ep, struct usb_request *req);
 205
 206 static int
 207 rx_submit(struct eth_dev *dev, struct usb_request *req, gfp_t gfp_flags)
 208 {
 209         struct sk_buff  *skb;
 210         int             retval = -ENOMEM;
 211         size_t          size = 0;
 212         struct usb_ep   *out;
 213         unsigned long   flags;
 214
 215         spin_lock_irqsave(&dev->lock, flags);
 216         if (dev->port_usb)
 217                 out = dev->port_usb->out_ep;
 218         else
 219                 out = NULL;
 220         spin_unlock_irqrestore(&dev->lock, flags);
 221
 222         if (!out)
 223                 return -ENOTCONN;
 224
 225
 226         /* Padding up to RX_EXTRA handles minor disagreements with host.
 227          * Normally we use the USB "terminate on short read" convention;
 228          * so allow up to (N*maxpacket), since that memory is normally
 229          * already allocated.  Some hardware doesn't deal well with short
 230          * reads (e.g. DMA must be N*maxpacket), so for now don't trim a
 231          * byte off the end (to force hardware errors on overflow).
 232          *
 233          * RNDIS uses internal framing, and explicitly allows senders to
 234          * pad to end-of-packet.  That's potentially nice for speed, but
 235          * means receivers can't recover lost synch on their own (because
 236          * new packets don't only start after a short RX).
 237          */
 238         size += sizeof(struct ethhdr) + dev->net->mtu + RX_EXTRA;
 239         size += dev->port_usb->header_len;
 240         size += out->maxpacket - 1;
 241         size -= size % out->maxpacket;
 242
 243 #ifdef CONFIG_USB_GADGET_S3C_OTGD_DMA_MODE
 244         /* for double word align */
 245         skb = alloc_skb(size + NET_IP_ALIGN + 6, gfp_flags);
 246 #else
 247         skb = alloc_skb(size + NET_IP_ALIGN, gfp_flags);
 248 #endif
 249         if (skb == NULL) {
 250                 DBG(dev, "no rx skb\n");
 251                 goto enomem;
 252         }
 253
 254         /* Some platforms perform better when IP packets are aligned,
 255          * but on at least one, checksumming fails otherwise.  Note:
 256          * RNDIS headers involve variable numbers of LE32 values.
 257          */
 258 #ifdef CONFIG_USB_GADGET_S3C_OTGD_DMA_MODE
 259         /* for double word align */
 260         skb_reserve(skb, NET_IP_ALIGN + 6);
 261 #else
 262         skb_reserve(skb, NET_IP_ALIGN);
 263 #endif
 264
 265         req->buf = skb->data;
 266         req->length = size;
 267         req->complete = rx_complete;
 268         req->context = skb;
 269
 270         retval = usb_ep_queue(out, req, gfp_flags);
 271         if (retval == -ENOMEM)
 272 enomem:
 273                 defer_kevent(dev, WORK_RX_MEMORY);
 274         if (retval) {
 275                 DBG(dev, "rx submit --> %d\n", retval);
 276                 if (skb)
 277                         dev_kfree_skb_any(skb);
 278                 spin_lock_irqsave(&dev->req_lock, flags);
 279                 list_add(&req->list, &dev->rx_reqs);
 280                 spin_unlock_irqrestore(&dev->req_lock, flags);
 281         }
 282         return retval;
 283 }
 284
 285 static void rx_complete(struct usb_ep *ep, struct usb_request *req)
 286 {
 287         struct sk_buff  *skb = req->context, *skb2;
 288         struct eth_dev  *dev = ep->driver_data;
 289         int             status = req->status;
 290
 291         switch (status) {
 292
 293         /* normal completion */
 294         case 0:
 295                 skb_put(skb, req->actual);
 296
 297                 if (dev->unwrap) {
 298                         unsigned long   flags;
 299
 300                         spin_lock_irqsave(&dev->lock, flags);
 301                         if (dev->port_usb) {
 302                                 status = dev->unwrap(dev->port_usb,
 303                                                         skb,
 304                                                         &dev->rx_frames);
 305                         } else {
 306                                 dev_kfree_skb_any(skb);
 307                                 status = -ENOTCONN;
 308                         }
 309                         spin_unlock_irqrestore(&dev->lock, flags);
 310                 } else {
 311                         skb_queue_tail(&dev->rx_frames, skb);
 312                 }
 313                 skb = NULL;
 314
 315                 skb2 = skb_dequeue(&dev->rx_frames);
 316                 while (skb2) {
 317                         if (status < 0
 318                                         || ETH_HLEN > skb2->len
 319                                         || skb2->len > ETH_FRAME_LEN) {
 320                                 dev->net->stats.rx_errors++;
 321                                 dev->net->stats.rx_length_errors++;
 322                                 DBG(dev, "rx length %d\n", skb2->len);
 323                                 dev_kfree_skb_any(skb2);
 324                                 goto next_frame;
 325                         }
 326                         skb2->protocol = eth_type_trans(skb2, dev->net);
 327                         dev->net->stats.rx_packets++;
 328                         dev->net->stats.rx_bytes += skb2->len;
 329
 330                         /* no buffer copies needed, unless hardware can't
 331                          * use skb buffers.
 332                          */
 333                         status = netif_rx(skb2);
 334 next_frame:
 335                         skb2 = skb_dequeue(&dev->rx_frames);
 336                 }
 337                 break;
 338
 339         /* software-driven interface shutdown */
 340         case -ECONNRESET:               /* unlink */
 341         case -ESHUTDOWN:                /* disconnect etc */
 342                 VDBG(dev, "rx shutdown, code %d\n", status);
 343                 goto quiesce;
 344
 345         /* for hardware automagic (such as pxa) */
 346         case -ECONNABORTED:             /* endpoint reset */
 347                 DBG(dev, "rx %s reset\n", ep->name);
 348                 defer_kevent(dev, WORK_RX_MEMORY);
 349 quiesce:
 350                 dev_kfree_skb_any(skb);
 351                 goto clean;
 352
 353         /* data overrun */
 354         case -EOVERFLOW:
 355                 dev->net->stats.rx_over_errors++;
 356                 /* FALLTHROUGH */
 357
 358         default:
 359                 dev->net->stats.rx_errors++;
 360                 DBG(dev, "rx status %d\n", status);
 361                 break;
 362         }
 363
 364         if (skb)
 365                 dev_kfree_skb_any(skb);
 366         if (!netif_running(dev->net)) {
 367 clean:
 368                 spin_lock(&dev->req_lock);
 369                 list_add(&req->list, &dev->rx_reqs);
 370                 spin_unlock(&dev->req_lock);
 371                 req = NULL;
 372         }
 373         if (req)
 374                 rx_submit(dev, req, GFP_ATOMIC);
 375 }
 376
 377 static int prealloc(struct list_head *list, struct usb_ep *ep, unsigned n)
 378 {
 379         unsigned                i;
 380         struct usb_request      *req;
 381
 382         if (!n)
 383                 return -ENOMEM;
 384
 385         /* queue/recycle up to N requests */
 386         i = n;
 387         list_for_each_entry(req, list, list) {
 388                 if (i-- == 0)
 389                         goto extra;
 390         }
 391         while (i--) {
 392                 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
 393                 if (!req)
 394                         return list_empty(list) ? -ENOMEM : 0;
 395                 list_add(&req->list, list);
 396         }
 397         return 0;
 398
 399 extra:
 400         /* free extras */
 401         for (;;) {
 402                 struct list_head        *next;
 403
 404                 next = req->list.next;
 405                 list_del(&req->list);
 406                 usb_ep_free_request(ep, req);
 407
 408                 if (next == list)
 409                         break;
 410
 411                 req = container_of(next, struct usb_request, list);
 412         }
 413         return 0;
 414 }
 415
 416 static int alloc_requests(struct eth_dev *dev, struct gether *link, unsigned n)
 417 {
 418         int     status;
 419
 420         spin_lock(&dev->req_lock);
 421         status = prealloc(&dev->tx_reqs, link->in_ep, n);
 422         if (status < 0)
 423                 goto fail;
 424         status = prealloc(&dev->rx_reqs, link->out_ep, n);
 425         if (status < 0)
 426                 goto fail;
 427         goto done;
 428 fail:
 429         DBG(dev, "can't alloc requests\n");
 430 done:
 431         spin_unlock(&dev->req_lock);
 432         return status;
 433 }
 434
 435 static void rx_fill(struct eth_dev *dev, gfp_t gfp_flags)
 436 {
 437         struct usb_request      *req;
 438         unsigned long           flags;
 439
 440         /* fill unused rxq slots with some skb */
 441         spin_lock_irqsave(&dev->req_lock, flags);
 442         while (!list_empty(&dev->rx_reqs)) {
 443                 req = container_of(dev->rx_reqs.next,
 444                                 struct usb_request, list);
 445                 list_del_init(&req->list);
 446                 spin_unlock_irqrestore(&dev->req_lock, flags);
 447
 448                 if (rx_submit(dev, req, gfp_flags) < 0) {
 449                         defer_kevent(dev, WORK_RX_MEMORY);
 450                         return;
 451                 }
 452
 453                 spin_lock_irqsave(&dev->req_lock, flags);
 454         }
 455         spin_unlock_irqrestore(&dev->req_lock, flags);
 456 }
 457
 458 static void eth_work(struct work_struct *work)
 459 {
 460         struct eth_dev  *dev = container_of(work, struct eth_dev, work);
 461
 462         if (test_and_clear_bit(WORK_RX_MEMORY, &dev->todo)) {
 463                 if (netif_running(dev->net))
 464                         rx_fill(dev, GFP_KERNEL);
 465         }
 466
 467         if (dev->todo)
 468                 DBG(dev, "work done, flags = 0x%lx\n", dev->todo);
 469 }
 470
 471 static void tx_complete(struct usb_ep *ep, struct usb_request *req)
 472 {
 473         struct sk_buff  *skb = req->context;
 474         struct eth_dev  *dev = ep->driver_data;
 475
 476         switch (req->status) {
 477         default:
 478                 dev->net->stats.tx_errors++;
 479                 VDBG(dev, "tx err %d\n", req->status);
 480                 /* FALLTHROUGH */
 481         case -ECONNRESET:               /* unlink */
 482         case -ESHUTDOWN:                /* disconnect etc */
 483                 break;
 484         case 0:
 485                 dev->net->stats.tx_bytes += skb->len;
 486         }
 487         dev->net->stats.tx_packets++;
 488
 489         spin_lock(&dev->req_lock);
 490         list_add(&req->list, &dev->tx_reqs);
 491         spin_unlock(&dev->req_lock);
 492
 493 #ifdef CONFIG_USB_GADGET_S3C_OTGD_DMA_MODE
 494         if(req->buf != skb->data)
 495                 kfree(req->buf);
 496 #endif
 497         dev_kfree_skb_any(skb);
 498
 499         atomic_dec(&dev->tx_qlen);
 500         if (netif_carrier_ok(dev->net))
 501                 netif_wake_queue(dev->net);
 502 }
 503
 504 static inline int is_promisc(u16 cdc_filter)
 505 {
 506         return cdc_filter & USB_CDC_PACKET_TYPE_PROMISCUOUS;
 507 }
 508
 509 static netdev_tx_t eth_start_xmit(struct sk_buff *skb,
 510                                         struct net_device *net)
 511 {
 512         struct eth_dev          *dev = netdev_priv(net);
 513         int                     length = skb->len;
 514         int                     retval;
 515         struct usb_request      *req = NULL;
 516         unsigned long           flags;
 517         struct usb_ep           *in;
 518         u16                     cdc_filter;
 519
 520         spin_lock_irqsave(&dev->lock, flags);
 521         if (dev->port_usb) {
 522                 in = dev->port_usb->in_ep;
 523                 cdc_filter = dev->port_usb->cdc_filter;
 524         } else {
 525                 in = NULL;
 526                 cdc_filter = 0;
 527         }
 528         spin_unlock_irqrestore(&dev->lock, flags);
 529
 530         if (!in) {
 531                 dev_kfree_skb_any(skb);
 532                 return NETDEV_TX_OK;
 533         }
 534
 535         /* apply outgoing CDC or RNDIS filters */
 536         if (!is_promisc(cdc_filter)) {
 537                 u8              *dest = skb->data;
 538
 539                 if (is_multicast_ether_addr(dest)) {
 540                         u16     type;
 541
 542                         /* ignores USB_CDC_PACKET_TYPE_MULTICAST and host
 543                          * SET_ETHERNET_MULTICAST_FILTERS requests
 544                          */
 545                         if (is_broadcast_ether_addr(dest))
 546                                 type = USB_CDC_PACKET_TYPE_BROADCAST;
 547                         else
 548                                 type = USB_CDC_PACKET_TYPE_ALL_MULTICAST;
 549                         if (!(cdc_filter & type)) {
 550                                 dev_kfree_skb_any(skb);
 551                                 return NETDEV_TX_OK;
 552                         }
 553                 }
 554                 /* ignores USB_CDC_PACKET_TYPE_DIRECTED */
 555         }
 556
 557         spin_lock_irqsave(&dev->req_lock, flags);
 558         /*
 559          * this freelist can be empty if an interrupt triggered disconnect()
 560          * and reconfigured the gadget (shutting down this queue) after the
 561          * network stack decided to xmit but before we got the spinlock.
 562          */
 563         if (list_empty(&dev->tx_reqs)) {
 564                 spin_unlock_irqrestore(&dev->req_lock, flags);
 565                 return NETDEV_TX_BUSY;
 566         }
 567
 568         req = container_of(dev->tx_reqs.next, struct usb_request, list);
 569         list_del(&req->list);
 570
 571         /* temporarily stop TX queue when the freelist empties */
 572         if (list_empty(&dev->tx_reqs))
 573                 netif_stop_queue(net);
 574         spin_unlock_irqrestore(&dev->req_lock, flags);
 575
 576         /* no buffer copies needed, unless the network stack did it
 577          * or the hardware can't use skb buffers.
 578          * or there's not enough space for extra headers we need
 579          */
 580         if (dev->wrap) {
 581                 unsigned long   flags;
 582
 583                 spin_lock_irqsave(&dev->lock, flags);
 584                 if (dev->port_usb)
 585                         skb = dev->wrap(dev->port_usb, skb);
 586                 spin_unlock_irqrestore(&dev->lock, flags);
 587                 if (!skb)
 588                         goto drop;
 589
 590                 length = skb->len;
 591         }
 592
 593 #ifdef CONFIG_USB_GADGET_S3C_OTGD_DMA_MODE
 594         /* for double word align */
 595         req->buf = kmalloc(skb->len, GFP_ATOMIC | GFP_DMA);
 596
 597         if (!req->buf) {
 598         req->buf = skb->data;
 599                 printk("%s: fail to kmalloc [req->buf = skb->data]\n", __FUNCTION__);
 600         }
 601         else
 602                 memcpy((void *)req->buf, (void *)skb->data, skb->len);
 603 #else
 604         req->buf = skb->data;
 605 #endif
 606
 607         req->context = skb;
 608         req->complete = tx_complete;
 609
 610         /* use zlp framing on tx for strict CDC-Ether conformance,
 611          * though any robust network rx path ignores extra padding.
 612          * and some hardware doesn't like to write zlps.
 613          */
 614         req->zero = 1;
 615         if (!dev->zlp && (length % in->maxpacket) == 0)
 616                 length++;
 617
 618         req->length = length;
 619
 620         /* throttle highspeed IRQ rate back slightly */
 621         if (gadget_is_dualspeed(dev->gadget))
 622                 req->no_interrupt = (dev->gadget->speed == USB_SPEED_HIGH)
 623                         ? ((atomic_read(&dev->tx_qlen) % qmult) != 0)
 624                         : 0;
 625
 626         retval = usb_ep_queue(in, req, GFP_ATOMIC);
 627         switch (retval) {
 628         default:
 629                 DBG(dev, "tx queue err %d\n", retval);
 630                 break;
 631         case 0:
 632                 net->trans_start = jiffies;
 633                 atomic_inc(&dev->tx_qlen);
 634         }
 635
 636         if (retval) {
 637 #ifdef CONFIG_USB_GADGET_S3C_OTGD_DMA_MODE
 638                 if(req->buf != skb->data)
 639                         kfree(req->buf);
 640 #endif
 641                 dev_kfree_skb_any(skb);
 642 drop:
 643                 dev->net->stats.tx_dropped++;
 644
 645                 spin_lock_irqsave(&dev->req_lock, flags);
 646                 if (list_empty(&dev->tx_reqs))
 647                         netif_start_queue(net);
 648                 list_add(&req->list, &dev->tx_reqs);
 649                 spin_unlock_irqrestore(&dev->req_lock, flags);
 650         }
 651         return NETDEV_TX_OK;
 652 }
 653
 654 /*-------------------------------------------------------------------------*/
 655
 656 static void eth_start(struct eth_dev *dev, gfp_t gfp_flags)
 657 {
 658         DBG(dev, "%s\n", __func__);
 659
 660         /* fill the rx queue */
 661         rx_fill(dev, gfp_flags);
 662
 663         /* and open the tx floodgates */
 664         atomic_set(&dev->tx_qlen, 0);
 665         netif_wake_queue(dev->net);
 666 }
 667
 668 static int eth_open(struct net_device *net)
 669 {
 670         struct eth_dev  *dev = netdev_priv(net);
 671         struct gether   *link;
 672
 673         DBG(dev, "%s\n", __func__);
 674         if (netif_carrier_ok(dev->net))
 675                 eth_start(dev, GFP_KERNEL);
 676
 677         spin_lock_irq(&dev->lock);
 678         link = dev->port_usb;
 679         if (link && link->open)
 680                 link->open(link);
 681         spin_unlock_irq(&dev->lock);
 682
 683         return 0;
 684 }
 685
 686 static int eth_stop(struct net_device *net)
 687 {
 688         struct eth_dev  *dev = netdev_priv(net);
 689         unsigned long   flags;
 690
 691         VDBG(dev, "%s\n", __func__);
 692         netif_stop_queue(net);
 693
 694         DBG(dev, "stop stats: rx/tx %ld/%ld, errs %ld/%ld\n",
 695                 dev->net->stats.rx_packets, dev->net->stats.tx_packets,
 696                 dev->net->stats.rx_errors, dev->net->stats.tx_errors
 697                 );
 698
 699         /* ensure there are no more active requests */
 700         spin_lock_irqsave(&dev->lock, flags);
 701         if (dev->port_usb) {
 702                 struct gether   *link = dev->port_usb;
 703
 704                 if (link->close)
 705                         link->close(link);
 706
 707                 /* NOTE:  we have no abort-queue primitive we could use
 708                  * to cancel all pending I/O.  Instead, we disable then
 709                  * reenable the endpoints ... this idiom may leave toggle
 710                  * wrong, but that's a self-correcting error.
 711                  *
 712                  * REVISIT:  we *COULD* just let the transfers complete at
 713                  * their own pace; the network stack can handle old packets.
 714                  * For the moment we leave this here, since it works.
 715                  */
 716                 usb_ep_disable(link->in_ep);
 717                 usb_ep_disable(link->out_ep);
 718                 if (netif_carrier_ok(net)) {
 719                         DBG(dev, "host still using in/out endpoints\n");
 720                         usb_ep_enable(link->in_ep, link->in);
 721                         usb_ep_enable(link->out_ep, link->out);
 722                 }
 723         }
 724         spin_unlock_irqrestore(&dev->lock, flags);
 725
 726         return 0;
 727 }
 728
 729 /*-------------------------------------------------------------------------*/
 730
 731 /* initial value, changed by "ifconfig usb0 hw ether xx:xx:xx:xx:xx:xx" */
 732 static char *dev_addr;
 733 module_param(dev_addr, charp, S_IRUGO);
 734 MODULE_PARM_DESC(dev_addr, "Device Ethernet Address");
 735
 736 /* this address is invisible to ifconfig */
 737 static char *host_addr;
 738 module_param(host_addr, charp, S_IRUGO);
 739 MODULE_PARM_DESC(host_addr, "Host Ethernet Address");
 740
 741
 742 static u8 __init nibble(unsigned char c)
 743 {
 744         if (isdigit(c))
 745                 return c - '0';
 746         c = toupper(c);
 747         if (isxdigit(c))
 748                 return 10 + c - 'A';
 749         return 0;
 750 }
 751
 752 static int get_ether_addr(const char *str, u8 *dev_addr)
 753 {
 754         if (str) {
 755                 unsigned        i;
 756
 757                 for (i = 0; i < 6; i++) {
 758                         unsigned char num;
 759
 760                         if ((*str == '.') || (*str == ':'))
 761                                 str++;
 762                         num = nibble(*str++) << 4;
 763                         num |= (nibble(*str++));
 764                         dev_addr [i] = num;
 765                 }
 766                 if (is_valid_ether_addr(dev_addr))
 767                         return 0;
 768         }
 769         random_ether_addr(dev_addr);
 770         return 1;
 771 }
 772
 773 static struct eth_dev *the_dev;
 774
 775 static const struct net_device_ops eth_netdev_ops = {
 776         .ndo_open               = eth_open,
 777         .ndo_stop               = eth_stop,
 778         .ndo_start_xmit         = eth_start_xmit,
 779         .ndo_change_mtu         = ueth_change_mtu,
 780         .ndo_set_mac_address    = eth_mac_addr,
 781         .ndo_validate_addr      = eth_validate_addr,
 782 };
 783
 784 static struct device_type gadget_type = {
 785         .name   = "gadget",
 786 };
 787
 788 /**
 789  * gether_setup - initialize one ethernet-over-usb link
 790  * @g: gadget to associated with these links
 791  * @ethaddr: NULL, or a buffer in which the ethernet address of the
 792  *      host side of the link is recorded
 793  * Context: may sleep
 794  *
 795  * This sets up the single network link that may be exported by a
 796  * gadget driver using this framework.  The link layer addresses are
 797  * set up using module parameters.
 798  *
 799  * Returns negative errno, or zero on success
 800  */
 801 int gether_setup(struct usb_gadget *g, u8 ethaddr[ETH_ALEN])
 802 {
 803         struct eth_dev          *dev;
 804         struct net_device       *net;
 805         int                     status;
 806
 807         if (the_dev)
 808                 return -EBUSY;
 809
 810         net = alloc_etherdev(sizeof *dev);
 811         if (!net)
 812                 return -ENOMEM;
 813
 814         dev = netdev_priv(net);
 815         spin_lock_init(&dev->lock);
 816         spin_lock_init(&dev->req_lock);
 817         INIT_WORK(&dev->work, eth_work);
 818         INIT_LIST_HEAD(&dev->tx_reqs);
 819         INIT_LIST_HEAD(&dev->rx_reqs);
 820
 821         skb_queue_head_init(&dev->rx_frames);
 822
 823         /* network device setup */
 824         dev->net = net;
 825         strcpy(net->name, "usb%d");
 826
 827         if (get_ether_addr(dev_addr, net->dev_addr))
 828                 dev_warn(&g->dev,
 829                         "using random %s ethernet address\n", "self");
 830         if (get_ether_addr(host_addr, dev->host_mac))
 831                 dev_warn(&g->dev,
 832                         "using random %s ethernet address\n", "host");
 833
 834         if (ethaddr)
 835                 memcpy(ethaddr, dev->host_mac, ETH_ALEN);
 836
 837         net->netdev_ops = &eth_netdev_ops;
 838
 839         SET_ETHTOOL_OPS(net, &ops);
 840
 841         /* two kinds of host-initiated state changes:
 842          *  - iff DATA transfer is active, carrier is "on"
 843          *  - tx queueing enabled if open *and* carrier is "on"
 844          */
 845         netif_stop_queue(net);
 846         netif_carrier_off(net);
 847
 848         dev->gadget = g;
 849         SET_NETDEV_DEV(net, &g->dev);
 850         SET_NETDEV_DEVTYPE(net, &gadget_type);
 851
 852         status = register_netdev(net);
 853         if (status < 0) {
 854                 dev_dbg(&g->dev, "register_netdev failed, %d\n", status);
 855                 free_netdev(net);
 856         } else {
 857                 INFO(dev, "MAC %pM\n", net->dev_addr);
 858                 INFO(dev, "HOST MAC %pM\n", dev->host_mac);
 859
 860                 the_dev = dev;
 861         }
 862
 863         return status;
 864 }
 865
 866 /**
 867  * gether_cleanup - remove Ethernet-over-USB device
 868  * Context: may sleep
 869  *
 870  * This is called to free all resources allocated by @gether_setup().
 871  */
 872 void gether_cleanup(void)
 873 {
 874         if (!the_dev)
 875                 return;
 876
 877         unregister_netdev(the_dev->net);
 878         free_netdev(the_dev->net);
 879
 880         /* assuming we used keventd, it must quiesce too */
 881         flush_scheduled_work();
 882
 883         the_dev = NULL;
 884 }
 885
 886
 887 /**
 888  * gether_connect - notify network layer that USB link is active
 889  * @link: the USB link, set up with endpoints, descriptors matching
 890  *      current device speed, and any framing wrapper(s) set up.
 891  * Context: irqs blocked
 892  *
 893  * This is called to activate endpoints and let the network layer know
 894  * the connection is active ("carrier detect").  It may cause the I/O
 895  * queues to open and start letting network packets flow, but will in
 896  * any case activate the endpoints so that they respond properly to the
 897  * USB host.
 898  *
 899  * Verify net_device pointer returned using IS_ERR().  If it doesn't
 900  * indicate some error code (negative errno), ep->driver_data values
 901  * have been overwritten.
 902  */
 903 struct net_device *gether_connect(struct gether *link)
 904 {
 905         struct eth_dev          *dev = the_dev;
 906         int                     result = 0;
 907
 908         if (!dev)
 909                 return ERR_PTR(-EINVAL);
 910
 911         link->in_ep->driver_data = dev;
 912         result = usb_ep_enable(link->in_ep, link->in);
 913         if (result != 0) {
 914                 DBG(dev, "enable %s --> %d\n",
 915                         link->in_ep->name, result);
 916                 goto fail0;
 917         }
 918
 919         link->out_ep->driver_data = dev;
 920         result = usb_ep_enable(link->out_ep, link->out);
 921         if (result != 0) {
 922                 DBG(dev, "enable %s --> %d\n",
 923                         link->out_ep->name, result);
 924                 goto fail1;
 925         }
 926
 927         if (result == 0)
 928                 result = alloc_requests(dev, link, qlen(dev->gadget));
 929
 930         if (result == 0) {
 931                 dev->zlp = link->is_zlp_ok;
 932                 DBG(dev, "qlen %d\n", qlen(dev->gadget));
 933
 934                 dev->header_len = link->header_len;
 935                 dev->unwrap = link->unwrap;
 936                 dev->wrap = link->wrap;
 937
 938                 spin_lock(&dev->lock);
 939                 dev->port_usb = link;
 940                 link->ioport = dev;
 941                 if (netif_running(dev->net)) {
 942                         if (link->open)
 943                                 link->open(link);
 944                 } else {
 945                         if (link->close)
 946                                 link->close(link);
 947                 }
 948                 spin_unlock(&dev->lock);
 949
 950                 netif_carrier_on(dev->net);
 951                 if (netif_running(dev->net))
 952                         eth_start(dev, GFP_ATOMIC);
 953
 954         /* on error, disable any endpoints  */
 955         } else {
 956                 (void) usb_ep_disable(link->out_ep);
 957 fail1:
 958                 (void) usb_ep_disable(link->in_ep);
 959         }
 960 fail0:
 961         /* caller is responsible for cleanup on error */
 962         if (result < 0)
 963                 return ERR_PTR(result);
 964         return dev->net;
 965 }
 966
 967 /**
 968  * gether_disconnect - notify network layer that USB link is inactive
 969  * @link: the USB link, on which gether_connect() was called
 970  * Context: irqs blocked
 971  *
 972  * This is called to deactivate endpoints and let the network layer know
 973  * the connection went inactive ("no carrier").
 974  *
 975  * On return, the state is as if gether_connect() had never been called.
 976  * The endpoints are inactive, and accordingly without active USB I/O.
 977  * Pointers to endpoint descriptors and endpoint private data are nulled.
 978  */
 979 void gether_disconnect(struct gether *link)
 980 {
 981         struct eth_dev          *dev = link->ioport;
 982         struct usb_request      *req;
 983
 984         if (!dev)
 985                 return;
 986
 987         DBG(dev, "%s\n", __func__);
 988
 989         netif_stop_queue(dev->net);
 990         netif_carrier_off(dev->net);
 991
 992         /* disable endpoints, forcing (synchronous) completion
 993          * of all pending i/o.  then free the request objects
 994          * and forget about the endpoints.
 995          */
 996         usb_ep_disable(link->in_ep);
 997         spin_lock(&dev->req_lock);
 998         while (!list_empty(&dev->tx_reqs)) {
 999                 req = container_of(dev->tx_reqs.next,
1000                                         struct usb_request, list);
1001                 list_del(&req->list);
1002
1003                 spin_unlock(&dev->req_lock);
1004                 usb_ep_free_request(link->in_ep, req);
1005                 spin_lock(&dev->req_lock);
1006         }
1007         spin_unlock(&dev->req_lock);
1008         link->in_ep->driver_data = NULL;
1009         link->in = NULL;
1010
1011         usb_ep_disable(link->out_ep);
1012         spin_lock(&dev->req_lock);
1013         while (!list_empty(&dev->rx_reqs)) {
1014                 req = container_of(dev->rx_reqs.next,
1015                                         struct usb_request, list);
1016                 list_del(&req->list);
1017
1018                 spin_unlock(&dev->req_lock);
1019                 usb_ep_free_request(link->out_ep, req);
1020                 spin_lock(&dev->req_lock);
1021         }
1022         spin_unlock(&dev->req_lock);
1023         link->out_ep->driver_data = NULL;
1024         link->out = NULL;
1025
1026         /* finish forgetting about this USB link episode */
1027         dev->header_len = 0;
1028         dev->unwrap = NULL;
1029         dev->wrap = NULL;
1030
1031         spin_lock(&dev->lock);
1032         dev->port_usb = NULL;
1033         link->ioport = NULL;
1034         spin_unlock(&dev->lock);
1035 }