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