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         if (!skb)
 380                 return NULL;
 381
 382         skb2 = skb_realloc_headroom(skb, sizeof(struct rndis_packet_msg_type));
 383         rndis_add_hdr(skb2);
 384
 385         dev_kfree_skb(skb);
 386         return skb2;
 387 }
 388
 389 static void rndis_response_available(void *_rndis)
 390 {
 391         struct f_rndis                  *rndis = _rndis;
 392         struct usb_request              *req = rndis->notify_req;
 393         struct usb_composite_dev        *cdev = rndis->port.func.config->cdev;
 394         __le32                          *data = req->buf;
 395         int                             status;
 396
 397         if (atomic_inc_return(&rndis->notify_count) != 1)
 398                 return;
 399
 400         /* Send RNDIS RESPONSE_AVAILABLE notification; a
 401          * USB_CDC_NOTIFY_RESPONSE_AVAILABLE "should" work too
 402          *
 403          * This is the only notification defined by RNDIS.
 404          */
 405         data[0] = cpu_to_le32(1);
 406         data[1] = cpu_to_le32(0);
 407
 408         status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
 409         if (status) {
 410                 atomic_dec(&rndis->notify_count);
 411                 DBG(cdev, "notify/0 --> %d\n", status);
 412         }
 413 }
 414
 415 static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req)
 416 {
 417         struct f_rndis                  *rndis = req->context;
 418         struct usb_composite_dev        *cdev = rndis->port.func.config->cdev;
 419         int                             status = req->status;
 420
 421         /* after TX:
 422          *  - USB_CDC_GET_ENCAPSULATED_RESPONSE (ep0/control)
 423          *  - RNDIS_RESPONSE_AVAILABLE (status/irq)
 424          */
 425         switch (status) {
 426         case -ECONNRESET:
 427         case -ESHUTDOWN:
 428                 /* connection gone */
 429                 atomic_set(&rndis->notify_count, 0);
 430                 break;
 431         default:
 432                 DBG(cdev, "RNDIS %s response error %d, %d/%d\n",
 433                         ep->name, status,
 434                         req->actual, req->length);
 435                 /* FALLTHROUGH */
 436         case 0:
 437                 if (ep != rndis->notify)
 438                         break;
 439
 440                 /* handle multiple pending RNDIS_RESPONSE_AVAILABLE
 441                  * notifications by resending until we're done
 442                  */
 443                 if (atomic_dec_and_test(&rndis->notify_count))
 444                         break;
 445                 status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
 446                 if (status) {
 447                         atomic_dec(&rndis->notify_count);
 448                         DBG(cdev, "notify/1 --> %d\n", status);
 449                 }
 450                 break;
 451         }
 452 }
 453
 454 static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req)
 455 {
 456         struct f_rndis                  *rndis = req->context;
 457         int                             status;
 458
 459         /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
 460 //      spin_lock(&dev->lock);
 461         status = rndis_msg_parser(rndis->params, (u8 *) req->buf);
 462         if (status < 0)
 463                 pr_err("RNDIS command error %d, %d/%d\n",
 464                         status, req->actual, req->length);
 465 //      spin_unlock(&dev->lock);
 466 }
 467
 468 static int
 469 rndis_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
 470 {
 471         struct f_rndis          *rndis = func_to_rndis(f);
 472         struct usb_composite_dev *cdev = f->config->cdev;
 473         struct usb_request      *req = cdev->req;
 474         int                     value = -EOPNOTSUPP;
 475         u16                     w_index = le16_to_cpu(ctrl->wIndex);
 476         u16                     w_value = le16_to_cpu(ctrl->wValue);
 477         u16                     w_length = le16_to_cpu(ctrl->wLength);
 478
 479         /* composite driver infrastructure handles everything except
 480          * CDC class messages; interface activation uses set_alt().
 481          */
 482         switch ((ctrl->bRequestType << 8) | ctrl->bRequest) {
 483
 484         /* RNDIS uses the CDC command encapsulation mechanism to implement
 485          * an RPC scheme, with much getting/setting of attributes by OID.
 486          */
 487         case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
 488                         | USB_CDC_SEND_ENCAPSULATED_COMMAND:
 489                 if (w_value || w_index != rndis->ctrl_id)
 490                         goto invalid;
 491                 /* read the request; process it later */
 492                 value = w_length;
 493                 req->complete = rndis_command_complete;
 494                 req->context = rndis;
 495                 /* later, rndis_response_available() sends a notification */
 496                 break;
 497
 498         case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
 499                         | USB_CDC_GET_ENCAPSULATED_RESPONSE:
 500                 if (w_value || w_index != rndis->ctrl_id)
 501                         goto invalid;
 502                 else {
 503                         u8 *buf;
 504                         u32 n;
 505
 506                         /* return the result */
 507                         buf = rndis_get_next_response(rndis->params, &n);
 508                         if (buf) {
 509                                 memcpy(req->buf, buf, n);
 510                                 req->complete = rndis_response_complete;
 511                                 req->context = rndis;
 512                                 rndis_free_response(rndis->params, buf);
 513                                 value = n;
 514                         }
 515                         /* else stalls ... spec says to avoid that */
 516                 }
 517                 break;
 518
 519         default:
 520 invalid:
 521                 VDBG(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n",
 522                         ctrl->bRequestType, ctrl->bRequest,
 523                         w_value, w_index, w_length);
 524         }
 525
 526         /* respond with data transfer or status phase? */
 527         if (value >= 0) {
 528                 DBG(cdev, "rndis req%02x.%02x v%04x i%04x l%d\n",
 529                         ctrl->bRequestType, ctrl->bRequest,
 530                         w_value, w_index, w_length);
 531                 req->zero = (value < w_length);
 532                 req->length = value;
 533                 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
 534                 if (value < 0)
 535                         ERROR(cdev, "rndis response on err %d\n", value);
 536         }
 537
 538         /* device either stalls (value < 0) or reports success */
 539         return value;
 540 }
 541
 542
 543 static int rndis_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
 544 {
 545         struct f_rndis          *rndis = func_to_rndis(f);
 546         struct usb_composite_dev *cdev = f->config->cdev;
 547
 548         /* we know alt == 0 */
 549
 550         if (intf == rndis->ctrl_id) {
 551                 VDBG(cdev, "reset rndis control %d\n", intf);
 552                 usb_ep_disable(rndis->notify);
 553
 554                 if (!rndis->notify->desc) {
 555                         VDBG(cdev, "init rndis ctrl %d\n", intf);
 556                         if (config_ep_by_speed(cdev->gadget, f, rndis->notify))
 557                                 goto fail;
 558                 }
 559                 usb_ep_enable(rndis->notify);
 560
 561         } else if (intf == rndis->data_id) {
 562                 struct net_device       *net;
 563
 564                 if (rndis->port.in_ep->enabled) {
 565                         DBG(cdev, "reset rndis\n");
 566                         gether_disconnect(&rndis->port);
 567                 }
 568
 569                 if (!rndis->port.in_ep->desc || !rndis->port.out_ep->desc) {
 570                         DBG(cdev, "init rndis\n");
 571                         if (config_ep_by_speed(cdev->gadget, f,
 572                                                rndis->port.in_ep) ||
 573                             config_ep_by_speed(cdev->gadget, f,
 574                                                rndis->port.out_ep)) {
 575                                 rndis->port.in_ep->desc = NULL;
 576                                 rndis->port.out_ep->desc = NULL;
 577                                 goto fail;
 578                         }
 579                 }
 580
 581                 /* Avoid ZLPs; they can be troublesome. */
 582                 rndis->port.is_zlp_ok = false;
 583
 584                 /* RNDIS should be in the "RNDIS uninitialized" state,
 585                  * either never activated or after rndis_uninit().
 586                  *
 587                  * We don't want data to flow here until a nonzero packet
 588                  * filter is set, at which point it enters "RNDIS data
 589                  * initialized" state ... but we do want the endpoints
 590                  * to be activated.  It's a strange little state.
 591                  *
 592                  * REVISIT the RNDIS gadget code has done this wrong for a
 593                  * very long time.  We need another call to the link layer
 594                  * code -- gether_updown(...bool) maybe -- to do it right.
 595                  */
 596                 rndis->port.cdc_filter = 0;
 597
 598                 DBG(cdev, "RNDIS RX/TX early activation ... \n");
 599                 net = gether_connect(&rndis->port);
 600                 if (IS_ERR(net))
 601                         return PTR_ERR(net);
 602
 603                 rndis_set_param_dev(rndis->params, net,
 604                                 &rndis->port.cdc_filter);
 605         } else
 606                 goto fail;
 607
 608         return 0;
 609 fail:
 610         return -EINVAL;
 611 }
 612
 613 static void rndis_disable(struct usb_function *f)
 614 {
 615         struct f_rndis          *rndis = func_to_rndis(f);
 616         struct usb_composite_dev *cdev = f->config->cdev;
 617
 618         if (!rndis->notify->enabled)
 619                 return;
 620
 621         DBG(cdev, "rndis deactivated\n");
 622
 623         rndis_uninit(rndis->params);
 624         gether_disconnect(&rndis->port);
 625
 626         usb_ep_disable(rndis->notify);
 627         rndis->notify->desc = NULL;
 628 }
 629
 630 /*-------------------------------------------------------------------------*/
 631
 632 /*
 633  * This isn't quite the same mechanism as CDC Ethernet, since the
 634  * notification scheme passes less data, but the same set of link
 635  * states must be tested.  A key difference is that altsettings are
 636  * not used to tell whether the link should send packets or not.
 637  */
 638
 639 static void rndis_open(struct gether *geth)
 640 {
 641         struct f_rndis          *rndis = func_to_rndis(&geth->func);
 642         struct usb_composite_dev *cdev = geth->func.config->cdev;
 643
 644         DBG(cdev, "%s\n", __func__);
 645
 646         rndis_set_param_medium(rndis->params, RNDIS_MEDIUM_802_3,
 647                                 bitrate(cdev->gadget) / 100);
 648         rndis_signal_connect(rndis->params);
 649 }
 650
 651 static void rndis_close(struct gether *geth)
 652 {
 653         struct f_rndis          *rndis = func_to_rndis(&geth->func);
 654
 655         DBG(geth->func.config->cdev, "%s\n", __func__);
 656
 657         rndis_set_param_medium(rndis->params, RNDIS_MEDIUM_802_3, 0);
 658         rndis_signal_disconnect(rndis->params);
 659 }
 660
 661 /*-------------------------------------------------------------------------*/
 662
 663 /* Some controllers can't support RNDIS ... */
 664 static inline bool can_support_rndis(struct usb_configuration *c)
 665 {
 666         /* everything else is *presumably* fine */
 667         return true;
 668 }
 669
 670 /* ethernet function driver setup/binding */
 671
 672 static int
 673 rndis_bind(struct usb_configuration *c, struct usb_function *f)
 674 {
 675         struct usb_composite_dev *cdev = c->cdev;
 676         struct f_rndis          *rndis = func_to_rndis(f);
 677         struct usb_string       *us;
 678         int                     status;
 679         struct usb_ep           *ep;
 680
 681         struct f_rndis_opts *rndis_opts;
 682
 683         if (!can_support_rndis(c))
 684                 return -EINVAL;
 685
 686         rndis_opts = container_of(f->fi, struct f_rndis_opts, func_inst);
 687
 688         if (cdev->use_os_string) {
 689                 f->os_desc_table = kzalloc(sizeof(*f->os_desc_table),
 690                                            GFP_KERNEL);
 691                 if (!f->os_desc_table)
 692                         return -ENOMEM;
 693                 f->os_desc_n = 1;
 694                 f->os_desc_table[0].os_desc = &rndis_opts->rndis_os_desc;
 695         }
 696
 697         rndis_iad_descriptor.bFunctionClass = rndis_opts->class;
 698         rndis_iad_descriptor.bFunctionSubClass = rndis_opts->subclass;
 699         rndis_iad_descriptor.bFunctionProtocol = rndis_opts->protocol;
 700
 701         /*
 702          * in drivers/usb/gadget/configfs.c:configfs_composite_bind()
 703          * configurations are bound in sequence with list_for_each_entry,
 704          * in each configuration its functions are bound in sequence
 705          * with list_for_each_entry, so we assume no race condition
 706          * with regard to rndis_opts->bound access
 707          */
 708         if (!rndis_opts->bound) {
 709                 gether_set_gadget(rndis_opts->net, cdev->gadget);
 710                 status = gether_register_netdev(rndis_opts->net);
 711                 if (status)
 712                         goto fail;
 713                 rndis_opts->bound = true;
 714         }
 715
 716         us = usb_gstrings_attach(cdev, rndis_strings,
 717                                  ARRAY_SIZE(rndis_string_defs));
 718         if (IS_ERR(us)) {
 719                 status = PTR_ERR(us);
 720                 goto fail;
 721         }
 722         rndis_control_intf.iInterface = us[0].id;
 723         rndis_data_intf.iInterface = us[1].id;
 724         rndis_iad_descriptor.iFunction = us[2].id;
 725
 726         /* allocate instance-specific interface IDs */
 727         status = usb_interface_id(c, f);
 728         if (status < 0)
 729                 goto fail;
 730         rndis->ctrl_id = status;
 731         rndis_iad_descriptor.bFirstInterface = status;
 732
 733         rndis_control_intf.bInterfaceNumber = status;
 734         rndis_union_desc.bMasterInterface0 = status;
 735
 736         if (cdev->use_os_string)
 737                 f->os_desc_table[0].if_id =
 738                         rndis_iad_descriptor.bFirstInterface;
 739
 740         status = usb_interface_id(c, f);
 741         if (status < 0)
 742                 goto fail;
 743         rndis->data_id = status;
 744
 745         rndis_data_intf.bInterfaceNumber = status;
 746         rndis_union_desc.bSlaveInterface0 = status;
 747
 748         status = -ENODEV;
 749
 750         /* allocate instance-specific endpoints */
 751         ep = usb_ep_autoconfig(cdev->gadget, &fs_in_desc);
 752         if (!ep)
 753                 goto fail;
 754         rndis->port.in_ep = ep;
 755
 756         ep = usb_ep_autoconfig(cdev->gadget, &fs_out_desc);
 757         if (!ep)
 758                 goto fail;
 759         rndis->port.out_ep = ep;
 760
 761         /* NOTE:  a status/notification endpoint is, strictly speaking,
 762          * optional.  We don't treat it that way though!  It's simpler,
 763          * and some newer profiles don't treat it as optional.
 764          */
 765         ep = usb_ep_autoconfig(cdev->gadget, &fs_notify_desc);
 766         if (!ep)
 767                 goto fail;
 768         rndis->notify = ep;
 769
 770         status = -ENOMEM;
 771
 772         /* allocate notification request and buffer */
 773         rndis->notify_req = usb_ep_alloc_request(ep, GFP_KERNEL);
 774         if (!rndis->notify_req)
 775                 goto fail;
 776         rndis->notify_req->buf = kmalloc(STATUS_BYTECOUNT, GFP_KERNEL);
 777         if (!rndis->notify_req->buf)
 778                 goto fail;
 779         rndis->notify_req->length = STATUS_BYTECOUNT;
 780         rndis->notify_req->context = rndis;
 781         rndis->notify_req->complete = rndis_response_complete;
 782
 783         /* support all relevant hardware speeds... we expect that when
 784          * hardware is dual speed, all bulk-capable endpoints work at
 785          * both speeds
 786          */
 787         hs_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
 788         hs_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
 789         hs_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
 790
 791         ss_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
 792         ss_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
 793         ss_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
 794
 795         status = usb_assign_descriptors(f, eth_fs_function, eth_hs_function,
 796                         eth_ss_function, eth_ss_function);
 797         if (status)
 798                 goto fail;
 799
 800         rndis->port.open = rndis_open;
 801         rndis->port.close = rndis_close;
 802
 803         rndis_set_param_medium(rndis->params, RNDIS_MEDIUM_802_3, 0);
 804         rndis_set_host_mac(rndis->params, rndis->ethaddr);
 805
 806         if (rndis->manufacturer && rndis->vendorID &&
 807                         rndis_set_param_vendor(rndis->params, rndis->vendorID,
 808                                                rndis->manufacturer)) {
 809                 status = -EINVAL;
 810                 goto fail_free_descs;
 811         }
 812
 813         /* NOTE:  all that is done without knowing or caring about
 814          * the network link ... which is unavailable to this code
 815          * until we're activated via set_alt().
 816          */
 817
 818         DBG(cdev, "RNDIS: %s speed IN/%s OUT/%s NOTIFY/%s\n",
 819                         gadget_is_superspeed(c->cdev->gadget) ? "super" :
 820                         gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
 821                         rndis->port.in_ep->name, rndis->port.out_ep->name,
 822                         rndis->notify->name);
 823         return 0;
 824
 825 fail_free_descs:
 826         usb_free_all_descriptors(f);
 827 fail:
 828         kfree(f->os_desc_table);
 829         f->os_desc_n = 0;
 830
 831         if (rndis->notify_req) {
 832                 kfree(rndis->notify_req->buf);
 833                 usb_ep_free_request(rndis->notify, rndis->notify_req);
 834         }
 835
 836         ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
 837
 838         return status;
 839 }
 840
 841 void rndis_borrow_net(struct usb_function_instance *f, struct net_device *net)
 842 {
 843         struct f_rndis_opts *opts;
 844
 845         opts = container_of(f, struct f_rndis_opts, func_inst);
 846         if (opts->bound)
 847                 gether_cleanup(netdev_priv(opts->net));
 848         else
 849                 free_netdev(opts->net);
 850         opts->borrowed_net = opts->bound = true;
 851         opts->net = net;
 852 }
 853 EXPORT_SYMBOL_GPL(rndis_borrow_net);
 854
 855 static inline struct f_rndis_opts *to_f_rndis_opts(struct config_item *item)
 856 {
 857         return container_of(to_config_group(item), struct f_rndis_opts,
 858                             func_inst.group);
 859 }
 860
 861 /* f_rndis_item_ops */
 862 USB_ETHERNET_CONFIGFS_ITEM(rndis);
 863
 864 /* f_rndis_opts_dev_addr */
 865 USB_ETHERNET_CONFIGFS_ITEM_ATTR_DEV_ADDR(rndis);
 866
 867 /* f_rndis_opts_host_addr */
 868 USB_ETHERNET_CONFIGFS_ITEM_ATTR_HOST_ADDR(rndis);
 869
 870 /* f_rndis_opts_qmult */
 871 USB_ETHERNET_CONFIGFS_ITEM_ATTR_QMULT(rndis);
 872
 873 /* f_rndis_opts_ifname */
 874 USB_ETHERNET_CONFIGFS_ITEM_ATTR_IFNAME(rndis);
 875
 876 /* f_rndis_opts_class */
 877 USB_ETHER_CONFIGFS_ITEM_ATTR_U8_RW(rndis, class);
 878
 879 /* f_rndis_opts_subclass */
 880 USB_ETHER_CONFIGFS_ITEM_ATTR_U8_RW(rndis, subclass);
 881
 882 /* f_rndis_opts_protocol */
 883 USB_ETHER_CONFIGFS_ITEM_ATTR_U8_RW(rndis, protocol);
 884
 885 static struct configfs_attribute *rndis_attrs[] = {
 886         &rndis_opts_attr_dev_addr,
 887         &rndis_opts_attr_host_addr,
 888         &rndis_opts_attr_qmult,
 889         &rndis_opts_attr_ifname,
 890         &rndis_opts_attr_class,
 891         &rndis_opts_attr_subclass,
 892         &rndis_opts_attr_protocol,
 893         NULL,
 894 };
 895
 896 static struct config_item_type rndis_func_type = {
 897         .ct_item_ops    = &rndis_item_ops,
 898         .ct_attrs       = rndis_attrs,
 899         .ct_owner       = THIS_MODULE,
 900 };
 901
 902 static void rndis_free_inst(struct usb_function_instance *f)
 903 {
 904         struct f_rndis_opts *opts;
 905
 906         opts = container_of(f, struct f_rndis_opts, func_inst);
 907         if (!opts->borrowed_net) {
 908                 if (opts->bound)
 909                         gether_cleanup(netdev_priv(opts->net));
 910                 else
 911                         free_netdev(opts->net);
 912         }
 913
 914         kfree(opts->rndis_interf_group);        /* single VLA chunk */
 915         kfree(opts);
 916 }
 917
 918 static struct usb_function_instance *rndis_alloc_inst(void)
 919 {
 920         struct f_rndis_opts *opts;
 921         struct usb_os_desc *descs[1];
 922         char *names[1];
 923         struct config_group *rndis_interf_group;
 924
 925         opts = kzalloc(sizeof(*opts), GFP_KERNEL);
 926         if (!opts)
 927                 return ERR_PTR(-ENOMEM);
 928         opts->rndis_os_desc.ext_compat_id = opts->rndis_ext_compat_id;
 929
 930         mutex_init(&opts->lock);
 931         opts->func_inst.free_func_inst = rndis_free_inst;
 932         opts->net = gether_setup_default();
 933         if (IS_ERR(opts->net)) {
 934                 struct net_device *net = opts->net;
 935                 kfree(opts);
 936                 return ERR_CAST(net);
 937         }
 938         INIT_LIST_HEAD(&opts->rndis_os_desc.ext_prop);
 939
 940         opts->class = rndis_iad_descriptor.bFunctionClass;
 941         opts->subclass = rndis_iad_descriptor.bFunctionSubClass;
 942         opts->protocol = rndis_iad_descriptor.bFunctionProtocol;
 943
 944         descs[0] = &opts->rndis_os_desc;
 945         names[0] = "rndis";
 946         config_group_init_type_name(&opts->func_inst.group, "",
 947                                     &rndis_func_type);
 948         rndis_interf_group =
 949                 usb_os_desc_prepare_interf_dir(&opts->func_inst.group, 1, descs,
 950                                                names, THIS_MODULE);
 951         if (IS_ERR(rndis_interf_group)) {
 952                 rndis_free_inst(&opts->func_inst);
 953                 return ERR_CAST(rndis_interf_group);
 954         }
 955         opts->rndis_interf_group = rndis_interf_group;
 956
 957         return &opts->func_inst;
 958 }
 959
 960 static void rndis_free(struct usb_function *f)
 961 {
 962         struct f_rndis *rndis;
 963         struct f_rndis_opts *opts;
 964
 965         rndis = func_to_rndis(f);
 966         rndis_deregister(rndis->params);
 967         opts = container_of(f->fi, struct f_rndis_opts, func_inst);
 968         kfree(rndis);
 969         mutex_lock(&opts->lock);
 970         opts->refcnt--;
 971         mutex_unlock(&opts->lock);
 972 }
 973
 974 static void rndis_unbind(struct usb_configuration *c, struct usb_function *f)
 975 {
 976         struct f_rndis          *rndis = func_to_rndis(f);
 977
 978         kfree(f->os_desc_table);
 979         f->os_desc_n = 0;
 980         usb_free_all_descriptors(f);
 981
 982         kfree(rndis->notify_req->buf);
 983         usb_ep_free_request(rndis->notify, rndis->notify_req);
 984 }
 985
 986 static struct usb_function *rndis_alloc(struct usb_function_instance *fi)
 987 {
 988         struct f_rndis  *rndis;
 989         struct f_rndis_opts *opts;
 990         struct rndis_params *params;
 991
 992         /* allocate and initialize one new instance */
 993         rndis = kzalloc(sizeof(*rndis), GFP_KERNEL);
 994         if (!rndis)
 995                 return ERR_PTR(-ENOMEM);
 996
 997         opts = container_of(fi, struct f_rndis_opts, func_inst);
 998         mutex_lock(&opts->lock);
 999         opts->refcnt++;
1000
1001         gether_get_host_addr_u8(opts->net, rndis->ethaddr);
1002         rndis->vendorID = opts->vendor_id;
1003         rndis->manufacturer = opts->manufacturer;
1004
1005         rndis->port.ioport = netdev_priv(opts->net);
1006         mutex_unlock(&opts->lock);
1007         /* RNDIS activates when the host changes this filter */
1008         rndis->port.cdc_filter = 0;
1009
1010         /* RNDIS has special (and complex) framing */
1011         rndis->port.header_len = sizeof(struct rndis_packet_msg_type);
1012         rndis->port.wrap = rndis_add_header;
1013         rndis->port.unwrap = rndis_rm_hdr;
1014
1015         rndis->port.func.name = "rndis";
1016         /* descriptors are per-instance copies */
1017         rndis->port.func.bind = rndis_bind;
1018         rndis->port.func.unbind = rndis_unbind;
1019         rndis->port.func.set_alt = rndis_set_alt;
1020         rndis->port.func.setup = rndis_setup;
1021         rndis->port.func.disable = rndis_disable;
1022         rndis->port.func.free_func = rndis_free;
1023
1024         params = rndis_register(rndis_response_available, rndis);
1025         if (IS_ERR(params)) {
1026                 kfree(rndis);
1027                 return ERR_CAST(params);
1028         }
1029         rndis->params = params;
1030
1031         return &rndis->port.func;
1032 }
1033
1034 DECLARE_USB_FUNCTION_INIT(rndis, rndis_alloc_inst, rndis_alloc);
1035 MODULE_LICENSE("GPL");
1036 MODULE_AUTHOR("David Brownell");