2 * f_rndis.c -- RNDIS link function driver
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)
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.
16 /* #define VERBOSE_DEBUG */
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>
24 #include <linux/atomic.h>
27 #include "u_ether_configfs.h"
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.
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.
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.
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".
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.
62 * Omissions from the RNDIS 1.0 specification include:
64 * - Power management ... references data that's scattered around lots
65 * of other documentation, which is incorrect/incomplete there too.
67 * - There are various undocumented protocol requirements, like the need
68 * to send garbage in some control-OUT messages.
70 * - MS-Windows drivers sometimes emit undocumented requests.
73 static unsigned int rndis_dl_max_pkt_per_xfer = 3;
74 module_param(rndis_dl_max_pkt_per_xfer, uint, S_IRUGO | S_IWUSR);
75 MODULE_PARM_DESC(rndis_dl_max_pkt_per_xfer,
76 "Maximum packets per transfer for DL aggregation");
78 static unsigned int rndis_ul_max_pkt_per_xfer = 3;
79 module_param(rndis_ul_max_pkt_per_xfer, uint, S_IRUGO | S_IWUSR);
80 MODULE_PARM_DESC(rndis_ul_max_pkt_per_xfer,
81 "Maximum packets per transfer for UL aggregation");
88 const char *manufacturer;
89 struct rndis_params *params;
91 struct usb_ep *notify;
92 struct usb_request *notify_req;
93 atomic_t notify_count;
96 static inline struct f_rndis *func_to_rndis(struct usb_function *f)
98 return container_of(f, struct f_rndis, port.func);
101 /* peak (theoretical) bulk transfer rate in bits-per-second */
102 static unsigned int bitrate(struct usb_gadget *g)
104 if (gadget_is_superspeed(g) && g->speed == USB_SPEED_SUPER)
105 return 13 * 1024 * 8 * 1000 * 8;
106 else if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
107 return 13 * 512 * 8 * 1000 * 8;
109 return 19 * 64 * 1 * 1000 * 8;
112 /*-------------------------------------------------------------------------*/
117 #define RNDIS_STATUS_INTERVAL_MS 32
118 #define STATUS_BYTECOUNT 8 /* 8 bytes data */
121 /* interface descriptor: */
123 static struct usb_interface_descriptor rndis_control_intf = {
124 .bLength = sizeof rndis_control_intf,
125 .bDescriptorType = USB_DT_INTERFACE,
127 /* .bInterfaceNumber = DYNAMIC */
128 /* status endpoint is optional; this could be patched later */
130 .bInterfaceClass = USB_CLASS_COMM,
131 .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
132 .bInterfaceProtocol = USB_CDC_ACM_PROTO_VENDOR,
133 /* .iInterface = DYNAMIC */
136 static struct usb_cdc_header_desc header_desc = {
137 .bLength = sizeof header_desc,
138 .bDescriptorType = USB_DT_CS_INTERFACE,
139 .bDescriptorSubType = USB_CDC_HEADER_TYPE,
141 .bcdCDC = cpu_to_le16(0x0110),
144 static struct usb_cdc_call_mgmt_descriptor call_mgmt_descriptor = {
145 .bLength = sizeof call_mgmt_descriptor,
146 .bDescriptorType = USB_DT_CS_INTERFACE,
147 .bDescriptorSubType = USB_CDC_CALL_MANAGEMENT_TYPE,
149 .bmCapabilities = 0x00,
150 .bDataInterface = 0x01,
153 static struct usb_cdc_acm_descriptor rndis_acm_descriptor = {
154 .bLength = sizeof rndis_acm_descriptor,
155 .bDescriptorType = USB_DT_CS_INTERFACE,
156 .bDescriptorSubType = USB_CDC_ACM_TYPE,
158 .bmCapabilities = 0x00,
161 static struct usb_cdc_union_desc rndis_union_desc = {
162 .bLength = sizeof(rndis_union_desc),
163 .bDescriptorType = USB_DT_CS_INTERFACE,
164 .bDescriptorSubType = USB_CDC_UNION_TYPE,
165 /* .bMasterInterface0 = DYNAMIC */
166 /* .bSlaveInterface0 = DYNAMIC */
169 /* the data interface has two bulk endpoints */
171 static struct usb_interface_descriptor rndis_data_intf = {
172 .bLength = sizeof rndis_data_intf,
173 .bDescriptorType = USB_DT_INTERFACE,
175 /* .bInterfaceNumber = DYNAMIC */
177 .bInterfaceClass = USB_CLASS_CDC_DATA,
178 .bInterfaceSubClass = 0,
179 .bInterfaceProtocol = 0,
180 /* .iInterface = DYNAMIC */
184 static struct usb_interface_assoc_descriptor
185 rndis_iad_descriptor = {
186 .bLength = sizeof rndis_iad_descriptor,
187 .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION,
189 .bFirstInterface = 0, /* XXX, hardcoded */
190 .bInterfaceCount = 2, // control + data
191 .bFunctionClass = USB_CLASS_COMM,
192 .bFunctionSubClass = USB_CDC_SUBCLASS_ETHERNET,
193 .bFunctionProtocol = USB_CDC_PROTO_NONE,
194 /* .iFunction = DYNAMIC */
197 /* full speed support: */
199 static struct usb_endpoint_descriptor fs_notify_desc = {
200 .bLength = USB_DT_ENDPOINT_SIZE,
201 .bDescriptorType = USB_DT_ENDPOINT,
203 .bEndpointAddress = USB_DIR_IN,
204 .bmAttributes = USB_ENDPOINT_XFER_INT,
205 .wMaxPacketSize = cpu_to_le16(STATUS_BYTECOUNT),
206 .bInterval = RNDIS_STATUS_INTERVAL_MS,
209 static struct usb_endpoint_descriptor fs_in_desc = {
210 .bLength = USB_DT_ENDPOINT_SIZE,
211 .bDescriptorType = USB_DT_ENDPOINT,
213 .bEndpointAddress = USB_DIR_IN,
214 .bmAttributes = USB_ENDPOINT_XFER_BULK,
217 static struct usb_endpoint_descriptor fs_out_desc = {
218 .bLength = USB_DT_ENDPOINT_SIZE,
219 .bDescriptorType = USB_DT_ENDPOINT,
221 .bEndpointAddress = USB_DIR_OUT,
222 .bmAttributes = USB_ENDPOINT_XFER_BULK,
225 static struct usb_descriptor_header *eth_fs_function[] = {
226 (struct usb_descriptor_header *) &rndis_iad_descriptor,
228 /* control interface matches ACM, not Ethernet */
229 (struct usb_descriptor_header *) &rndis_control_intf,
230 (struct usb_descriptor_header *) &header_desc,
231 (struct usb_descriptor_header *) &call_mgmt_descriptor,
232 (struct usb_descriptor_header *) &rndis_acm_descriptor,
233 (struct usb_descriptor_header *) &rndis_union_desc,
234 (struct usb_descriptor_header *) &fs_notify_desc,
236 /* data interface has no altsetting */
237 (struct usb_descriptor_header *) &rndis_data_intf,
238 (struct usb_descriptor_header *) &fs_in_desc,
239 (struct usb_descriptor_header *) &fs_out_desc,
243 /* high speed support: */
245 static struct usb_endpoint_descriptor hs_notify_desc = {
246 .bLength = USB_DT_ENDPOINT_SIZE,
247 .bDescriptorType = USB_DT_ENDPOINT,
249 .bEndpointAddress = USB_DIR_IN,
250 .bmAttributes = USB_ENDPOINT_XFER_INT,
251 .wMaxPacketSize = cpu_to_le16(STATUS_BYTECOUNT),
252 .bInterval = USB_MS_TO_HS_INTERVAL(RNDIS_STATUS_INTERVAL_MS)
255 static struct usb_endpoint_descriptor hs_in_desc = {
256 .bLength = USB_DT_ENDPOINT_SIZE,
257 .bDescriptorType = USB_DT_ENDPOINT,
259 .bEndpointAddress = USB_DIR_IN,
260 .bmAttributes = USB_ENDPOINT_XFER_BULK,
261 .wMaxPacketSize = cpu_to_le16(512),
264 static struct usb_endpoint_descriptor hs_out_desc = {
265 .bLength = USB_DT_ENDPOINT_SIZE,
266 .bDescriptorType = USB_DT_ENDPOINT,
268 .bEndpointAddress = USB_DIR_OUT,
269 .bmAttributes = USB_ENDPOINT_XFER_BULK,
270 .wMaxPacketSize = cpu_to_le16(512),
273 static struct usb_descriptor_header *eth_hs_function[] = {
274 (struct usb_descriptor_header *) &rndis_iad_descriptor,
276 /* control interface matches ACM, not Ethernet */
277 (struct usb_descriptor_header *) &rndis_control_intf,
278 (struct usb_descriptor_header *) &header_desc,
279 (struct usb_descriptor_header *) &call_mgmt_descriptor,
280 (struct usb_descriptor_header *) &rndis_acm_descriptor,
281 (struct usb_descriptor_header *) &rndis_union_desc,
282 (struct usb_descriptor_header *) &hs_notify_desc,
284 /* data interface has no altsetting */
285 (struct usb_descriptor_header *) &rndis_data_intf,
286 (struct usb_descriptor_header *) &hs_in_desc,
287 (struct usb_descriptor_header *) &hs_out_desc,
291 /* super speed support: */
293 static struct usb_endpoint_descriptor ss_notify_desc = {
294 .bLength = USB_DT_ENDPOINT_SIZE,
295 .bDescriptorType = USB_DT_ENDPOINT,
297 .bEndpointAddress = USB_DIR_IN,
298 .bmAttributes = USB_ENDPOINT_XFER_INT,
299 .wMaxPacketSize = cpu_to_le16(STATUS_BYTECOUNT),
300 .bInterval = USB_MS_TO_HS_INTERVAL(RNDIS_STATUS_INTERVAL_MS)
303 static struct usb_ss_ep_comp_descriptor ss_intr_comp_desc = {
304 .bLength = sizeof ss_intr_comp_desc,
305 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
307 /* the following 3 values can be tweaked if necessary */
308 /* .bMaxBurst = 0, */
309 /* .bmAttributes = 0, */
310 .wBytesPerInterval = cpu_to_le16(STATUS_BYTECOUNT),
313 static struct usb_endpoint_descriptor ss_in_desc = {
314 .bLength = USB_DT_ENDPOINT_SIZE,
315 .bDescriptorType = USB_DT_ENDPOINT,
317 .bEndpointAddress = USB_DIR_IN,
318 .bmAttributes = USB_ENDPOINT_XFER_BULK,
319 .wMaxPacketSize = cpu_to_le16(1024),
322 static struct usb_endpoint_descriptor ss_out_desc = {
323 .bLength = USB_DT_ENDPOINT_SIZE,
324 .bDescriptorType = USB_DT_ENDPOINT,
326 .bEndpointAddress = USB_DIR_OUT,
327 .bmAttributes = USB_ENDPOINT_XFER_BULK,
328 .wMaxPacketSize = cpu_to_le16(1024),
331 static struct usb_ss_ep_comp_descriptor ss_bulk_comp_desc = {
332 .bLength = sizeof ss_bulk_comp_desc,
333 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
335 /* the following 2 values can be tweaked if necessary */
336 /* .bMaxBurst = 0, */
337 /* .bmAttributes = 0, */
340 static struct usb_descriptor_header *eth_ss_function[] = {
341 (struct usb_descriptor_header *) &rndis_iad_descriptor,
343 /* control interface matches ACM, not Ethernet */
344 (struct usb_descriptor_header *) &rndis_control_intf,
345 (struct usb_descriptor_header *) &header_desc,
346 (struct usb_descriptor_header *) &call_mgmt_descriptor,
347 (struct usb_descriptor_header *) &rndis_acm_descriptor,
348 (struct usb_descriptor_header *) &rndis_union_desc,
349 (struct usb_descriptor_header *) &ss_notify_desc,
350 (struct usb_descriptor_header *) &ss_intr_comp_desc,
352 /* data interface has no altsetting */
353 (struct usb_descriptor_header *) &rndis_data_intf,
354 (struct usb_descriptor_header *) &ss_in_desc,
355 (struct usb_descriptor_header *) &ss_bulk_comp_desc,
356 (struct usb_descriptor_header *) &ss_out_desc,
357 (struct usb_descriptor_header *) &ss_bulk_comp_desc,
361 /* string descriptors: */
363 static struct usb_string rndis_string_defs[] = {
364 [0].s = "RNDIS Communications Control",
365 [1].s = "RNDIS Ethernet Data",
367 { } /* end of list */
370 static struct usb_gadget_strings rndis_string_table = {
371 .language = 0x0409, /* en-us */
372 .strings = rndis_string_defs,
375 static struct usb_gadget_strings *rndis_strings[] = {
380 /*-------------------------------------------------------------------------*/
382 static struct sk_buff *rndis_add_header(struct gether *port,
385 struct sk_buff *skb2;
387 skb2 = skb_realloc_headroom(skb, sizeof(struct rndis_packet_msg_type));
394 static void rndis_response_available(void *_rndis)
396 struct f_rndis *rndis = _rndis;
397 struct usb_request *req = rndis->notify_req;
398 struct usb_composite_dev *cdev = rndis->port.func.config->cdev;
399 __le32 *data = req->buf;
402 if (atomic_inc_return(&rndis->notify_count) != 1)
405 /* Send RNDIS RESPONSE_AVAILABLE notification; a
406 * USB_CDC_NOTIFY_RESPONSE_AVAILABLE "should" work too
408 * This is the only notification defined by RNDIS.
410 data[0] = cpu_to_le32(1);
411 data[1] = cpu_to_le32(0);
413 status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
415 atomic_dec(&rndis->notify_count);
416 DBG(cdev, "notify/0 --> %d\n", status);
420 static void rndis_response_complete(struct usb_ep *ep, struct usb_request *req)
422 struct f_rndis *rndis = req->context;
423 struct usb_composite_dev *cdev = rndis->port.func.config->cdev;
424 int status = req->status;
427 * - USB_CDC_GET_ENCAPSULATED_RESPONSE (ep0/control)
428 * - RNDIS_RESPONSE_AVAILABLE (status/irq)
433 /* connection gone */
434 atomic_set(&rndis->notify_count, 0);
437 DBG(cdev, "RNDIS %s response error %d, %d/%d\n",
439 req->actual, req->length);
442 if (ep != rndis->notify)
445 /* handle multiple pending RNDIS_RESPONSE_AVAILABLE
446 * notifications by resending until we're done
448 if (atomic_dec_and_test(&rndis->notify_count))
450 status = usb_ep_queue(rndis->notify, req, GFP_ATOMIC);
452 atomic_dec(&rndis->notify_count);
453 DBG(cdev, "notify/1 --> %d\n", status);
459 static void rndis_command_complete(struct usb_ep *ep, struct usb_request *req)
461 struct f_rndis *rndis = req->context;
462 struct usb_composite_dev *cdev = rndis->port.func.config->cdev;
464 rndis_init_msg_type *buf;
466 /* received RNDIS command from USB_CDC_SEND_ENCAPSULATED_COMMAND */
467 // spin_lock(&dev->lock);
468 status = rndis_msg_parser(rndis->params, (u8 *) req->buf);
470 pr_err("RNDIS command error %d, %d/%d\n",
471 status, req->actual, req->length);
473 buf = (rndis_init_msg_type *)req->buf;
475 if (buf->MessageType == RNDIS_MSG_INIT) {
476 if (buf->MaxTransferSize > 2048)
477 rndis->port.multi_pkt_xfer = 1;
479 rndis->port.multi_pkt_xfer = 0;
480 DBG(cdev, "%s: MaxTransferSize: %d : Multi_pkt_txr: %s\n",
481 __func__, buf->MaxTransferSize,
482 rndis->port.multi_pkt_xfer ? "enabled" :
484 if (rndis_dl_max_pkt_per_xfer <= 1)
485 rndis->port.multi_pkt_xfer = 0;
487 // spin_unlock(&dev->lock);
491 rndis_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
493 struct f_rndis *rndis = func_to_rndis(f);
494 struct usb_composite_dev *cdev = f->config->cdev;
495 struct usb_request *req = cdev->req;
496 int value = -EOPNOTSUPP;
497 u16 w_index = le16_to_cpu(ctrl->wIndex);
498 u16 w_value = le16_to_cpu(ctrl->wValue);
499 u16 w_length = le16_to_cpu(ctrl->wLength);
501 /* composite driver infrastructure handles everything except
502 * CDC class messages; interface activation uses set_alt().
504 switch ((ctrl->bRequestType << 8) | ctrl->bRequest) {
506 /* RNDIS uses the CDC command encapsulation mechanism to implement
507 * an RPC scheme, with much getting/setting of attributes by OID.
509 case ((USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
510 | USB_CDC_SEND_ENCAPSULATED_COMMAND:
511 if (w_value || w_index != rndis->ctrl_id)
513 /* read the request; process it later */
515 req->complete = rndis_command_complete;
516 req->context = rndis;
517 /* later, rndis_response_available() sends a notification */
520 case ((USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE) << 8)
521 | USB_CDC_GET_ENCAPSULATED_RESPONSE:
522 if (w_value || w_index != rndis->ctrl_id)
528 /* return the result */
529 buf = rndis_get_next_response(rndis->params, &n);
531 memcpy(req->buf, buf, n);
532 req->complete = rndis_response_complete;
533 req->context = rndis;
534 rndis_free_response(rndis->params, buf);
537 /* else stalls ... spec says to avoid that */
543 VDBG(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n",
544 ctrl->bRequestType, ctrl->bRequest,
545 w_value, w_index, w_length);
548 /* respond with data transfer or status phase? */
550 DBG(cdev, "rndis req%02x.%02x v%04x i%04x l%d\n",
551 ctrl->bRequestType, ctrl->bRequest,
552 w_value, w_index, w_length);
553 req->zero = (value < w_length);
555 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
557 ERROR(cdev, "rndis response on err %d\n", value);
560 /* device either stalls (value < 0) or reports success */
565 static int rndis_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
567 struct f_rndis *rndis = func_to_rndis(f);
568 struct usb_composite_dev *cdev = f->config->cdev;
570 /* we know alt == 0 */
572 if (intf == rndis->ctrl_id) {
573 VDBG(cdev, "reset rndis control %d\n", intf);
574 usb_ep_disable(rndis->notify);
576 if (!rndis->notify->desc) {
577 VDBG(cdev, "init rndis ctrl %d\n", intf);
578 if (config_ep_by_speed(cdev->gadget, f, rndis->notify))
581 usb_ep_enable(rndis->notify);
583 } else if (intf == rndis->data_id) {
584 struct net_device *net;
586 if (rndis->port.in_ep->enabled) {
587 DBG(cdev, "reset rndis\n");
588 gether_disconnect(&rndis->port);
591 if (!rndis->port.in_ep->desc || !rndis->port.out_ep->desc) {
592 DBG(cdev, "init rndis\n");
593 if (config_ep_by_speed(cdev->gadget, f,
594 rndis->port.in_ep) ||
595 config_ep_by_speed(cdev->gadget, f,
596 rndis->port.out_ep)) {
597 rndis->port.in_ep->desc = NULL;
598 rndis->port.out_ep->desc = NULL;
603 /* Avoid ZLPs; they can be troublesome. */
604 rndis->port.is_zlp_ok = false;
606 /* RNDIS should be in the "RNDIS uninitialized" state,
607 * either never activated or after rndis_uninit().
609 * We don't want data to flow here until a nonzero packet
610 * filter is set, at which point it enters "RNDIS data
611 * initialized" state ... but we do want the endpoints
612 * to be activated. It's a strange little state.
614 * REVISIT the RNDIS gadget code has done this wrong for a
615 * very long time. We need another call to the link layer
616 * code -- gether_updown(...bool) maybe -- to do it right.
618 rndis->port.cdc_filter = 0;
620 DBG(cdev, "RNDIS RX/TX early activation ... \n");
621 net = gether_connect(&rndis->port);
625 rndis_set_param_dev(rndis->params, net,
626 &rndis->port.cdc_filter);
635 static void rndis_disable(struct usb_function *f)
637 struct f_rndis *rndis = func_to_rndis(f);
638 struct usb_composite_dev *cdev = f->config->cdev;
640 if (!rndis->notify->enabled)
643 DBG(cdev, "rndis deactivated\n");
645 rndis_uninit(rndis->params);
646 gether_disconnect(&rndis->port);
648 usb_ep_disable(rndis->notify);
651 /*-------------------------------------------------------------------------*/
654 * This isn't quite the same mechanism as CDC Ethernet, since the
655 * notification scheme passes less data, but the same set of link
656 * states must be tested. A key difference is that altsettings are
657 * not used to tell whether the link should send packets or not.
660 static void rndis_open(struct gether *geth)
662 struct f_rndis *rndis = func_to_rndis(&geth->func);
663 struct usb_composite_dev *cdev = geth->func.config->cdev;
665 DBG(cdev, "%s\n", __func__);
667 rndis_set_param_medium(rndis->params, RNDIS_MEDIUM_802_3,
668 bitrate(cdev->gadget) / 100);
669 rndis_signal_connect(rndis->params);
672 static void rndis_close(struct gether *geth)
674 struct f_rndis *rndis = func_to_rndis(&geth->func);
676 DBG(geth->func.config->cdev, "%s\n", __func__);
678 rndis_set_param_medium(rndis->params, RNDIS_MEDIUM_802_3, 0);
679 rndis_signal_disconnect(rndis->params);
682 /*-------------------------------------------------------------------------*/
684 /* Some controllers can't support RNDIS ... */
685 static inline bool can_support_rndis(struct usb_configuration *c)
687 /* everything else is *presumably* fine */
691 /* ethernet function driver setup/binding */
694 rndis_bind(struct usb_configuration *c, struct usb_function *f)
696 struct usb_composite_dev *cdev = c->cdev;
697 struct f_rndis *rndis = func_to_rndis(f);
698 struct usb_string *us;
702 struct f_rndis_opts *rndis_opts;
704 if (!can_support_rndis(c))
707 rndis_opts = container_of(f->fi, struct f_rndis_opts, func_inst);
709 if (cdev->use_os_string) {
710 f->os_desc_table = kzalloc(sizeof(*f->os_desc_table),
712 if (!f->os_desc_table)
715 f->os_desc_table[0].os_desc = &rndis_opts->rndis_os_desc;
719 * in drivers/usb/gadget/configfs.c:configfs_composite_bind()
720 * configurations are bound in sequence with list_for_each_entry,
721 * in each configuration its functions are bound in sequence
722 * with list_for_each_entry, so we assume no race condition
723 * with regard to rndis_opts->bound access
725 if (!rndis_opts->bound) {
726 gether_set_gadget(rndis_opts->net, cdev->gadget);
727 status = gether_register_netdev(rndis_opts->net);
730 rndis_opts->bound = true;
733 us = usb_gstrings_attach(cdev, rndis_strings,
734 ARRAY_SIZE(rndis_string_defs));
736 status = PTR_ERR(us);
739 rndis_control_intf.iInterface = us[0].id;
740 rndis_data_intf.iInterface = us[1].id;
741 rndis_iad_descriptor.iFunction = us[2].id;
743 /* allocate instance-specific interface IDs */
744 status = usb_interface_id(c, f);
747 rndis->ctrl_id = status;
748 rndis_iad_descriptor.bFirstInterface = status;
750 rndis_control_intf.bInterfaceNumber = status;
751 rndis_union_desc.bMasterInterface0 = status;
753 if (cdev->use_os_string)
754 f->os_desc_table[0].if_id =
755 rndis_iad_descriptor.bFirstInterface;
757 status = usb_interface_id(c, f);
760 rndis->data_id = status;
762 rndis_data_intf.bInterfaceNumber = status;
763 rndis_union_desc.bSlaveInterface0 = status;
767 /* allocate instance-specific endpoints */
768 ep = usb_ep_autoconfig(cdev->gadget, &fs_in_desc);
771 rndis->port.in_ep = ep;
773 ep = usb_ep_autoconfig(cdev->gadget, &fs_out_desc);
776 rndis->port.out_ep = ep;
778 /* NOTE: a status/notification endpoint is, strictly speaking,
779 * optional. We don't treat it that way though! It's simpler,
780 * and some newer profiles don't treat it as optional.
782 ep = usb_ep_autoconfig(cdev->gadget, &fs_notify_desc);
789 /* allocate notification request and buffer */
790 rndis->notify_req = usb_ep_alloc_request(ep, GFP_KERNEL);
791 if (!rndis->notify_req)
793 rndis->notify_req->buf = kmalloc(STATUS_BYTECOUNT, GFP_KERNEL);
794 if (!rndis->notify_req->buf)
796 rndis->notify_req->length = STATUS_BYTECOUNT;
797 rndis->notify_req->context = rndis;
798 rndis->notify_req->complete = rndis_response_complete;
800 /* support all relevant hardware speeds... we expect that when
801 * hardware is dual speed, all bulk-capable endpoints work at
804 hs_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
805 hs_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
806 hs_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
808 ss_in_desc.bEndpointAddress = fs_in_desc.bEndpointAddress;
809 ss_out_desc.bEndpointAddress = fs_out_desc.bEndpointAddress;
810 ss_notify_desc.bEndpointAddress = fs_notify_desc.bEndpointAddress;
812 status = usb_assign_descriptors(f, eth_fs_function, eth_hs_function,
817 rndis->port.open = rndis_open;
818 rndis->port.close = rndis_close;
820 rndis_set_param_medium(rndis->params, RNDIS_MEDIUM_802_3, 0);
821 rndis_set_host_mac(rndis->params, rndis->ethaddr);
822 rndis_set_max_pkt_xfer(rndis->params, rndis_ul_max_pkt_per_xfer);
824 if (rndis->manufacturer && rndis->vendorID &&
825 rndis_set_param_vendor(rndis->params, rndis->vendorID,
826 rndis->manufacturer)) {
828 goto fail_free_descs;
831 /* NOTE: all that is done without knowing or caring about
832 * the network link ... which is unavailable to this code
833 * until we're activated via set_alt().
836 DBG(cdev, "RNDIS: %s speed IN/%s OUT/%s NOTIFY/%s\n",
837 gadget_is_superspeed(c->cdev->gadget) ? "super" :
838 gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full",
839 rndis->port.in_ep->name, rndis->port.out_ep->name,
840 rndis->notify->name);
844 usb_free_all_descriptors(f);
846 kfree(f->os_desc_table);
849 if (rndis->notify_req) {
850 kfree(rndis->notify_req->buf);
851 usb_ep_free_request(rndis->notify, rndis->notify_req);
854 ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
859 void rndis_borrow_net(struct usb_function_instance *f, struct net_device *net)
861 struct f_rndis_opts *opts;
863 opts = container_of(f, struct f_rndis_opts, func_inst);
865 gether_cleanup(netdev_priv(opts->net));
867 free_netdev(opts->net);
868 opts->borrowed_net = opts->bound = true;
871 EXPORT_SYMBOL_GPL(rndis_borrow_net);
873 static inline struct f_rndis_opts *to_f_rndis_opts(struct config_item *item)
875 return container_of(to_config_group(item), struct f_rndis_opts,
879 /* f_rndis_item_ops */
880 USB_ETHERNET_CONFIGFS_ITEM(rndis);
882 /* f_rndis_opts_dev_addr */
883 USB_ETHERNET_CONFIGFS_ITEM_ATTR_DEV_ADDR(rndis);
885 /* f_rndis_opts_host_addr */
886 USB_ETHERNET_CONFIGFS_ITEM_ATTR_HOST_ADDR(rndis);
888 /* f_rndis_opts_qmult */
889 USB_ETHERNET_CONFIGFS_ITEM_ATTR_QMULT(rndis);
891 /* f_rndis_opts_ifname */
892 USB_ETHERNET_CONFIGFS_ITEM_ATTR_IFNAME(rndis);
894 static struct configfs_attribute *rndis_attrs[] = {
895 &rndis_opts_attr_dev_addr,
896 &rndis_opts_attr_host_addr,
897 &rndis_opts_attr_qmult,
898 &rndis_opts_attr_ifname,
902 static struct config_item_type rndis_func_type = {
903 .ct_item_ops = &rndis_item_ops,
904 .ct_attrs = rndis_attrs,
905 .ct_owner = THIS_MODULE,
908 static void rndis_free_inst(struct usb_function_instance *f)
910 struct f_rndis_opts *opts;
912 opts = container_of(f, struct f_rndis_opts, func_inst);
913 if (!opts->borrowed_net) {
915 gether_cleanup(netdev_priv(opts->net));
917 free_netdev(opts->net);
920 kfree(opts->rndis_os_desc.group.default_groups); /* single VLA chunk */
924 static struct usb_function_instance *rndis_alloc_inst(void)
926 struct f_rndis_opts *opts;
927 struct usb_os_desc *descs[1];
930 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
932 return ERR_PTR(-ENOMEM);
933 opts->rndis_os_desc.ext_compat_id = opts->rndis_ext_compat_id;
935 mutex_init(&opts->lock);
936 opts->func_inst.free_func_inst = rndis_free_inst;
937 opts->net = gether_setup_default();
938 if (IS_ERR(opts->net)) {
939 struct net_device *net = opts->net;
941 return ERR_CAST(net);
943 INIT_LIST_HEAD(&opts->rndis_os_desc.ext_prop);
945 descs[0] = &opts->rndis_os_desc;
947 usb_os_desc_prepare_interf_dir(&opts->func_inst.group, 1, descs,
949 config_group_init_type_name(&opts->func_inst.group, "",
952 return &opts->func_inst;
955 static void rndis_free(struct usb_function *f)
957 struct f_rndis *rndis;
958 struct f_rndis_opts *opts;
960 rndis = func_to_rndis(f);
961 rndis_deregister(rndis->params);
962 opts = container_of(f->fi, struct f_rndis_opts, func_inst);
964 mutex_lock(&opts->lock);
966 mutex_unlock(&opts->lock);
969 static void rndis_unbind(struct usb_configuration *c, struct usb_function *f)
971 struct f_rndis *rndis = func_to_rndis(f);
973 kfree(f->os_desc_table);
975 usb_free_all_descriptors(f);
977 kfree(rndis->notify_req->buf);
978 usb_ep_free_request(rndis->notify, rndis->notify_req);
981 static struct usb_function *rndis_alloc(struct usb_function_instance *fi)
983 struct f_rndis *rndis;
984 struct f_rndis_opts *opts;
985 struct rndis_params *params;
987 /* allocate and initialize one new instance */
988 rndis = kzalloc(sizeof(*rndis), GFP_KERNEL);
990 return ERR_PTR(-ENOMEM);
992 opts = container_of(fi, struct f_rndis_opts, func_inst);
993 mutex_lock(&opts->lock);
996 gether_get_host_addr_u8(opts->net, rndis->ethaddr);
997 rndis->vendorID = opts->vendor_id;
998 rndis->manufacturer = opts->manufacturer;
1000 rndis->port.ioport = netdev_priv(opts->net);
1001 mutex_unlock(&opts->lock);
1002 /* RNDIS activates when the host changes this filter */
1003 rndis->port.cdc_filter = 0;
1005 /* RNDIS has special (and complex) framing */
1006 rndis->port.header_len = sizeof(struct rndis_packet_msg_type);
1007 rndis->port.wrap = rndis_add_header;
1008 rndis->port.unwrap = rndis_rm_hdr;
1009 rndis->port.ul_max_pkts_per_xfer = rndis_ul_max_pkt_per_xfer;
1010 rndis->port.dl_max_pkts_per_xfer = rndis_dl_max_pkt_per_xfer;
1012 rndis->port.func.name = "rndis";
1013 /* descriptors are per-instance copies */
1014 rndis->port.func.bind = rndis_bind;
1015 rndis->port.func.unbind = rndis_unbind;
1016 rndis->port.func.set_alt = rndis_set_alt;
1017 rndis->port.func.setup = rndis_setup;
1018 rndis->port.func.disable = rndis_disable;
1019 rndis->port.func.free_func = rndis_free;
1021 params = rndis_register(rndis_response_available, rndis);
1022 if (IS_ERR(params)) {
1024 return ERR_CAST(params);
1026 rndis->params = params;
1028 return &rndis->port.func;
1031 DECLARE_USB_FUNCTION_INIT(rndis, rndis_alloc_inst, rndis_alloc);
1032 MODULE_LICENSE("GPL");
1033 MODULE_AUTHOR("David Brownell");