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