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  * Copyright (c) 2014, NVIDIA CORPORATION.  All rights reserved.
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  */
  16
  17 /* #define VERBOSE_DEBUG */
  18
  19 #include <linux/slab.h>
  20 #include <linux/kernel.h>
  21 #include <linux/device.h>
  22 #include <linux/etherdevice.h>
  23 #include <linux/moduleparam.h>
  24
  25 #include <linux/atomic.h>
  26
  27 #include "u_ether.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 static bool rndis_multipacket_dl_disable;
  72 module_param(rndis_multipacket_dl_disable, bool, S_IRUGO|S_IWUSR);
  73 MODULE_PARM_DESC(rndis_multipacket_dl_disable,
  74         "Disable RNDIS Multi-packet support in DownLink");
  75
  76 static unsigned int rndis_ul_max_pkt_per_xfer = 3;
  77 module_param(rndis_ul_max_pkt_per_xfer, uint, S_IRUGO | S_IWUSR);
  78 MODULE_PARM_DESC(rndis_ul_max_pkt_per_xfer,
  79        "Maximum packets per transfer for UL aggregation");
  80
  81 struct f_rndis {
  82         struct gether                   port;
  83         u8                              ctrl_id, data_id;
  84         u8                              ethaddr[ETH_ALEN];
  85         u32                             vendorID;
  86         const char                      *manufacturer;
  87         int                             config;
  88
  89         struct usb_ep                   *notify;
  90         struct usb_request              *notify_req;
  91         atomic_t                        notify_count;
  92 };
  93
  94 static inline struct f_rndis *func_to_rndis(struct usb_function *f)
  95 {
  96         return container_of(f, struct f_rndis, port.func);
  97 }
  98
  99 /* peak (theoretical) bulk transfer rate in bits-per-second */
 100 static unsigned int bitrate(struct usb_gadget *g)
 101 {
 102         if (gadget_is_superspeed(g) && g->speed == USB_SPEED_SUPER)
 103                 return 13 * 1024 * 8 * 1000 * 8;
 104         else if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
 105                 return 13 * 512 * 8 * 1000 * 8;
 106         else
 107                 return 19 * 64 * 1 * 1000 * 8;
 108 }
 109
 110 /*-------------------------------------------------------------------------*/
 111
 112 /*
 113  */
 114
 115 #define RNDIS_STATUS_INTERVAL_MS        32
 116 #define STATUS_BYTECOUNT                8       /* 8 bytes data */
 117
 118
 119 /* interface descriptor: */
 120
 121 static struct usb_interface_descriptor rndis_control_intf = {
 122         .bLength =              sizeof rndis_control_intf,
 123         .bDescriptorType =      USB_DT_INTERFACE,
 124
 125         /* .bInterfaceNumber = DYNAMIC */
 126         /* status endpoint is optional; this could be patched later */
 127         .bNumEndpoints =        1,
 128         .bInterfaceClass =      USB_CLASS_COMM,
 129         .bInterfaceSubClass =   USB_CDC_SUBCLASS_ACM,
 130         .bInterfaceProtocol =   USB_CDC_ACM_PROTO_VENDOR,
 131         /* .iInterface = DYNAMIC */
 132 };
 133
 134 static struct usb_cdc_header_desc header_desc = {
 135         .bLength =              sizeof header_desc,
 136         .bDescriptorType =      USB_DT_CS_INTERFACE,
 137         .bDescriptorSubType =   USB_CDC_HEADER_TYPE,
 138
 139         .bcdCDC =               cpu_to_le16(0x0110),
 140 };
 141
 142 static struct usb_cdc_call_mgmt_descriptor call_mgmt_descriptor = {
 143         .bLength =              sizeof call_mgmt_descriptor,
 144         .bDescriptorType =      USB_DT_CS_INTERFACE,
 145         .bDescriptorSubType =   USB_CDC_CALL_MANAGEMENT_TYPE,
 146
 147         .bmCapabilities =       0x00,
 148         .bDataInterface =       0x01,
 149 };
 150
 151 static struct usb_cdc_acm_descriptor rndis_acm_descriptor = {
 152         .bLength =              sizeof rndis_acm_descriptor,
 153         .bDescriptorType =      USB_DT_CS_INTERFACE,
 154         .bDescriptorSubType =   USB_CDC_ACM_TYPE,
 155
 156         .bmCapabilities =       0x00,
 157 };
 158
 159 static struct usb_cdc_union_desc rndis_union_desc = {
 160         .bLength =              sizeof(rndis_union_desc),
 161         .bDescriptorType =      USB_DT_CS_INTERFACE,
 162         .bDescriptorSubType =   USB_CDC_UNION_TYPE,
 163         /* .bMasterInterface0 = DYNAMIC */
 164         /* .bSlaveInterface0 =  DYNAMIC */
 165 };
 166
 167 /* the data interface has two bulk endpoints */
 168
 169 static struct usb_interface_descriptor rndis_data_intf = {
 170         .bLength =              sizeof rndis_data_intf,
 171         .bDescriptorType =      USB_DT_INTERFACE,
 172
 173         /* .bInterfaceNumber = DYNAMIC */
 174         .bNumEndpoints =        2,
 175         .bInterfaceClass =      USB_CLASS_CDC_DATA,
 176         .bInterfaceSubClass =   0,
 177         .bInterfaceProtocol =   0,
 178         /* .iInterface = DYNAMIC */
 179 };
 180
 181
 182 static struct usb_interface_assoc_descriptor
 183 rndis_iad_descriptor = {
 184         .bLength =              sizeof rndis_iad_descriptor,
 185         .bDescriptorType =      USB_DT_INTERFACE_ASSOCIATION,
 186
 187         .bFirstInterface =      0, /* XXX, hardcoded */
 188         .bInterfaceCount =      2,      // control + data
 189         .bFunctionClass =       USB_CLASS_COMM,
 190         .bFunctionSubClass =    USB_CDC_SUBCLASS_ETHERNET,
 191         .bFunctionProtocol =    USB_CDC_PROTO_NONE,
 192         /* .iFunction = DYNAMIC */
 193 };
 194
 195 /* full speed support: */
 196
 197 static struct usb_endpoint_descriptor fs_notify_desc = {
 198         .bLength =              USB_DT_ENDPOINT_SIZE,
 199         .bDescriptorType =      USB_DT_ENDPOINT,
 200
 201         .bEndpointAddress =     USB_DIR_IN,
 202         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 203         .wMaxPacketSize =       cpu_to_le16(STATUS_BYTECOUNT),
 204         .bInterval =            RNDIS_STATUS_INTERVAL_MS,
 205 };
 206
 207 static struct usb_endpoint_descriptor fs_in_desc = {
 208         .bLength =              USB_DT_ENDPOINT_SIZE,
 209         .bDescriptorType =      USB_DT_ENDPOINT,
 210
 211         .bEndpointAddress =     USB_DIR_IN,
 212         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 213 };
 214
 215 static struct usb_endpoint_descriptor fs_out_desc = {
 216         .bLength =              USB_DT_ENDPOINT_SIZE,
 217         .bDescriptorType =      USB_DT_ENDPOINT,
 218
 219         .bEndpointAddress =     USB_DIR_OUT,
 220         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 221 };
 222
 223 static struct usb_descriptor_header *eth_fs_function[] = {
 224         (struct usb_descriptor_header *) &rndis_iad_descriptor,
 225
 226         /* control interface matches ACM, not Ethernet */
 227         (struct usb_descriptor_header *) &rndis_control_intf,
 228         (struct usb_descriptor_header *) &header_desc,
 229         (struct usb_descriptor_header *) &call_mgmt_descriptor,
 230         (struct usb_descriptor_header *) &rndis_acm_descriptor,
 231         (struct usb_descriptor_header *) &rndis_union_desc,
 232         (struct usb_descriptor_header *) &fs_notify_desc,
 233
 234         /* data interface has no altsetting */
 235         (struct usb_descriptor_header *) &rndis_data_intf,
 236         (struct usb_descriptor_header *) &fs_in_desc,
 237         (struct usb_descriptor_header *) &fs_out_desc,
 238         NULL,
 239 };
 240
 241 /* high speed support: */
 242
 243 static struct usb_endpoint_descriptor hs_notify_desc = {
 244         .bLength =              USB_DT_ENDPOINT_SIZE,
 245         .bDescriptorType =      USB_DT_ENDPOINT,
 246
 247         .bEndpointAddress =     USB_DIR_IN,
 248         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 249         .wMaxPacketSize =       cpu_to_le16(STATUS_BYTECOUNT),
 250         .bInterval =            USB_MS_TO_HS_INTERVAL(RNDIS_STATUS_INTERVAL_MS)
 251 };
 252
 253 static struct usb_endpoint_descriptor hs_in_desc = {
 254         .bLength =              USB_DT_ENDPOINT_SIZE,
 255         .bDescriptorType =      USB_DT_ENDPOINT,
 256
 257         .bEndpointAddress =     USB_DIR_IN,
 258         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 259         .wMaxPacketSize =       cpu_to_le16(512),
 260 };
 261
 262 static struct usb_endpoint_descriptor hs_out_desc = {
 263         .bLength =              USB_DT_ENDPOINT_SIZE,
 264         .bDescriptorType =      USB_DT_ENDPOINT,
 265
 266         .bEndpointAddress =     USB_DIR_OUT,
 267         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 268         .wMaxPacketSize =       cpu_to_le16(512),
 269 };
 270
 271 static struct usb_descriptor_header *eth_hs_function[] = {
 272         (struct usb_descriptor_header *) &rndis_iad_descriptor,
 273
 274         /* control interface matches ACM, not Ethernet */
 275         (struct usb_descriptor_header *) &rndis_control_intf,
 276         (struct usb_descriptor_header *) &header_desc,
 277         (struct usb_descriptor_header *) &call_mgmt_descriptor,
 278         (struct usb_descriptor_header *) &rndis_acm_descriptor,
 279         (struct usb_descriptor_header *) &rndis_union_desc,
 280         (struct usb_descriptor_header *) &hs_notify_desc,
 281
 282         /* data interface has no altsetting */
 283         (struct usb_descriptor_header *) &rndis_data_intf,
 284         (struct usb_descriptor_header *) &hs_in_desc,
 285         (struct usb_descriptor_header *) &hs_out_desc,
 286         NULL,
 287 };
 288
 289 /* super speed support: */
 290
 291 static struct usb_endpoint_descriptor ss_notify_desc = {
 292         .bLength =              USB_DT_ENDPOINT_SIZE,
 293         .bDescriptorType =      USB_DT_ENDPOINT,
 294
 295         .bEndpointAddress =     USB_DIR_IN,
 296         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 297         .wMaxPacketSize =       cpu_to_le16(STATUS_BYTECOUNT),
 298         .bInterval =            USB_MS_TO_HS_INTERVAL(RNDIS_STATUS_INTERVAL_MS)
 299 };
 300
 301 static struct usb_ss_ep_comp_descriptor ss_intr_comp_desc = {
 302         .bLength =              sizeof ss_intr_comp_desc,
 303         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
 304
 305         /* the following 3 values can be tweaked if necessary */
 306         /* .bMaxBurst =         0, */
 307         /* .bmAttributes =      0, */
 308         .wBytesPerInterval =    cpu_to_le16(STATUS_BYTECOUNT),
 309 };
 310
 311 static struct usb_endpoint_descriptor ss_in_desc = {
 312         .bLength =              USB_DT_ENDPOINT_SIZE,
 313         .bDescriptorType =      USB_DT_ENDPOINT,
 314
 315         .bEndpointAddress =     USB_DIR_IN,
 316         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 317         .wMaxPacketSize =       cpu_to_le16(1024),
 318 };
 319
 320 static struct usb_endpoint_descriptor ss_out_desc = {
 321         .bLength =              USB_DT_ENDPOINT_SIZE,
 322         .bDescriptorType =      USB_DT_ENDPOINT,
 323
 324         .bEndpointAddress =     USB_DIR_OUT,
 325         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 326         .wMaxPacketSize =       cpu_to_le16(1024),
 327 };
 328
 329 static struct usb_ss_ep_comp_descriptor ss_bulk_comp_desc = {
 330         .bLength =              sizeof ss_bulk_comp_desc,
 331         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
 332
 333         /* the following 2 values can be tweaked if necessary */
 334         /* .bMaxBurst =         0, */
 335         /* .bmAttributes =      0, */
 336 };
 337
 338 static struct usb_descriptor_header *eth_ss_function[] = {
 339         (struct usb_descriptor_header *) &rndis_iad_descriptor,
 340
 341         /* control interface matches ACM, not Ethernet */
 342         (struct usb_descriptor_header *) &rndis_control_intf,
 343         (struct usb_descriptor_header *) &header_desc,
 344         (struct usb_descriptor_header *) &call_mgmt_descriptor,
 345         (struct usb_descriptor_header *) &rndis_acm_descriptor,
 346         (struct usb_descriptor_header *) &rndis_union_desc,
 347         (struct usb_descriptor_header *) &ss_notify_desc,
 348         (struct usb_descriptor_header *) &ss_intr_comp_desc,
 349
 350         /* data interface has no altsetting */
 351         (struct usb_descriptor_header *) &rndis_data_intf,
 352         (struct usb_descriptor_header *) &ss_in_desc,
 353         (struct usb_descriptor_header *) &ss_bulk_comp_desc,
 354         (struct usb_descriptor_header *) &ss_out_desc,
 355         (struct usb_descriptor_header *) &ss_bulk_comp_desc,
 356         NULL,
 357 };
 358
 359 /* string descriptors: */
 360
 361 static struct usb_string rndis_string_defs[] = {
 362         [0].s = "RNDIS Communications Control",
 363         [1].s = "RNDIS Ethernet Data",
 364         [2].s = "RNDIS",
 365         {  } /* end of list */
 366 };
 367
 368 static struct usb_gadget_strings rndis_string_table = {
 369         .language =             0x0409, /* en-us */
 370         .strings =              rndis_string_defs,
 371 };
 372
 373 static struct usb_gadget_strings *rndis_strings[] = {
 374         &rndis_string_table,
 375         NULL,
 376 };
 377
 378 /*-------------------------------------------------------------------------*/
 379
 380 static struct sk_buff *rndis_add_header(struct gether *port,
 381                                         struct sk_buff *skb)
 382 {
 383         struct sk_buff *skb2;
 384
 385         skb2 = skb_realloc_headroom(skb, sizeof(struct rndis_packet_msg_type));
 386         if (skb2)
 387                 rndis_add_hdr(skb2);
 388
 389         dev_kfree_skb_any(skb);
 390         return skb2;
 391 }
 392
 393 static void rndis_response_available(void *_rndis)
 394 {
 395         struct f_rndis                  *rndis = _rndis;
 396         struct usb_request              *req = rndis->notify_req;
 397         __le32                          *data = req->buf;
 398         int                             status;
 399
 400         if (atomic_inc_return(&rndis->notify_count) != 1)
 401                 return;
 402
 403         /* Send RNDIS RESPONSE_AVAILABLE notification; a
 404          * USB_CDC_NOTIFY_RESPONSE_AVAILABLE "should" work too
 405          *
 406          * This is the only notification defined by RNDIS.
 407          */
 408         data[0] = cpu_to_le32(1);
 409         data[1] = cpu_to_le32(0);
 410
 411         status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
 412         if (status) {
 413                 atomic_dec(&rndis->notify_count);
 414                 pr_err("notify/0 --> %d\n", status);
 415         }
 416 }
 417
 418 static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req)
 419 {
 420         struct f_rndis                  *rndis = req->context;
 421         int                             status = req->status;
 422
 423         /* after TX:
 424          *  - USB_CDC_GET_ENCAPSULATED_RESPONSE (ep0/control)
 425          *  - RNDIS_RESPONSE_AVAILABLE (status/irq)
 426          */
 427         switch (status) {
 428         case -ECONNRESET:
 429         case -ESHUTDOWN:
 430                 /* connection gone */
 431                 atomic_set(&rndis->notify_count, 0);
 432                 break;
 433         default:
 434                 pr_err("RNDIS %s response error %d, %d/%d\n",
 435                         ep->name, status,
 436                         req->actual, req->length);
 437                 /* FALLTHROUGH */
 438         case 0:
 439                 if (ep != rndis->notify)
 440                         break;
 441
 442                 /* handle multiple pending RNDIS_RESPONSE_AVAILABLE
 443                  * notifications by resending until we're done
 444                  */
 445                 if (atomic_dec_and_test(&rndis->notify_count))
 446                         break;
 447                 status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
 448                 if (status) {
 449                         atomic_dec(&rndis->notify_count);
 450                         pr_err("notify/1 --> %d\n", status);
 451                 }
 452                 break;
 453         }
 454 }
 455
 456 static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req)
 457 {
 458         struct f_rndis                  *rndis = req->context;
 459         int                             status;
 460         rndis_init_msg_type             *buf;
 461
 462         /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
 463 //      spin_lock(&dev->lock);
 464         status = rndis_msg_parser(rndis->config, (u8 *) req->buf);
 465         if (status < 0)
 466                 pr_err("RNDIS command error %d, %d/%d\n",
 467                         status, req->actual, req->length);
 468
 469         buf = (rndis_init_msg_type *)req->buf;
 470
 471         if (buf->MessageType == RNDIS_MSG_INIT) {
 472                 if (buf->MaxTransferSize > 2048)
 473                         rndis->port.multi_pkt_xfer = 1;
 474                 else
 475                         rndis->port.multi_pkt_xfer = 0;
 476                 pr_info("%s: MaxTransferSize: %d : Multi_pkt_txr: %s\n",
 477                                 __func__, buf->MaxTransferSize,
 478                                 rndis->port.multi_pkt_xfer ? "enabled" :
 479                                                             "disabled");
 480                 if (rndis_multipacket_dl_disable)
 481                         rndis->port.multi_pkt_xfer = 0;
 482         }
 483 //      spin_unlock(&dev->lock);
 484 }
 485
 486 static int
 487 rndis_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
 488 {
 489         struct f_rndis          *rndis = func_to_rndis(f);
 490         struct usb_composite_dev *cdev = f->config->cdev;
 491         struct usb_request      *req = cdev->req;
 492         int                     value = -EOPNOTSUPP;
 493         u16                     w_index = le16_to_cpu(ctrl->wIndex);
 494         u16                     w_value = le16_to_cpu(ctrl->wValue);
 495         u16                     w_length = le16_to_cpu(ctrl->wLength);
 496
 497         /* composite driver infrastructure handles everything except
 498          * CDC class messages; interface activation uses set_alt().
 499          */
 500         switch ((ctrl->bRequestType << 8) | ctrl->bRequest) {
 501
 502         /* RNDIS uses the CDC command encapsulation mechanism to implement
 503          * an RPC scheme, with much getting/setting of attributes by OID.
 504          */
 505         case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
 506                         | USB_CDC_SEND_ENCAPSULATED_COMMAND:
 507                 if (w_value || w_index != rndis->ctrl_id)
 508                         goto invalid;
 509                 /* read the request; process it later */
 510                 value = w_length;
 511                 req->complete = rndis_command_complete;
 512                 req->context = rndis;
 513                 /* later, rndis_response_available() sends a notification */
 514                 break;
 515
 516         case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
 517                         | USB_CDC_GET_ENCAPSULATED_RESPONSE:
 518                 if (w_value || w_index != rndis->ctrl_id)
 519                         goto invalid;
 520                 else {
 521                         u8 *buf;
 522                         u32 n;
 523
 524                         /* return the result */
 525                         buf = rndis_get_next_response(rndis->config, &n);
 526                         if (buf) {
 527                                 memcpy(req->buf, buf, n);
 528                                 req->complete = rndis_response_complete;
 529                                 req->context = rndis;
 530                                 rndis_free_response(rndis->config, buf);
 531                                 value = n;
 532                         }
 533                         /* else stalls ... spec says to avoid that */
 534                 }
 535                 break;
 536
 537         default:
 538 invalid:
 539                 VDBG(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n",
 540                         ctrl->bRequestType, ctrl->bRequest,
 541                         w_value, w_index, w_length);
 542         }
 543
 544         /* respond with data transfer or status phase? */
 545         if (value >= 0) {
 546                 DBG(cdev, "rndis req%02x.%02x v%04x i%04x l%d\n",
 547                         ctrl->bRequestType, ctrl->bRequest,
 548                         w_value, w_index, w_length);
 549                 req->zero = (value < w_length);
 550                 req->length = value;
 551                 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
 552                 if (value < 0)
 553                         ERROR(cdev, "rndis response on err %d\n", value);
 554         }
 555
 556         /* device either stalls (value < 0) or reports success */
 557         return value;
 558 }
 559
 560
 561 static int rndis_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
 562 {
 563         struct f_rndis          *rndis = func_to_rndis(f);
 564         struct usb_composite_dev *cdev = f->config->cdev;
 565
 566         /* we know alt == 0 */
 567
 568         if (intf == rndis->ctrl_id) {
 569                 if (rndis->notify->driver_data) {
 570                         VDBG(cdev, "reset rndis control %d\n", intf);
 571                         usb_ep_disable(rndis->notify);
 572                 }
 573                 if (!rndis->notify->desc) {
 574                         VDBG(cdev, "init rndis ctrl %d\n", intf);
 575                         if (config_ep_by_speed(cdev->gadget, f, rndis->notify))
 576                                 goto fail;
 577                 }
 578                 usb_ep_enable(rndis->notify);
 579                 rndis->notify->driver_data = rndis;
 580
 581         } else if (intf == rndis->data_id) {
 582                 struct net_device       *net;
 583
 584                 if (rndis->port.in_ep->driver_data) {
 585                         DBG(cdev, "reset rndis\n");
 586                         gether_disconnect(&rndis->port);
 587                 }
 588
 589                 if (!rndis->port.in_ep->desc || !rndis->port.out_ep->desc) {
 590                         DBG(cdev, "init rndis\n");
 591                         if (config_ep_by_speed(cdev->gadget, f,
 592                                                rndis->port.in_ep) ||
 593                             config_ep_by_speed(cdev->gadget, f,
 594                                                rndis->port.out_ep)) {
 595                                 rndis->port.in_ep->desc = NULL;
 596                                 rndis->port.out_ep->desc = NULL;
 597                                 goto fail;
 598                         }
 599                 }
 600
 601                 /* Avoid ZLPs; they can be troublesome. */
 602                 rndis->port.is_zlp_ok = false;
 603
 604                 /* RNDIS should be in the "RNDIS uninitialized" state,
 605                  * either never activated or after rndis_uninit().
 606                  *
 607                  * We don't want data to flow here until a nonzero packet
 608                  * filter is set, at which point it enters "RNDIS data
 609                  * initialized" state ... but we do want the endpoints
 610                  * to be activated.  It's a strange little state.
 611                  *
 612                  * REVISIT the RNDIS gadget code has done this wrong for a
 613                  * very long time.  We need another call to the link layer
 614                  * code -- gether_updown(...bool) maybe -- to do it right.
 615                  */
 616                 rndis->port.cdc_filter = 0;
 617
 618                 DBG(cdev, "RNDIS RX/TX early activation ... \n");
 619                 net = gether_connect(&rndis->port);
 620                 if (IS_ERR(net))
 621                         return PTR_ERR(net);
 622
 623                 rndis_set_param_dev(rndis->config, net,
 624                                 &rndis->port.cdc_filter);
 625         } else
 626                 goto fail;
 627
 628         return 0;
 629 fail:
 630         return -EINVAL;
 631 }
 632
 633 static void rndis_disable(struct usb_function *f)
 634 {
 635         struct f_rndis          *rndis = func_to_rndis(f);
 636         struct usb_composite_dev *cdev = f->config->cdev;
 637
 638         if (!rndis->notify->driver_data)
 639                 return;
 640
 641         DBG(cdev, "rndis deactivated\n");
 642
 643         rndis_uninit(rndis->config);
 644         gether_disconnect(&rndis->port);
 645
 646         usb_ep_disable(rndis->notify);
 647         rndis->notify->driver_data = NULL;
 648 }
 649
 650 /*-------------------------------------------------------------------------*/
 651
 652 /*
 653  * This isn't quite the same mechanism as CDC Ethernet, since the
 654  * notification scheme passes less data, but the same set of link
 655  * states must be tested.  A key difference is that altsettings are
 656  * not used to tell whether the link should send packets or not.
 657  */
 658
 659 static void rndis_open(struct gether *geth)
 660 {
 661         struct f_rndis          *rndis = func_to_rndis(&geth->func);
 662         struct usb_composite_dev *cdev = geth->func.config->cdev;
 663
 664         DBG(cdev, "%s\n", __func__);
 665
 666         rndis_set_param_medium(rndis->config, RNDIS_MEDIUM_802_3,
 667                                 bitrate(cdev->gadget) / 100);
 668         rndis_signal_connect(rndis->config);
 669 }
 670
 671 static void rndis_close(struct gether *geth)
 672 {
 673         struct f_rndis          *rndis = func_to_rndis(&geth->func);
 674
 675         DBG(geth->func.config->cdev, "%s\n", __func__);
 676
 677         rndis_set_param_medium(rndis->config, RNDIS_MEDIUM_802_3, 0);
 678         rndis_signal_disconnect(rndis->config);
 679 }
 680
 681 /*-------------------------------------------------------------------------*/
 682
 683 /* ethernet function driver setup/binding */
 684
 685 static int
 686 rndis_bind(struct usb_configuration *c, struct usb_function *f)
 687 {
 688         struct usb_composite_dev *cdev = c->cdev;
 689         struct f_rndis          *rndis = func_to_rndis(f);
 690         int                     status;
 691         struct usb_ep           *ep;
 692
 693         /* allocate instance-specific interface IDs */
 694         status = usb_interface_id(c, f);
 695         if (status < 0)
 696                 goto fail;
 697         rndis->ctrl_id = status;
 698         rndis_iad_descriptor.bFirstInterface = status;
 699
 700         rndis_control_intf.bInterfaceNumber = status;
 701         rndis_union_desc.bMasterInterface0 = status;
 702
 703         status = usb_interface_id(c, f);
 704         if (status < 0)
 705                 goto fail;
 706         rndis->data_id = status;
 707
 708         rndis_data_intf.bInterfaceNumber = status;
 709         rndis_union_desc.bSlaveInterface0 = status;
 710
 711         status = -ENODEV;
 712
 713         /* allocate instance-specific endpoints */
 714         ep = usb_ep_autoconfig(cdev->gadget, &fs_in_desc);
 715         if (!ep)
 716                 goto fail;
 717         rndis->port.in_ep = ep;
 718         ep->driver_data = cdev; /* claim */
 719
 720         ep = usb_ep_autoconfig(cdev->gadget, &fs_out_desc);
 721         if (!ep)
 722                 goto fail;
 723         rndis->port.out_ep = ep;
 724         ep->driver_data = cdev; /* claim */
 725
 726         /* NOTE:  a status/notification endpoint is, strictly speaking,
 727          * optional.  We don't treat it that way though!  It's simpler,
 728          * and some newer profiles don't treat it as optional.
 729          */
 730         ep = usb_ep_autoconfig(cdev->gadget, &fs_notify_desc);
 731         if (!ep)
 732                 goto fail;
 733         rndis->notify = ep;
 734         ep->driver_data = cdev; /* claim */
 735
 736         status = -ENOMEM;
 737
 738         /* allocate notification request and buffer */
 739         rndis->notify_req = usb_ep_alloc_request(ep, GFP_KERNEL);
 740         if (!rndis->notify_req)
 741                 goto fail;
 742         rndis->notify_req->buf = kmalloc(STATUS_BYTECOUNT, GFP_KERNEL);
 743         if (!rndis->notify_req->buf)
 744                 goto fail;
 745         rndis->notify_req->length = STATUS_BYTECOUNT;
 746         rndis->notify_req->context = rndis;
 747         rndis->notify_req->complete = rndis_response_complete;
 748
 749         /* support all relevant hardware speeds... we expect that when
 750          * hardware is dual speed, all bulk-capable endpoints work at
 751          * both speeds
 752          */
 753         hs_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
 754         hs_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
 755         hs_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
 756
 757         ss_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
 758         ss_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
 759         ss_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
 760
 761         status = usb_assign_descriptors(f, eth_fs_function, eth_hs_function,
 762                         eth_ss_function);
 763         if (status)
 764                 goto fail;
 765
 766         rndis->port.open = rndis_open;
 767         rndis->port.close = rndis_close;
 768
 769         status = rndis_register(rndis_response_available, rndis);
 770         if (status < 0)
 771                 goto fail;
 772         rndis->config = status;
 773
 774         rndis_set_param_medium(rndis->config, RNDIS_MEDIUM_802_3, 0);
 775         rndis_set_host_mac(rndis->config, rndis->ethaddr);
 776         rndis_set_max_pkt_xfer(rndis->config, rndis_ul_max_pkt_per_xfer);
 777
 778         if (rndis->manufacturer && rndis->vendorID &&
 779                         rndis_set_param_vendor(rndis->config, rndis->vendorID,
 780                                                rndis->manufacturer))
 781                 goto fail;
 782
 783         /* NOTE:  all that is done without knowing or caring about
 784          * the network link ... which is unavailable to this code
 785          * until we're activated via set_alt().
 786          */
 787
 788         DBG(cdev, "RNDIS: %s speed IN/%s OUT/%s NOTIFY/%s\n",
 789                         gadget_is_superspeed(c->cdev->gadget) ? "super" :
 790                         gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
 791                         rndis->port.in_ep->name, rndis->port.out_ep->name,
 792                         rndis->notify->name);
 793         return 0;
 794
 795 fail:
 796         usb_free_all_descriptors(f);
 797
 798         if (rndis->notify_req) {
 799                 kfree(rndis->notify_req->buf);
 800                 usb_ep_free_request(rndis->notify, rndis->notify_req);
 801         }
 802
 803         /* we might as well release our claims on endpoints */
 804         if (rndis->notify)
 805                 rndis->notify->driver_data = NULL;
 806         if (rndis->port.out_ep)
 807                 rndis->port.out_ep->driver_data = NULL;
 808         if (rndis->port.in_ep)
 809                 rndis->port.in_ep->driver_data = NULL;
 810
 811         ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
 812
 813         return status;
 814 }
 815
 816 static void
 817 rndis_unbind(struct usb_configuration *c, struct usb_function *f)
 818 {
 819         struct f_rndis          *rndis = func_to_rndis(f);
 820
 821         rndis_deregister(rndis->config);
 822         rndis_exit();
 823         rndis_string_defs[0].id = 0;
 824
 825         rndis_string_defs[0].id = 0;
 826         usb_free_all_descriptors(f);
 827
 828         kfree(rndis->notify_req->buf);
 829         usb_ep_free_request(rndis->notify, rndis->notify_req);
 830
 831         kfree(rndis);
 832 }
 833
 834 /* Some controllers can't support RNDIS ... */
 835 static inline bool can_support_rndis(struct usb_configuration *c)
 836 {
 837         /* everything else is *presumably* fine */
 838         return true;
 839 }
 840
 841 int
 842 rndis_bind_config_vendor(struct usb_configuration *c, u8 ethaddr[ETH_ALEN],
 843                 u32 vendorID, const char *manufacturer, struct eth_dev *dev)
 844 {
 845         struct f_rndis  *rndis;
 846         int             status;
 847
 848         if (!can_support_rndis(c) || !ethaddr)
 849                 return -EINVAL;
 850
 851         /* setup RNDIS itself */
 852         status = rndis_init();
 853         if (status < 0)
 854                 return status;
 855
 856         status = usb_string_ids_tab(c->cdev, rndis_string_defs);
 857         if (status)
 858                 return status;
 859
 860         rndis_control_intf.iInterface = rndis_string_defs[0].id;
 861         rndis_data_intf.iInterface = rndis_string_defs[1].id;
 862         rndis_iad_descriptor.iFunction = rndis_string_defs[2].id;
 863
 864         /* allocate and initialize one new instance */
 865         status = -ENOMEM;
 866         rndis = kzalloc(sizeof *rndis, GFP_KERNEL);
 867         if (!rndis)
 868                 goto fail;
 869
 870         memcpy(rndis->ethaddr, ethaddr, ETH_ALEN);
 871         rndis->vendorID = vendorID;
 872         rndis->manufacturer = manufacturer;
 873
 874         rndis->port.ioport = dev;
 875         /* RNDIS activates when the host changes this filter */
 876         rndis->port.cdc_filter = 0;
 877
 878         /* RNDIS has special (and complex) framing */
 879         rndis->port.header_len = sizeof(struct rndis_packet_msg_type);
 880         rndis->port.wrap = rndis_add_header;
 881         rndis->port.unwrap = rndis_rm_hdr;
 882         rndis->port.ul_max_pkts_per_xfer = rndis_ul_max_pkt_per_xfer;
 883
 884         rndis->port.func.name = "rndis";
 885         rndis->port.func.strings = rndis_strings;
 886         /* descriptors are per-instance copies */
 887         rndis->port.func.bind = rndis_bind;
 888         rndis->port.func.unbind = rndis_unbind;
 889         rndis->port.func.set_alt = rndis_set_alt;
 890         rndis->port.func.setup = rndis_setup;
 891         rndis->port.func.disable = rndis_disable;
 892
 893         status = usb_add_function(c, &rndis->port.func);
 894         if (status) {
 895                 kfree(rndis);
 896 fail:
 897                 rndis_exit();
 898         }
 899         return status;
 900 }