drivers/usb/gadget/f_rndis.c

   1 /*
   2  * f_rndis.c -- RNDIS link function driver
   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  * Copyright (C) 2009 Samsung Electronics
   8  *                    Author: Michal Nazarewicz (mina86@mina86.com)
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  */
  15
  16 /* #define VERBOSE_DEBUG */
  17
  18 #include <linux/slab.h>
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/device.h>
  22 #include <linux/etherdevice.h>
  23
  24 #include <linux/atomic.h>
  25
  26 #include "u_ether.h"
  27 #include "u_rndis.h"
  28 #include "rndis.h"
  29
  30 /*
  31  * This function is an RNDIS Ethernet port -- a Microsoft protocol that's
  32  * been promoted instead of the standard CDC Ethernet.  The published RNDIS
  33  * spec is ambiguous, incomplete, and needlessly complex.  Variants such as
  34  * ActiveSync have even worse status in terms of specification.
  35  *
  36  * In short:  it's a protocol controlled by (and for) Microsoft, not for an
  37  * Open ecosystem or markets.  Linux supports it *only* because Microsoft
  38  * doesn't support the CDC Ethernet standard.
  39  *
  40  * The RNDIS data transfer model is complex, with multiple Ethernet packets
  41  * per USB message, and out of band data.  The control model is built around
  42  * what's essentially an "RNDIS RPC" protocol.  It's all wrapped in a CDC ACM
  43  * (modem, not Ethernet) veneer, with those ACM descriptors being entirely
  44  * useless (they're ignored).  RNDIS expects to be the only function in its
  45  * configuration, so it's no real help if you need composite devices; and
  46  * it expects to be the first configuration too.
  47  *
  48  * There is a single technical advantage of RNDIS over CDC Ethernet, if you
  49  * discount the fluff that its RPC can be made to deliver: it doesn't need
  50  * a NOP altsetting for the data interface.  That lets it work on some of the
  51  * "so smart it's stupid" hardware which takes over configuration changes
  52  * from the software, and adds restrictions like "no altsettings".
  53  *
  54  * Unfortunately MSFT's RNDIS drivers are buggy.  They hang or oops, and
  55  * have all sorts of contrary-to-specification oddities that can prevent
  56  * them from working sanely.  Since bugfixes (or accurate specs, letting
  57  * Linux work around those bugs) are unlikely to ever come from MSFT, you
  58  * may want to avoid using RNDIS on purely operational grounds.
  59  *
  60  * Omissions from the RNDIS 1.0 specification include:
  61  *
  62  *   - Power management ... references data that's scattered around lots
  63  *     of other documentation, which is incorrect/incomplete there too.
  64  *
  65  *   - There are various undocumented protocol requirements, like the need
  66  *     to send garbage in some control-OUT messages.
  67  *
  68  *   - MS-Windows drivers sometimes emit undocumented requests.
  69  */
  70
  71 struct f_rndis {
  72         struct gether                   port;
  73         u8                              ctrl_id, data_id;
  74         u8                              ethaddr[ETH_ALEN];
  75         u32                             vendorID;
  76         const char                      *manufacturer;
  77         int                             config;
  78
  79         struct usb_ep                   *notify;
  80         struct usb_request              *notify_req;
  81         atomic_t                        notify_count;
  82 };
  83
  84 static inline struct f_rndis *func_to_rndis(struct usb_function *f)
  85 {
  86         return container_of(f, struct f_rndis, port.func);
  87 }
  88
  89 /* peak (theoretical) bulk transfer rate in bits-per-second */
  90 static unsigned int bitrate(struct usb_gadget *g)
  91 {
  92         if (gadget_is_superspeed(g) && g->speed == USB_SPEED_SUPER)
  93                 return 13 * 1024 * 8 * 1000 * 8;
  94         else if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
  95                 return 13 * 512 * 8 * 1000 * 8;
  96         else
  97                 return 19 * 64 * 1 * 1000 * 8;
  98 }
  99
 100 /*-------------------------------------------------------------------------*/
 101
 102 /*
 103  */
 104
 105 #define RNDIS_STATUS_INTERVAL_MS        32
 106 #define STATUS_BYTECOUNT                8       /* 8 bytes data */
 107
 108
 109 /* interface descriptor: */
 110
 111 static struct usb_interface_descriptor rndis_control_intf = {
 112         .bLength =              sizeof rndis_control_intf,
 113         .bDescriptorType =      USB_DT_INTERFACE,
 114
 115         /* .bInterfaceNumber = DYNAMIC */
 116         /* status endpoint is optional; this could be patched later */
 117         .bNumEndpoints =        1,
 118         .bInterfaceClass =      USB_CLASS_COMM,
 119         .bInterfaceSubClass =   USB_CDC_SUBCLASS_ACM,
 120         .bInterfaceProtocol =   USB_CDC_ACM_PROTO_VENDOR,
 121         /* .iInterface = DYNAMIC */
 122 };
 123
 124 static struct usb_cdc_header_desc header_desc = {
 125         .bLength =              sizeof header_desc,
 126         .bDescriptorType =      USB_DT_CS_INTERFACE,
 127         .bDescriptorSubType =   USB_CDC_HEADER_TYPE,
 128
 129         .bcdCDC =               cpu_to_le16(0x0110),
 130 };
 131
 132 static struct usb_cdc_call_mgmt_descriptor call_mgmt_descriptor = {
 133         .bLength =              sizeof call_mgmt_descriptor,
 134         .bDescriptorType =      USB_DT_CS_INTERFACE,
 135         .bDescriptorSubType =   USB_CDC_CALL_MANAGEMENT_TYPE,
 136
 137         .bmCapabilities =       0x00,
 138         .bDataInterface =       0x01,
 139 };
 140
 141 static struct usb_cdc_acm_descriptor rndis_acm_descriptor = {
 142         .bLength =              sizeof rndis_acm_descriptor,
 143         .bDescriptorType =      USB_DT_CS_INTERFACE,
 144         .bDescriptorSubType =   USB_CDC_ACM_TYPE,
 145
 146         .bmCapabilities =       0x00,
 147 };
 148
 149 static struct usb_cdc_union_desc rndis_union_desc = {
 150         .bLength =              sizeof(rndis_union_desc),
 151         .bDescriptorType =      USB_DT_CS_INTERFACE,
 152         .bDescriptorSubType =   USB_CDC_UNION_TYPE,
 153         /* .bMasterInterface0 = DYNAMIC */
 154         /* .bSlaveInterface0 =  DYNAMIC */
 155 };
 156
 157 /* the data interface has two bulk endpoints */
 158
 159 static struct usb_interface_descriptor rndis_data_intf = {
 160         .bLength =              sizeof rndis_data_intf,
 161         .bDescriptorType =      USB_DT_INTERFACE,
 162
 163         /* .bInterfaceNumber = DYNAMIC */
 164         .bNumEndpoints =        2,
 165         .bInterfaceClass =      USB_CLASS_CDC_DATA,
 166         .bInterfaceSubClass =   0,
 167         .bInterfaceProtocol =   0,
 168         /* .iInterface = DYNAMIC */
 169 };
 170
 171
 172 static struct usb_interface_assoc_descriptor
 173 rndis_iad_descriptor = {
 174         .bLength =              sizeof rndis_iad_descriptor,
 175         .bDescriptorType =      USB_DT_INTERFACE_ASSOCIATION,
 176
 177         .bFirstInterface =      0, /* XXX, hardcoded */
 178         .bInterfaceCount =      2,      // control + data
 179         .bFunctionClass =       USB_CLASS_COMM,
 180         .bFunctionSubClass =    USB_CDC_SUBCLASS_ETHERNET,
 181         .bFunctionProtocol =    USB_CDC_PROTO_NONE,
 182         /* .iFunction = DYNAMIC */
 183 };
 184
 185 /* full speed support: */
 186
 187 static struct usb_endpoint_descriptor fs_notify_desc = {
 188         .bLength =              USB_DT_ENDPOINT_SIZE,
 189         .bDescriptorType =      USB_DT_ENDPOINT,
 190
 191         .bEndpointAddress =     USB_DIR_IN,
 192         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 193         .wMaxPacketSize =       cpu_to_le16(STATUS_BYTECOUNT),
 194         .bInterval =            RNDIS_STATUS_INTERVAL_MS,
 195 };
 196
 197 static struct usb_endpoint_descriptor fs_in_desc = {
 198         .bLength =              USB_DT_ENDPOINT_SIZE,
 199         .bDescriptorType =      USB_DT_ENDPOINT,
 200
 201         .bEndpointAddress =     USB_DIR_IN,
 202         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 203 };
 204
 205 static struct usb_endpoint_descriptor fs_out_desc = {
 206         .bLength =              USB_DT_ENDPOINT_SIZE,
 207         .bDescriptorType =      USB_DT_ENDPOINT,
 208
 209         .bEndpointAddress =     USB_DIR_OUT,
 210         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 211 };
 212
 213 static struct usb_descriptor_header *eth_fs_function[] = {
 214         (struct usb_descriptor_header *) &rndis_iad_descriptor,
 215
 216         /* control interface matches ACM, not Ethernet */
 217         (struct usb_descriptor_header *) &rndis_control_intf,
 218         (struct usb_descriptor_header *) &header_desc,
 219         (struct usb_descriptor_header *) &call_mgmt_descriptor,
 220         (struct usb_descriptor_header *) &rndis_acm_descriptor,
 221         (struct usb_descriptor_header *) &rndis_union_desc,
 222         (struct usb_descriptor_header *) &fs_notify_desc,
 223
 224         /* data interface has no altsetting */
 225         (struct usb_descriptor_header *) &rndis_data_intf,
 226         (struct usb_descriptor_header *) &fs_in_desc,
 227         (struct usb_descriptor_header *) &fs_out_desc,
 228         NULL,
 229 };
 230
 231 /* high speed support: */
 232
 233 static struct usb_endpoint_descriptor hs_notify_desc = {
 234         .bLength =              USB_DT_ENDPOINT_SIZE,
 235         .bDescriptorType =      USB_DT_ENDPOINT,
 236
 237         .bEndpointAddress =     USB_DIR_IN,
 238         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 239         .wMaxPacketSize =       cpu_to_le16(STATUS_BYTECOUNT),
 240         .bInterval =            USB_MS_TO_HS_INTERVAL(RNDIS_STATUS_INTERVAL_MS)
 241 };
 242
 243 static struct usb_endpoint_descriptor hs_in_desc = {
 244         .bLength =              USB_DT_ENDPOINT_SIZE,
 245         .bDescriptorType =      USB_DT_ENDPOINT,
 246
 247         .bEndpointAddress =     USB_DIR_IN,
 248         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 249         .wMaxPacketSize =       cpu_to_le16(512),
 250 };
 251
 252 static struct usb_endpoint_descriptor hs_out_desc = {
 253         .bLength =              USB_DT_ENDPOINT_SIZE,
 254         .bDescriptorType =      USB_DT_ENDPOINT,
 255
 256         .bEndpointAddress =     USB_DIR_OUT,
 257         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 258         .wMaxPacketSize =       cpu_to_le16(512),
 259 };
 260
 261 static struct usb_descriptor_header *eth_hs_function[] = {
 262         (struct usb_descriptor_header *) &rndis_iad_descriptor,
 263
 264         /* control interface matches ACM, not Ethernet */
 265         (struct usb_descriptor_header *) &rndis_control_intf,
 266         (struct usb_descriptor_header *) &header_desc,
 267         (struct usb_descriptor_header *) &call_mgmt_descriptor,
 268         (struct usb_descriptor_header *) &rndis_acm_descriptor,
 269         (struct usb_descriptor_header *) &rndis_union_desc,
 270         (struct usb_descriptor_header *) &hs_notify_desc,
 271
 272         /* data interface has no altsetting */
 273         (struct usb_descriptor_header *) &rndis_data_intf,
 274         (struct usb_descriptor_header *) &hs_in_desc,
 275         (struct usb_descriptor_header *) &hs_out_desc,
 276         NULL,
 277 };
 278
 279 /* super speed support: */
 280
 281 static struct usb_endpoint_descriptor ss_notify_desc = {
 282         .bLength =              USB_DT_ENDPOINT_SIZE,
 283         .bDescriptorType =      USB_DT_ENDPOINT,
 284
 285         .bEndpointAddress =     USB_DIR_IN,
 286         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 287         .wMaxPacketSize =       cpu_to_le16(STATUS_BYTECOUNT),
 288         .bInterval =            USB_MS_TO_HS_INTERVAL(RNDIS_STATUS_INTERVAL_MS)
 289 };
 290
 291 static struct usb_ss_ep_comp_descriptor ss_intr_comp_desc = {
 292         .bLength =              sizeof ss_intr_comp_desc,
 293         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
 294
 295         /* the following 3 values can be tweaked if necessary */
 296         /* .bMaxBurst =         0, */
 297         /* .bmAttributes =      0, */
 298         .wBytesPerInterval =    cpu_to_le16(STATUS_BYTECOUNT),
 299 };
 300
 301 static struct usb_endpoint_descriptor ss_in_desc = {
 302         .bLength =              USB_DT_ENDPOINT_SIZE,
 303         .bDescriptorType =      USB_DT_ENDPOINT,
 304
 305         .bEndpointAddress =     USB_DIR_IN,
 306         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 307         .wMaxPacketSize =       cpu_to_le16(1024),
 308 };
 309
 310 static struct usb_endpoint_descriptor ss_out_desc = {
 311         .bLength =              USB_DT_ENDPOINT_SIZE,
 312         .bDescriptorType =      USB_DT_ENDPOINT,
 313
 314         .bEndpointAddress =     USB_DIR_OUT,
 315         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 316         .wMaxPacketSize =       cpu_to_le16(1024),
 317 };
 318
 319 static struct usb_ss_ep_comp_descriptor ss_bulk_comp_desc = {
 320         .bLength =              sizeof ss_bulk_comp_desc,
 321         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
 322
 323         /* the following 2 values can be tweaked if necessary */
 324         /* .bMaxBurst =         0, */
 325         /* .bmAttributes =      0, */
 326 };
 327
 328 static struct usb_descriptor_header *eth_ss_function[] = {
 329         (struct usb_descriptor_header *) &rndis_iad_descriptor,
 330
 331         /* control interface matches ACM, not Ethernet */
 332         (struct usb_descriptor_header *) &rndis_control_intf,
 333         (struct usb_descriptor_header *) &header_desc,
 334         (struct usb_descriptor_header *) &call_mgmt_descriptor,
 335         (struct usb_descriptor_header *) &rndis_acm_descriptor,
 336         (struct usb_descriptor_header *) &rndis_union_desc,
 337         (struct usb_descriptor_header *) &ss_notify_desc,
 338         (struct usb_descriptor_header *) &ss_intr_comp_desc,
 339
 340         /* data interface has no altsetting */
 341         (struct usb_descriptor_header *) &rndis_data_intf,
 342         (struct usb_descriptor_header *) &ss_in_desc,
 343         (struct usb_descriptor_header *) &ss_bulk_comp_desc,
 344         (struct usb_descriptor_header *) &ss_out_desc,
 345         (struct usb_descriptor_header *) &ss_bulk_comp_desc,
 346         NULL,
 347 };
 348
 349 /* string descriptors: */
 350
 351 static struct usb_string rndis_string_defs[] = {
 352         [0].s = "RNDIS Communications Control",
 353         [1].s = "RNDIS Ethernet Data",
 354         [2].s = "RNDIS",
 355         {  } /* end of list */
 356 };
 357
 358 static struct usb_gadget_strings rndis_string_table = {
 359         .language =             0x0409, /* en-us */
 360         .strings =              rndis_string_defs,
 361 };
 362
 363 static struct usb_gadget_strings *rndis_strings[] = {
 364         &rndis_string_table,
 365         NULL,
 366 };
 367
 368 /*-------------------------------------------------------------------------*/
 369
 370 static struct sk_buff *rndis_add_header(struct gether *port,
 371                                         struct sk_buff *skb)
 372 {
 373         struct sk_buff *skb2;
 374
 375         skb2 = skb_realloc_headroom(skb, sizeof(struct rndis_packet_msg_type));
 376         if (skb2)
 377                 rndis_add_hdr(skb2);
 378
 379         dev_kfree_skb_any(skb);
 380         return skb2;
 381 }
 382
 383 static void rndis_response_available(void *_rndis)
 384 {
 385         struct f_rndis                  *rndis = _rndis;
 386         struct usb_request              *req = rndis->notify_req;
 387         struct usb_composite_dev        *cdev = rndis->port.func.config->cdev;
 388         __le32                          *data = req->buf;
 389         int                             status;
 390
 391         if (atomic_inc_return(&rndis->notify_count) != 1)
 392                 return;
 393
 394         /* Send RNDIS RESPONSE_AVAILABLE notification; a
 395          * USB_CDC_NOTIFY_RESPONSE_AVAILABLE "should" work too
 396          *
 397          * This is the only notification defined by RNDIS.
 398          */
 399         data[0] = cpu_to_le32(1);
 400         data[1] = cpu_to_le32(0);
 401
 402         status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
 403         if (status) {
 404                 atomic_dec(&rndis->notify_count);
 405                 DBG(cdev, "notify/0 --> %d\n", status);
 406         }
 407 }
 408
 409 static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req)
 410 {
 411         struct f_rndis                  *rndis = req->context;
 412         struct usb_composite_dev        *cdev = rndis->port.func.config->cdev;
 413         int                             status = req->status;
 414
 415         /* after TX:
 416          *  - USB_CDC_GET_ENCAPSULATED_RESPONSE (ep0/control)
 417          *  - RNDIS_RESPONSE_AVAILABLE (status/irq)
 418          */
 419         switch (status) {
 420         case -ECONNRESET:
 421         case -ESHUTDOWN:
 422                 /* connection gone */
 423                 atomic_set(&rndis->notify_count, 0);
 424                 break;
 425         default:
 426                 DBG(cdev, "RNDIS %s response error %d, %d/%d\n",
 427                         ep->name, status,
 428                         req->actual, req->length);
 429                 /* FALLTHROUGH */
 430         case 0:
 431                 if (ep != rndis->notify)
 432                         break;
 433
 434                 /* handle multiple pending RNDIS_RESPONSE_AVAILABLE
 435                  * notifications by resending until we're done
 436                  */
 437                 if (atomic_dec_and_test(&rndis->notify_count))
 438                         break;
 439                 status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
 440                 if (status) {
 441                         atomic_dec(&rndis->notify_count);
 442                         DBG(cdev, "notify/1 --> %d\n", status);
 443                 }
 444                 break;
 445         }
 446 }
 447
 448 static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req)
 449 {
 450         struct f_rndis                  *rndis = req->context;
 451         int                             status;
 452
 453         /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
 454 //      spin_lock(&dev->lock);
 455         status = rndis_msg_parser(rndis->config, (u8 *) req->buf);
 456         if (status < 0)
 457                 pr_err("RNDIS command error %d, %d/%d\n",
 458                         status, req->actual, req->length);
 459 //      spin_unlock(&dev->lock);
 460 }
 461
 462 static int
 463 rndis_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
 464 {
 465         struct f_rndis          *rndis = func_to_rndis(f);
 466         struct usb_composite_dev *cdev = f->config->cdev;
 467         struct usb_request      *req = cdev->req;
 468         int                     value = -EOPNOTSUPP;
 469         u16                     w_index = le16_to_cpu(ctrl->wIndex);
 470         u16                     w_value = le16_to_cpu(ctrl->wValue);
 471         u16                     w_length = le16_to_cpu(ctrl->wLength);
 472
 473         /* composite driver infrastructure handles everything except
 474          * CDC class messages; interface activation uses set_alt().
 475          */
 476         switch ((ctrl->bRequestType << 8) | ctrl->bRequest) {
 477
 478         /* RNDIS uses the CDC command encapsulation mechanism to implement
 479          * an RPC scheme, with much getting/setting of attributes by OID.
 480          */
 481         case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
 482                         | USB_CDC_SEND_ENCAPSULATED_COMMAND:
 483                 if (w_value || w_index != rndis->ctrl_id)
 484                         goto invalid;
 485                 /* read the request; process it later */
 486                 value = w_length;
 487                 req->complete = rndis_command_complete;
 488                 req->context = rndis;
 489                 /* later, rndis_response_available() sends a notification */
 490                 break;
 491
 492         case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
 493                         | USB_CDC_GET_ENCAPSULATED_RESPONSE:
 494                 if (w_value || w_index != rndis->ctrl_id)
 495                         goto invalid;
 496                 else {
 497                         u8 *buf;
 498                         u32 n;
 499
 500                         /* return the result */
 501                         buf = rndis_get_next_response(rndis->config, &n);
 502                         if (buf) {
 503                                 memcpy(req->buf, buf, n);
 504                                 req->complete = rndis_response_complete;
 505                                 req->context = rndis;
 506                                 rndis_free_response(rndis->config, buf);
 507                                 value = n;
 508                         }
 509                         /* else stalls ... spec says to avoid that */
 510                 }
 511                 break;
 512
 513         default:
 514 invalid:
 515                 VDBG(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n",
 516                         ctrl->bRequestType, ctrl->bRequest,
 517                         w_value, w_index, w_length);
 518         }
 519
 520         /* respond with data transfer or status phase? */
 521         if (value >= 0) {
 522                 DBG(cdev, "rndis req%02x.%02x v%04x i%04x l%d\n",
 523                         ctrl->bRequestType, ctrl->bRequest,
 524                         w_value, w_index, w_length);
 525                 req->zero = (value < w_length);
 526                 req->length = value;
 527                 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
 528                 if (value < 0)
 529                         ERROR(cdev, "rndis response on err %d\n", value);
 530         }
 531
 532         /* device either stalls (value < 0) or reports success */
 533         return value;
 534 }
 535
 536
 537 static int rndis_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
 538 {
 539         struct f_rndis          *rndis = func_to_rndis(f);
 540         struct usb_composite_dev *cdev = f->config->cdev;
 541
 542         /* we know alt == 0 */
 543
 544         if (intf == rndis->ctrl_id) {
 545                 if (rndis->notify->driver_data) {
 546                         VDBG(cdev, "reset rndis control %d\n", intf);
 547                         usb_ep_disable(rndis->notify);
 548                 }
 549                 if (!rndis->notify->desc) {
 550                         VDBG(cdev, "init rndis ctrl %d\n", intf);
 551                         if (config_ep_by_speed(cdev->gadget, f, rndis->notify))
 552                                 goto fail;
 553                 }
 554                 usb_ep_enable(rndis->notify);
 555                 rndis->notify->driver_data = rndis;
 556
 557         } else if (intf == rndis->data_id) {
 558                 struct net_device       *net;
 559
 560                 if (rndis->port.in_ep->driver_data) {
 561                         DBG(cdev, "reset rndis\n");
 562                         gether_disconnect(&rndis->port);
 563                 }
 564
 565                 if (!rndis->port.in_ep->desc || !rndis->port.out_ep->desc) {
 566                         DBG(cdev, "init rndis\n");
 567                         if (config_ep_by_speed(cdev->gadget, f,
 568                                                rndis->port.in_ep) ||
 569                             config_ep_by_speed(cdev->gadget, f,
 570                                                rndis->port.out_ep)) {
 571                                 rndis->port.in_ep->desc = NULL;
 572                                 rndis->port.out_ep->desc = NULL;
 573                                 goto fail;
 574                         }
 575                 }
 576
 577                 /* Avoid ZLPs; they can be troublesome. */
 578                 rndis->port.is_zlp_ok = false;
 579
 580                 /* RNDIS should be in the "RNDIS uninitialized" state,
 581                  * either never activated or after rndis_uninit().
 582                  *
 583                  * We don't want data to flow here until a nonzero packet
 584                  * filter is set, at which point it enters "RNDIS data
 585                  * initialized" state ... but we do want the endpoints
 586                  * to be activated.  It's a strange little state.
 587                  *
 588                  * REVISIT the RNDIS gadget code has done this wrong for a
 589                  * very long time.  We need another call to the link layer
 590                  * code -- gether_updown(...bool) maybe -- to do it right.
 591                  */
 592                 rndis->port.cdc_filter = 0;
 593
 594                 DBG(cdev, "RNDIS RX/TX early activation ... \n");
 595                 net = gether_connect(&rndis->port);
 596                 if (IS_ERR(net))
 597                         return PTR_ERR(net);
 598
 599                 rndis_set_param_dev(rndis->config, net,
 600                                 &rndis->port.cdc_filter);
 601         } else
 602                 goto fail;
 603
 604         return 0;
 605 fail:
 606         return -EINVAL;
 607 }
 608
 609 static void rndis_disable(struct usb_function *f)
 610 {
 611         struct f_rndis          *rndis = func_to_rndis(f);
 612         struct usb_composite_dev *cdev = f->config->cdev;
 613
 614         if (!rndis->notify->driver_data)
 615                 return;
 616
 617         DBG(cdev, "rndis deactivated\n");
 618
 619         rndis_uninit(rndis->config);
 620         gether_disconnect(&rndis->port);
 621
 622         usb_ep_disable(rndis->notify);
 623         rndis->notify->driver_data = NULL;
 624 }
 625
 626 /*-------------------------------------------------------------------------*/
 627
 628 /*
 629  * This isn't quite the same mechanism as CDC Ethernet, since the
 630  * notification scheme passes less data, but the same set of link
 631  * states must be tested.  A key difference is that altsettings are
 632  * not used to tell whether the link should send packets or not.
 633  */
 634
 635 static void rndis_open(struct gether *geth)
 636 {
 637         struct f_rndis          *rndis = func_to_rndis(&geth->func);
 638         struct usb_composite_dev *cdev = geth->func.config->cdev;
 639
 640         DBG(cdev, "%s\n", __func__);
 641
 642         rndis_set_param_medium(rndis->config, RNDIS_MEDIUM_802_3,
 643                                 bitrate(cdev->gadget) / 100);
 644         rndis_signal_connect(rndis->config);
 645 }
 646
 647 static void rndis_close(struct gether *geth)
 648 {
 649         struct f_rndis          *rndis = func_to_rndis(&geth->func);
 650
 651         DBG(geth->func.config->cdev, "%s\n", __func__);
 652
 653         rndis_set_param_medium(rndis->config, RNDIS_MEDIUM_802_3, 0);
 654         rndis_signal_disconnect(rndis->config);
 655 }
 656
 657 /*-------------------------------------------------------------------------*/
 658
 659 /* Some controllers can't support RNDIS ... */
 660 static inline bool can_support_rndis(struct usb_configuration *c)
 661 {
 662         /* everything else is *presumably* fine */
 663         return true;
 664 }
 665
 666 /* ethernet function driver setup/binding */
 667
 668 static int
 669 rndis_bind(struct usb_configuration *c, struct usb_function *f)
 670 {
 671         struct usb_composite_dev *cdev = c->cdev;
 672         struct f_rndis          *rndis = func_to_rndis(f);
 673         int                     status;
 674         struct usb_ep           *ep;
 675
 676 #ifndef USB_FRNDIS_INCLUDED
 677         struct f_rndis_opts *rndis_opts;
 678
 679         if (!can_support_rndis(c))
 680                 return -EINVAL;
 681
 682         rndis_opts = container_of(f->fi, struct f_rndis_opts, func_inst);
 683
 684         /*
 685          * in drivers/usb/gadget/configfs.c:configfs_composite_bind()
 686          * configurations are bound in sequence with list_for_each_entry,
 687          * in each configuration its functions are bound in sequence
 688          * with list_for_each_entry, so we assume no race condition
 689          * with regard to rndis_opts->bound access
 690          */
 691         if (!rndis_opts->bound) {
 692                 gether_set_gadget(rndis_opts->net, cdev->gadget);
 693                 status = gether_register_netdev(rndis_opts->net);
 694                 if (status)
 695                         return status;
 696                 rndis_opts->bound = true;
 697         }
 698 #endif
 699
 700         if (rndis_string_defs[0].id == 0) {
 701                 status = usb_string_ids_tab(c->cdev, rndis_string_defs);
 702                 if (status)
 703                         return status;
 704
 705                 rndis_control_intf.iInterface = rndis_string_defs[0].id;
 706                 rndis_data_intf.iInterface = rndis_string_defs[1].id;
 707                 rndis_iad_descriptor.iFunction = rndis_string_defs[2].id;
 708         }
 709
 710         /* allocate instance-specific interface IDs */
 711         status = usb_interface_id(c, f);
 712         if (status < 0)
 713                 goto fail;
 714         rndis->ctrl_id = status;
 715         rndis_iad_descriptor.bFirstInterface = status;
 716
 717         rndis_control_intf.bInterfaceNumber = status;
 718         rndis_union_desc.bMasterInterface0 = status;
 719
 720         status = usb_interface_id(c, f);
 721         if (status < 0)
 722                 goto fail;
 723         rndis->data_id = status;
 724
 725         rndis_data_intf.bInterfaceNumber = status;
 726         rndis_union_desc.bSlaveInterface0 = status;
 727
 728         status = -ENODEV;
 729
 730         /* allocate instance-specific endpoints */
 731         ep = usb_ep_autoconfig(cdev->gadget, &fs_in_desc);
 732         if (!ep)
 733                 goto fail;
 734         rndis->port.in_ep = ep;
 735         ep->driver_data = cdev; /* claim */
 736
 737         ep = usb_ep_autoconfig(cdev->gadget, &fs_out_desc);
 738         if (!ep)
 739                 goto fail;
 740         rndis->port.out_ep = ep;
 741         ep->driver_data = cdev; /* claim */
 742
 743         /* NOTE:  a status/notification endpoint is, strictly speaking,
 744          * optional.  We don't treat it that way though!  It's simpler,
 745          * and some newer profiles don't treat it as optional.
 746          */
 747         ep = usb_ep_autoconfig(cdev->gadget, &fs_notify_desc);
 748         if (!ep)
 749                 goto fail;
 750         rndis->notify = ep;
 751         ep->driver_data = cdev; /* claim */
 752
 753         status = -ENOMEM;
 754
 755         /* allocate notification request and buffer */
 756         rndis->notify_req = usb_ep_alloc_request(ep, GFP_KERNEL);
 757         if (!rndis->notify_req)
 758                 goto fail;
 759         rndis->notify_req->buf = kmalloc(STATUS_BYTECOUNT, GFP_KERNEL);
 760         if (!rndis->notify_req->buf)
 761                 goto fail;
 762         rndis->notify_req->length = STATUS_BYTECOUNT;
 763         rndis->notify_req->context = rndis;
 764         rndis->notify_req->complete = rndis_response_complete;
 765
 766         /* support all relevant hardware speeds... we expect that when
 767          * hardware is dual speed, all bulk-capable endpoints work at
 768          * both speeds
 769          */
 770         hs_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
 771         hs_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
 772         hs_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
 773
 774         ss_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
 775         ss_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
 776         ss_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
 777
 778         status = usb_assign_descriptors(f, eth_fs_function, eth_hs_function,
 779                         eth_ss_function);
 780         if (status)
 781                 goto fail;
 782
 783         rndis->port.open = rndis_open;
 784         rndis->port.close = rndis_close;
 785
 786 #ifdef USB_FRNDIS_INCLUDED
 787         status = rndis_register(rndis_response_available, rndis);
 788         if (status < 0)
 789                 goto fail;
 790         rndis->config = status;
 791 #endif
 792
 793         rndis_set_param_medium(rndis->config, RNDIS_MEDIUM_802_3, 0);
 794         rndis_set_host_mac(rndis->config, rndis->ethaddr);
 795
 796         if (rndis->manufacturer && rndis->vendorID &&
 797                         rndis_set_param_vendor(rndis->config, rndis->vendorID,
 798                                                rndis->manufacturer))
 799                 goto fail;
 800
 801         /* NOTE:  all that is done without knowing or caring about
 802          * the network link ... which is unavailable to this code
 803          * until we're activated via set_alt().
 804          */
 805
 806         DBG(cdev, "RNDIS: %s speed IN/%s OUT/%s NOTIFY/%s\n",
 807                         gadget_is_superspeed(c->cdev->gadget) ? "super" :
 808                         gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
 809                         rndis->port.in_ep->name, rndis->port.out_ep->name,
 810                         rndis->notify->name);
 811         return 0;
 812
 813 fail:
 814         usb_free_all_descriptors(f);
 815
 816         if (rndis->notify_req) {
 817                 kfree(rndis->notify_req->buf);
 818                 usb_ep_free_request(rndis->notify, rndis->notify_req);
 819         }
 820
 821         /* we might as well release our claims on endpoints */
 822         if (rndis->notify)
 823                 rndis->notify->driver_data = NULL;
 824         if (rndis->port.out_ep)
 825                 rndis->port.out_ep->driver_data = NULL;
 826         if (rndis->port.in_ep)
 827                 rndis->port.in_ep->driver_data = NULL;
 828
 829         ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
 830
 831         return status;
 832 }
 833
 834 #ifdef USB_FRNDIS_INCLUDED
 835
 836 static void
 837 rndis_old_unbind(struct usb_configuration *c, struct usb_function *f)
 838 {
 839         struct f_rndis          *rndis = func_to_rndis(f);
 840
 841         rndis_deregister(rndis->config);
 842
 843         rndis_string_defs[0].id = 0;
 844         usb_free_all_descriptors(f);
 845
 846         kfree(rndis->notify_req->buf);
 847         usb_ep_free_request(rndis->notify, rndis->notify_req);
 848
 849         kfree(rndis);
 850 }
 851
 852 int
 853 rndis_bind_config_vendor(struct usb_configuration *c, u8 ethaddr[ETH_ALEN],
 854                 u32 vendorID, const char *manufacturer, struct eth_dev *dev)
 855 {
 856         struct f_rndis  *rndis;
 857         int             status;
 858
 859         /* allocate and initialize one new instance */
 860         status = -ENOMEM;
 861         rndis = kzalloc(sizeof *rndis, GFP_KERNEL);
 862         if (!rndis)
 863                 goto fail;
 864
 865         memcpy(rndis->ethaddr, ethaddr, ETH_ALEN);
 866         rndis->vendorID = vendorID;
 867         rndis->manufacturer = manufacturer;
 868
 869         rndis->port.ioport = dev;
 870         /* RNDIS activates when the host changes this filter */
 871         rndis->port.cdc_filter = 0;
 872
 873         /* RNDIS has special (and complex) framing */
 874         rndis->port.header_len = sizeof(struct rndis_packet_msg_type);
 875         rndis->port.wrap = rndis_add_header;
 876         rndis->port.unwrap = rndis_rm_hdr;
 877
 878         rndis->port.func.name = "rndis";
 879         rndis->port.func.strings = rndis_strings;
 880         /* descriptors are per-instance copies */
 881         rndis->port.func.bind = rndis_bind;
 882         rndis->port.func.unbind = rndis_old_unbind;
 883         rndis->port.func.set_alt = rndis_set_alt;
 884         rndis->port.func.setup = rndis_setup;
 885         rndis->port.func.disable = rndis_disable;
 886
 887         status = usb_add_function(c, &rndis->port.func);
 888         if (status)
 889                 kfree(rndis);
 890 fail:
 891         return status;
 892 }
 893
 894 #else
 895
 896 void rndis_borrow_net(struct usb_function_instance *f, struct net_device *net)
 897 {
 898         struct f_rndis_opts *opts;
 899
 900         opts = container_of(f, struct f_rndis_opts, func_inst);
 901         if (opts->bound)
 902                 gether_cleanup(netdev_priv(opts->net));
 903         else
 904                 free_netdev(opts->net);
 905         opts->borrowed_net = opts->bound = true;
 906         opts->net = net;
 907 }
 908 EXPORT_SYMBOL(rndis_borrow_net);
 909
 910 static void rndis_free_inst(struct usb_function_instance *f)
 911 {
 912         struct f_rndis_opts *opts;
 913
 914         opts = container_of(f, struct f_rndis_opts, func_inst);
 915         if (!opts->borrowed_net) {
 916                 if (opts->bound)
 917                         gether_cleanup(netdev_priv(opts->net));
 918                 else
 919                         free_netdev(opts->net);
 920         }
 921         kfree(opts);
 922 }
 923
 924 static struct usb_function_instance *rndis_alloc_inst(void)
 925 {
 926         struct f_rndis_opts *opts;
 927
 928         opts = kzalloc(sizeof(*opts), GFP_KERNEL);
 929         if (!opts)
 930                 return ERR_PTR(-ENOMEM);
 931
 932         opts->func_inst.free_func_inst = rndis_free_inst;
 933         opts->net = gether_setup_default();
 934         if (IS_ERR(opts->net))
 935                 return ERR_CAST(opts->net);
 936
 937         return &opts->func_inst;
 938 }
 939
 940 static void rndis_free(struct usb_function *f)
 941 {
 942         struct f_rndis *rndis;
 943
 944         rndis = func_to_rndis(f);
 945         rndis_deregister(rndis->config);
 946         kfree(rndis);
 947 }
 948
 949 static void rndis_unbind(struct usb_configuration *c, struct usb_function *f)
 950 {
 951         struct f_rndis          *rndis = func_to_rndis(f);
 952
 953         rndis_string_defs[0].id = 0;
 954         usb_free_all_descriptors(f);
 955
 956         kfree(rndis->notify_req->buf);
 957         usb_ep_free_request(rndis->notify, rndis->notify_req);
 958 }
 959
 960 static struct usb_function *rndis_alloc(struct usb_function_instance *fi)
 961 {
 962         struct f_rndis  *rndis;
 963         struct f_rndis_opts *opts;
 964         int status;
 965
 966         /* allocate and initialize one new instance */
 967         rndis = kzalloc(sizeof(*rndis), GFP_KERNEL);
 968         if (!rndis)
 969                 return ERR_PTR(-ENOMEM);
 970
 971         opts = container_of(fi, struct f_rndis_opts, func_inst);
 972
 973         gether_get_host_addr_u8(opts->net, rndis->ethaddr);
 974         rndis->vendorID = opts->vendor_id;
 975         rndis->manufacturer = opts->manufacturer;
 976
 977         rndis->port.ioport = netdev_priv(opts->net);
 978         /* RNDIS activates when the host changes this filter */
 979         rndis->port.cdc_filter = 0;
 980
 981         /* RNDIS has special (and complex) framing */
 982         rndis->port.header_len = sizeof(struct rndis_packet_msg_type);
 983         rndis->port.wrap = rndis_add_header;
 984         rndis->port.unwrap = rndis_rm_hdr;
 985
 986         rndis->port.func.name = "rndis";
 987         rndis->port.func.strings = rndis_strings;
 988         /* descriptors are per-instance copies */
 989         rndis->port.func.bind = rndis_bind;
 990         rndis->port.func.unbind = rndis_unbind;
 991         rndis->port.func.set_alt = rndis_set_alt;
 992         rndis->port.func.setup = rndis_setup;
 993         rndis->port.func.disable = rndis_disable;
 994         rndis->port.func.free_func = rndis_free;
 995
 996         status = rndis_register(rndis_response_available, rndis);
 997         if (status < 0) {
 998                 kfree(rndis);
 999                 return ERR_PTR(status);
1000         }
1001         rndis->config = status;
1002
1003         return &rndis->port.func;
1004 }
1005
1006 DECLARE_USB_FUNCTION_INIT(rndis, rndis_alloc_inst, rndis_alloc);
1007 MODULE_LICENSE("GPL");
1008 MODULE_AUTHOR("David Brownell");
1009
1010 #endif