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