4 * Authors: Benedikt Spranger, Pengutronix
5 * Robert Schwebel, Pengutronix
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2, as published by the Free Software Foundation.
11 * This software was originally developed in conformance with
12 * Microsoft's Remote NDIS Specification License Agreement.
14 * 03/12/2004 Kai-Uwe Bloem <linux-development@auerswald.de>
15 * Fixed message length bug in init_response
17 * 03/25/2004 Kai-Uwe Bloem <linux-development@auerswald.de>
18 * Fixed rndis_rm_hdr length bug.
20 * Copyright (C) 2004 by David Brownell
21 * updates to merge with Linux 2.6, better match RNDIS spec
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <linux/kernel.h>
27 #include <linux/errno.h>
28 #include <linux/idr.h>
29 #include <linux/list.h>
30 #include <linux/proc_fs.h>
31 #include <linux/slab.h>
32 #include <linux/seq_file.h>
33 #include <linux/netdevice.h>
36 #include <asm/byteorder.h>
37 #include <asm/unaligned.h>
46 /* The driver for your USB chip needs to support ep0 OUT to work with
47 * RNDIS, plus all three CDC Ethernet endpoints (interrupt not optional).
49 * Windows hosts need an INF file like Documentation/usb/linux.inf
50 * and will be happier if you provide the host_addr module parameter.
54 static int rndis_debug = 0;
55 module_param (rndis_debug, int, 0);
56 MODULE_PARM_DESC (rndis_debug, "enable debugging");
61 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
63 #define NAME_TEMPLATE "driver/rndis-%03d"
65 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
67 static DEFINE_IDA(rndis_ida);
70 static const __le32 rndis_driver_version = cpu_to_le32(1);
72 /* Function Prototypes */
73 static rndis_resp_t *rndis_add_response(struct rndis_params *params,
76 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
78 static const struct file_operations rndis_proc_fops;
80 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
83 static const u32 oid_supported_list[] =
85 /* the general stuff */
86 RNDIS_OID_GEN_SUPPORTED_LIST,
87 RNDIS_OID_GEN_HARDWARE_STATUS,
88 RNDIS_OID_GEN_MEDIA_SUPPORTED,
89 RNDIS_OID_GEN_MEDIA_IN_USE,
90 RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE,
91 RNDIS_OID_GEN_LINK_SPEED,
92 RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE,
93 RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE,
94 RNDIS_OID_GEN_VENDOR_ID,
95 RNDIS_OID_GEN_VENDOR_DESCRIPTION,
96 RNDIS_OID_GEN_VENDOR_DRIVER_VERSION,
97 RNDIS_OID_GEN_CURRENT_PACKET_FILTER,
98 RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE,
99 RNDIS_OID_GEN_MEDIA_CONNECT_STATUS,
100 RNDIS_OID_GEN_PHYSICAL_MEDIUM,
102 /* the statistical stuff */
103 RNDIS_OID_GEN_XMIT_OK,
104 RNDIS_OID_GEN_RCV_OK,
105 RNDIS_OID_GEN_XMIT_ERROR,
106 RNDIS_OID_GEN_RCV_ERROR,
107 RNDIS_OID_GEN_RCV_NO_BUFFER,
108 #ifdef RNDIS_OPTIONAL_STATS
109 RNDIS_OID_GEN_DIRECTED_BYTES_XMIT,
110 RNDIS_OID_GEN_DIRECTED_FRAMES_XMIT,
111 RNDIS_OID_GEN_MULTICAST_BYTES_XMIT,
112 RNDIS_OID_GEN_MULTICAST_FRAMES_XMIT,
113 RNDIS_OID_GEN_BROADCAST_BYTES_XMIT,
114 RNDIS_OID_GEN_BROADCAST_FRAMES_XMIT,
115 RNDIS_OID_GEN_DIRECTED_BYTES_RCV,
116 RNDIS_OID_GEN_DIRECTED_FRAMES_RCV,
117 RNDIS_OID_GEN_MULTICAST_BYTES_RCV,
118 RNDIS_OID_GEN_MULTICAST_FRAMES_RCV,
119 RNDIS_OID_GEN_BROADCAST_BYTES_RCV,
120 RNDIS_OID_GEN_BROADCAST_FRAMES_RCV,
121 RNDIS_OID_GEN_RCV_CRC_ERROR,
122 RNDIS_OID_GEN_TRANSMIT_QUEUE_LENGTH,
123 #endif /* RNDIS_OPTIONAL_STATS */
125 /* mandatory 802.3 */
126 /* the general stuff */
127 RNDIS_OID_802_3_PERMANENT_ADDRESS,
128 RNDIS_OID_802_3_CURRENT_ADDRESS,
129 RNDIS_OID_802_3_MULTICAST_LIST,
130 RNDIS_OID_802_3_MAC_OPTIONS,
131 RNDIS_OID_802_3_MAXIMUM_LIST_SIZE,
133 /* the statistical stuff */
134 RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT,
135 RNDIS_OID_802_3_XMIT_ONE_COLLISION,
136 RNDIS_OID_802_3_XMIT_MORE_COLLISIONS,
137 #ifdef RNDIS_OPTIONAL_STATS
138 RNDIS_OID_802_3_XMIT_DEFERRED,
139 RNDIS_OID_802_3_XMIT_MAX_COLLISIONS,
140 RNDIS_OID_802_3_RCV_OVERRUN,
141 RNDIS_OID_802_3_XMIT_UNDERRUN,
142 RNDIS_OID_802_3_XMIT_HEARTBEAT_FAILURE,
143 RNDIS_OID_802_3_XMIT_TIMES_CRS_LOST,
144 RNDIS_OID_802_3_XMIT_LATE_COLLISIONS,
145 #endif /* RNDIS_OPTIONAL_STATS */
148 /* PM and wakeup are "mandatory" for USB, but the RNDIS specs
149 * don't say what they mean ... and the NDIS specs are often
150 * confusing and/or ambiguous in this context. (That is, more
151 * so than their specs for the other OIDs.)
153 * FIXME someone who knows what these should do, please
157 /* power management */
158 OID_PNP_CAPABILITIES,
164 OID_PNP_ENABLE_WAKE_UP,
165 OID_PNP_ADD_WAKE_UP_PATTERN,
166 OID_PNP_REMOVE_WAKE_UP_PATTERN,
167 #endif /* RNDIS_WAKEUP */
168 #endif /* RNDIS_PM */
173 static int gen_ndis_query_resp(struct rndis_params *params, u32 OID, u8 *buf,
174 unsigned buf_len, rndis_resp_t *r)
176 int retval = -ENOTSUPP;
177 u32 length = 4; /* usually */
180 rndis_query_cmplt_type *resp;
181 struct net_device *net;
182 struct rtnl_link_stats64 temp;
183 const struct rtnl_link_stats64 *stats;
185 if (!r) return -ENOMEM;
186 resp = (rndis_query_cmplt_type *)r->buf;
188 if (!resp) return -ENOMEM;
190 if (buf_len && rndis_debug > 1) {
191 pr_debug("query OID %08x value, len %d:\n", OID, buf_len);
192 for (i = 0; i < buf_len; i += 16) {
193 pr_debug("%03d: %08x %08x %08x %08x\n", i,
194 get_unaligned_le32(&buf[i]),
195 get_unaligned_le32(&buf[i + 4]),
196 get_unaligned_le32(&buf[i + 8]),
197 get_unaligned_le32(&buf[i + 12]));
201 /* response goes here, right after the header */
202 outbuf = (__le32 *)&resp[1];
203 resp->InformationBufferOffset = cpu_to_le32(16);
206 stats = dev_get_stats(net, &temp);
210 /* general oids (table 4-1) */
213 case RNDIS_OID_GEN_SUPPORTED_LIST:
214 pr_debug("%s: RNDIS_OID_GEN_SUPPORTED_LIST\n", __func__);
215 length = sizeof(oid_supported_list);
216 count = length / sizeof(u32);
217 for (i = 0; i < count; i++)
218 outbuf[i] = cpu_to_le32(oid_supported_list[i]);
223 case RNDIS_OID_GEN_HARDWARE_STATUS:
224 pr_debug("%s: RNDIS_OID_GEN_HARDWARE_STATUS\n", __func__);
226 * Hardware must be ready to receive high level protocols.
228 * reddite ergo quae sunt Caesaris Caesari
229 * et quae sunt Dei Deo!
231 *outbuf = cpu_to_le32(0);
236 case RNDIS_OID_GEN_MEDIA_SUPPORTED:
237 pr_debug("%s: RNDIS_OID_GEN_MEDIA_SUPPORTED\n", __func__);
238 *outbuf = cpu_to_le32(params->medium);
243 case RNDIS_OID_GEN_MEDIA_IN_USE:
244 pr_debug("%s: RNDIS_OID_GEN_MEDIA_IN_USE\n", __func__);
245 /* one medium, one transport... (maybe you do it better) */
246 *outbuf = cpu_to_le32(params->medium);
251 case RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE:
252 pr_debug("%s: RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE\n", __func__);
254 *outbuf = cpu_to_le32(params->dev->mtu);
260 case RNDIS_OID_GEN_LINK_SPEED:
262 pr_debug("%s: RNDIS_OID_GEN_LINK_SPEED\n", __func__);
263 if (params->media_state == RNDIS_MEDIA_STATE_DISCONNECTED)
264 *outbuf = cpu_to_le32(0);
266 *outbuf = cpu_to_le32(params->speed);
271 case RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE:
272 pr_debug("%s: RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE\n", __func__);
274 *outbuf = cpu_to_le32(params->dev->mtu);
280 case RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE:
281 pr_debug("%s: RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE\n", __func__);
283 *outbuf = cpu_to_le32(params->dev->mtu);
289 case RNDIS_OID_GEN_VENDOR_ID:
290 pr_debug("%s: RNDIS_OID_GEN_VENDOR_ID\n", __func__);
291 *outbuf = cpu_to_le32(params->vendorID);
296 case RNDIS_OID_GEN_VENDOR_DESCRIPTION:
297 pr_debug("%s: RNDIS_OID_GEN_VENDOR_DESCRIPTION\n", __func__);
298 if (params->vendorDescr) {
299 length = strlen(params->vendorDescr);
300 memcpy(outbuf, params->vendorDescr, length);
307 case RNDIS_OID_GEN_VENDOR_DRIVER_VERSION:
308 pr_debug("%s: RNDIS_OID_GEN_VENDOR_DRIVER_VERSION\n", __func__);
310 *outbuf = rndis_driver_version;
315 case RNDIS_OID_GEN_CURRENT_PACKET_FILTER:
316 pr_debug("%s: RNDIS_OID_GEN_CURRENT_PACKET_FILTER\n", __func__);
317 *outbuf = cpu_to_le32(*params->filter);
322 case RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE:
323 pr_debug("%s: RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE\n", __func__);
324 *outbuf = cpu_to_le32(RNDIS_MAX_TOTAL_SIZE);
329 case RNDIS_OID_GEN_MEDIA_CONNECT_STATUS:
331 pr_debug("%s: RNDIS_OID_GEN_MEDIA_CONNECT_STATUS\n", __func__);
332 *outbuf = cpu_to_le32(params->media_state);
336 case RNDIS_OID_GEN_PHYSICAL_MEDIUM:
337 pr_debug("%s: RNDIS_OID_GEN_PHYSICAL_MEDIUM\n", __func__);
338 *outbuf = cpu_to_le32(0);
342 /* The RNDIS specification is incomplete/wrong. Some versions
343 * of MS-Windows expect OIDs that aren't specified there. Other
344 * versions emit undefined RNDIS messages. DOCUMENT ALL THESE!
346 case RNDIS_OID_GEN_MAC_OPTIONS: /* from WinME */
347 pr_debug("%s: RNDIS_OID_GEN_MAC_OPTIONS\n", __func__);
348 *outbuf = cpu_to_le32(
349 RNDIS_MAC_OPTION_RECEIVE_SERIALIZED
350 | RNDIS_MAC_OPTION_FULL_DUPLEX);
354 /* statistics OIDs (table 4-2) */
357 case RNDIS_OID_GEN_XMIT_OK:
359 pr_debug("%s: RNDIS_OID_GEN_XMIT_OK\n", __func__);
361 *outbuf = cpu_to_le32(stats->tx_packets
362 - stats->tx_errors - stats->tx_dropped);
368 case RNDIS_OID_GEN_RCV_OK:
370 pr_debug("%s: RNDIS_OID_GEN_RCV_OK\n", __func__);
372 *outbuf = cpu_to_le32(stats->rx_packets
373 - stats->rx_errors - stats->rx_dropped);
379 case RNDIS_OID_GEN_XMIT_ERROR:
381 pr_debug("%s: RNDIS_OID_GEN_XMIT_ERROR\n", __func__);
383 *outbuf = cpu_to_le32(stats->tx_errors);
389 case RNDIS_OID_GEN_RCV_ERROR:
391 pr_debug("%s: RNDIS_OID_GEN_RCV_ERROR\n", __func__);
393 *outbuf = cpu_to_le32(stats->rx_errors);
399 case RNDIS_OID_GEN_RCV_NO_BUFFER:
400 pr_debug("%s: RNDIS_OID_GEN_RCV_NO_BUFFER\n", __func__);
402 *outbuf = cpu_to_le32(stats->rx_dropped);
407 /* ieee802.3 OIDs (table 4-3) */
410 case RNDIS_OID_802_3_PERMANENT_ADDRESS:
411 pr_debug("%s: RNDIS_OID_802_3_PERMANENT_ADDRESS\n", __func__);
414 memcpy(outbuf, params->host_mac, length);
420 case RNDIS_OID_802_3_CURRENT_ADDRESS:
421 pr_debug("%s: RNDIS_OID_802_3_CURRENT_ADDRESS\n", __func__);
424 memcpy(outbuf, params->host_mac, length);
430 case RNDIS_OID_802_3_MULTICAST_LIST:
431 pr_debug("%s: RNDIS_OID_802_3_MULTICAST_LIST\n", __func__);
432 /* Multicast base address only */
433 *outbuf = cpu_to_le32(0xE0000000);
438 case RNDIS_OID_802_3_MAXIMUM_LIST_SIZE:
439 pr_debug("%s: RNDIS_OID_802_3_MAXIMUM_LIST_SIZE\n", __func__);
440 /* Multicast base address only */
441 *outbuf = cpu_to_le32(1);
445 case RNDIS_OID_802_3_MAC_OPTIONS:
446 pr_debug("%s: RNDIS_OID_802_3_MAC_OPTIONS\n", __func__);
447 *outbuf = cpu_to_le32(0);
451 /* ieee802.3 statistics OIDs (table 4-4) */
454 case RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT:
455 pr_debug("%s: RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT\n", __func__);
457 *outbuf = cpu_to_le32(stats->rx_frame_errors);
463 case RNDIS_OID_802_3_XMIT_ONE_COLLISION:
464 pr_debug("%s: RNDIS_OID_802_3_XMIT_ONE_COLLISION\n", __func__);
465 *outbuf = cpu_to_le32(0);
470 case RNDIS_OID_802_3_XMIT_MORE_COLLISIONS:
471 pr_debug("%s: RNDIS_OID_802_3_XMIT_MORE_COLLISIONS\n", __func__);
472 *outbuf = cpu_to_le32(0);
477 pr_warning("%s: query unknown OID 0x%08X\n",
483 resp->InformationBufferLength = cpu_to_le32(length);
484 r->length = length + sizeof(*resp);
485 resp->MessageLength = cpu_to_le32(r->length);
489 static int gen_ndis_set_resp(struct rndis_params *params, u32 OID,
490 u8 *buf, u32 buf_len, rndis_resp_t *r)
492 rndis_set_cmplt_type *resp;
493 int i, retval = -ENOTSUPP;
497 resp = (rndis_set_cmplt_type *)r->buf;
501 if (buf_len && rndis_debug > 1) {
502 pr_debug("set OID %08x value, len %d:\n", OID, buf_len);
503 for (i = 0; i < buf_len; i += 16) {
504 pr_debug("%03d: %08x %08x %08x %08x\n", i,
505 get_unaligned_le32(&buf[i]),
506 get_unaligned_le32(&buf[i + 4]),
507 get_unaligned_le32(&buf[i + 8]),
508 get_unaligned_le32(&buf[i + 12]));
513 case RNDIS_OID_GEN_CURRENT_PACKET_FILTER:
515 /* these NDIS_PACKET_TYPE_* bitflags are shared with
516 * cdc_filter; it's not RNDIS-specific
517 * NDIS_PACKET_TYPE_x == USB_CDC_PACKET_TYPE_x for x in:
518 * PROMISCUOUS, DIRECTED,
519 * MULTICAST, ALL_MULTICAST, BROADCAST
521 *params->filter = (u16)get_unaligned_le32(buf);
522 pr_debug("%s: RNDIS_OID_GEN_CURRENT_PACKET_FILTER %08x\n",
523 __func__, *params->filter);
525 /* this call has a significant side effect: it's
526 * what makes the packet flow start and stop, like
527 * activating the CDC Ethernet altsetting.
530 if (*params->filter) {
531 params->state = RNDIS_DATA_INITIALIZED;
532 netif_carrier_on(params->dev);
533 if (netif_running(params->dev))
534 netif_wake_queue(params->dev);
536 params->state = RNDIS_INITIALIZED;
537 netif_carrier_off(params->dev);
538 netif_stop_queue(params->dev);
542 case RNDIS_OID_802_3_MULTICAST_LIST:
543 /* I think we can ignore this */
544 pr_debug("%s: RNDIS_OID_802_3_MULTICAST_LIST\n", __func__);
549 pr_warning("%s: set unknown OID 0x%08X, size %d\n",
550 __func__, OID, buf_len);
560 static int rndis_init_response(struct rndis_params *params,
561 rndis_init_msg_type *buf)
563 rndis_init_cmplt_type *resp;
569 r = rndis_add_response(params, sizeof(rndis_init_cmplt_type));
572 resp = (rndis_init_cmplt_type *)r->buf;
574 resp->MessageType = cpu_to_le32(RNDIS_MSG_INIT_C);
575 resp->MessageLength = cpu_to_le32(52);
576 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
577 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
578 resp->MajorVersion = cpu_to_le32(RNDIS_MAJOR_VERSION);
579 resp->MinorVersion = cpu_to_le32(RNDIS_MINOR_VERSION);
580 resp->DeviceFlags = cpu_to_le32(RNDIS_DF_CONNECTIONLESS);
581 resp->Medium = cpu_to_le32(RNDIS_MEDIUM_802_3);
582 resp->MaxPacketsPerTransfer = cpu_to_le32(1);
583 resp->MaxTransferSize = cpu_to_le32(
585 + sizeof(struct ethhdr)
586 + sizeof(struct rndis_packet_msg_type)
588 resp->PacketAlignmentFactor = cpu_to_le32(0);
589 resp->AFListOffset = cpu_to_le32(0);
590 resp->AFListSize = cpu_to_le32(0);
592 params->resp_avail(params->v);
596 static int rndis_query_response(struct rndis_params *params,
597 rndis_query_msg_type *buf)
599 rndis_query_cmplt_type *resp;
602 /* pr_debug("%s: OID = %08X\n", __func__, cpu_to_le32(buf->OID)); */
607 * we need more memory:
608 * gen_ndis_query_resp expects enough space for
609 * rndis_query_cmplt_type followed by data.
610 * oid_supported_list is the largest data reply
612 r = rndis_add_response(params,
613 sizeof(oid_supported_list) + sizeof(rndis_query_cmplt_type));
616 resp = (rndis_query_cmplt_type *)r->buf;
618 resp->MessageType = cpu_to_le32(RNDIS_MSG_QUERY_C);
619 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
621 if (gen_ndis_query_resp(params, le32_to_cpu(buf->OID),
622 le32_to_cpu(buf->InformationBufferOffset)
624 le32_to_cpu(buf->InformationBufferLength),
626 /* OID not supported */
627 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
628 resp->MessageLength = cpu_to_le32(sizeof *resp);
629 resp->InformationBufferLength = cpu_to_le32(0);
630 resp->InformationBufferOffset = cpu_to_le32(0);
632 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
634 params->resp_avail(params->v);
638 static int rndis_set_response(struct rndis_params *params,
639 rndis_set_msg_type *buf)
641 u32 BufLength, BufOffset;
642 rndis_set_cmplt_type *resp;
645 BufLength = le32_to_cpu(buf->InformationBufferLength);
646 BufOffset = le32_to_cpu(buf->InformationBufferOffset);
647 if ((BufLength > RNDIS_MAX_TOTAL_SIZE) ||
648 (BufOffset > RNDIS_MAX_TOTAL_SIZE) ||
649 (BufOffset + 8 >= RNDIS_MAX_TOTAL_SIZE))
652 r = rndis_add_response(params, sizeof(rndis_set_cmplt_type));
655 resp = (rndis_set_cmplt_type *)r->buf;
658 pr_debug("%s: Length: %d\n", __func__, BufLength);
659 pr_debug("%s: Offset: %d\n", __func__, BufOffset);
660 pr_debug("%s: InfoBuffer: ", __func__);
662 for (i = 0; i < BufLength; i++) {
663 pr_debug("%02x ", *(((u8 *) buf) + i + 8 + BufOffset));
669 resp->MessageType = cpu_to_le32(RNDIS_MSG_SET_C);
670 resp->MessageLength = cpu_to_le32(16);
671 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
672 if (gen_ndis_set_resp(params, le32_to_cpu(buf->OID),
673 ((u8 *)buf) + 8 + BufOffset, BufLength, r))
674 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
676 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
678 params->resp_avail(params->v);
682 static int rndis_reset_response(struct rndis_params *params,
683 rndis_reset_msg_type *buf)
685 rndis_reset_cmplt_type *resp;
690 /* drain the response queue */
691 while ((xbuf = rndis_get_next_response(params, &length)))
692 rndis_free_response(params, xbuf);
694 r = rndis_add_response(params, sizeof(rndis_reset_cmplt_type));
697 resp = (rndis_reset_cmplt_type *)r->buf;
699 resp->MessageType = cpu_to_le32(RNDIS_MSG_RESET_C);
700 resp->MessageLength = cpu_to_le32(16);
701 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
702 /* resent information */
703 resp->AddressingReset = cpu_to_le32(1);
705 params->resp_avail(params->v);
709 static int rndis_keepalive_response(struct rndis_params *params,
710 rndis_keepalive_msg_type *buf)
712 rndis_keepalive_cmplt_type *resp;
715 /* host "should" check only in RNDIS_DATA_INITIALIZED state */
717 r = rndis_add_response(params, sizeof(rndis_keepalive_cmplt_type));
720 resp = (rndis_keepalive_cmplt_type *)r->buf;
722 resp->MessageType = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C);
723 resp->MessageLength = cpu_to_le32(16);
724 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
725 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
727 params->resp_avail(params->v);
733 * Device to Host Comunication
735 static int rndis_indicate_status_msg(struct rndis_params *params, u32 status)
737 rndis_indicate_status_msg_type *resp;
740 if (params->state == RNDIS_UNINITIALIZED)
743 r = rndis_add_response(params, sizeof(rndis_indicate_status_msg_type));
746 resp = (rndis_indicate_status_msg_type *)r->buf;
748 resp->MessageType = cpu_to_le32(RNDIS_MSG_INDICATE);
749 resp->MessageLength = cpu_to_le32(20);
750 resp->Status = cpu_to_le32(status);
751 resp->StatusBufferLength = cpu_to_le32(0);
752 resp->StatusBufferOffset = cpu_to_le32(0);
754 params->resp_avail(params->v);
758 int rndis_signal_connect(struct rndis_params *params)
760 params->media_state = RNDIS_MEDIA_STATE_CONNECTED;
761 return rndis_indicate_status_msg(params, RNDIS_STATUS_MEDIA_CONNECT);
763 EXPORT_SYMBOL_GPL(rndis_signal_connect);
765 int rndis_signal_disconnect(struct rndis_params *params)
767 params->media_state = RNDIS_MEDIA_STATE_DISCONNECTED;
768 return rndis_indicate_status_msg(params, RNDIS_STATUS_MEDIA_DISCONNECT);
770 EXPORT_SYMBOL_GPL(rndis_signal_disconnect);
772 void rndis_uninit(struct rndis_params *params)
779 params->state = RNDIS_UNINITIALIZED;
781 /* drain the response queue */
782 while ((buf = rndis_get_next_response(params, &length)))
783 rndis_free_response(params, buf);
785 EXPORT_SYMBOL_GPL(rndis_uninit);
787 void rndis_set_host_mac(struct rndis_params *params, const u8 *addr)
789 params->host_mac = addr;
791 EXPORT_SYMBOL_GPL(rndis_set_host_mac);
796 int rndis_msg_parser(struct rndis_params *params, u8 *buf)
798 u32 MsgType, MsgLength;
805 MsgType = get_unaligned_le32(tmp++);
806 MsgLength = get_unaligned_le32(tmp++);
811 /* NOTE: RNDIS is *EXTREMELY* chatty ... Windows constantly polls for
812 * rx/tx statistics and link status, in addition to KEEPALIVE traffic
813 * and normal HC level polling to see if there's any IN traffic.
816 /* For USB: responses may take up to 10 seconds */
819 pr_debug("%s: RNDIS_MSG_INIT\n",
821 params->state = RNDIS_INITIALIZED;
822 return rndis_init_response(params, (rndis_init_msg_type *)buf);
825 pr_debug("%s: RNDIS_MSG_HALT\n",
827 params->state = RNDIS_UNINITIALIZED;
829 netif_carrier_off(params->dev);
830 netif_stop_queue(params->dev);
834 case RNDIS_MSG_QUERY:
835 return rndis_query_response(params,
836 (rndis_query_msg_type *)buf);
839 return rndis_set_response(params, (rndis_set_msg_type *)buf);
841 case RNDIS_MSG_RESET:
842 pr_debug("%s: RNDIS_MSG_RESET\n",
844 return rndis_reset_response(params,
845 (rndis_reset_msg_type *)buf);
847 case RNDIS_MSG_KEEPALIVE:
848 /* For USB: host does this every 5 seconds */
850 pr_debug("%s: RNDIS_MSG_KEEPALIVE\n",
852 return rndis_keepalive_response(params,
853 (rndis_keepalive_msg_type *)
857 /* At least Windows XP emits some undefined RNDIS messages.
858 * In one case those messages seemed to relate to the host
861 pr_warning("%s: unknown RNDIS message 0x%08X len %d\n",
862 __func__, MsgType, MsgLength);
863 print_hex_dump_bytes(__func__, DUMP_PREFIX_OFFSET,
870 EXPORT_SYMBOL_GPL(rndis_msg_parser);
872 static inline int rndis_get_nr(void)
874 return ida_simple_get(&rndis_ida, 0, 0, GFP_KERNEL);
877 static inline void rndis_put_nr(int nr)
879 ida_simple_remove(&rndis_ida, nr);
882 struct rndis_params *rndis_register(void (*resp_avail)(void *v), void *v)
884 struct rndis_params *params;
888 return ERR_PTR(-EINVAL);
892 pr_debug("failed\n");
894 return ERR_PTR(-ENODEV);
897 params = kzalloc(sizeof(*params), GFP_KERNEL);
901 return ERR_PTR(-ENOMEM);
904 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
906 struct proc_dir_entry *proc_entry;
909 sprintf(name, NAME_TEMPLATE, i);
910 proc_entry = proc_create_data(name, 0660, NULL,
911 &rndis_proc_fops, params);
916 return ERR_PTR(-EIO);
921 params->confignr = i;
923 params->state = RNDIS_UNINITIALIZED;
924 params->media_state = RNDIS_MEDIA_STATE_DISCONNECTED;
925 params->resp_avail = resp_avail;
927 INIT_LIST_HEAD(¶ms->resp_queue);
928 spin_lock_init(¶ms->resp_lock);
929 pr_debug("%s: configNr = %d\n", __func__, i);
933 EXPORT_SYMBOL_GPL(rndis_register);
935 void rndis_deregister(struct rndis_params *params)
939 pr_debug("%s:\n", __func__);
944 i = params->confignr;
946 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
950 sprintf(name, NAME_TEMPLATE, i);
951 remove_proc_entry(name, NULL);
958 EXPORT_SYMBOL_GPL(rndis_deregister);
959 int rndis_set_param_dev(struct rndis_params *params, struct net_device *dev,
962 pr_debug("%s:\n", __func__);
969 params->filter = cdc_filter;
973 EXPORT_SYMBOL_GPL(rndis_set_param_dev);
975 int rndis_set_param_vendor(struct rndis_params *params, u32 vendorID,
976 const char *vendorDescr)
978 pr_debug("%s:\n", __func__);
979 if (!vendorDescr) return -1;
983 params->vendorID = vendorID;
984 params->vendorDescr = vendorDescr;
988 EXPORT_SYMBOL_GPL(rndis_set_param_vendor);
990 int rndis_set_param_medium(struct rndis_params *params, u32 medium, u32 speed)
992 pr_debug("%s: %u %u\n", __func__, medium, speed);
996 params->medium = medium;
997 params->speed = speed;
1001 EXPORT_SYMBOL_GPL(rndis_set_param_medium);
1003 void rndis_add_hdr(struct sk_buff *skb)
1005 struct rndis_packet_msg_type *header;
1009 header = (void *)skb_push(skb, sizeof(*header));
1010 memset(header, 0, sizeof *header);
1011 header->MessageType = cpu_to_le32(RNDIS_MSG_PACKET);
1012 header->MessageLength = cpu_to_le32(skb->len);
1013 header->DataOffset = cpu_to_le32(36);
1014 header->DataLength = cpu_to_le32(skb->len - sizeof(*header));
1016 EXPORT_SYMBOL_GPL(rndis_add_hdr);
1018 void rndis_free_response(struct rndis_params *params, u8 *buf)
1020 rndis_resp_t *r, *n;
1022 spin_lock(¶ms->resp_lock);
1023 list_for_each_entry_safe(r, n, ¶ms->resp_queue, list) {
1024 if (r->buf == buf) {
1029 spin_unlock(¶ms->resp_lock);
1031 EXPORT_SYMBOL_GPL(rndis_free_response);
1033 u8 *rndis_get_next_response(struct rndis_params *params, u32 *length)
1035 rndis_resp_t *r, *n;
1037 if (!length) return NULL;
1039 spin_lock(¶ms->resp_lock);
1040 list_for_each_entry_safe(r, n, ¶ms->resp_queue, list) {
1043 *length = r->length;
1044 spin_unlock(¶ms->resp_lock);
1049 spin_unlock(¶ms->resp_lock);
1052 EXPORT_SYMBOL_GPL(rndis_get_next_response);
1054 static rndis_resp_t *rndis_add_response(struct rndis_params *params, u32 length)
1058 /* NOTE: this gets copied into ether.c USB_BUFSIZ bytes ... */
1059 r = kmalloc(sizeof(rndis_resp_t) + length, GFP_ATOMIC);
1060 if (!r) return NULL;
1062 r->buf = (u8 *)(r + 1);
1066 spin_lock(¶ms->resp_lock);
1067 list_add_tail(&r->list, ¶ms->resp_queue);
1068 spin_unlock(¶ms->resp_lock);
1072 int rndis_rm_hdr(struct gether *port,
1073 struct sk_buff *skb,
1074 struct sk_buff_head *list)
1076 /* tmp points to a struct rndis_packet_msg_type */
1077 __le32 *tmp = (void *)skb->data;
1079 /* MessageType, MessageLength */
1080 if (cpu_to_le32(RNDIS_MSG_PACKET)
1081 != get_unaligned(tmp++)) {
1082 dev_kfree_skb_any(skb);
1087 /* DataOffset, DataLength */
1088 if (!skb_pull(skb, get_unaligned_le32(tmp++) + 8)) {
1089 dev_kfree_skb_any(skb);
1092 skb_trim(skb, get_unaligned_le32(tmp++));
1094 skb_queue_tail(list, skb);
1097 EXPORT_SYMBOL_GPL(rndis_rm_hdr);
1099 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1101 static int rndis_proc_show(struct seq_file *m, void *v)
1103 rndis_params *param = m->private;
1112 "vendor ID : 0x%08X\n"
1114 param->confignr, (param->used) ? "y" : "n",
1116 switch (param->state) {
1117 case RNDIS_UNINITIALIZED:
1118 s = "RNDIS_UNINITIALIZED"; break;
1119 case RNDIS_INITIALIZED:
1120 s = "RNDIS_INITIALIZED"; break;
1121 case RNDIS_DATA_INITIALIZED:
1122 s = "RNDIS_DATA_INITIALIZED"; break;
1125 (param->media_state) ? 0 : param->speed*100,
1126 (param->media_state) ? "disconnected" : "connected",
1127 param->vendorID, param->vendorDescr);
1131 static ssize_t rndis_proc_write(struct file *file, const char __user *buffer,
1132 size_t count, loff_t *ppos)
1134 rndis_params *p = PDE_DATA(file_inode(file));
1136 int i, fl_speed = 0;
1138 for (i = 0; i < count; i++) {
1140 if (get_user(c, buffer))
1154 speed = speed * 10 + c - '0';
1158 rndis_signal_connect(p);
1162 rndis_signal_disconnect(p);
1165 if (fl_speed) p->speed = speed;
1166 else pr_debug("%c is not valid\n", c);
1176 static int rndis_proc_open(struct inode *inode, struct file *file)
1178 return single_open(file, rndis_proc_show, PDE_DATA(inode));
1181 static const struct file_operations rndis_proc_fops = {
1182 .owner = THIS_MODULE,
1183 .open = rndis_proc_open,
1185 .llseek = seq_lseek,
1186 .release = single_release,
1187 .write = rndis_proc_write,
1190 #define NAME_TEMPLATE "driver/rndis-%03d"
1192 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */