projects/linux·blob master · refs

1201 lines · 29.1 KiB

1// SPDX-License-Identifier: GPL-2.0
2/*
3 * RNDIS MSG parser
4 *
5 * Authors: Benedikt Spranger, Pengutronix
6 * Robert Schwebel, Pengutronix
7 *
8 * This software was originally developed in conformance with
9 * Microsoft's Remote NDIS Specification License Agreement.
10 *
11 * 03/12/2004 Kai-Uwe Bloem <[email protected]>
12 * Fixed message length bug in init_response
13 *
14 * 03/25/2004 Kai-Uwe Bloem <[email protected]>
15 * Fixed rndis_rm_hdr length bug.
16 *
17 * Copyright (C) 2004 by David Brownell
18 * updates to merge with Linux 2.6, better match RNDIS spec
19 */
20
21#include <linux/module.h>
22#include <linux/moduleparam.h>
23#include <linux/kernel.h>
24#include <linux/errno.h>
25#include <linux/idr.h>
26#include <linux/list.h>
27#include <linux/proc_fs.h>
28#include <linux/slab.h>
29#include <linux/seq_file.h>
30#include <linux/netdevice.h>
31
32#include <asm/io.h>
33#include <asm/byteorder.h>
34#include <linux/unaligned.h>
35
36#include "u_rndis.h"
37
38#undef VERBOSE_DEBUG
39
40#include "rndis.h"
41
42
43/* The driver for your USB chip needs to support ep0 OUT to work with
44 * RNDIS, plus all three CDC Ethernet endpoints (interrupt not optional).
45 *
46 * Windows hosts need an INF file like Documentation/usb/linux.inf
47 * and will be happier if you provide the host_addr module parameter.
48 */
49
50#if 0
51static int rndis_debug = 0;
52module_param (rndis_debug, int, 0);
53MODULE_PARM_DESC (rndis_debug, "enable debugging");
54#else
55#define rndis_debug 0
56#endif
57
58#ifdef CONFIG_USB_GADGET_DEBUG_FILES
59
60#define NAME_TEMPLATE "driver/rndis-%03d"
61
62#endif /* CONFIG_USB_GADGET_DEBUG_FILES */
63
64static DEFINE_IDA(rndis_ida);
65
66/* Driver Version */
67static const __le32 rndis_driver_version = cpu_to_le32(1);
68
69/* Function Prototypes */
70static rndis_resp_t *rndis_add_response(struct rndis_params *params,
71 u32 length);
72
73#ifdef CONFIG_USB_GADGET_DEBUG_FILES
74
75static const struct proc_ops rndis_proc_ops;
76
77#endif /* CONFIG_USB_GADGET_DEBUG_FILES */
78
79/* supported OIDs */
80static const u32 oid_supported_list[] = {
81 /* the general stuff */
82 RNDIS_OID_GEN_SUPPORTED_LIST,
83 RNDIS_OID_GEN_HARDWARE_STATUS,
84 RNDIS_OID_GEN_MEDIA_SUPPORTED,
85 RNDIS_OID_GEN_MEDIA_IN_USE,
86 RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE,
87 RNDIS_OID_GEN_LINK_SPEED,
88 RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE,
89 RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE,
90 RNDIS_OID_GEN_VENDOR_ID,
91 RNDIS_OID_GEN_VENDOR_DESCRIPTION,
92 RNDIS_OID_GEN_VENDOR_DRIVER_VERSION,
93 RNDIS_OID_GEN_CURRENT_PACKET_FILTER,
94 RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE,
95 RNDIS_OID_GEN_MEDIA_CONNECT_STATUS,
96 RNDIS_OID_GEN_PHYSICAL_MEDIUM,
97
98 /* the statistical stuff */
99 RNDIS_OID_GEN_XMIT_OK,
100 RNDIS_OID_GEN_RCV_OK,
101 RNDIS_OID_GEN_XMIT_ERROR,
102 RNDIS_OID_GEN_RCV_ERROR,
103 RNDIS_OID_GEN_RCV_NO_BUFFER,
104#ifdef RNDIS_OPTIONAL_STATS
105 RNDIS_OID_GEN_DIRECTED_BYTES_XMIT,
106 RNDIS_OID_GEN_DIRECTED_FRAMES_XMIT,
107 RNDIS_OID_GEN_MULTICAST_BYTES_XMIT,
108 RNDIS_OID_GEN_MULTICAST_FRAMES_XMIT,
109 RNDIS_OID_GEN_BROADCAST_BYTES_XMIT,
110 RNDIS_OID_GEN_BROADCAST_FRAMES_XMIT,
111 RNDIS_OID_GEN_DIRECTED_BYTES_RCV,
112 RNDIS_OID_GEN_DIRECTED_FRAMES_RCV,
113 RNDIS_OID_GEN_MULTICAST_BYTES_RCV,
114 RNDIS_OID_GEN_MULTICAST_FRAMES_RCV,
115 RNDIS_OID_GEN_BROADCAST_BYTES_RCV,
116 RNDIS_OID_GEN_BROADCAST_FRAMES_RCV,
117 RNDIS_OID_GEN_RCV_CRC_ERROR,
118 RNDIS_OID_GEN_TRANSMIT_QUEUE_LENGTH,
119#endif /* RNDIS_OPTIONAL_STATS */
120
121 /* mandatory 802.3 */
122 /* the general stuff */
123 RNDIS_OID_802_3_PERMANENT_ADDRESS,
124 RNDIS_OID_802_3_CURRENT_ADDRESS,
125 RNDIS_OID_802_3_MULTICAST_LIST,
126 RNDIS_OID_802_3_MAC_OPTIONS,
127 RNDIS_OID_802_3_MAXIMUM_LIST_SIZE,
128
129 /* the statistical stuff */
130 RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT,
131 RNDIS_OID_802_3_XMIT_ONE_COLLISION,
132 RNDIS_OID_802_3_XMIT_MORE_COLLISIONS,
133#ifdef RNDIS_OPTIONAL_STATS
134 RNDIS_OID_802_3_XMIT_DEFERRED,
135 RNDIS_OID_802_3_XMIT_MAX_COLLISIONS,
136 RNDIS_OID_802_3_RCV_OVERRUN,
137 RNDIS_OID_802_3_XMIT_UNDERRUN,
138 RNDIS_OID_802_3_XMIT_HEARTBEAT_FAILURE,
139 RNDIS_OID_802_3_XMIT_TIMES_CRS_LOST,
140 RNDIS_OID_802_3_XMIT_LATE_COLLISIONS,
141#endif /* RNDIS_OPTIONAL_STATS */
142
143#ifdef RNDIS_PM
144 /* PM and wakeup are "mandatory" for USB, but the RNDIS specs
145 * don't say what they mean ... and the NDIS specs are often
146 * confusing and/or ambiguous in this context. (That is, more
147 * so than their specs for the other OIDs.)
148 *
149 * FIXME someone who knows what these should do, please
150 * implement them!
151 */
152
153 /* power management */
154 OID_PNP_CAPABILITIES,
155 OID_PNP_QUERY_POWER,
156 OID_PNP_SET_POWER,
157
158#ifdef RNDIS_WAKEUP
159 /* wake up host */
160 OID_PNP_ENABLE_WAKE_UP,
161 OID_PNP_ADD_WAKE_UP_PATTERN,
162 OID_PNP_REMOVE_WAKE_UP_PATTERN,
163#endif /* RNDIS_WAKEUP */
164#endif /* RNDIS_PM */
165};
166
167
168/* NDIS Functions */
169static int gen_ndis_query_resp(struct rndis_params *params, u32 OID, u8 *buf,
170 unsigned buf_len, rndis_resp_t *r)
171{
172 int retval = -ENOTSUPP;
173 u32 length = 4; /* usually */
174 __le32 *outbuf;
175 int i, count;
176 rndis_query_cmplt_type *resp;
177 struct net_device *net;
178 struct rtnl_link_stats64 temp;
179 const struct rtnl_link_stats64 *stats;
180
181 if (!r) return -ENOMEM;
182 resp = (rndis_query_cmplt_type *)r->buf;
183
184 if (!resp) return -ENOMEM;
185
186 if (buf_len && rndis_debug > 1) {
187 pr_debug("query OID %08x value, len %d:\n", OID, buf_len);
188 for (i = 0; i < buf_len; i += 16) {
189 pr_debug("%03d: %08x %08x %08x %08x\n", i,
190 get_unaligned_le32(&buf[i]),
191 get_unaligned_le32(&buf[i + 4]),
192 get_unaligned_le32(&buf[i + 8]),
193 get_unaligned_le32(&buf[i + 12]));
194 }
195 }
196
197 /* response goes here, right after the header */
198 outbuf = (__le32 *)&resp[1];
199 resp->InformationBufferOffset = cpu_to_le32(16);
200
201 net = params->dev;
202 stats = dev_get_stats(net, &temp);
203
204 switch (OID) {
205
206 /* general oids (table 4-1) */
207
208 /* mandatory */
209 case RNDIS_OID_GEN_SUPPORTED_LIST:
210 pr_debug("%s: RNDIS_OID_GEN_SUPPORTED_LIST\n", __func__);
211 length = sizeof(oid_supported_list);
212 count = length / sizeof(u32);
213 for (i = 0; i < count; i++)
214 outbuf[i] = cpu_to_le32(oid_supported_list[i]);
215 retval = 0;
216 break;
217
218 /* mandatory */
219 case RNDIS_OID_GEN_HARDWARE_STATUS:
220 pr_debug("%s: RNDIS_OID_GEN_HARDWARE_STATUS\n", __func__);
221 /* Bogus question!
222 * Hardware must be ready to receive high level protocols.
223 * BTW:
224 * reddite ergo quae sunt Caesaris Caesari
225 * et quae sunt Dei Deo!
226 */
227 *outbuf = cpu_to_le32(0);
228 retval = 0;
229 break;
230
231 /* mandatory */
232 case RNDIS_OID_GEN_MEDIA_SUPPORTED:
233 pr_debug("%s: RNDIS_OID_GEN_MEDIA_SUPPORTED\n", __func__);
234 *outbuf = cpu_to_le32(params->medium);
235 retval = 0;
236 break;
237
238 /* mandatory */
239 case RNDIS_OID_GEN_MEDIA_IN_USE:
240 pr_debug("%s: RNDIS_OID_GEN_MEDIA_IN_USE\n", __func__);
241 /* one medium, one transport... (maybe you do it better) */
242 *outbuf = cpu_to_le32(params->medium);
243 retval = 0;
244 break;
245
246 /* mandatory */
247 case RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE:
248 pr_debug("%s: RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE\n", __func__);
249 if (params->dev) {
250 *outbuf = cpu_to_le32(params->dev->mtu);
251 retval = 0;
252 }
253 break;
254
255 /* mandatory */
256 case RNDIS_OID_GEN_LINK_SPEED:
257 if (rndis_debug > 1)
258 pr_debug("%s: RNDIS_OID_GEN_LINK_SPEED\n", __func__);
259 if (params->media_state == RNDIS_MEDIA_STATE_DISCONNECTED)
260 *outbuf = cpu_to_le32(0);
261 else
262 *outbuf = cpu_to_le32(params->speed);
263 retval = 0;
264 break;
265
266 /* mandatory */
267 case RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE:
268 pr_debug("%s: RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE\n", __func__);
269 if (params->dev) {
270 *outbuf = cpu_to_le32(params->dev->mtu);
271 retval = 0;
272 }
273 break;
274
275 /* mandatory */
276 case RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE:
277 pr_debug("%s: RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE\n", __func__);
278 if (params->dev) {
279 *outbuf = cpu_to_le32(params->dev->mtu);
280 retval = 0;
281 }
282 break;
283
284 /* mandatory */
285 case RNDIS_OID_GEN_VENDOR_ID:
286 pr_debug("%s: RNDIS_OID_GEN_VENDOR_ID\n", __func__);
287 *outbuf = cpu_to_le32(params->vendorID);
288 retval = 0;
289 break;
290
291 /* mandatory */
292 case RNDIS_OID_GEN_VENDOR_DESCRIPTION:
293 pr_debug("%s: RNDIS_OID_GEN_VENDOR_DESCRIPTION\n", __func__);
294 if (params->vendorDescr) {
295 length = strlen(params->vendorDescr);
296 memcpy(outbuf, params->vendorDescr, length);
297 } else {
298 outbuf[0] = 0;
299 }
300 retval = 0;
301 break;
302
303 case RNDIS_OID_GEN_VENDOR_DRIVER_VERSION:
304 pr_debug("%s: RNDIS_OID_GEN_VENDOR_DRIVER_VERSION\n", __func__);
305 /* Created as LE */
306 *outbuf = rndis_driver_version;
307 retval = 0;
308 break;
309
310 /* mandatory */
311 case RNDIS_OID_GEN_CURRENT_PACKET_FILTER:
312 pr_debug("%s: RNDIS_OID_GEN_CURRENT_PACKET_FILTER\n", __func__);
313 *outbuf = cpu_to_le32(*params->filter);
314 retval = 0;
315 break;
316
317 /* mandatory */
318 case RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE:
319 pr_debug("%s: RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE\n", __func__);
320 *outbuf = cpu_to_le32(RNDIS_MAX_TOTAL_SIZE);
321 retval = 0;
322 break;
323
324 /* mandatory */
325 case RNDIS_OID_GEN_MEDIA_CONNECT_STATUS:
326 if (rndis_debug > 1)
327 pr_debug("%s: RNDIS_OID_GEN_MEDIA_CONNECT_STATUS\n", __func__);
328 *outbuf = cpu_to_le32(params->media_state);
329 retval = 0;
330 break;
331
332 case RNDIS_OID_GEN_PHYSICAL_MEDIUM:
333 pr_debug("%s: RNDIS_OID_GEN_PHYSICAL_MEDIUM\n", __func__);
334 *outbuf = cpu_to_le32(0);
335 retval = 0;
336 break;
337
338 /* The RNDIS specification is incomplete/wrong. Some versions
339 * of MS-Windows expect OIDs that aren't specified there. Other
340 * versions emit undefined RNDIS messages. DOCUMENT ALL THESE!
341 */
342 case RNDIS_OID_GEN_MAC_OPTIONS: /* from WinME */
343 pr_debug("%s: RNDIS_OID_GEN_MAC_OPTIONS\n", __func__);
344 *outbuf = cpu_to_le32(
345 RNDIS_MAC_OPTION_RECEIVE_SERIALIZED
346 | RNDIS_MAC_OPTION_FULL_DUPLEX);
347 retval = 0;
348 break;
349
350 /* statistics OIDs (table 4-2) */
351
352 /* mandatory */
353 case RNDIS_OID_GEN_XMIT_OK:
354 if (rndis_debug > 1)
355 pr_debug("%s: RNDIS_OID_GEN_XMIT_OK\n", __func__);
356 if (stats) {
357 *outbuf = cpu_to_le32(stats->tx_packets
358 - stats->tx_errors - stats->tx_dropped);
359 retval = 0;
360 }
361 break;
362
363 /* mandatory */
364 case RNDIS_OID_GEN_RCV_OK:
365 if (rndis_debug > 1)
366 pr_debug("%s: RNDIS_OID_GEN_RCV_OK\n", __func__);
367 if (stats) {
368 *outbuf = cpu_to_le32(stats->rx_packets
369 - stats->rx_errors - stats->rx_dropped);
370 retval = 0;
371 }
372 break;
373
374 /* mandatory */
375 case RNDIS_OID_GEN_XMIT_ERROR:
376 if (rndis_debug > 1)
377 pr_debug("%s: RNDIS_OID_GEN_XMIT_ERROR\n", __func__);
378 if (stats) {
379 *outbuf = cpu_to_le32(stats->tx_errors);
380 retval = 0;
381 }
382 break;
383
384 /* mandatory */
385 case RNDIS_OID_GEN_RCV_ERROR:
386 if (rndis_debug > 1)
387 pr_debug("%s: RNDIS_OID_GEN_RCV_ERROR\n", __func__);
388 if (stats) {
389 *outbuf = cpu_to_le32(stats->rx_errors);
390 retval = 0;
391 }
392 break;
393
394 /* mandatory */
395 case RNDIS_OID_GEN_RCV_NO_BUFFER:
396 pr_debug("%s: RNDIS_OID_GEN_RCV_NO_BUFFER\n", __func__);
397 if (stats) {
398 *outbuf = cpu_to_le32(stats->rx_dropped);
399 retval = 0;
400 }
401 break;
402
403 /* ieee802.3 OIDs (table 4-3) */
404
405 /* mandatory */
406 case RNDIS_OID_802_3_PERMANENT_ADDRESS:
407 pr_debug("%s: RNDIS_OID_802_3_PERMANENT_ADDRESS\n", __func__);
408 if (params->dev) {
409 length = ETH_ALEN;
410 memcpy(outbuf, params->host_mac, length);
411 retval = 0;
412 }
413 break;
414
415 /* mandatory */
416 case RNDIS_OID_802_3_CURRENT_ADDRESS:
417 pr_debug("%s: RNDIS_OID_802_3_CURRENT_ADDRESS\n", __func__);
418 if (params->dev) {
419 length = ETH_ALEN;
420 memcpy(outbuf, params->host_mac, length);
421 retval = 0;
422 }
423 break;
424
425 /* mandatory */
426 case RNDIS_OID_802_3_MULTICAST_LIST:
427 pr_debug("%s: RNDIS_OID_802_3_MULTICAST_LIST\n", __func__);
428 /* Multicast base address only */
429 *outbuf = cpu_to_le32(0xE0000000);
430 retval = 0;
431 break;
432
433 /* mandatory */
434 case RNDIS_OID_802_3_MAXIMUM_LIST_SIZE:
435 pr_debug("%s: RNDIS_OID_802_3_MAXIMUM_LIST_SIZE\n", __func__);
436 /* Multicast base address only */
437 *outbuf = cpu_to_le32(1);
438 retval = 0;
439 break;
440
441 case RNDIS_OID_802_3_MAC_OPTIONS:
442 pr_debug("%s: RNDIS_OID_802_3_MAC_OPTIONS\n", __func__);
443 *outbuf = cpu_to_le32(0);
444 retval = 0;
445 break;
446
447 /* ieee802.3 statistics OIDs (table 4-4) */
448
449 /* mandatory */
450 case RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT:
451 pr_debug("%s: RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT\n", __func__);
452 if (stats) {
453 *outbuf = cpu_to_le32(stats->rx_frame_errors);
454 retval = 0;
455 }
456 break;
457
458 /* mandatory */
459 case RNDIS_OID_802_3_XMIT_ONE_COLLISION:
460 pr_debug("%s: RNDIS_OID_802_3_XMIT_ONE_COLLISION\n", __func__);
461 *outbuf = cpu_to_le32(0);
462 retval = 0;
463 break;
464
465 /* mandatory */
466 case RNDIS_OID_802_3_XMIT_MORE_COLLISIONS:
467 pr_debug("%s: RNDIS_OID_802_3_XMIT_MORE_COLLISIONS\n", __func__);
468 *outbuf = cpu_to_le32(0);
469 retval = 0;
470 break;
471
472 default:
473 pr_warn("%s: query unknown OID 0x%08X\n", __func__, OID);
474 }
475 if (retval < 0)
476 length = 0;
477
478 resp->InformationBufferLength = cpu_to_le32(length);
479 r->length = length + sizeof(*resp);
480 resp->MessageLength = cpu_to_le32(r->length);
481 return retval;
482}
483
484static int gen_ndis_set_resp(struct rndis_params *params, u32 OID,
485 u8 *buf, u32 buf_len, rndis_resp_t *r)
486{
487 rndis_set_cmplt_type *resp;
488 int i, retval = -ENOTSUPP;
489
490 if (!r)
491 return -ENOMEM;
492 resp = (rndis_set_cmplt_type *)r->buf;
493 if (!resp)
494 return -ENOMEM;
495
496 if (buf_len && rndis_debug > 1) {
497 pr_debug("set OID %08x value, len %d:\n", OID, buf_len);
498 for (i = 0; i < buf_len; i += 16) {
499 pr_debug("%03d: %08x %08x %08x %08x\n", i,
500 get_unaligned_le32(&buf[i]),
501 get_unaligned_le32(&buf[i + 4]),
502 get_unaligned_le32(&buf[i + 8]),
503 get_unaligned_le32(&buf[i + 12]));
504 }
505 }
506
507 switch (OID) {
508 case RNDIS_OID_GEN_CURRENT_PACKET_FILTER:
509
510 /* these NDIS_PACKET_TYPE_* bitflags are shared with
511 * cdc_filter; it's not RNDIS-specific
512 * NDIS_PACKET_TYPE_x == USB_CDC_PACKET_TYPE_x for x in:
513 * PROMISCUOUS, DIRECTED,
514 * MULTICAST, ALL_MULTICAST, BROADCAST
515 */
516 *params->filter = (u16)get_unaligned_le32(buf);
517 pr_debug("%s: RNDIS_OID_GEN_CURRENT_PACKET_FILTER %08x\n",
518 __func__, *params->filter);
519
520 /* this call has a significant side effect: it's
521 * what makes the packet flow start and stop, like
522 * activating the CDC Ethernet altsetting.
523 */
524 retval = 0;
525 if (*params->filter) {
526 params->state = RNDIS_DATA_INITIALIZED;
527 netif_carrier_on(params->dev);
528 if (netif_running(params->dev))
529 netif_wake_queue(params->dev);
530 } else {
531 params->state = RNDIS_INITIALIZED;
532 netif_carrier_off(params->dev);
533 netif_stop_queue(params->dev);
534 }
535 break;
536
537 case RNDIS_OID_802_3_MULTICAST_LIST:
538 /* I think we can ignore this */
539 pr_debug("%s: RNDIS_OID_802_3_MULTICAST_LIST\n", __func__);
540 retval = 0;
541 break;
542
543 default:
544 pr_warn("%s: set unknown OID 0x%08X, size %d\n",
545 __func__, OID, buf_len);
546 }
547
548 return retval;
549}
550
551/*
552 * Response Functions
553 */
554
555static int rndis_init_response(struct rndis_params *params,
556 rndis_init_msg_type *buf)
557{
558 rndis_init_cmplt_type *resp;
559 rndis_resp_t *r;
560
561 if (!params->dev)
562 return -ENOTSUPP;
563
564 r = rndis_add_response(params, sizeof(rndis_init_cmplt_type));
565 if (!r)
566 return -ENOMEM;
567 resp = (rndis_init_cmplt_type *)r->buf;
568
569 resp->MessageType = cpu_to_le32(RNDIS_MSG_INIT_C);
570 resp->MessageLength = cpu_to_le32(52);
571 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
572 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
573 resp->MajorVersion = cpu_to_le32(RNDIS_MAJOR_VERSION);
574 resp->MinorVersion = cpu_to_le32(RNDIS_MINOR_VERSION);
575 resp->DeviceFlags = cpu_to_le32(RNDIS_DF_CONNECTIONLESS);
576 resp->Medium = cpu_to_le32(RNDIS_MEDIUM_802_3);
577 resp->MaxPacketsPerTransfer = cpu_to_le32(1);
578 resp->MaxTransferSize = cpu_to_le32(
579 params->dev->mtu
580 + sizeof(struct ethhdr)
581 + sizeof(struct rndis_packet_msg_type)
582 + 22);
583 resp->PacketAlignmentFactor = cpu_to_le32(0);
584 resp->AFListOffset = cpu_to_le32(0);
585 resp->AFListSize = cpu_to_le32(0);
586
587 params->resp_avail(params->v);
588 return 0;
589}
590
591static int rndis_query_response(struct rndis_params *params,
592 rndis_query_msg_type *buf)
593{
594 u32 BufLength, BufOffset;
595 rndis_query_cmplt_type *resp;
596 rndis_resp_t *r;
597
598 /* pr_debug("%s: OID = %08X\n", __func__, cpu_to_le32(buf->OID)); */
599 if (!params->dev)
600 return -ENOTSUPP;
601
602 BufLength = le32_to_cpu(buf->InformationBufferLength);
603 BufOffset = le32_to_cpu(buf->InformationBufferOffset);
604 if ((BufLength > RNDIS_MAX_TOTAL_SIZE) ||
605 (BufOffset > RNDIS_MAX_TOTAL_SIZE) ||
606 (BufOffset + 8 >= RNDIS_MAX_TOTAL_SIZE))
607 return -EINVAL;
608
609 /*
610 * we need more memory:
611 * gen_ndis_query_resp expects enough space for
612 * rndis_query_cmplt_type followed by data.
613 * oid_supported_list is the largest data reply
614 */
615 r = rndis_add_response(params,
616 sizeof(oid_supported_list) + sizeof(rndis_query_cmplt_type));
617 if (!r)
618 return -ENOMEM;
619 resp = (rndis_query_cmplt_type *)r->buf;
620
621 resp->MessageType = cpu_to_le32(RNDIS_MSG_QUERY_C);
622 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
623
624 if (gen_ndis_query_resp(params, le32_to_cpu(buf->OID),
625 BufOffset + 8 + (u8 *)buf,
626 BufLength, r)) {
627 /* OID not supported */
628 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
629 resp->MessageLength = cpu_to_le32(sizeof *resp);
630 resp->InformationBufferLength = cpu_to_le32(0);
631 resp->InformationBufferOffset = cpu_to_le32(0);
632 } else
633 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
634
635 params->resp_avail(params->v);
636 return 0;
637}
638
639static int rndis_set_response(struct rndis_params *params,
640 rndis_set_msg_type *buf)
641{
642 u32 BufLength, BufOffset;
643 rndis_set_cmplt_type *resp;
644 rndis_resp_t *r;
645
646 BufLength = le32_to_cpu(buf->InformationBufferLength);
647 BufOffset = le32_to_cpu(buf->InformationBufferOffset);
648 if ((BufLength > RNDIS_MAX_TOTAL_SIZE) ||
649 (BufOffset > RNDIS_MAX_TOTAL_SIZE) ||
650 (BufOffset + 8 >= RNDIS_MAX_TOTAL_SIZE))
651 return -EINVAL;
652
653 r = rndis_add_response(params, sizeof(rndis_set_cmplt_type));
654 if (!r)
655 return -ENOMEM;
656 resp = (rndis_set_cmplt_type *)r->buf;
657
658#ifdef VERBOSE_DEBUG
659 pr_debug("%s: Length: %d\n", __func__, BufLength);
660 pr_debug("%s: Offset: %d\n", __func__, BufOffset);
661 pr_debug("%s: InfoBuffer: ", __func__);
662
663 for (i = 0; i < BufLength; i++) {
664 pr_debug("%02x ", *(((u8 *) buf) + i + 8 + BufOffset));
665 }
666
667 pr_debug("\n");
668#endif
669
670 resp->MessageType = cpu_to_le32(RNDIS_MSG_SET_C);
671 resp->MessageLength = cpu_to_le32(16);
672 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
673 if (gen_ndis_set_resp(params, le32_to_cpu(buf->OID),
674 ((u8 *)buf) + 8 + BufOffset, BufLength, r))
675 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
676 else
677 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
678
679 params->resp_avail(params->v);
680 return 0;
681}
682
683static int rndis_reset_response(struct rndis_params *params,
684 rndis_reset_msg_type *buf)
685{
686 rndis_reset_cmplt_type *resp;
687 rndis_resp_t *r;
688 u8 *xbuf;
689 u32 length;
690
691 /* drain the response queue */
692 while ((xbuf = rndis_get_next_response(params, &length)))
693 rndis_free_response(params, xbuf);
694
695 r = rndis_add_response(params, sizeof(rndis_reset_cmplt_type));
696 if (!r)
697 return -ENOMEM;
698 resp = (rndis_reset_cmplt_type *)r->buf;
699
700 resp->MessageType = cpu_to_le32(RNDIS_MSG_RESET_C);
701 resp->MessageLength = cpu_to_le32(16);
702 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
703 /* resent information */
704 resp->AddressingReset = cpu_to_le32(1);
705
706 params->resp_avail(params->v);
707 return 0;
708}
709
710static int rndis_keepalive_response(struct rndis_params *params,
711 rndis_keepalive_msg_type *buf)
712{
713 rndis_keepalive_cmplt_type *resp;
714 rndis_resp_t *r;
715
716 /* host "should" check only in RNDIS_DATA_INITIALIZED state */
717
718 r = rndis_add_response(params, sizeof(rndis_keepalive_cmplt_type));
719 if (!r)
720 return -ENOMEM;
721 resp = (rndis_keepalive_cmplt_type *)r->buf;
722
723 resp->MessageType = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C);
724 resp->MessageLength = cpu_to_le32(16);
725 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
726 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
727
728 params->resp_avail(params->v);
729 return 0;
730}
731
732
733/*
734 * Device to Host Comunication
735 */
736static int rndis_indicate_status_msg(struct rndis_params *params, u32 status)
737{
738 rndis_indicate_status_msg_type *resp;
739 rndis_resp_t *r;
740
741 if (params->state == RNDIS_UNINITIALIZED)
742 return -ENOTSUPP;
743
744 r = rndis_add_response(params, sizeof(rndis_indicate_status_msg_type));
745 if (!r)
746 return -ENOMEM;
747 resp = (rndis_indicate_status_msg_type *)r->buf;
748
749 resp->MessageType = cpu_to_le32(RNDIS_MSG_INDICATE);
750 resp->MessageLength = cpu_to_le32(20);
751 resp->Status = cpu_to_le32(status);
752 resp->StatusBufferLength = cpu_to_le32(0);
753 resp->StatusBufferOffset = cpu_to_le32(0);
754
755 params->resp_avail(params->v);
756 return 0;
757}
758
759int rndis_signal_connect(struct rndis_params *params)
760{
761 params->media_state = RNDIS_MEDIA_STATE_CONNECTED;
762 return rndis_indicate_status_msg(params, RNDIS_STATUS_MEDIA_CONNECT);
763}
764EXPORT_SYMBOL_GPL(rndis_signal_connect);
765
766int rndis_signal_disconnect(struct rndis_params *params)
767{
768 params->media_state = RNDIS_MEDIA_STATE_DISCONNECTED;
769 return rndis_indicate_status_msg(params, RNDIS_STATUS_MEDIA_DISCONNECT);
770}
771EXPORT_SYMBOL_GPL(rndis_signal_disconnect);
772
773void rndis_uninit(struct rndis_params *params)
774{
775 u8 *buf;
776 u32 length;
777
778 if (!params)
779 return;
780 params->state = RNDIS_UNINITIALIZED;
781
782 /* drain the response queue */
783 while ((buf = rndis_get_next_response(params, &length)))
784 rndis_free_response(params, buf);
785}
786EXPORT_SYMBOL_GPL(rndis_uninit);
787
788void rndis_set_host_mac(struct rndis_params *params, const u8 *addr)
789{
790 params->host_mac = addr;
791}
792EXPORT_SYMBOL_GPL(rndis_set_host_mac);
793
794/*
795 * Message Parser
796 */
797int rndis_msg_parser(struct rndis_params *params, u8 *buf)
798{
799 u32 MsgType, MsgLength;
800 __le32 *tmp;
801
802 if (!buf)
803 return -ENOMEM;
804
805 tmp = (__le32 *)buf;
806 MsgType = get_unaligned_le32(tmp++);
807 MsgLength = get_unaligned_le32(tmp++);
808
809 if (!params)
810 return -ENOTSUPP;
811
812 /* NOTE: RNDIS is *EXTREMELY* chatty ... Windows constantly polls for
813 * rx/tx statistics and link status, in addition to KEEPALIVE traffic
814 * and normal HC level polling to see if there's any IN traffic.
815 */
816
817 /* For USB: responses may take up to 10 seconds */
818 switch (MsgType) {
819 case RNDIS_MSG_INIT:
820 pr_debug("%s: RNDIS_MSG_INIT\n",
821 __func__);
822 params->state = RNDIS_INITIALIZED;
823 return rndis_init_response(params, (rndis_init_msg_type *)buf);
824
825 case RNDIS_MSG_HALT:
826 pr_debug("%s: RNDIS_MSG_HALT\n",
827 __func__);
828 params->state = RNDIS_UNINITIALIZED;
829 if (params->dev) {
830 netif_carrier_off(params->dev);
831 netif_stop_queue(params->dev);
832 }
833 return 0;
834
835 case RNDIS_MSG_QUERY:
836 return rndis_query_response(params,
837 (rndis_query_msg_type *)buf);
838
839 case RNDIS_MSG_SET:
840 return rndis_set_response(params, (rndis_set_msg_type *)buf);
841
842 case RNDIS_MSG_RESET:
843 pr_debug("%s: RNDIS_MSG_RESET\n",
844 __func__);
845 return rndis_reset_response(params,
846 (rndis_reset_msg_type *)buf);
847
848 case RNDIS_MSG_KEEPALIVE:
849 /* For USB: host does this every 5 seconds */
850 if (rndis_debug > 1)
851 pr_debug("%s: RNDIS_MSG_KEEPALIVE\n",
852 __func__);
853 return rndis_keepalive_response(params,
854 (rndis_keepalive_msg_type *)
855 buf);
856
857 default:
858 /* At least Windows XP emits some undefined RNDIS messages.
859 * In one case those messages seemed to relate to the host
860 * suspending itself.
861 */
862 pr_warn("%s: unknown RNDIS message 0x%08X len %d\n",
863 __func__, MsgType, MsgLength);
864 /* Garbled message can be huge, so limit what we display */
865 if (MsgLength > 16)
866 MsgLength = 16;
867 print_hex_dump_bytes(__func__, DUMP_PREFIX_OFFSET,
868 buf, MsgLength);
869 break;
870 }
871
872 return -ENOTSUPP;
873}
874EXPORT_SYMBOL_GPL(rndis_msg_parser);
875
876static inline int rndis_get_nr(void)
877{
878 return ida_alloc_max(&rndis_ida, 999, GFP_KERNEL);
879}
880
881static inline void rndis_put_nr(int nr)
882{
883 ida_free(&rndis_ida, nr);
884}
885
886struct rndis_params *rndis_register(void (*resp_avail)(void *v), void *v)
887{
888 struct rndis_params *params;
889 int i;
890
891 if (!resp_avail)
892 return ERR_PTR(-EINVAL);
893
894 i = rndis_get_nr();
895 if (i < 0) {
896 pr_debug("failed\n");
897
898 return ERR_PTR(-ENODEV);
899 }
900
901 params = kzalloc_obj(*params);
902 if (!params) {
903 rndis_put_nr(i);
904
905 return ERR_PTR(-ENOMEM);
906 }
907
908#ifdef CONFIG_USB_GADGET_DEBUG_FILES
909 {
910 struct proc_dir_entry *proc_entry;
911 char name[20];
912
913 sprintf(name, NAME_TEMPLATE, i);
914 proc_entry = proc_create_data(name, 0660, NULL,
915 &rndis_proc_ops, params);
916 if (!proc_entry) {
917 kfree(params);
918 rndis_put_nr(i);
919
920 return ERR_PTR(-EIO);
921 }
922 }
923#endif
924
925 params->confignr = i;
926 params->used = 1;
927 params->state = RNDIS_UNINITIALIZED;
928 params->media_state = RNDIS_MEDIA_STATE_DISCONNECTED;
929 params->resp_avail = resp_avail;
930 params->v = v;
931 INIT_LIST_HEAD(&params->resp_queue);
932 spin_lock_init(&params->resp_lock);
933 pr_debug("%s: configNr = %d\n", __func__, i);
934
935 return params;
936}
937EXPORT_SYMBOL_GPL(rndis_register);
938
939void rndis_deregister(struct rndis_params *params)
940{
941 int i;
942
943 pr_debug("%s:\n", __func__);
944
945 if (!params)
946 return;
947
948 i = params->confignr;
949
950#ifdef CONFIG_USB_GADGET_DEBUG_FILES
951 {
952 char name[20];
953
954 sprintf(name, NAME_TEMPLATE, i);
955 remove_proc_entry(name, NULL);
956 }
957#endif
958
959 kfree(params);
960 rndis_put_nr(i);
961}
962EXPORT_SYMBOL_GPL(rndis_deregister);
963int rndis_set_param_dev(struct rndis_params *params, struct net_device *dev,
964 u16 *cdc_filter)
965{
966 pr_debug("%s:\n", __func__);
967 if (!dev)
968 return -EINVAL;
969 if (!params)
970 return -1;
971
972 params->dev = dev;
973 params->filter = cdc_filter;
974
975 return 0;
976}
977EXPORT_SYMBOL_GPL(rndis_set_param_dev);
978
979int rndis_set_param_vendor(struct rndis_params *params, u32 vendorID,
980 const char *vendorDescr)
981{
982 pr_debug("%s:\n", __func__);
983 if (!vendorDescr) return -1;
984 if (!params)
985 return -1;
986
987 params->vendorID = vendorID;
988 params->vendorDescr = vendorDescr;
989
990 return 0;
991}
992EXPORT_SYMBOL_GPL(rndis_set_param_vendor);
993
994int rndis_set_param_medium(struct rndis_params *params, u32 medium, u32 speed)
995{
996 pr_debug("%s: %u %u\n", __func__, medium, speed);
997 if (!params)
998 return -1;
999
1000 params->medium = medium;
1001 params->speed = speed;
1002
1003 return 0;
1004}
1005EXPORT_SYMBOL_GPL(rndis_set_param_medium);
1006
1007void rndis_add_hdr(struct sk_buff *skb)
1008{
1009 struct rndis_packet_msg_type *header;
1010
1011 if (!skb)
1012 return;
1013 header = skb_push(skb, sizeof(*header));
1014 memset(header, 0, sizeof *header);
1015 header->MessageType = cpu_to_le32(RNDIS_MSG_PACKET);
1016 header->MessageLength = cpu_to_le32(skb->len);
1017 header->DataOffset = cpu_to_le32(36);
1018 header->DataLength = cpu_to_le32(skb->len - sizeof(*header));
1019}
1020EXPORT_SYMBOL_GPL(rndis_add_hdr);
1021
1022void rndis_free_response(struct rndis_params *params, u8 *buf)
1023{
1024 rndis_resp_t *r, *n;
1025
1026 spin_lock(&params->resp_lock);
1027 list_for_each_entry_safe(r, n, &params->resp_queue, list) {
1028 if (r->buf == buf) {
1029 list_del(&r->list);
1030 kfree(r);
1031 }
1032 }
1033 spin_unlock(&params->resp_lock);
1034}
1035EXPORT_SYMBOL_GPL(rndis_free_response);
1036
1037u8 *rndis_get_next_response(struct rndis_params *params, u32 *length)
1038{
1039 rndis_resp_t *r, *n;
1040
1041 if (!length) return NULL;
1042
1043 spin_lock(&params->resp_lock);
1044 list_for_each_entry_safe(r, n, &params->resp_queue, list) {
1045 if (!r->send) {
1046 r->send = 1;
1047 *length = r->length;
1048 spin_unlock(&params->resp_lock);
1049 return r->buf;
1050 }
1051 }
1052
1053 spin_unlock(&params->resp_lock);
1054 return NULL;
1055}
1056EXPORT_SYMBOL_GPL(rndis_get_next_response);
1057
1058static rndis_resp_t *rndis_add_response(struct rndis_params *params, u32 length)
1059{
1060 rndis_resp_t *r;
1061
1062 /* NOTE: this gets copied into ether.c USB_BUFSIZ bytes ... */
1063 r = kmalloc(sizeof(rndis_resp_t) + length, GFP_ATOMIC);
1064 if (!r) return NULL;
1065
1066 r->buf = (u8 *)(r + 1);
1067 r->length = length;
1068 r->send = 0;
1069
1070 spin_lock(&params->resp_lock);
1071 list_add_tail(&r->list, &params->resp_queue);
1072 spin_unlock(&params->resp_lock);
1073 return r;
1074}
1075
1076int rndis_rm_hdr(struct gether *port,
1077 struct sk_buff *skb,
1078 struct sk_buff_head *list)
1079{
1080 /* tmp points to a struct rndis_packet_msg_type */
1081 __le32 *tmp = (void *)skb->data;
1082
1083 /* Need at least MessageType, MessageLength, DataOffset, DataLength */
1084 if (skb->len < 16) {
1085 dev_kfree_skb_any(skb);
1086 return -EINVAL;
1087 }
1088
1089 /* MessageType, MessageLength */
1090 if (cpu_to_le32(RNDIS_MSG_PACKET)
1091 != get_unaligned(tmp++)) {
1092 dev_kfree_skb_any(skb);
1093 return -EINVAL;
1094 }
1095 tmp++;
1096
1097 /* DataOffset, DataLength */
1098 if (!skb_pull(skb, get_unaligned_le32(tmp++) + 8)) {
1099 dev_kfree_skb_any(skb);
1100 return -EOVERFLOW;
1101 }
1102 skb_trim(skb, get_unaligned_le32(tmp++));
1103
1104 skb_queue_tail(list, skb);
1105 return 0;
1106}
1107EXPORT_SYMBOL_GPL(rndis_rm_hdr);
1108
1109#ifdef CONFIG_USB_GADGET_DEBUG_FILES
1110
1111static int rndis_proc_show(struct seq_file *m, void *v)
1112{
1113 rndis_params *param = m->private;
1114
1115 seq_printf(m,
1116 "Config Nr. %d\n"
1117 "used : %s\n"
1118 "state : %s\n"
1119 "medium : 0x%08X\n"
1120 "speed : %u\n"
1121 "cable : %s\n"
1122 "vendor ID : 0x%08X\n"
1123 "vendor : %s\n",
1124 param->confignr, (param->used) ? "y" : "n",
1125 ({ char *s = "?";
1126 switch (param->state) {
1127 case RNDIS_UNINITIALIZED:
1128 s = "RNDIS_UNINITIALIZED"; break;
1129 case RNDIS_INITIALIZED:
1130 s = "RNDIS_INITIALIZED"; break;
1131 case RNDIS_DATA_INITIALIZED:
1132 s = "RNDIS_DATA_INITIALIZED"; break;
1133 } s; }),
1134 param->medium,
1135 (param->media_state) ? 0 : param->speed*100,
1136 (param->media_state) ? "disconnected" : "connected",
1137 param->vendorID, param->vendorDescr);
1138 return 0;
1139}
1140
1141static ssize_t rndis_proc_write(struct file *file, const char __user *buffer,
1142 size_t count, loff_t *ppos)
1143{
1144 rndis_params *p = pde_data(file_inode(file));
1145 u32 speed = 0;
1146 int i, fl_speed = 0;
1147
1148 for (i = 0; i < count; i++) {
1149 char c;
1150 if (get_user(c, buffer))
1151 return -EFAULT;
1152 switch (c) {
1153 case '0':
1154 case '1':
1155 case '2':
1156 case '3':
1157 case '4':
1158 case '5':
1159 case '6':
1160 case '7':
1161 case '8':
1162 case '9':
1163 fl_speed = 1;
1164 speed = speed * 10 + c - '0';
1165 break;
1166 case 'C':
1167 case 'c':
1168 rndis_signal_connect(p);
1169 break;
1170 case 'D':
1171 case 'd':
1172 rndis_signal_disconnect(p);
1173 break;
1174 default:
1175 if (fl_speed) p->speed = speed;
1176 else pr_debug("%c is not valid\n", c);
1177 break;
1178 }
1179
1180 buffer++;
1181 }
1182
1183 return count;
1184}
1185
1186static int rndis_proc_open(struct inode *inode, struct file *file)
1187{
1188 return single_open(file, rndis_proc_show, pde_data(inode));
1189}
1190
1191static const struct proc_ops rndis_proc_ops = {
1192 .proc_open = rndis_proc_open,
1193 .proc_read = seq_read,
1194 .proc_lseek = seq_lseek,
1195 .proc_release = single_release,
1196 .proc_write = rndis_proc_write,
1197};
1198
1199#define NAME_TEMPLATE "driver/rndis-%03d"
1200
1201#endif /* CONFIG_USB_GADGET_DEBUG_FILES */