drivers/usb/gadget/rndis.c

   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/system.h>
  38 #include <asm/unaligned.h>
  39
  40
  41 #undef  VERBOSE_DEBUG
  42
  43 #include "rndis.h"
  44
  45
  46 /* The driver for your USB chip needs to support ep0 OUT to work with
  47  * RNDIS, plus all three CDC Ethernet endpoints (interrupt not optional).
  48  *
  49  * Windows hosts need an INF file like Documentation/usb/linux.inf
  50  * and will be happier if you provide the host_addr module parameter.
  51  */
  52
  53 #if 0
  54 static int rndis_debug = 0;
  55 module_param (rndis_debug, int, 0);
  56 MODULE_PARM_DESC (rndis_debug, "enable debugging");
  57 #else
  58 #define rndis_debug             0
  59 #endif
  60
  61 #define RNDIS_MAX_CONFIGS       1
  62
  63
  64 static rndis_params rndis_per_dev_params [RNDIS_MAX_CONFIGS];
  65
  66 /* Driver Version */
  67 static const __le32 rndis_driver_version = cpu_to_le32 (1);
  68
  69 /* Function Prototypes */
  70 static rndis_resp_t *rndis_add_response (int configNr, u32 length);
  71
  72
  73 /* supported OIDs */
  74 static const u32 oid_supported_list [] =
  75 {
  76         /* the general stuff */
  77         OID_GEN_SUPPORTED_LIST,
  78         OID_GEN_HARDWARE_STATUS,
  79         OID_GEN_MEDIA_SUPPORTED,
  80         OID_GEN_MEDIA_IN_USE,
  81         OID_GEN_MAXIMUM_FRAME_SIZE,
  82         OID_GEN_LINK_SPEED,
  83         OID_GEN_TRANSMIT_BLOCK_SIZE,
  84         OID_GEN_RECEIVE_BLOCK_SIZE,
  85         OID_GEN_VENDOR_ID,
  86         OID_GEN_VENDOR_DESCRIPTION,
  87         OID_GEN_VENDOR_DRIVER_VERSION,
  88         OID_GEN_CURRENT_PACKET_FILTER,
  89         OID_GEN_MAXIMUM_TOTAL_SIZE,
  90         OID_GEN_MEDIA_CONNECT_STATUS,
  91         OID_GEN_PHYSICAL_MEDIUM,
  92
  93         /* the statistical stuff */
  94         OID_GEN_XMIT_OK,
  95         OID_GEN_RCV_OK,
  96         OID_GEN_XMIT_ERROR,
  97         OID_GEN_RCV_ERROR,
  98         OID_GEN_RCV_NO_BUFFER,
  99 #ifdef  RNDIS_OPTIONAL_STATS
 100         OID_GEN_DIRECTED_BYTES_XMIT,
 101         OID_GEN_DIRECTED_FRAMES_XMIT,
 102         OID_GEN_MULTICAST_BYTES_XMIT,
 103         OID_GEN_MULTICAST_FRAMES_XMIT,
 104         OID_GEN_BROADCAST_BYTES_XMIT,
 105         OID_GEN_BROADCAST_FRAMES_XMIT,
 106         OID_GEN_DIRECTED_BYTES_RCV,
 107         OID_GEN_DIRECTED_FRAMES_RCV,
 108         OID_GEN_MULTICAST_BYTES_RCV,
 109         OID_GEN_MULTICAST_FRAMES_RCV,
 110         OID_GEN_BROADCAST_BYTES_RCV,
 111         OID_GEN_BROADCAST_FRAMES_RCV,
 112         OID_GEN_RCV_CRC_ERROR,
 113         OID_GEN_TRANSMIT_QUEUE_LENGTH,
 114 #endif  /* RNDIS_OPTIONAL_STATS */
 115
 116         /* mandatory 802.3 */
 117         /* the general stuff */
 118         OID_802_3_PERMANENT_ADDRESS,
 119         OID_802_3_CURRENT_ADDRESS,
 120         OID_802_3_MULTICAST_LIST,
 121         OID_802_3_MAC_OPTIONS,
 122         OID_802_3_MAXIMUM_LIST_SIZE,
 123
 124         /* the statistical stuff */
 125         OID_802_3_RCV_ERROR_ALIGNMENT,
 126         OID_802_3_XMIT_ONE_COLLISION,
 127         OID_802_3_XMIT_MORE_COLLISIONS,
 128 #ifdef  RNDIS_OPTIONAL_STATS
 129         OID_802_3_XMIT_DEFERRED,
 130         OID_802_3_XMIT_MAX_COLLISIONS,
 131         OID_802_3_RCV_OVERRUN,
 132         OID_802_3_XMIT_UNDERRUN,
 133         OID_802_3_XMIT_HEARTBEAT_FAILURE,
 134         OID_802_3_XMIT_TIMES_CRS_LOST,
 135         OID_802_3_XMIT_LATE_COLLISIONS,
 136 #endif  /* RNDIS_OPTIONAL_STATS */
 137
 138 #ifdef  RNDIS_PM
 139         /* PM and wakeup are "mandatory" for USB, but the RNDIS specs
 140          * don't say what they mean ... and the NDIS specs are often
 141          * confusing and/or ambiguous in this context.  (That is, more
 142          * so than their specs for the other OIDs.)
 143          *
 144          * FIXME someone who knows what these should do, please
 145          * implement them!
 146          */
 147
 148         /* power management */
 149         OID_PNP_CAPABILITIES,
 150         OID_PNP_QUERY_POWER,
 151         OID_PNP_SET_POWER,
 152
 153 #ifdef  RNDIS_WAKEUP
 154         /* wake up host */
 155         OID_PNP_ENABLE_WAKE_UP,
 156         OID_PNP_ADD_WAKE_UP_PATTERN,
 157         OID_PNP_REMOVE_WAKE_UP_PATTERN,
 158 #endif  /* RNDIS_WAKEUP */
 159 #endif  /* RNDIS_PM */
 160 };
 161
 162
 163 /* NDIS Functions */
 164 static int
 165 gen_ndis_query_resp (int configNr, u32 OID, u8 *buf, unsigned buf_len,
 166                 rndis_resp_t *r)
 167 {
 168         int                     retval = -ENOTSUPP;
 169         u32                     length = 4;     /* usually */
 170         __le32                  *outbuf;
 171         int                     i, count;
 172         rndis_query_cmplt_type  *resp;
 173         struct net_device       *net;
 174         struct rtnl_link_stats64 temp;
 175         const struct rtnl_link_stats64 *stats;
 176
 177         if (!r) return -ENOMEM;
 178         resp = (rndis_query_cmplt_type *) r->buf;
 179
 180         if (!resp) return -ENOMEM;
 181
 182         if (buf_len && rndis_debug > 1) {
 183                 pr_debug("query OID %08x value, len %d:\n", OID, buf_len);
 184                 for (i = 0; i < buf_len; i += 16) {
 185                         pr_debug("%03d: %08x %08x %08x %08x\n", i,
 186                                 get_unaligned_le32(&buf[i]),
 187                                 get_unaligned_le32(&buf[i + 4]),
 188                                 get_unaligned_le32(&buf[i + 8]),
 189                                 get_unaligned_le32(&buf[i + 12]));
 190                 }
 191         }
 192
 193         /* response goes here, right after the header */
 194         outbuf = (__le32 *) &resp[1];
 195         resp->InformationBufferOffset = cpu_to_le32 (16);
 196
 197         net = rndis_per_dev_params[configNr].dev;
 198         stats = dev_get_stats(net, &temp);
 199
 200         switch (OID) {
 201
 202         /* general oids (table 4-1) */
 203
 204         /* mandatory */
 205         case OID_GEN_SUPPORTED_LIST:
 206                 pr_debug("%s: OID_GEN_SUPPORTED_LIST\n", __func__);
 207                 length = sizeof (oid_supported_list);
 208                 count  = length / sizeof (u32);
 209                 for (i = 0; i < count; i++)
 210                         outbuf[i] = cpu_to_le32 (oid_supported_list[i]);
 211                 retval = 0;
 212                 break;
 213
 214         /* mandatory */
 215         case OID_GEN_HARDWARE_STATUS:
 216                 pr_debug("%s: OID_GEN_HARDWARE_STATUS\n", __func__);
 217                 /* Bogus question!
 218                  * Hardware must be ready to receive high level protocols.
 219                  * BTW:
 220                  * reddite ergo quae sunt Caesaris Caesari
 221                  * et quae sunt Dei Deo!
 222                  */
 223                 *outbuf = cpu_to_le32 (0);
 224                 retval = 0;
 225                 break;
 226
 227         /* mandatory */
 228         case OID_GEN_MEDIA_SUPPORTED:
 229                 pr_debug("%s: OID_GEN_MEDIA_SUPPORTED\n", __func__);
 230                 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr].medium);
 231                 retval = 0;
 232                 break;
 233
 234         /* mandatory */
 235         case OID_GEN_MEDIA_IN_USE:
 236                 pr_debug("%s: OID_GEN_MEDIA_IN_USE\n", __func__);
 237                 /* one medium, one transport... (maybe you do it better) */
 238                 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr].medium);
 239                 retval = 0;
 240                 break;
 241
 242         /* mandatory */
 243         case OID_GEN_MAXIMUM_FRAME_SIZE:
 244                 pr_debug("%s: OID_GEN_MAXIMUM_FRAME_SIZE\n", __func__);
 245                 if (rndis_per_dev_params [configNr].dev) {
 246                         *outbuf = cpu_to_le32 (
 247                                 rndis_per_dev_params [configNr].dev->mtu);
 248                         retval = 0;
 249                 }
 250                 break;
 251
 252         /* mandatory */
 253         case OID_GEN_LINK_SPEED:
 254                 if (rndis_debug > 1)
 255                         pr_debug("%s: OID_GEN_LINK_SPEED\n", __func__);
 256                 if (rndis_per_dev_params [configNr].media_state
 257                                 == NDIS_MEDIA_STATE_DISCONNECTED)
 258                         *outbuf = cpu_to_le32 (0);
 259                 else
 260                         *outbuf = cpu_to_le32 (
 261                                 rndis_per_dev_params [configNr].speed);
 262                 retval = 0;
 263                 break;
 264
 265         /* mandatory */
 266         case OID_GEN_TRANSMIT_BLOCK_SIZE:
 267                 pr_debug("%s: OID_GEN_TRANSMIT_BLOCK_SIZE\n", __func__);
 268                 if (rndis_per_dev_params [configNr].dev) {
 269                         *outbuf = cpu_to_le32 (
 270                                 rndis_per_dev_params [configNr].dev->mtu);
 271                         retval = 0;
 272                 }
 273                 break;
 274
 275         /* mandatory */
 276         case OID_GEN_RECEIVE_BLOCK_SIZE:
 277                 pr_debug("%s: OID_GEN_RECEIVE_BLOCK_SIZE\n", __func__);
 278                 if (rndis_per_dev_params [configNr].dev) {
 279                         *outbuf = cpu_to_le32 (
 280                                 rndis_per_dev_params [configNr].dev->mtu);
 281                         retval = 0;
 282                 }
 283                 break;
 284
 285         /* mandatory */
 286         case OID_GEN_VENDOR_ID:
 287                 pr_debug("%s: OID_GEN_VENDOR_ID\n", __func__);
 288                 *outbuf = cpu_to_le32 (
 289                         rndis_per_dev_params [configNr].vendorID);
 290                 retval = 0;
 291                 break;
 292
 293         /* mandatory */
 294         case OID_GEN_VENDOR_DESCRIPTION:
 295                 pr_debug("%s: OID_GEN_VENDOR_DESCRIPTION\n", __func__);
 296                 if ( rndis_per_dev_params [configNr].vendorDescr ) {
 297                         length = strlen (rndis_per_dev_params [configNr].vendorDescr);
 298                         memcpy (outbuf,
 299                                 rndis_per_dev_params [configNr].vendorDescr, 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
 493 static 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
 566 static 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 (
 581                         REMOTE_NDIS_INITIALIZE_CMPLT);
 582         resp->MessageLength = cpu_to_le32 (52);
 583         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 584         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 585         resp->MajorVersion = cpu_to_le32 (RNDIS_MAJOR_VERSION);
 586         resp->MinorVersion = cpu_to_le32 (RNDIS_MINOR_VERSION);
 587         resp->DeviceFlags = cpu_to_le32 (RNDIS_DF_CONNECTIONLESS);
 588         resp->Medium = cpu_to_le32 (RNDIS_MEDIUM_802_3);
 589         resp->MaxPacketsPerTransfer = cpu_to_le32 (1);
 590         resp->MaxTransferSize = cpu_to_le32 (
 591                   params->dev->mtu
 592                 + sizeof (struct ethhdr)
 593                 + sizeof (struct rndis_packet_msg_type)
 594                 + 22);
 595         resp->PacketAlignmentFactor = cpu_to_le32 (0);
 596         resp->AFListOffset = cpu_to_le32 (0);
 597         resp->AFListSize = cpu_to_le32 (0);
 598
 599         params->resp_avail(params->v);
 600         return 0;
 601 }
 602
 603 static int rndis_query_response (int configNr, rndis_query_msg_type *buf)
 604 {
 605         rndis_query_cmplt_type *resp;
 606         rndis_resp_t            *r;
 607         struct rndis_params     *params = rndis_per_dev_params + configNr;
 608
 609         /* pr_debug("%s: OID = %08X\n", __func__, cpu_to_le32(buf->OID)); */
 610         if (!params->dev)
 611                 return -ENOTSUPP;
 612
 613         /*
 614          * we need more memory:
 615          * gen_ndis_query_resp expects enough space for
 616          * rndis_query_cmplt_type followed by data.
 617          * oid_supported_list is the largest data reply
 618          */
 619         r = rndis_add_response (configNr,
 620                 sizeof (oid_supported_list) + sizeof(rndis_query_cmplt_type));
 621         if (!r)
 622                 return -ENOMEM;
 623         resp = (rndis_query_cmplt_type *) r->buf;
 624
 625         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_QUERY_CMPLT);
 626         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 627
 628         if (gen_ndis_query_resp (configNr, le32_to_cpu (buf->OID),
 629                         le32_to_cpu(buf->InformationBufferOffset)
 630                                         + 8 + (u8 *) buf,
 631                         le32_to_cpu(buf->InformationBufferLength),
 632                         r)) {
 633                 /* OID not supported */
 634                 resp->Status = cpu_to_le32 (
 635                                 RNDIS_STATUS_NOT_SUPPORTED);
 636                 resp->MessageLength = cpu_to_le32 (sizeof *resp);
 637                 resp->InformationBufferLength = cpu_to_le32 (0);
 638                 resp->InformationBufferOffset = cpu_to_le32 (0);
 639         } else
 640                 resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 641
 642         params->resp_avail(params->v);
 643         return 0;
 644 }
 645
 646 static int rndis_set_response (int configNr, rndis_set_msg_type *buf)
 647 {
 648         u32                     BufLength, BufOffset;
 649         rndis_set_cmplt_type    *resp;
 650         rndis_resp_t            *r;
 651         struct rndis_params     *params = rndis_per_dev_params + configNr;
 652
 653         r = rndis_add_response (configNr, sizeof (rndis_set_cmplt_type));
 654         if (!r)
 655                 return -ENOMEM;
 656         resp = (rndis_set_cmplt_type *) r->buf;
 657
 658         BufLength = le32_to_cpu (buf->InformationBufferLength);
 659         BufOffset = le32_to_cpu (buf->InformationBufferOffset);
 660
 661 #ifdef  VERBOSE_DEBUG
 662         pr_debug("%s: Length: %d\n", __func__, BufLength);
 663         pr_debug("%s: Offset: %d\n", __func__, BufOffset);
 664         pr_debug("%s: InfoBuffer: ", __func__);
 665
 666         for (i = 0; i < BufLength; i++) {
 667                 pr_debug("%02x ", *(((u8 *) buf) + i + 8 + BufOffset));
 668         }
 669
 670         pr_debug("\n");
 671 #endif
 672
 673         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_SET_CMPLT);
 674         resp->MessageLength = cpu_to_le32 (16);
 675         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 676         if (gen_ndis_set_resp (configNr, le32_to_cpu (buf->OID),
 677                         ((u8 *) buf) + 8 + BufOffset, BufLength, r))
 678                 resp->Status = cpu_to_le32 (RNDIS_STATUS_NOT_SUPPORTED);
 679         else
 680                 resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 681
 682         params->resp_avail(params->v);
 683         return 0;
 684 }
 685
 686 static int rndis_reset_response (int configNr, rndis_reset_msg_type *buf)
 687 {
 688         rndis_reset_cmplt_type  *resp;
 689         rndis_resp_t            *r;
 690         struct rndis_params     *params = rndis_per_dev_params + configNr;
 691
 692         r = rndis_add_response (configNr, sizeof (rndis_reset_cmplt_type));
 693         if (!r)
 694                 return -ENOMEM;
 695         resp = (rndis_reset_cmplt_type *) r->buf;
 696
 697         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_RESET_CMPLT);
 698         resp->MessageLength = cpu_to_le32 (16);
 699         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 700         /* resent information */
 701         resp->AddressingReset = cpu_to_le32 (1);
 702
 703         params->resp_avail(params->v);
 704         return 0;
 705 }
 706
 707 static int rndis_keepalive_response (int configNr,
 708                                 rndis_keepalive_msg_type *buf)
 709 {
 710         rndis_keepalive_cmplt_type      *resp;
 711         rndis_resp_t                    *r;
 712         struct rndis_params     *params = rndis_per_dev_params + configNr;
 713
 714         /* host "should" check only in RNDIS_DATA_INITIALIZED state */
 715
 716         r = rndis_add_response (configNr, sizeof (rndis_keepalive_cmplt_type));
 717         if (!r)
 718                 return -ENOMEM;
 719         resp = (rndis_keepalive_cmplt_type *) r->buf;
 720
 721         resp->MessageType = cpu_to_le32 (
 722                         REMOTE_NDIS_KEEPALIVE_CMPLT);
 723         resp->MessageLength = cpu_to_le32 (16);
 724         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 725         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 726
 727         params->resp_avail(params->v);
 728         return 0;
 729 }
 730
 731
 732 /*
 733  * Device to Host Comunication
 734  */
 735 static int rndis_indicate_status_msg (int configNr, u32 status)
 736 {
 737         rndis_indicate_status_msg_type  *resp;
 738         rndis_resp_t                    *r;
 739         struct rndis_params     *params = rndis_per_dev_params + configNr;
 740
 741         if (params->state == RNDIS_UNINITIALIZED)
 742                 return -ENOTSUPP;
 743
 744         r = rndis_add_response (configNr,
 745                                 sizeof (rndis_indicate_status_msg_type));
 746         if (!r)
 747                 return -ENOMEM;
 748         resp = (rndis_indicate_status_msg_type *) r->buf;
 749
 750         resp->MessageType = cpu_to_le32 (
 751                         REMOTE_NDIS_INDICATE_STATUS_MSG);
 752         resp->MessageLength = cpu_to_le32 (20);
 753         resp->Status = cpu_to_le32 (status);
 754         resp->StatusBufferLength = cpu_to_le32 (0);
 755         resp->StatusBufferOffset = cpu_to_le32 (0);
 756
 757         params->resp_avail(params->v);
 758         return 0;
 759 }
 760
 761 int rndis_signal_connect (int configNr)
 762 {
 763         rndis_per_dev_params [configNr].media_state
 764                         = NDIS_MEDIA_STATE_CONNECTED;
 765         return rndis_indicate_status_msg (configNr,
 766                                           RNDIS_STATUS_MEDIA_CONNECT);
 767 }
 768
 769 int rndis_signal_disconnect (int configNr)
 770 {
 771         rndis_per_dev_params [configNr].media_state
 772                         = NDIS_MEDIA_STATE_DISCONNECTED;
 773         return rndis_indicate_status_msg (configNr,
 774                                           RNDIS_STATUS_MEDIA_DISCONNECT);
 775 }
 776
 777 void rndis_uninit (int configNr)
 778 {
 779         u8 *buf;
 780         u32 length;
 781
 782         if (configNr >= RNDIS_MAX_CONFIGS)
 783                 return;
 784         rndis_per_dev_params [configNr].state = RNDIS_UNINITIALIZED;
 785
 786         /* drain the response queue */
 787         while ((buf = rndis_get_next_response(configNr, &length)))
 788                 rndis_free_response(configNr, buf);
 789 }
 790
 791 void rndis_set_host_mac (int configNr, const u8 *addr)
 792 {
 793         rndis_per_dev_params [configNr].host_mac = addr;
 794 }
 795
 796 /*
 797  * Message Parser
 798  */
 799 int rndis_msg_parser (u8 configNr, u8 *buf)
 800 {
 801         u32 MsgType, MsgLength;
 802         __le32 *tmp;
 803         struct rndis_params             *params;
 804
 805         if (!buf)
 806                 return -ENOMEM;
 807
 808         tmp = (__le32 *) buf;
 809         MsgType   = get_unaligned_le32(tmp++);
 810         MsgLength = get_unaligned_le32(tmp++);
 811
 812         if (configNr >= RNDIS_MAX_CONFIGS)
 813                 return -ENOTSUPP;
 814         params = &rndis_per_dev_params [configNr];
 815
 816         /* NOTE: RNDIS is *EXTREMELY* chatty ... Windows constantly polls for
 817          * rx/tx statistics and link status, in addition to KEEPALIVE traffic
 818          * and normal HC level polling to see if there's any IN traffic.
 819          */
 820
 821         /* For USB: responses may take up to 10 seconds */
 822         switch (MsgType) {
 823         case REMOTE_NDIS_INITIALIZE_MSG:
 824                 pr_debug("%s: REMOTE_NDIS_INITIALIZE_MSG\n",
 825                         __func__ );
 826                 params->state = RNDIS_INITIALIZED;
 827                 return  rndis_init_response (configNr,
 828                                         (rndis_init_msg_type *) buf);
 829
 830         case REMOTE_NDIS_HALT_MSG:
 831                 pr_debug("%s: REMOTE_NDIS_HALT_MSG\n",
 832                         __func__ );
 833                 params->state = RNDIS_UNINITIALIZED;
 834                 if (params->dev) {
 835                         netif_carrier_off (params->dev);
 836                         netif_stop_queue (params->dev);
 837                 }
 838                 return 0;
 839
 840         case REMOTE_NDIS_QUERY_MSG:
 841                 return rndis_query_response (configNr,
 842                                         (rndis_query_msg_type *) buf);
 843
 844         case REMOTE_NDIS_SET_MSG:
 845                 return rndis_set_response (configNr,
 846                                         (rndis_set_msg_type *) buf);
 847
 848         case REMOTE_NDIS_RESET_MSG:
 849                 pr_debug("%s: REMOTE_NDIS_RESET_MSG\n",
 850                         __func__ );
 851                 return rndis_reset_response (configNr,
 852                                         (rndis_reset_msg_type *) buf);
 853
 854         case REMOTE_NDIS_KEEPALIVE_MSG:
 855                 /* For USB: host does this every 5 seconds */
 856                 if (rndis_debug > 1)
 857                         pr_debug("%s: REMOTE_NDIS_KEEPALIVE_MSG\n",
 858                                 __func__ );
 859                 return rndis_keepalive_response (configNr,
 860                                                  (rndis_keepalive_msg_type *)
 861                                                  buf);
 862
 863         default:
 864                 /* At least Windows XP emits some undefined RNDIS messages.
 865                  * In one case those messages seemed to relate to the host
 866                  * suspending itself.
 867                  */
 868                 pr_warning("%s: unknown RNDIS message 0x%08X len %d\n",
 869                         __func__ , MsgType, MsgLength);
 870                 {
 871                         unsigned i;
 872                         for (i = 0; i < MsgLength; i += 16) {
 873                                 pr_debug("%03d: "
 874                                         " %02x %02x %02x %02x"
 875                                         " %02x %02x %02x %02x"
 876                                         " %02x %02x %02x %02x"
 877                                         " %02x %02x %02x %02x"
 878                                         "\n",
 879                                         i,
 880                                         buf[i], buf [i+1],
 881                                                 buf[i+2], buf[i+3],
 882                                         buf[i+4], buf [i+5],
 883                                                 buf[i+6], buf[i+7],
 884                                         buf[i+8], buf [i+9],
 885                                                 buf[i+10], buf[i+11],
 886                                         buf[i+12], buf [i+13],
 887                                                 buf[i+14], buf[i+15]);
 888                         }
 889                 }
 890                 break;
 891         }
 892
 893         return -ENOTSUPP;
 894 }
 895
 896 int rndis_register(void (*resp_avail)(void *v), void *v)
 897 {
 898         u8 i;
 899
 900         if (!resp_avail)
 901                 return -EINVAL;
 902
 903         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
 904                 if (!rndis_per_dev_params [i].used) {
 905                         rndis_per_dev_params [i].used = 1;
 906                         rndis_per_dev_params [i].resp_avail = resp_avail;
 907                         rndis_per_dev_params [i].v = v;
 908                         pr_debug("%s: configNr = %d\n", __func__, i);
 909                         return i;
 910                 }
 911         }
 912         pr_debug("failed\n");
 913
 914         return -ENODEV;
 915 }
 916
 917 void rndis_deregister (int configNr)
 918 {
 919         pr_debug("%s: \n", __func__);
 920
 921         if (configNr >= RNDIS_MAX_CONFIGS) return;
 922         rndis_per_dev_params [configNr].used = 0;
 923
 924         return;
 925 }
 926
 927 int rndis_set_param_dev(u8 configNr, struct net_device *dev, u16 *cdc_filter)
 928 {
 929         pr_debug("%s:\n", __func__);
 930         if (!dev)
 931                 return -EINVAL;
 932         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
 933
 934         rndis_per_dev_params [configNr].dev = dev;
 935         rndis_per_dev_params [configNr].filter = cdc_filter;
 936
 937         return 0;
 938 }
 939
 940 int rndis_set_param_vendor (u8 configNr, u32 vendorID, const char *vendorDescr)
 941 {
 942         pr_debug("%s:\n", __func__);
 943         if (!vendorDescr) return -1;
 944         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
 945
 946         rndis_per_dev_params [configNr].vendorID = vendorID;
 947         rndis_per_dev_params [configNr].vendorDescr = vendorDescr;
 948
 949         return 0;
 950 }
 951
 952 int rndis_set_param_medium (u8 configNr, u32 medium, u32 speed)
 953 {
 954         pr_debug("%s: %u %u\n", __func__, medium, speed);
 955         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
 956
 957         rndis_per_dev_params [configNr].medium = medium;
 958         rndis_per_dev_params [configNr].speed = speed;
 959
 960         return 0;
 961 }
 962
 963 void rndis_add_hdr (struct sk_buff *skb)
 964 {
 965         struct rndis_packet_msg_type    *header;
 966
 967         if (!skb)
 968                 return;
 969         header = (void *) skb_push (skb, sizeof *header);
 970         memset (header, 0, sizeof *header);
 971         header->MessageType = cpu_to_le32(REMOTE_NDIS_PACKET_MSG);
 972         header->MessageLength = cpu_to_le32(skb->len);
 973         header->DataOffset = cpu_to_le32 (36);
 974         header->DataLength = cpu_to_le32(skb->len - sizeof *header);
 975 }
 976
 977 void rndis_free_response (int configNr, u8 *buf)
 978 {
 979         rndis_resp_t            *r;
 980         struct list_head        *act, *tmp;
 981
 982         list_for_each_safe (act, tmp,
 983                         &(rndis_per_dev_params [configNr].resp_queue))
 984         {
 985                 r = list_entry (act, rndis_resp_t, list);
 986                 if (r && r->buf == buf) {
 987                         list_del (&r->list);
 988                         kfree (r);
 989                 }
 990         }
 991 }
 992
 993 u8 *rndis_get_next_response (int configNr, u32 *length)
 994 {
 995         rndis_resp_t            *r;
 996         struct list_head        *act, *tmp;
 997
 998         if (!length) return NULL;
 999
1000         list_for_each_safe (act, tmp,
1001                         &(rndis_per_dev_params [configNr].resp_queue))
1002         {
1003                 r = list_entry (act, rndis_resp_t, list);
1004                 if (!r->send) {
1005                         r->send = 1;
1006                         *length = r->length;
1007                         return r->buf;
1008                 }
1009         }
1010
1011         return NULL;
1012 }
1013
1014 static rndis_resp_t *rndis_add_response (int configNr, u32 length)
1015 {
1016         rndis_resp_t    *r;
1017
1018         /* NOTE:  this gets copied into ether.c USB_BUFSIZ bytes ... */
1019         r = kmalloc (sizeof (rndis_resp_t) + length, GFP_ATOMIC);
1020         if (!r) return NULL;
1021
1022         r->buf = (u8 *) (r + 1);
1023         r->length = length;
1024         r->send = 0;
1025
1026         list_add_tail (&r->list,
1027                 &(rndis_per_dev_params [configNr].resp_queue));
1028         return r;
1029 }
1030
1031 int rndis_rm_hdr(struct gether *port,
1032                         struct sk_buff *skb,
1033                         struct sk_buff_head *list)
1034 {
1035         /* tmp points to a struct rndis_packet_msg_type */
1036         __le32          *tmp = (void *) skb->data;
1037
1038         /* MessageType, MessageLength */
1039         if (cpu_to_le32(REMOTE_NDIS_PACKET_MSG)
1040                         != get_unaligned(tmp++)) {
1041                 dev_kfree_skb_any(skb);
1042                 return -EINVAL;
1043         }
1044         tmp++;
1045
1046         /* DataOffset, DataLength */
1047         if (!skb_pull(skb, get_unaligned_le32(tmp++) + 8)) {
1048                 dev_kfree_skb_any(skb);
1049                 return -EOVERFLOW;
1050         }
1051         skb_trim(skb, get_unaligned_le32(tmp++));
1052
1053         skb_queue_tail(list, skb);
1054         return 0;
1055 }
1056
1057 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1058
1059 static int rndis_proc_show(struct seq_file *m, void *v)
1060 {
1061         rndis_params *param = m->private;
1062
1063         seq_printf(m,
1064                          "Config Nr. %d\n"
1065                          "used      : %s\n"
1066                          "state     : %s\n"
1067                          "medium    : 0x%08X\n"
1068                          "speed     : %d\n"
1069                          "cable     : %s\n"
1070                          "vendor ID : 0x%08X\n"
1071                          "vendor    : %s\n",
1072                          param->confignr, (param->used) ? "y" : "n",
1073                          ({ char *s = "?";
1074                          switch (param->state) {
1075                          case RNDIS_UNINITIALIZED:
1076                                 s = "RNDIS_UNINITIALIZED"; break;
1077                          case RNDIS_INITIALIZED:
1078                                 s = "RNDIS_INITIALIZED"; break;
1079                          case RNDIS_DATA_INITIALIZED:
1080                                 s = "RNDIS_DATA_INITIALIZED"; break;
1081                         }; s; }),
1082                          param->medium,
1083                          (param->media_state) ? 0 : param->speed*100,
1084                          (param->media_state) ? "disconnected" : "connected",
1085                          param->vendorID, param->vendorDescr);
1086         return 0;
1087 }
1088
1089 static ssize_t rndis_proc_write(struct file *file, const char __user *buffer,
1090                 size_t count, loff_t *ppos)
1091 {
1092         rndis_params *p = PDE(file->f_path.dentry->d_inode)->data;
1093         u32 speed = 0;
1094         int i, fl_speed = 0;
1095
1096         for (i = 0; i < count; i++) {
1097                 char c;
1098                 if (get_user(c, buffer))
1099                         return -EFAULT;
1100                 switch (c) {
1101                 case '0':
1102                 case '1':
1103                 case '2':
1104                 case '3':
1105                 case '4':
1106                 case '5':
1107                 case '6':
1108                 case '7':
1109                 case '8':
1110                 case '9':
1111                         fl_speed = 1;
1112                         speed = speed*10 + c - '0';
1113                         break;
1114                 case 'C':
1115                 case 'c':
1116                         rndis_signal_connect (p->confignr);
1117                         break;
1118                 case 'D':
1119                 case 'd':
1120                         rndis_signal_disconnect(p->confignr);
1121                         break;
1122                 default:
1123                         if (fl_speed) p->speed = speed;
1124                         else pr_debug("%c is not valid\n", c);
1125                         break;
1126                 }
1127
1128                 buffer++;
1129         }
1130
1131         return count;
1132 }
1133
1134 static int rndis_proc_open(struct inode *inode, struct file *file)
1135 {
1136         return single_open(file, rndis_proc_show, PDE(inode)->data);
1137 }
1138
1139 static const struct file_operations rndis_proc_fops = {
1140         .owner          = THIS_MODULE,
1141         .open           = rndis_proc_open,
1142         .read           = seq_read,
1143         .llseek         = seq_lseek,
1144         .release        = single_release,
1145         .write          = rndis_proc_write,
1146 };
1147
1148 #define NAME_TEMPLATE   "driver/rndis-%03d"
1149
1150 static struct proc_dir_entry *rndis_connect_state [RNDIS_MAX_CONFIGS];
1151
1152 #endif  /* CONFIG_USB_GADGET_DEBUG_FILES */
1153
1154
1155 int rndis_init(void)
1156 {
1157         u8 i;
1158
1159         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1160 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1161                 char name [20];
1162
1163                 sprintf (name, NAME_TEMPLATE, i);
1164                 if (!(rndis_connect_state [i]
1165                                 = proc_create_data(name, 0660, NULL,
1166                                         &rndis_proc_fops,
1167                                         (void *)(rndis_per_dev_params + i))))
1168                 {
1169                         pr_debug("%s :remove entries", __func__);
1170                         while (i) {
1171                                 sprintf (name, NAME_TEMPLATE, --i);
1172                                 remove_proc_entry (name, NULL);
1173                         }
1174                         pr_debug("\n");
1175                         return -EIO;
1176                 }
1177 #endif
1178                 rndis_per_dev_params [i].confignr = i;
1179                 rndis_per_dev_params [i].used = 0;
1180                 rndis_per_dev_params [i].state = RNDIS_UNINITIALIZED;
1181                 rndis_per_dev_params [i].media_state
1182                                 = NDIS_MEDIA_STATE_DISCONNECTED;
1183                 INIT_LIST_HEAD (&(rndis_per_dev_params [i].resp_queue));
1184         }
1185
1186         return 0;
1187 }
1188
1189 void rndis_exit (void)
1190 {
1191 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1192         u8 i;
1193         char name [20];
1194
1195         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1196                 sprintf (name, NAME_TEMPLATE, i);
1197                 remove_proc_entry (name, NULL);
1198         }
1199 #endif
1200 }
1201