4 * Version: $Id: rndis.c,v 1.19 2004/03/25 21:33:46 robert Exp $
6 * Authors: Benedikt Spranger, Pengutronix
7 * Robert Schwebel, Pengutronix
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * version 2, as published by the Free Software Foundation.
13 * This software was originally developed in conformance with
14 * Microsoft's Remote NDIS Specification License Agreement.
16 * 03/12/2004 Kai-Uwe Bloem <linux-development@auerswald.de>
17 * Fixed message length bug in init_response
19 * 03/25/2004 Kai-Uwe Bloem <linux-development@auerswald.de>
20 * Fixed rndis_rm_hdr length bug.
22 * Copyright (C) 2004 by David Brownell
23 * updates to merge with Linux 2.6, better match RNDIS spec
26 #include <linux/config.h>
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/kernel.h>
30 #include <linux/errno.h>
31 #include <linux/init.h>
32 #include <linux/list.h>
33 #include <linux/proc_fs.h>
34 #include <linux/netdevice.h>
37 #include <asm/byteorder.h>
38 #include <asm/system.h>
39 #include <asm/unaligned.h>
49 /* The driver for your USB chip needs to support ep0 OUT to work with
50 * RNDIS, plus all three CDC Ethernet endpoints (interrupt not optional).
52 * Windows hosts need an INF file like Documentation/usb/linux.inf
53 * and will be happier if you provide the host_addr module parameter.
57 #define DEBUG(str,args...) do { \
59 printk(KERN_DEBUG str , ## args ); \
61 static int rndis_debug = 0;
63 module_param (rndis_debug, int, 0);
64 MODULE_PARM_DESC (rndis_debug, "enable debugging");
69 #define DEBUG(str,args...) do{}while(0)
72 #define RNDIS_MAX_CONFIGS 1
75 static rndis_params rndis_per_dev_params [RNDIS_MAX_CONFIGS];
78 static const __le32 rndis_driver_version = __constant_cpu_to_le32 (1);
80 /* Function Prototypes */
81 static rndis_resp_t *rndis_add_response (int configNr, u32 length);
85 static const u32 oid_supported_list [] =
87 /* the general stuff */
88 OID_GEN_SUPPORTED_LIST,
89 OID_GEN_HARDWARE_STATUS,
90 OID_GEN_MEDIA_SUPPORTED,
92 OID_GEN_MAXIMUM_FRAME_SIZE,
94 OID_GEN_TRANSMIT_BLOCK_SIZE,
95 OID_GEN_RECEIVE_BLOCK_SIZE,
97 OID_GEN_VENDOR_DESCRIPTION,
98 OID_GEN_VENDOR_DRIVER_VERSION,
99 OID_GEN_CURRENT_PACKET_FILTER,
100 OID_GEN_MAXIMUM_TOTAL_SIZE,
101 OID_GEN_MEDIA_CONNECT_STATUS,
102 OID_GEN_PHYSICAL_MEDIUM,
104 OID_GEN_RNDIS_CONFIG_PARAMETER,
107 /* the statistical stuff */
112 OID_GEN_RCV_NO_BUFFER,
113 #ifdef RNDIS_OPTIONAL_STATS
114 OID_GEN_DIRECTED_BYTES_XMIT,
115 OID_GEN_DIRECTED_FRAMES_XMIT,
116 OID_GEN_MULTICAST_BYTES_XMIT,
117 OID_GEN_MULTICAST_FRAMES_XMIT,
118 OID_GEN_BROADCAST_BYTES_XMIT,
119 OID_GEN_BROADCAST_FRAMES_XMIT,
120 OID_GEN_DIRECTED_BYTES_RCV,
121 OID_GEN_DIRECTED_FRAMES_RCV,
122 OID_GEN_MULTICAST_BYTES_RCV,
123 OID_GEN_MULTICAST_FRAMES_RCV,
124 OID_GEN_BROADCAST_BYTES_RCV,
125 OID_GEN_BROADCAST_FRAMES_RCV,
126 OID_GEN_RCV_CRC_ERROR,
127 OID_GEN_TRANSMIT_QUEUE_LENGTH,
128 #endif /* RNDIS_OPTIONAL_STATS */
130 /* mandatory 802.3 */
131 /* the general stuff */
132 OID_802_3_PERMANENT_ADDRESS,
133 OID_802_3_CURRENT_ADDRESS,
134 OID_802_3_MULTICAST_LIST,
135 OID_802_3_MAC_OPTIONS,
136 OID_802_3_MAXIMUM_LIST_SIZE,
138 /* the statistical stuff */
139 OID_802_3_RCV_ERROR_ALIGNMENT,
140 OID_802_3_XMIT_ONE_COLLISION,
141 OID_802_3_XMIT_MORE_COLLISIONS,
142 #ifdef RNDIS_OPTIONAL_STATS
143 OID_802_3_XMIT_DEFERRED,
144 OID_802_3_XMIT_MAX_COLLISIONS,
145 OID_802_3_RCV_OVERRUN,
146 OID_802_3_XMIT_UNDERRUN,
147 OID_802_3_XMIT_HEARTBEAT_FAILURE,
148 OID_802_3_XMIT_TIMES_CRS_LOST,
149 OID_802_3_XMIT_LATE_COLLISIONS,
150 #endif /* RNDIS_OPTIONAL_STATS */
153 /* PM and wakeup are mandatory for USB: */
155 /* power management */
156 OID_PNP_CAPABILITIES,
162 OID_PNP_ENABLE_WAKE_UP,
163 OID_PNP_ADD_WAKE_UP_PATTERN,
164 OID_PNP_REMOVE_WAKE_UP_PATTERN,
165 #endif /* RNDIS_WAKEUP */
166 #endif /* RNDIS_PM */
172 gen_ndis_query_resp (int configNr, u32 OID, u8 *buf, unsigned buf_len,
175 int retval = -ENOTSUPP;
176 u32 length = 4; /* usually */
179 rndis_query_cmplt_type *resp;
181 if (!r) return -ENOMEM;
182 resp = (rndis_query_cmplt_type *) r->buf;
184 if (!resp) return -ENOMEM;
186 if (buf_len && rndis_debug > 1) {
187 DEBUG("query OID %08x value, len %d:\n", OID, buf_len);
188 for (i = 0; i < buf_len; i += 16) {
189 DEBUG ("%03d: %08x %08x %08x %08x\n", i,
190 le32_to_cpup((__le32 *)&buf[i]),
191 le32_to_cpup((__le32 *)&buf[i + 4]),
192 le32_to_cpup((__le32 *)&buf[i + 8]),
193 le32_to_cpup((__le32 *)&buf[i + 12]));
197 /* response goes here, right after the header */
198 outbuf = (__le32 *) &resp[1];
199 resp->InformationBufferOffset = __constant_cpu_to_le32 (16);
203 /* general oids (table 4-1) */
206 case OID_GEN_SUPPORTED_LIST:
207 DEBUG ("%s: OID_GEN_SUPPORTED_LIST\n", __FUNCTION__);
208 length = sizeof (oid_supported_list);
209 count = length / sizeof (u32);
210 for (i = 0; i < count; i++)
211 outbuf[i] = cpu_to_le32 (oid_supported_list[i]);
216 case OID_GEN_HARDWARE_STATUS:
217 DEBUG("%s: OID_GEN_HARDWARE_STATUS\n", __FUNCTION__);
219 * Hardware must be ready to receive high level protocols.
221 * reddite ergo quae sunt Caesaris Caesari
222 * et quae sunt Dei Deo!
224 *outbuf = __constant_cpu_to_le32 (0);
229 case OID_GEN_MEDIA_SUPPORTED:
230 DEBUG("%s: OID_GEN_MEDIA_SUPPORTED\n", __FUNCTION__);
231 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr].medium);
236 case OID_GEN_MEDIA_IN_USE:
237 DEBUG("%s: OID_GEN_MEDIA_IN_USE\n", __FUNCTION__);
238 /* one medium, one transport... (maybe you do it better) */
239 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr].medium);
244 case OID_GEN_MAXIMUM_FRAME_SIZE:
245 DEBUG("%s: OID_GEN_MAXIMUM_FRAME_SIZE\n", __FUNCTION__);
246 if (rndis_per_dev_params [configNr].dev) {
247 *outbuf = cpu_to_le32 (
248 rndis_per_dev_params [configNr].dev->mtu);
254 case OID_GEN_LINK_SPEED:
256 DEBUG("%s: OID_GEN_LINK_SPEED\n", __FUNCTION__);
257 if (rndis_per_dev_params [configNr].media_state
258 == NDIS_MEDIA_STATE_DISCONNECTED)
259 *outbuf = __constant_cpu_to_le32 (0);
261 *outbuf = cpu_to_le32 (
262 rndis_per_dev_params [configNr].speed);
267 case OID_GEN_TRANSMIT_BLOCK_SIZE:
268 DEBUG("%s: OID_GEN_TRANSMIT_BLOCK_SIZE\n", __FUNCTION__);
269 if (rndis_per_dev_params [configNr].dev) {
270 *outbuf = cpu_to_le32 (
271 rndis_per_dev_params [configNr].dev->mtu);
277 case OID_GEN_RECEIVE_BLOCK_SIZE:
278 DEBUG("%s: OID_GEN_RECEIVE_BLOCK_SIZE\n", __FUNCTION__);
279 if (rndis_per_dev_params [configNr].dev) {
280 *outbuf = cpu_to_le32 (
281 rndis_per_dev_params [configNr].dev->mtu);
287 case OID_GEN_VENDOR_ID:
288 DEBUG("%s: OID_GEN_VENDOR_ID\n", __FUNCTION__);
289 *outbuf = cpu_to_le32 (
290 rndis_per_dev_params [configNr].vendorID);
295 case OID_GEN_VENDOR_DESCRIPTION:
296 DEBUG("%s: OID_GEN_VENDOR_DESCRIPTION\n", __FUNCTION__);
297 length = strlen (rndis_per_dev_params [configNr].vendorDescr);
299 rndis_per_dev_params [configNr].vendorDescr, length);
303 case OID_GEN_VENDOR_DRIVER_VERSION:
304 DEBUG("%s: OID_GEN_VENDOR_DRIVER_VERSION\n", __FUNCTION__);
306 *outbuf = rndis_driver_version;
311 case OID_GEN_CURRENT_PACKET_FILTER:
312 DEBUG("%s: OID_GEN_CURRENT_PACKET_FILTER\n", __FUNCTION__);
313 *outbuf = cpu_to_le32 (*rndis_per_dev_params[configNr].filter);
318 case OID_GEN_MAXIMUM_TOTAL_SIZE:
319 DEBUG("%s: OID_GEN_MAXIMUM_TOTAL_SIZE\n", __FUNCTION__);
320 *outbuf = __constant_cpu_to_le32(RNDIS_MAX_TOTAL_SIZE);
325 case OID_GEN_MEDIA_CONNECT_STATUS:
327 DEBUG("%s: OID_GEN_MEDIA_CONNECT_STATUS\n", __FUNCTION__);
328 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
333 case OID_GEN_PHYSICAL_MEDIUM:
334 DEBUG("%s: OID_GEN_PHYSICAL_MEDIUM\n", __FUNCTION__);
335 *outbuf = __constant_cpu_to_le32 (0);
339 /* The RNDIS specification is incomplete/wrong. Some versions
340 * of MS-Windows expect OIDs that aren't specified there. Other
341 * versions emit undefined RNDIS messages. DOCUMENT ALL THESE!
343 case OID_GEN_MAC_OPTIONS: /* from WinME */
344 DEBUG("%s: OID_GEN_MAC_OPTIONS\n", __FUNCTION__);
345 *outbuf = __constant_cpu_to_le32(
346 NDIS_MAC_OPTION_RECEIVE_SERIALIZED
347 | NDIS_MAC_OPTION_FULL_DUPLEX);
351 /* statistics OIDs (table 4-2) */
354 case OID_GEN_XMIT_OK:
356 DEBUG("%s: OID_GEN_XMIT_OK\n", __FUNCTION__);
357 if (rndis_per_dev_params [configNr].stats) {
358 *outbuf = cpu_to_le32 (
359 rndis_per_dev_params [configNr].stats->tx_packets -
360 rndis_per_dev_params [configNr].stats->tx_errors -
361 rndis_per_dev_params [configNr].stats->tx_dropped);
369 DEBUG("%s: OID_GEN_RCV_OK\n", __FUNCTION__);
370 if (rndis_per_dev_params [configNr].stats) {
371 *outbuf = cpu_to_le32 (
372 rndis_per_dev_params [configNr].stats->rx_packets -
373 rndis_per_dev_params [configNr].stats->rx_errors -
374 rndis_per_dev_params [configNr].stats->rx_dropped);
380 case OID_GEN_XMIT_ERROR:
382 DEBUG("%s: OID_GEN_XMIT_ERROR\n", __FUNCTION__);
383 if (rndis_per_dev_params [configNr].stats) {
384 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
391 case OID_GEN_RCV_ERROR:
393 DEBUG("%s: OID_GEN_RCV_ERROR\n", __FUNCTION__);
394 if (rndis_per_dev_params [configNr].stats) {
395 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
402 case OID_GEN_RCV_NO_BUFFER:
403 DEBUG("%s: OID_GEN_RCV_NO_BUFFER\n", __FUNCTION__);
404 if (rndis_per_dev_params [configNr].stats) {
405 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
411 #ifdef RNDIS_OPTIONAL_STATS
412 case OID_GEN_DIRECTED_BYTES_XMIT:
413 DEBUG("%s: OID_GEN_DIRECTED_BYTES_XMIT\n", __FUNCTION__);
415 * Aunt Tilly's size of shoes
416 * minus antarctica count of penguins
417 * divided by weight of Alpha Centauri
419 if (rndis_per_dev_params [configNr].stats) {
420 *outbuf = cpu_to_le32 (
421 (rndis_per_dev_params [configNr]
423 rndis_per_dev_params [configNr]
425 rndis_per_dev_params [configNr]
432 case OID_GEN_DIRECTED_FRAMES_XMIT:
433 DEBUG("%s: OID_GEN_DIRECTED_FRAMES_XMIT\n", __FUNCTION__);
435 if (rndis_per_dev_params [configNr].stats) {
436 *outbuf = cpu_to_le32 (
437 (rndis_per_dev_params [configNr]
439 rndis_per_dev_params [configNr]
441 rndis_per_dev_params [configNr]
448 case OID_GEN_MULTICAST_BYTES_XMIT:
449 DEBUG("%s: OID_GEN_MULTICAST_BYTES_XMIT\n", __FUNCTION__);
450 if (rndis_per_dev_params [configNr].stats) {
451 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
452 .stats->multicast*1234);
457 case OID_GEN_MULTICAST_FRAMES_XMIT:
458 DEBUG("%s: OID_GEN_MULTICAST_FRAMES_XMIT\n", __FUNCTION__);
459 if (rndis_per_dev_params [configNr].stats) {
460 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
466 case OID_GEN_BROADCAST_BYTES_XMIT:
467 DEBUG("%s: OID_GEN_BROADCAST_BYTES_XMIT\n", __FUNCTION__);
468 if (rndis_per_dev_params [configNr].stats) {
469 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
470 .stats->tx_packets/42*255);
475 case OID_GEN_BROADCAST_FRAMES_XMIT:
476 DEBUG("%s: OID_GEN_BROADCAST_FRAMES_XMIT\n", __FUNCTION__);
477 if (rndis_per_dev_params [configNr].stats) {
478 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
479 .stats->tx_packets/42);
484 case OID_GEN_DIRECTED_BYTES_RCV:
485 DEBUG("%s: OID_GEN_DIRECTED_BYTES_RCV\n", __FUNCTION__);
486 *outbuf = __constant_cpu_to_le32 (0);
490 case OID_GEN_DIRECTED_FRAMES_RCV:
491 DEBUG("%s: OID_GEN_DIRECTED_FRAMES_RCV\n", __FUNCTION__);
492 *outbuf = __constant_cpu_to_le32 (0);
496 case OID_GEN_MULTICAST_BYTES_RCV:
497 DEBUG("%s: OID_GEN_MULTICAST_BYTES_RCV\n", __FUNCTION__);
498 if (rndis_per_dev_params [configNr].stats) {
499 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
500 .stats->multicast * 1111);
505 case OID_GEN_MULTICAST_FRAMES_RCV:
506 DEBUG("%s: OID_GEN_MULTICAST_FRAMES_RCV\n", __FUNCTION__);
507 if (rndis_per_dev_params [configNr].stats) {
508 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
514 case OID_GEN_BROADCAST_BYTES_RCV:
515 DEBUG("%s: OID_GEN_BROADCAST_BYTES_RCV\n", __FUNCTION__);
516 if (rndis_per_dev_params [configNr].stats) {
517 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
518 .stats->rx_packets/42*255);
523 case OID_GEN_BROADCAST_FRAMES_RCV:
524 DEBUG("%s: OID_GEN_BROADCAST_FRAMES_RCV\n", __FUNCTION__);
525 if (rndis_per_dev_params [configNr].stats) {
526 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
527 .stats->rx_packets/42);
532 case OID_GEN_RCV_CRC_ERROR:
533 DEBUG("%s: OID_GEN_RCV_CRC_ERROR\n", __FUNCTION__);
534 if (rndis_per_dev_params [configNr].stats) {
535 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
536 .stats->rx_crc_errors);
541 case OID_GEN_TRANSMIT_QUEUE_LENGTH:
542 DEBUG("%s: OID_GEN_TRANSMIT_QUEUE_LENGTH\n", __FUNCTION__);
543 *outbuf = __constant_cpu_to_le32 (0);
546 #endif /* RNDIS_OPTIONAL_STATS */
548 /* ieee802.3 OIDs (table 4-3) */
551 case OID_802_3_PERMANENT_ADDRESS:
552 DEBUG("%s: OID_802_3_PERMANENT_ADDRESS\n", __FUNCTION__);
553 if (rndis_per_dev_params [configNr].dev) {
556 rndis_per_dev_params [configNr].host_mac,
563 case OID_802_3_CURRENT_ADDRESS:
564 DEBUG("%s: OID_802_3_CURRENT_ADDRESS\n", __FUNCTION__);
565 if (rndis_per_dev_params [configNr].dev) {
568 rndis_per_dev_params [configNr].host_mac,
575 case OID_802_3_MULTICAST_LIST:
576 DEBUG("%s: OID_802_3_MULTICAST_LIST\n", __FUNCTION__);
577 /* Multicast base address only */
578 *outbuf = __constant_cpu_to_le32 (0xE0000000);
583 case OID_802_3_MAXIMUM_LIST_SIZE:
584 DEBUG("%s: OID_802_3_MAXIMUM_LIST_SIZE\n", __FUNCTION__);
585 /* Multicast base address only */
586 *outbuf = __constant_cpu_to_le32 (1);
590 case OID_802_3_MAC_OPTIONS:
591 DEBUG("%s: OID_802_3_MAC_OPTIONS\n", __FUNCTION__);
594 /* ieee802.3 statistics OIDs (table 4-4) */
597 case OID_802_3_RCV_ERROR_ALIGNMENT:
598 DEBUG("%s: OID_802_3_RCV_ERROR_ALIGNMENT\n", __FUNCTION__);
599 if (rndis_per_dev_params [configNr].stats) {
600 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
601 .stats->rx_frame_errors);
607 case OID_802_3_XMIT_ONE_COLLISION:
608 DEBUG("%s: OID_802_3_XMIT_ONE_COLLISION\n", __FUNCTION__);
609 *outbuf = __constant_cpu_to_le32 (0);
614 case OID_802_3_XMIT_MORE_COLLISIONS:
615 DEBUG("%s: OID_802_3_XMIT_MORE_COLLISIONS\n", __FUNCTION__);
616 *outbuf = __constant_cpu_to_le32 (0);
620 #ifdef RNDIS_OPTIONAL_STATS
621 case OID_802_3_XMIT_DEFERRED:
622 DEBUG("%s: OID_802_3_XMIT_DEFERRED\n", __FUNCTION__);
626 case OID_802_3_XMIT_MAX_COLLISIONS:
627 DEBUG("%s: OID_802_3_XMIT_MAX_COLLISIONS\n", __FUNCTION__);
631 case OID_802_3_RCV_OVERRUN:
632 DEBUG("%s: OID_802_3_RCV_OVERRUN\n", __FUNCTION__);
636 case OID_802_3_XMIT_UNDERRUN:
637 DEBUG("%s: OID_802_3_XMIT_UNDERRUN\n", __FUNCTION__);
641 case OID_802_3_XMIT_HEARTBEAT_FAILURE:
642 DEBUG("%s: OID_802_3_XMIT_HEARTBEAT_FAILURE\n", __FUNCTION__);
646 case OID_802_3_XMIT_TIMES_CRS_LOST:
647 DEBUG("%s: OID_802_3_XMIT_TIMES_CRS_LOST\n", __FUNCTION__);
651 case OID_802_3_XMIT_LATE_COLLISIONS:
652 DEBUG("%s: OID_802_3_XMIT_LATE_COLLISIONS\n", __FUNCTION__);
655 #endif /* RNDIS_OPTIONAL_STATS */
658 /* power management OIDs (table 4-5) */
659 case OID_PNP_CAPABILITIES:
660 DEBUG("%s: OID_PNP_CAPABILITIES\n", __FUNCTION__);
662 /* for now, no wakeup capabilities */
663 length = sizeof (struct NDIS_PNP_CAPABILITIES);
664 memset(outbuf, 0, length);
667 case OID_PNP_QUERY_POWER:
668 DEBUG("%s: OID_PNP_QUERY_POWER D%d\n", __FUNCTION__,
669 le32_to_cpup((__le32 *) buf) - 1);
670 /* only suspend is a real power state, and
671 * it can't be entered by OID_PNP_SET_POWER...
679 printk (KERN_WARNING "%s: query unknown OID 0x%08X\n",
685 resp->InformationBufferLength = cpu_to_le32 (length);
686 r->length = length + sizeof *resp;
687 resp->MessageLength = cpu_to_le32 (r->length);
691 static int gen_ndis_set_resp (u8 configNr, u32 OID, u8 *buf, u32 buf_len,
694 rndis_set_cmplt_type *resp;
695 int i, retval = -ENOTSUPP;
696 struct rndis_params *params;
700 resp = (rndis_set_cmplt_type *) r->buf;
704 if (buf_len && rndis_debug > 1) {
705 DEBUG("set OID %08x value, len %d:\n", OID, buf_len);
706 for (i = 0; i < buf_len; i += 16) {
707 DEBUG ("%03d: %08x %08x %08x %08x\n", i,
708 le32_to_cpup((__le32 *)&buf[i]),
709 le32_to_cpup((__le32 *)&buf[i + 4]),
710 le32_to_cpup((__le32 *)&buf[i + 8]),
711 le32_to_cpup((__le32 *)&buf[i + 12]));
715 params = &rndis_per_dev_params [configNr];
717 case OID_GEN_CURRENT_PACKET_FILTER:
719 /* these NDIS_PACKET_TYPE_* bitflags are shared with
720 * cdc_filter; it's not RNDIS-specific
721 * NDIS_PACKET_TYPE_x == USB_CDC_PACKET_TYPE_x for x in:
722 * PROMISCUOUS, DIRECTED,
723 * MULTICAST, ALL_MULTICAST, BROADCAST
725 *params->filter = (u16) le32_to_cpup((__le32 *)buf);
726 DEBUG("%s: OID_GEN_CURRENT_PACKET_FILTER %08x\n",
727 __FUNCTION__, *params->filter);
729 /* this call has a significant side effect: it's
730 * what makes the packet flow start and stop, like
731 * activating the CDC Ethernet altsetting.
737 if (*params->filter) {
738 params->state = RNDIS_DATA_INITIALIZED;
739 netif_carrier_on(params->dev);
740 if (netif_running(params->dev))
741 netif_wake_queue (params->dev);
743 params->state = RNDIS_INITIALIZED;
744 netif_carrier_off (params->dev);
745 netif_stop_queue (params->dev);
749 case OID_802_3_MULTICAST_LIST:
750 /* I think we can ignore this */
751 DEBUG("%s: OID_802_3_MULTICAST_LIST\n", __FUNCTION__);
755 case OID_GEN_RNDIS_CONFIG_PARAMETER:
757 struct rndis_config_parameter *param;
758 param = (struct rndis_config_parameter *) buf;
759 DEBUG("%s: OID_GEN_RNDIS_CONFIG_PARAMETER '%*s'\n",
761 min(cpu_to_le32(param->ParameterNameLength),80),
762 buf + param->ParameterNameOffset);
769 case OID_PNP_SET_POWER:
770 /* The only real power state is USB suspend, and RNDIS requests
771 * can't enter it; this one isn't really about power. After
772 * resuming, Windows forces a reset, and then SET_POWER D0.
773 * FIXME ... then things go batty; Windows wedges itself.
775 i = le32_to_cpup((__force __le32 *)buf);
776 DEBUG("%s: OID_PNP_SET_POWER D%d\n", __FUNCTION__, i - 1);
778 case NdisDeviceStateD0:
779 *params->filter = params->saved_filter;
780 goto update_linkstate;
781 case NdisDeviceStateD3:
782 case NdisDeviceStateD2:
783 case NdisDeviceStateD1:
784 params->saved_filter = *params->filter;
791 // no wakeup support advertised, so wakeup OIDs always fail:
792 // - OID_PNP_ENABLE_WAKE_UP
793 // - OID_PNP_{ADD,REMOVE}_WAKE_UP_PATTERN
796 #endif /* RNDIS_PM */
799 printk (KERN_WARNING "%s: set unknown OID 0x%08X, size %d\n",
800 __FUNCTION__, OID, buf_len);
810 static int rndis_init_response (int configNr, rndis_init_msg_type *buf)
812 rndis_init_cmplt_type *resp;
815 if (!rndis_per_dev_params [configNr].dev) return -ENOTSUPP;
817 r = rndis_add_response (configNr, sizeof (rndis_init_cmplt_type));
820 resp = (rndis_init_cmplt_type *) r->buf;
822 resp->MessageType = __constant_cpu_to_le32 (
823 REMOTE_NDIS_INITIALIZE_CMPLT);
824 resp->MessageLength = __constant_cpu_to_le32 (52);
825 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
826 resp->Status = __constant_cpu_to_le32 (RNDIS_STATUS_SUCCESS);
827 resp->MajorVersion = __constant_cpu_to_le32 (RNDIS_MAJOR_VERSION);
828 resp->MinorVersion = __constant_cpu_to_le32 (RNDIS_MINOR_VERSION);
829 resp->DeviceFlags = __constant_cpu_to_le32 (RNDIS_DF_CONNECTIONLESS);
830 resp->Medium = __constant_cpu_to_le32 (RNDIS_MEDIUM_802_3);
831 resp->MaxPacketsPerTransfer = __constant_cpu_to_le32 (1);
832 resp->MaxTransferSize = cpu_to_le32 (
833 rndis_per_dev_params [configNr].dev->mtu
834 + sizeof (struct ethhdr)
835 + sizeof (struct rndis_packet_msg_type)
837 resp->PacketAlignmentFactor = __constant_cpu_to_le32 (0);
838 resp->AFListOffset = __constant_cpu_to_le32 (0);
839 resp->AFListSize = __constant_cpu_to_le32 (0);
841 if (rndis_per_dev_params [configNr].ack)
842 rndis_per_dev_params [configNr].ack (
843 rndis_per_dev_params [configNr].dev);
848 static int rndis_query_response (int configNr, rndis_query_msg_type *buf)
850 rndis_query_cmplt_type *resp;
853 // DEBUG("%s: OID = %08X\n", __FUNCTION__, cpu_to_le32(buf->OID));
854 if (!rndis_per_dev_params [configNr].dev) return -ENOTSUPP;
857 * we need more memory:
858 * gen_ndis_query_resp expects enough space for
859 * rndis_query_cmplt_type followed by data.
860 * oid_supported_list is the largest data reply
862 r = rndis_add_response (configNr,
863 sizeof (oid_supported_list) + sizeof(rndis_query_cmplt_type));
866 resp = (rndis_query_cmplt_type *) r->buf;
868 resp->MessageType = __constant_cpu_to_le32 (REMOTE_NDIS_QUERY_CMPLT);
869 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
871 if (gen_ndis_query_resp (configNr, le32_to_cpu (buf->OID),
872 le32_to_cpu(buf->InformationBufferOffset)
874 le32_to_cpu(buf->InformationBufferLength),
876 /* OID not supported */
877 resp->Status = __constant_cpu_to_le32 (
878 RNDIS_STATUS_NOT_SUPPORTED);
879 resp->MessageLength = __constant_cpu_to_le32 (sizeof *resp);
880 resp->InformationBufferLength = __constant_cpu_to_le32 (0);
881 resp->InformationBufferOffset = __constant_cpu_to_le32 (0);
883 resp->Status = __constant_cpu_to_le32 (RNDIS_STATUS_SUCCESS);
885 if (rndis_per_dev_params [configNr].ack)
886 rndis_per_dev_params [configNr].ack (
887 rndis_per_dev_params [configNr].dev);
891 static int rndis_set_response (int configNr, rndis_set_msg_type *buf)
893 u32 BufLength, BufOffset;
894 rndis_set_cmplt_type *resp;
897 r = rndis_add_response (configNr, sizeof (rndis_set_cmplt_type));
900 resp = (rndis_set_cmplt_type *) r->buf;
902 BufLength = le32_to_cpu (buf->InformationBufferLength);
903 BufOffset = le32_to_cpu (buf->InformationBufferOffset);
906 DEBUG("%s: Length: %d\n", __FUNCTION__, BufLength);
907 DEBUG("%s: Offset: %d\n", __FUNCTION__, BufOffset);
908 DEBUG("%s: InfoBuffer: ", __FUNCTION__);
910 for (i = 0; i < BufLength; i++) {
911 DEBUG ("%02x ", *(((u8 *) buf) + i + 8 + BufOffset));
917 resp->MessageType = __constant_cpu_to_le32 (REMOTE_NDIS_SET_CMPLT);
918 resp->MessageLength = __constant_cpu_to_le32 (16);
919 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
920 if (gen_ndis_set_resp (configNr, le32_to_cpu (buf->OID),
921 ((u8 *) buf) + 8 + BufOffset, BufLength, r))
922 resp->Status = __constant_cpu_to_le32 (RNDIS_STATUS_NOT_SUPPORTED);
924 resp->Status = __constant_cpu_to_le32 (RNDIS_STATUS_SUCCESS);
926 if (rndis_per_dev_params [configNr].ack)
927 rndis_per_dev_params [configNr].ack (
928 rndis_per_dev_params [configNr].dev);
933 static int rndis_reset_response (int configNr, rndis_reset_msg_type *buf)
935 rndis_reset_cmplt_type *resp;
938 r = rndis_add_response (configNr, sizeof (rndis_reset_cmplt_type));
941 resp = (rndis_reset_cmplt_type *) r->buf;
943 resp->MessageType = __constant_cpu_to_le32 (REMOTE_NDIS_RESET_CMPLT);
944 resp->MessageLength = __constant_cpu_to_le32 (16);
945 resp->Status = __constant_cpu_to_le32 (RNDIS_STATUS_SUCCESS);
946 /* resent information */
947 resp->AddressingReset = __constant_cpu_to_le32 (1);
949 if (rndis_per_dev_params [configNr].ack)
950 rndis_per_dev_params [configNr].ack (
951 rndis_per_dev_params [configNr].dev);
956 static int rndis_keepalive_response (int configNr,
957 rndis_keepalive_msg_type *buf)
959 rndis_keepalive_cmplt_type *resp;
962 /* host "should" check only in RNDIS_DATA_INITIALIZED state */
964 r = rndis_add_response (configNr, sizeof (rndis_keepalive_cmplt_type));
967 resp = (rndis_keepalive_cmplt_type *) r->buf;
969 resp->MessageType = __constant_cpu_to_le32 (
970 REMOTE_NDIS_KEEPALIVE_CMPLT);
971 resp->MessageLength = __constant_cpu_to_le32 (16);
972 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
973 resp->Status = __constant_cpu_to_le32 (RNDIS_STATUS_SUCCESS);
975 if (rndis_per_dev_params [configNr].ack)
976 rndis_per_dev_params [configNr].ack (
977 rndis_per_dev_params [configNr].dev);
984 * Device to Host Comunication
986 static int rndis_indicate_status_msg (int configNr, u32 status)
988 rndis_indicate_status_msg_type *resp;
991 if (rndis_per_dev_params [configNr].state == RNDIS_UNINITIALIZED)
994 r = rndis_add_response (configNr,
995 sizeof (rndis_indicate_status_msg_type));
998 resp = (rndis_indicate_status_msg_type *) r->buf;
1000 resp->MessageType = __constant_cpu_to_le32 (
1001 REMOTE_NDIS_INDICATE_STATUS_MSG);
1002 resp->MessageLength = __constant_cpu_to_le32 (20);
1003 resp->Status = cpu_to_le32 (status);
1004 resp->StatusBufferLength = __constant_cpu_to_le32 (0);
1005 resp->StatusBufferOffset = __constant_cpu_to_le32 (0);
1007 if (rndis_per_dev_params [configNr].ack)
1008 rndis_per_dev_params [configNr].ack (
1009 rndis_per_dev_params [configNr].dev);
1013 int rndis_signal_connect (int configNr)
1015 rndis_per_dev_params [configNr].media_state
1016 = NDIS_MEDIA_STATE_CONNECTED;
1017 return rndis_indicate_status_msg (configNr,
1018 RNDIS_STATUS_MEDIA_CONNECT);
1021 int rndis_signal_disconnect (int configNr)
1023 rndis_per_dev_params [configNr].media_state
1024 = NDIS_MEDIA_STATE_DISCONNECTED;
1025 return rndis_indicate_status_msg (configNr,
1026 RNDIS_STATUS_MEDIA_DISCONNECT);
1029 void rndis_uninit (int configNr)
1034 if (configNr >= RNDIS_MAX_CONFIGS)
1036 rndis_per_dev_params [configNr].used = 0;
1037 rndis_per_dev_params [configNr].state = RNDIS_UNINITIALIZED;
1039 /* drain the response queue */
1040 while ((buf = rndis_get_next_response(configNr, &length)))
1041 rndis_free_response(configNr, buf);
1044 void rndis_set_host_mac (int configNr, const u8 *addr)
1046 rndis_per_dev_params [configNr].host_mac = addr;
1052 int rndis_msg_parser (u8 configNr, u8 *buf)
1054 u32 MsgType, MsgLength;
1056 struct rndis_params *params;
1061 tmp = (__le32 *) buf;
1062 MsgType = le32_to_cpup(tmp++);
1063 MsgLength = le32_to_cpup(tmp++);
1065 if (configNr >= RNDIS_MAX_CONFIGS)
1067 params = &rndis_per_dev_params [configNr];
1069 /* NOTE: RNDIS is *EXTREMELY* chatty ... Windows constantly polls for
1070 * rx/tx statistics and link status, in addition to KEEPALIVE traffic
1071 * and normal HC level polling to see if there's any IN traffic.
1074 /* For USB: responses may take up to 10 seconds */
1076 case REMOTE_NDIS_INITIALIZE_MSG:
1077 DEBUG("%s: REMOTE_NDIS_INITIALIZE_MSG\n",
1079 params->state = RNDIS_INITIALIZED;
1080 return rndis_init_response (configNr,
1081 (rndis_init_msg_type *) buf);
1083 case REMOTE_NDIS_HALT_MSG:
1084 DEBUG("%s: REMOTE_NDIS_HALT_MSG\n",
1086 params->state = RNDIS_UNINITIALIZED;
1088 netif_carrier_off (params->dev);
1089 netif_stop_queue (params->dev);
1093 case REMOTE_NDIS_QUERY_MSG:
1094 return rndis_query_response (configNr,
1095 (rndis_query_msg_type *) buf);
1097 case REMOTE_NDIS_SET_MSG:
1098 return rndis_set_response (configNr,
1099 (rndis_set_msg_type *) buf);
1101 case REMOTE_NDIS_RESET_MSG:
1102 DEBUG("%s: REMOTE_NDIS_RESET_MSG\n",
1104 return rndis_reset_response (configNr,
1105 (rndis_reset_msg_type *) buf);
1107 case REMOTE_NDIS_KEEPALIVE_MSG:
1108 /* For USB: host does this every 5 seconds */
1109 if (rndis_debug > 1)
1110 DEBUG("%s: REMOTE_NDIS_KEEPALIVE_MSG\n",
1112 return rndis_keepalive_response (configNr,
1113 (rndis_keepalive_msg_type *)
1117 /* At least Windows XP emits some undefined RNDIS messages.
1118 * In one case those messages seemed to relate to the host
1119 * suspending itself.
1121 printk (KERN_WARNING
1122 "%s: unknown RNDIS message 0x%08X len %d\n",
1123 __FUNCTION__ , MsgType, MsgLength);
1126 for (i = 0; i < MsgLength; i += 16) {
1128 " %02x %02x %02x %02x"
1129 " %02x %02x %02x %02x"
1130 " %02x %02x %02x %02x"
1131 " %02x %02x %02x %02x"
1136 buf[i+4], buf [i+5],
1138 buf[i+8], buf [i+9],
1139 buf[i+10], buf[i+11],
1140 buf[i+12], buf [i+13],
1141 buf[i+14], buf[i+15]);
1150 int rndis_register (int (* rndis_control_ack) (struct net_device *))
1154 for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1155 if (!rndis_per_dev_params [i].used) {
1156 rndis_per_dev_params [i].used = 1;
1157 rndis_per_dev_params [i].ack = rndis_control_ack;
1158 DEBUG("%s: configNr = %d\n", __FUNCTION__, i);
1167 void rndis_deregister (int configNr)
1169 DEBUG("%s: \n", __FUNCTION__ );
1171 if (configNr >= RNDIS_MAX_CONFIGS) return;
1172 rndis_per_dev_params [configNr].used = 0;
1177 int rndis_set_param_dev (u8 configNr, struct net_device *dev,
1178 struct net_device_stats *stats,
1181 DEBUG("%s:\n", __FUNCTION__ );
1182 if (!dev || !stats) return -1;
1183 if (configNr >= RNDIS_MAX_CONFIGS) return -1;
1185 rndis_per_dev_params [configNr].dev = dev;
1186 rndis_per_dev_params [configNr].stats = stats;
1187 rndis_per_dev_params [configNr].filter = cdc_filter;
1192 int rndis_set_param_vendor (u8 configNr, u32 vendorID, const char *vendorDescr)
1194 DEBUG("%s:\n", __FUNCTION__ );
1195 if (!vendorDescr) return -1;
1196 if (configNr >= RNDIS_MAX_CONFIGS) return -1;
1198 rndis_per_dev_params [configNr].vendorID = vendorID;
1199 rndis_per_dev_params [configNr].vendorDescr = vendorDescr;
1204 int rndis_set_param_medium (u8 configNr, u32 medium, u32 speed)
1206 DEBUG("%s: %u %u\n", __FUNCTION__, medium, speed);
1207 if (configNr >= RNDIS_MAX_CONFIGS) return -1;
1209 rndis_per_dev_params [configNr].medium = medium;
1210 rndis_per_dev_params [configNr].speed = speed;
1215 void rndis_add_hdr (struct sk_buff *skb)
1217 struct rndis_packet_msg_type *header;
1221 header = (void *) skb_push (skb, sizeof *header);
1222 memset (header, 0, sizeof *header);
1223 header->MessageType = __constant_cpu_to_le32(REMOTE_NDIS_PACKET_MSG);
1224 header->MessageLength = cpu_to_le32(skb->len);
1225 header->DataOffset = __constant_cpu_to_le32 (36);
1226 header->DataLength = cpu_to_le32(skb->len - sizeof *header);
1229 void rndis_free_response (int configNr, u8 *buf)
1232 struct list_head *act, *tmp;
1234 list_for_each_safe (act, tmp,
1235 &(rndis_per_dev_params [configNr].resp_queue))
1237 r = list_entry (act, rndis_resp_t, list);
1238 if (r && r->buf == buf) {
1239 list_del (&r->list);
1245 u8 *rndis_get_next_response (int configNr, u32 *length)
1248 struct list_head *act, *tmp;
1250 if (!length) return NULL;
1252 list_for_each_safe (act, tmp,
1253 &(rndis_per_dev_params [configNr].resp_queue))
1255 r = list_entry (act, rndis_resp_t, list);
1258 *length = r->length;
1266 static rndis_resp_t *rndis_add_response (int configNr, u32 length)
1270 /* NOTE: this gets copied into ether.c USB_BUFSIZ bytes ... */
1271 r = kmalloc (sizeof (rndis_resp_t) + length, GFP_ATOMIC);
1272 if (!r) return NULL;
1274 r->buf = (u8 *) (r + 1);
1278 list_add_tail (&r->list,
1279 &(rndis_per_dev_params [configNr].resp_queue));
1283 int rndis_rm_hdr(struct sk_buff *skb)
1285 /* tmp points to a struct rndis_packet_msg_type */
1286 __le32 *tmp = (void *) skb->data;
1288 /* MessageType, MessageLength */
1289 if (__constant_cpu_to_le32(REMOTE_NDIS_PACKET_MSG)
1290 != get_unaligned(tmp++))
1294 /* DataOffset, DataLength */
1295 if (!skb_pull(skb, le32_to_cpu(get_unaligned(tmp++))
1296 + 8 /* offset of DataOffset */))
1298 skb_trim(skb, le32_to_cpu(get_unaligned(tmp++)));
1303 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1305 static int rndis_proc_read (char *page, char **start, off_t off, int count, int *eof,
1310 rndis_params *param = (rndis_params *) data;
1312 out += snprintf (out, count,
1319 "vendor ID : 0x%08X\n"
1321 param->confignr, (param->used) ? "y" : "n",
1323 switch (param->state) {
1324 case RNDIS_UNINITIALIZED:
1325 s = "RNDIS_UNINITIALIZED"; break;
1326 case RNDIS_INITIALIZED:
1327 s = "RNDIS_INITIALIZED"; break;
1328 case RNDIS_DATA_INITIALIZED:
1329 s = "RNDIS_DATA_INITIALIZED"; break;
1332 (param->media_state) ? 0 : param->speed*100,
1333 (param->media_state) ? "disconnected" : "connected",
1334 param->vendorID, param->vendorDescr);
1346 *start = page + off;
1350 static int rndis_proc_write (struct file *file, const char __user *buffer,
1351 unsigned long count, void *data)
1353 rndis_params *p = data;
1355 int i, fl_speed = 0;
1357 for (i = 0; i < count; i++) {
1359 if (get_user(c, buffer))
1373 speed = speed*10 + c - '0';
1377 rndis_signal_connect (p->confignr);
1381 rndis_signal_disconnect(p->confignr);
1384 if (fl_speed) p->speed = speed;
1385 else DEBUG ("%c is not valid\n", c);
1395 #define NAME_TEMPLATE "driver/rndis-%03d"
1397 static struct proc_dir_entry *rndis_connect_state [RNDIS_MAX_CONFIGS];
1399 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
1402 int __init rndis_init (void)
1406 for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1407 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1410 sprintf (name, NAME_TEMPLATE, i);
1411 if (!(rndis_connect_state [i]
1412 = create_proc_entry (name, 0660, NULL)))
1414 DEBUG ("%s :remove entries", __FUNCTION__);
1416 sprintf (name, NAME_TEMPLATE, --i);
1417 remove_proc_entry (name, NULL);
1423 rndis_connect_state [i]->nlink = 1;
1424 rndis_connect_state [i]->write_proc = rndis_proc_write;
1425 rndis_connect_state [i]->read_proc = rndis_proc_read;
1426 rndis_connect_state [i]->data = (void *)
1427 (rndis_per_dev_params + i);
1429 rndis_per_dev_params [i].confignr = i;
1430 rndis_per_dev_params [i].used = 0;
1431 rndis_per_dev_params [i].state = RNDIS_UNINITIALIZED;
1432 rndis_per_dev_params [i].media_state
1433 = NDIS_MEDIA_STATE_DISCONNECTED;
1434 INIT_LIST_HEAD (&(rndis_per_dev_params [i].resp_queue));
1440 void rndis_exit (void)
1442 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1446 for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1447 sprintf (name, NAME_TEMPLATE, i);
1448 remove_proc_entry (name, NULL);