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 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 if (buf_len < 2) { 510 pr_err("%s:Not support for buf_len < 2\n", __func__); 511 break; 512 } 513 514 /* these NDIS_PACKET_TYPE_* bitflags are shared with 515 * cdc_filter; it's not RNDIS-specific 516 * NDIS_PACKET_TYPE_x == USB_CDC_PACKET_TYPE_x for x in: 517 * PROMISCUOUS, DIRECTED, 518 * MULTICAST, ALL_MULTICAST, BROADCAST 519 */ 520 *params->filter = (u16)get_unaligned_le32(buf); 521 pr_debug("%s: RNDIS_OID_GEN_CURRENT_PACKET_FILTER %08x\n", 522 __func__, *params->filter); 523 524 /* this call has a significant side effect: it's 525 * what makes the packet flow start and stop, like 526 * activating the CDC Ethernet altsetting. 527 */ 528 retval = 0; 529 if (*params->filter) { 530 params->state = RNDIS_DATA_INITIALIZED; 531 netif_carrier_on(params->dev); 532 if (netif_running(params->dev)) 533 netif_wake_queue(params->dev); 534 } else { 535 params->state = RNDIS_INITIALIZED; 536 netif_carrier_off(params->dev); 537 netif_stop_queue(params->dev); 538 } 539 break; 540 541 case RNDIS_OID_802_3_MULTICAST_LIST: 542 /* I think we can ignore this */ 543 pr_debug("%s: RNDIS_OID_802_3_MULTICAST_LIST\n", __func__); 544 retval = 0; 545 break; 546 547 default: 548 pr_warn("%s: set unknown OID 0x%08X, size %d\n", 549 __func__, OID, buf_len); 550 } 551 552 return retval; 553} 554 555/* 556 * Response Functions 557 */ 558 559static int rndis_init_response(struct rndis_params *params, 560 rndis_init_msg_type *buf) 561{ 562 rndis_init_cmplt_type *resp; 563 rndis_resp_t *r; 564 565 if (!params->dev) 566 return -ENOTSUPP; 567 568 r = rndis_add_response(params, sizeof(rndis_init_cmplt_type)); 569 if (!r) 570 return -ENOMEM; 571 resp = (rndis_init_cmplt_type *)r->buf; 572 573 resp->MessageType = cpu_to_le32(RNDIS_MSG_INIT_C); 574 resp->MessageLength = cpu_to_le32(52); 575 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */ 576 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS); 577 resp->MajorVersion = cpu_to_le32(RNDIS_MAJOR_VERSION); 578 resp->MinorVersion = cpu_to_le32(RNDIS_MINOR_VERSION); 579 resp->DeviceFlags = cpu_to_le32(RNDIS_DF_CONNECTIONLESS); 580 resp->Medium = cpu_to_le32(RNDIS_MEDIUM_802_3); 581 resp->MaxPacketsPerTransfer = cpu_to_le32(1); 582 resp->MaxTransferSize = cpu_to_le32( 583 params->dev->mtu 584 + sizeof(struct ethhdr) 585 + sizeof(struct rndis_packet_msg_type) 586 + 22); 587 resp->PacketAlignmentFactor = cpu_to_le32(0); 588 resp->AFListOffset = cpu_to_le32(0); 589 resp->AFListSize = cpu_to_le32(0); 590 591 params->resp_avail(params->v); 592 return 0; 593} 594 595static int rndis_query_response(struct rndis_params *params, 596 rndis_query_msg_type *buf) 597{ 598 rndis_query_cmplt_type *resp; 599 u32 BufOffset, BufLength; 600 rndis_resp_t *r; 601 602 /* pr_debug("%s: OID = %08X\n", __func__, cpu_to_le32(buf->OID)); */ 603 if (!params->dev) 604 return -ENOTSUPP; 605 606 /* 607 * we need more memory: 608 * gen_ndis_query_resp expects enough space for 609 * rndis_query_cmplt_type followed by data. 610 * oid_supported_list is the largest data reply 611 */ 612 r = rndis_add_response(params, 613 sizeof(oid_supported_list) + sizeof(rndis_query_cmplt_type)); 614 if (!r) 615 return -ENOMEM; 616 resp = (rndis_query_cmplt_type *)r->buf; 617 618 resp->MessageType = cpu_to_le32(RNDIS_MSG_QUERY_C); 619 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */ 620 BufOffset = le32_to_cpu(buf->InformationBufferOffset); 621 BufLength = le32_to_cpu(buf->InformationBufferLength); 622 623 /* 624 * If the address of the buf to be accessed exceeds the valid 625 * range of the buf, then return RNDIS_STATUS_NOT_SUPPORTED. 626 */ 627 if (8 + BufOffset + BufLength >= USB_COMP_EP0_BUFSIZ) { 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 params->resp_avail(params->v); 633 return 0; 634 } 635 636 if (gen_ndis_query_resp(params, le32_to_cpu(buf->OID), 637 BufOffset + 8 + (u8 *)buf, BufLength, 638 r)) { 639 /* OID not supported */ 640 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED); 641 resp->MessageLength = cpu_to_le32(sizeof *resp); 642 resp->InformationBufferLength = cpu_to_le32(0); 643 resp->InformationBufferOffset = cpu_to_le32(0); 644 } else 645 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS); 646 647 params->resp_avail(params->v); 648 return 0; 649} 650 651static int rndis_set_response(struct rndis_params *params, 652 rndis_set_msg_type *buf) 653{ 654 u32 BufLength, BufOffset; 655 rndis_set_cmplt_type *resp; 656 rndis_resp_t *r; 657 658 BufLength = le32_to_cpu(buf->InformationBufferLength); 659 BufOffset = le32_to_cpu(buf->InformationBufferOffset); 660 if ((BufLength > RNDIS_MAX_TOTAL_SIZE) || 661 (BufOffset > RNDIS_MAX_TOTAL_SIZE) || 662 (BufOffset + 8 >= RNDIS_MAX_TOTAL_SIZE)) 663 return -EINVAL; 664 665 r = rndis_add_response(params, sizeof(rndis_set_cmplt_type)); 666 if (!r) 667 return -ENOMEM; 668 resp = (rndis_set_cmplt_type *)r->buf; 669 670#ifdef VERBOSE_DEBUG 671 pr_debug("%s: Length: %d\n", __func__, BufLength); 672 pr_debug("%s: Offset: %d\n", __func__, BufOffset); 673 pr_debug("%s: InfoBuffer: ", __func__); 674 675 for (i = 0; i < BufLength; i++) { 676 pr_debug("%02x ", *(((u8 *) buf) + i + 8 + BufOffset)); 677 } 678 679 pr_debug("\n"); 680#endif 681 682 resp->MessageType = cpu_to_le32(RNDIS_MSG_SET_C); 683 resp->MessageLength = cpu_to_le32(16); 684 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */ 685 686 /* 687 * If the address of the buf to be accessed exceeds the valid 688 * range of the buf, then return RNDIS_STATUS_NOT_SUPPORTED. 689 */ 690 if (8 + BufOffset + BufLength >= USB_COMP_EP0_BUFSIZ) { 691 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED); 692 params->resp_avail(params->v); 693 return 0; 694 } 695 696 if (gen_ndis_set_resp(params, le32_to_cpu(buf->OID), 697 ((u8 *)buf) + 8 + BufOffset, BufLength, r)) 698 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED); 699 else 700 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS); 701 702 params->resp_avail(params->v); 703 return 0; 704} 705 706static int rndis_reset_response(struct rndis_params *params, 707 rndis_reset_msg_type *buf) 708{ 709 rndis_reset_cmplt_type *resp; 710 rndis_resp_t *r; 711 u8 *xbuf; 712 u32 length; 713 714 /* drain the response queue */ 715 while ((xbuf = rndis_get_next_response(params, &length))) 716 rndis_free_response(params, xbuf); 717 718 r = rndis_add_response(params, sizeof(rndis_reset_cmplt_type)); 719 if (!r) 720 return -ENOMEM; 721 resp = (rndis_reset_cmplt_type *)r->buf; 722 723 resp->MessageType = cpu_to_le32(RNDIS_MSG_RESET_C); 724 resp->MessageLength = cpu_to_le32(16); 725 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS); 726 /* resent information */ 727 resp->AddressingReset = cpu_to_le32(1); 728 729 params->resp_avail(params->v); 730 return 0; 731} 732 733static int rndis_keepalive_response(struct rndis_params *params, 734 rndis_keepalive_msg_type *buf) 735{ 736 rndis_keepalive_cmplt_type *resp; 737 rndis_resp_t *r; 738 739 /* host "should" check only in RNDIS_DATA_INITIALIZED state */ 740 741 r = rndis_add_response(params, sizeof(rndis_keepalive_cmplt_type)); 742 if (!r) 743 return -ENOMEM; 744 resp = (rndis_keepalive_cmplt_type *)r->buf; 745 746 resp->MessageType = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C); 747 resp->MessageLength = cpu_to_le32(16); 748 resp->RequestID = buf->RequestID; /* Still LE in msg buffer */ 749 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS); 750 751 params->resp_avail(params->v); 752 return 0; 753} 754 755 756/* 757 * Device to Host Comunication 758 */ 759static int rndis_indicate_status_msg(struct rndis_params *params, u32 status) 760{ 761 rndis_indicate_status_msg_type *resp; 762 rndis_resp_t *r; 763 764 if (params->state == RNDIS_UNINITIALIZED) 765 return -ENOTSUPP; 766 767 r = rndis_add_response(params, sizeof(rndis_indicate_status_msg_type)); 768 if (!r) 769 return -ENOMEM; 770 resp = (rndis_indicate_status_msg_type *)r->buf; 771 772 resp->MessageType = cpu_to_le32(RNDIS_MSG_INDICATE); 773 resp->MessageLength = cpu_to_le32(20); 774 resp->Status = cpu_to_le32(status); 775 resp->StatusBufferLength = cpu_to_le32(0); 776 resp->StatusBufferOffset = cpu_to_le32(0); 777 778 params->resp_avail(params->v); 779 return 0; 780} 781 782int rndis_signal_connect(struct rndis_params *params) 783{ 784 params->media_state = RNDIS_MEDIA_STATE_CONNECTED; 785 return rndis_indicate_status_msg(params, RNDIS_STATUS_MEDIA_CONNECT); 786} 787EXPORT_SYMBOL_GPL(rndis_signal_connect); 788 789int rndis_signal_disconnect(struct rndis_params *params) 790{ 791 params->media_state = RNDIS_MEDIA_STATE_DISCONNECTED; 792 return rndis_indicate_status_msg(params, RNDIS_STATUS_MEDIA_DISCONNECT); 793} 794EXPORT_SYMBOL_GPL(rndis_signal_disconnect); 795 796void rndis_uninit(struct rndis_params *params) 797{ 798 u8 *buf; 799 u32 length; 800 801 if (!params) 802 return; 803 params->state = RNDIS_UNINITIALIZED; 804 805 /* drain the response queue */ 806 while ((buf = rndis_get_next_response(params, &length))) 807 rndis_free_response(params, buf); 808} 809EXPORT_SYMBOL_GPL(rndis_uninit); 810 811void rndis_set_host_mac(struct rndis_params *params, const u8 *addr) 812{ 813 params->host_mac = addr; 814} 815EXPORT_SYMBOL_GPL(rndis_set_host_mac); 816 817/* 818 * Message Parser 819 */ 820int rndis_msg_parser(struct rndis_params *params, u8 *buf) 821{ 822 u32 MsgType, MsgLength; 823 __le32 *tmp; 824 825 if (!buf) 826 return -ENOMEM; 827 828 tmp = (__le32 *)buf; 829 MsgType = get_unaligned_le32(tmp++); 830 MsgLength = get_unaligned_le32(tmp++); 831 832 if (!params) 833 return -ENOTSUPP; 834 835 /* NOTE: RNDIS is *EXTREMELY* chatty ... Windows constantly polls for 836 * rx/tx statistics and link status, in addition to KEEPALIVE traffic 837 * and normal HC level polling to see if there's any IN traffic. 838 */ 839 840 /* For USB: responses may take up to 10 seconds */ 841 switch (MsgType) { 842 case RNDIS_MSG_INIT: 843 pr_debug("%s: RNDIS_MSG_INIT\n", 844 __func__); 845 params->state = RNDIS_INITIALIZED; 846 return rndis_init_response(params, (rndis_init_msg_type *)buf); 847 848 case RNDIS_MSG_HALT: 849 pr_debug("%s: RNDIS_MSG_HALT\n", 850 __func__); 851 params->state = RNDIS_UNINITIALIZED; 852 if (params->dev) { 853 netif_carrier_off(params->dev); 854 netif_stop_queue(params->dev); 855 } 856 return 0; 857 858 case RNDIS_MSG_QUERY: 859 return rndis_query_response(params, 860 (rndis_query_msg_type *)buf); 861 862 case RNDIS_MSG_SET: 863 return rndis_set_response(params, (rndis_set_msg_type *)buf); 864 865 case RNDIS_MSG_RESET: 866 pr_debug("%s: RNDIS_MSG_RESET\n", 867 __func__); 868 return rndis_reset_response(params, 869 (rndis_reset_msg_type *)buf); 870 871 case RNDIS_MSG_KEEPALIVE: 872 /* For USB: host does this every 5 seconds */ 873 if (rndis_debug > 1) 874 pr_debug("%s: RNDIS_MSG_KEEPALIVE\n", 875 __func__); 876 return rndis_keepalive_response(params, 877 (rndis_keepalive_msg_type *) 878 buf); 879 880 default: 881 /* At least Windows XP emits some undefined RNDIS messages. 882 * In one case those messages seemed to relate to the host 883 * suspending itself. 884 */ 885 pr_warn("%s: unknown RNDIS message 0x%08X len %d\n", 886 __func__, MsgType, MsgLength); 887 /* Garbled message can be huge, so limit what we display */ 888 if (MsgLength > 16) 889 MsgLength = 16; 890 print_hex_dump_bytes(__func__, DUMP_PREFIX_OFFSET, 891 buf, MsgLength); 892 break; 893 } 894 895 return -ENOTSUPP; 896} 897EXPORT_SYMBOL_GPL(rndis_msg_parser); 898 899static inline int rndis_get_nr(void) 900{ 901 return ida_simple_get(&rndis_ida, 0, 0, GFP_KERNEL); 902} 903 904static inline void rndis_put_nr(int nr) 905{ 906 ida_simple_remove(&rndis_ida, nr); 907} 908 909struct rndis_params *rndis_register(void (*resp_avail)(void *v), void *v) 910{ 911 struct rndis_params *params; 912 int i; 913 914 if (!resp_avail) 915 return ERR_PTR(-EINVAL); 916 917 i = rndis_get_nr(); 918 if (i < 0) { 919 pr_debug("failed\n"); 920 921 return ERR_PTR(-ENODEV); 922 } 923 924 params = kzalloc(sizeof(*params), GFP_KERNEL); 925 if (!params) { 926 rndis_put_nr(i); 927 928 return ERR_PTR(-ENOMEM); 929 } 930 931#ifdef CONFIG_USB_GADGET_DEBUG_FILES 932 { 933 struct proc_dir_entry *proc_entry; 934 char name[20]; 935 936 sprintf(name, NAME_TEMPLATE, i); 937 proc_entry = proc_create_data(name, 0660, NULL, 938 &rndis_proc_ops, params); 939 if (!proc_entry) { 940 kfree(params); 941 rndis_put_nr(i); 942 943 return ERR_PTR(-EIO); 944 } 945 } 946#endif 947 948 params->confignr = i; 949 params->used = 1; 950 params->state = RNDIS_UNINITIALIZED; 951 params->media_state = RNDIS_MEDIA_STATE_DISCONNECTED; 952 params->resp_avail = resp_avail; 953 params->v = v; 954 INIT_LIST_HEAD(¶ms->resp_queue); 955 spin_lock_init(¶ms->resp_lock); 956 pr_debug("%s: configNr = %d\n", __func__, i); 957 958 return params; 959} 960EXPORT_SYMBOL_GPL(rndis_register); 961 962void rndis_deregister(struct rndis_params *params) 963{ 964 int i; 965 966 pr_debug("%s:\n", __func__); 967 968 if (!params) 969 return; 970 971 i = params->confignr; 972 973#ifdef CONFIG_USB_GADGET_DEBUG_FILES 974 { 975 char name[20]; 976 977 sprintf(name, NAME_TEMPLATE, i); 978 remove_proc_entry(name, NULL); 979 } 980#endif 981 982 kfree(params); 983 rndis_put_nr(i); 984} 985EXPORT_SYMBOL_GPL(rndis_deregister); 986int rndis_set_param_dev(struct rndis_params *params, struct net_device *dev, 987 u16 *cdc_filter) 988{ 989 pr_debug("%s:\n", __func__); 990 if (!dev) 991 return -EINVAL; 992 if (!params) 993 return -1; 994 995 params->dev = dev; 996 params->filter = cdc_filter; 997 998 return 0; 999} 1000EXPORT_SYMBOL_GPL(rndis_set_param_dev); 1001 1002int rndis_set_param_vendor(struct rndis_params *params, u32 vendorID, 1003 const char *vendorDescr) 1004{ 1005 pr_debug("%s:\n", __func__); 1006 if (!vendorDescr) return -1; 1007 if (!params) 1008 return -1; 1009 1010 params->vendorID = vendorID; 1011 params->vendorDescr = vendorDescr; 1012 1013 return 0; 1014} 1015EXPORT_SYMBOL_GPL(rndis_set_param_vendor); 1016 1017int rndis_set_param_medium(struct rndis_params *params, u32 medium, u32 speed) 1018{ 1019 pr_debug("%s: %u %u\n", __func__, medium, speed); 1020 if (!params) 1021 return -1; 1022 1023 params->medium = medium; 1024 params->speed = speed; 1025 1026 return 0; 1027} 1028EXPORT_SYMBOL_GPL(rndis_set_param_medium); 1029 1030void rndis_add_hdr(struct sk_buff *skb) 1031{ 1032 struct rndis_packet_msg_type *header; 1033 1034 if (!skb) 1035 return; 1036 header = skb_push(skb, sizeof(*header)); 1037 memset(header, 0, sizeof *header); 1038 header->MessageType = cpu_to_le32(RNDIS_MSG_PACKET); 1039 header->MessageLength = cpu_to_le32(skb->len); 1040 header->DataOffset = cpu_to_le32(36); 1041 header->DataLength = cpu_to_le32(skb->len - sizeof(*header)); 1042} 1043EXPORT_SYMBOL_GPL(rndis_add_hdr); 1044 1045void rndis_free_response(struct rndis_params *params, u8 *buf) 1046{ 1047 rndis_resp_t *r, *n; 1048 1049 spin_lock(¶ms->resp_lock); 1050 list_for_each_entry_safe(r, n, ¶ms->resp_queue, list) { 1051 if (r->buf == buf) { 1052 list_del(&r->list); 1053 kfree(r); 1054 } 1055 } 1056 spin_unlock(¶ms->resp_lock); 1057} 1058EXPORT_SYMBOL_GPL(rndis_free_response); 1059 1060u8 *rndis_get_next_response(struct rndis_params *params, u32 *length) 1061{ 1062 rndis_resp_t *r, *n; 1063 1064 if (!length) return NULL; 1065 1066 spin_lock(¶ms->resp_lock); 1067 list_for_each_entry_safe(r, n, ¶ms->resp_queue, list) { 1068 if (!r->send) { 1069 r->send = 1; 1070 *length = r->length; 1071 spin_unlock(¶ms->resp_lock); 1072 return r->buf; 1073 } 1074 } 1075 1076 spin_unlock(¶ms->resp_lock); 1077 return NULL; 1078} 1079EXPORT_SYMBOL_GPL(rndis_get_next_response); 1080 1081static rndis_resp_t *rndis_add_response(struct rndis_params *params, u32 length) 1082{ 1083 rndis_resp_t *r; 1084 1085 /* NOTE: this gets copied into ether.c USB_BUFSIZ bytes ... */ 1086 r = kmalloc(sizeof(rndis_resp_t) + length, GFP_ATOMIC); 1087 if (!r) return NULL; 1088 1089 r->buf = (u8 *)(r + 1); 1090 r->length = length; 1091 r->send = 0; 1092 1093 spin_lock(¶ms->resp_lock); 1094 list_add_tail(&r->list, ¶ms->resp_queue); 1095 spin_unlock(¶ms->resp_lock); 1096 return r; 1097} 1098 1099int rndis_rm_hdr(struct gether *port, 1100 struct sk_buff *skb, 1101 struct sk_buff_head *list) 1102{ 1103 /* tmp points to a struct rndis_packet_msg_type */ 1104 __le32 *tmp = (void *)skb->data; 1105 1106 /* MessageType, MessageLength */ 1107 if (cpu_to_le32(RNDIS_MSG_PACKET) 1108 != get_unaligned(tmp++)) { 1109 dev_kfree_skb_any(skb); 1110 return -EINVAL; 1111 } 1112 tmp++; 1113 1114 /* DataOffset, DataLength */ 1115 if (!skb_pull(skb, get_unaligned_le32(tmp++) + 8)) { 1116 dev_kfree_skb_any(skb); 1117 return -EOVERFLOW; 1118 } 1119 skb_trim(skb, get_unaligned_le32(tmp++)); 1120 1121 skb_queue_tail(list, skb); 1122 return 0; 1123} 1124EXPORT_SYMBOL_GPL(rndis_rm_hdr); 1125 1126#ifdef CONFIG_USB_GADGET_DEBUG_FILES 1127 1128static int rndis_proc_show(struct seq_file *m, void *v) 1129{ 1130 rndis_params *param = m->private; 1131 1132 seq_printf(m, 1133 "Config Nr. %d\n" 1134 "used : %s\n" 1135 "state : %s\n" 1136 "medium : 0x%08X\n" 1137 "speed : %d\n" 1138 "cable : %s\n" 1139 "vendor ID : 0x%08X\n" 1140 "vendor : %s\n", 1141 param->confignr, (param->used) ? "y" : "n", 1142 ({ char *s = "?"; 1143 switch (param->state) { 1144 case RNDIS_UNINITIALIZED: 1145 s = "RNDIS_UNINITIALIZED"; break; 1146 case RNDIS_INITIALIZED: 1147 s = "RNDIS_INITIALIZED"; break; 1148 case RNDIS_DATA_INITIALIZED: 1149 s = "RNDIS_DATA_INITIALIZED"; break; 1150 } s; }), 1151 param->medium, 1152 (param->media_state) ? 0 : param->speed*100, 1153 (param->media_state) ? "disconnected" : "connected", 1154 param->vendorID, param->vendorDescr); 1155 return 0; 1156} 1157 1158static ssize_t rndis_proc_write(struct file *file, const char __user *buffer, 1159 size_t count, loff_t *ppos) 1160{ 1161 rndis_params *p = PDE_DATA(file_inode(file)); 1162 u32 speed = 0; 1163 int i, fl_speed = 0; 1164 1165 for (i = 0; i < count; i++) { 1166 char c; 1167 if (get_user(c, buffer)) 1168 return -EFAULT; 1169 switch (c) { 1170 case '0': 1171 case '1': 1172 case '2': 1173 case '3': 1174 case '4': 1175 case '5': 1176 case '6': 1177 case '7': 1178 case '8': 1179 case '9': 1180 fl_speed = 1; 1181 speed = speed * 10 + c - '0'; 1182 break; 1183 case 'C': 1184 case 'c': 1185 rndis_signal_connect(p); 1186 break; 1187 case 'D': 1188 case 'd': 1189 rndis_signal_disconnect(p); 1190 break; 1191 default: 1192 if (fl_speed) p->speed = speed; 1193 else pr_debug("%c is not valid\n", c); 1194 break; 1195 } 1196 1197 buffer++; 1198 } 1199 1200 return count; 1201} 1202 1203static int rndis_proc_open(struct inode *inode, struct file *file) 1204{ 1205 return single_open(file, rndis_proc_show, PDE_DATA(inode)); 1206} 1207 1208static const struct proc_ops rndis_proc_ops = { 1209 .proc_open = rndis_proc_open, 1210 .proc_read = seq_read, 1211 .proc_lseek = seq_lseek, 1212 .proc_release = single_release, 1213 .proc_write = rndis_proc_write, 1214}; 1215 1216#define NAME_TEMPLATE "driver/rndis-%03d" 1217 1218#endif /* CONFIG_USB_GADGET_DEBUG_FILES */ 1219