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                 length = strlen (rndis_per_dev_params [configNr].vendorDescr);
 297                 memcpy (outbuf,
 298                         rndis_per_dev_params [configNr].vendorDescr, length);
 299                 retval = 0;
 300                 break;
 301
 302         case OID_GEN_VENDOR_DRIVER_VERSION:
 303                 pr_debug("%s: OID_GEN_VENDOR_DRIVER_VERSION\n", __func__);
 304                 /* Created as LE */
 305                 *outbuf = rndis_driver_version;
 306                 retval = 0;
 307                 break;
 308
 309         /* mandatory */
 310         case OID_GEN_CURRENT_PACKET_FILTER:
 311                 pr_debug("%s: OID_GEN_CURRENT_PACKET_FILTER\n", __func__);
 312                 *outbuf = cpu_to_le32 (*rndis_per_dev_params[configNr].filter);
 313                 retval = 0;
 314                 break;
 315
 316         /* mandatory */
 317         case OID_GEN_MAXIMUM_TOTAL_SIZE:
 318                 pr_debug("%s: OID_GEN_MAXIMUM_TOTAL_SIZE\n", __func__);
 319                 *outbuf = cpu_to_le32(RNDIS_MAX_TOTAL_SIZE);
 320                 retval = 0;
 321                 break;
 322
 323         /* mandatory */
 324         case OID_GEN_MEDIA_CONNECT_STATUS:
 325                 if (rndis_debug > 1)
 326                         pr_debug("%s: OID_GEN_MEDIA_CONNECT_STATUS\n", __func__);
 327                 *outbuf = cpu_to_le32 (rndis_per_dev_params [configNr]
 328                                                 .media_state);
 329                 retval = 0;
 330                 break;
 331
 332         case OID_GEN_PHYSICAL_MEDIUM:
 333                 pr_debug("%s: 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 OID_GEN_MAC_OPTIONS:               /* from WinME */
 343                 pr_debug("%s: OID_GEN_MAC_OPTIONS\n", __func__);
 344                 *outbuf = cpu_to_le32(
 345                           NDIS_MAC_OPTION_RECEIVE_SERIALIZED
 346                         | NDIS_MAC_OPTION_FULL_DUPLEX);
 347                 retval = 0;
 348                 break;
 349
 350         /* statistics OIDs (table 4-2) */
 351
 352         /* mandatory */
 353         case OID_GEN_XMIT_OK:
 354                 if (rndis_debug > 1)
 355                         pr_debug("%s: 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 OID_GEN_RCV_OK:
 365                 if (rndis_debug > 1)
 366                         pr_debug("%s: 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 OID_GEN_XMIT_ERROR:
 376                 if (rndis_debug > 1)
 377                         pr_debug("%s: 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 OID_GEN_RCV_ERROR:
 386                 if (rndis_debug > 1)
 387                         pr_debug("%s: 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 OID_GEN_RCV_NO_BUFFER:
 396                 pr_debug("%s: 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 OID_802_3_PERMANENT_ADDRESS:
 407                 pr_debug("%s: OID_802_3_PERMANENT_ADDRESS\n", __func__);
 408                 if (rndis_per_dev_params [configNr].dev) {
 409                         length = ETH_ALEN;
 410                         memcpy (outbuf,
 411                                 rndis_per_dev_params [configNr].host_mac,
 412                                 length);
 413                         retval = 0;
 414                 }
 415                 break;
 416
 417         /* mandatory */
 418         case OID_802_3_CURRENT_ADDRESS:
 419                 pr_debug("%s: OID_802_3_CURRENT_ADDRESS\n", __func__);
 420                 if (rndis_per_dev_params [configNr].dev) {
 421                         length = ETH_ALEN;
 422                         memcpy (outbuf,
 423                                 rndis_per_dev_params [configNr].host_mac,
 424                                 length);
 425                         retval = 0;
 426                 }
 427                 break;
 428
 429         /* mandatory */
 430         case OID_802_3_MULTICAST_LIST:
 431                 pr_debug("%s: OID_802_3_MULTICAST_LIST\n", __func__);
 432                 /* Multicast base address only */
 433                 *outbuf = cpu_to_le32 (0xE0000000);
 434                 retval = 0;
 435                 break;
 436
 437         /* mandatory */
 438         case OID_802_3_MAXIMUM_LIST_SIZE:
 439                 pr_debug("%s: OID_802_3_MAXIMUM_LIST_SIZE\n", __func__);
 440                 /* Multicast base address only */
 441                 *outbuf = cpu_to_le32 (1);
 442                 retval = 0;
 443                 break;
 444
 445         case OID_802_3_MAC_OPTIONS:
 446                 pr_debug("%s: OID_802_3_MAC_OPTIONS\n", __func__);
 447                 *outbuf = cpu_to_le32(0);
 448                 retval = 0;
 449                 break;
 450
 451         /* ieee802.3 statistics OIDs (table 4-4) */
 452
 453         /* mandatory */
 454         case OID_802_3_RCV_ERROR_ALIGNMENT:
 455                 pr_debug("%s: OID_802_3_RCV_ERROR_ALIGNMENT\n", __func__);
 456                 if (stats) {
 457                         *outbuf = cpu_to_le32(stats->rx_frame_errors);
 458                         retval = 0;
 459                 }
 460                 break;
 461
 462         /* mandatory */
 463         case OID_802_3_XMIT_ONE_COLLISION:
 464                 pr_debug("%s: OID_802_3_XMIT_ONE_COLLISION\n", __func__);
 465                 *outbuf = cpu_to_le32 (0);
 466                 retval = 0;
 467                 break;
 468
 469         /* mandatory */
 470         case OID_802_3_XMIT_MORE_COLLISIONS:
 471                 pr_debug("%s: OID_802_3_XMIT_MORE_COLLISIONS\n", __func__);
 472                 *outbuf = cpu_to_le32 (0);
 473                 retval = 0;
 474                 break;
 475
 476         default:
 477                 pr_warning("%s: query unknown OID 0x%08X\n",
 478                          __func__, OID);
 479         }
 480         if (retval < 0)
 481                 length = 0;
 482
 483         resp->InformationBufferLength = cpu_to_le32 (length);
 484         r->length = length + sizeof *resp;
 485         resp->MessageLength = cpu_to_le32 (r->length);
 486         return retval;
 487 }
 488
 489 static int gen_ndis_set_resp (u8 configNr, u32 OID, u8 *buf, u32 buf_len,
 490                         rndis_resp_t *r)
 491 {
 492         rndis_set_cmplt_type            *resp;
 493         int                             i, retval = -ENOTSUPP;
 494         struct rndis_params             *params;
 495
 496         if (!r)
 497                 return -ENOMEM;
 498         resp = (rndis_set_cmplt_type *) r->buf;
 499         if (!resp)
 500                 return -ENOMEM;
 501
 502         if (buf_len && rndis_debug > 1) {
 503                 pr_debug("set OID %08x value, len %d:\n", OID, buf_len);
 504                 for (i = 0; i < buf_len; i += 16) {
 505                         pr_debug("%03d: %08x %08x %08x %08x\n", i,
 506                                 get_unaligned_le32(&buf[i]),
 507                                 get_unaligned_le32(&buf[i + 4]),
 508                                 get_unaligned_le32(&buf[i + 8]),
 509                                 get_unaligned_le32(&buf[i + 12]));
 510                 }
 511         }
 512
 513         params = &rndis_per_dev_params [configNr];
 514         switch (OID) {
 515         case OID_GEN_CURRENT_PACKET_FILTER:
 516
 517                 /* these NDIS_PACKET_TYPE_* bitflags are shared with
 518                  * cdc_filter; it's not RNDIS-specific
 519                  * NDIS_PACKET_TYPE_x == USB_CDC_PACKET_TYPE_x for x in:
 520                  *      PROMISCUOUS, DIRECTED,
 521                  *      MULTICAST, ALL_MULTICAST, BROADCAST
 522                  */
 523                 *params->filter = (u16)get_unaligned_le32(buf);
 524                 pr_debug("%s: OID_GEN_CURRENT_PACKET_FILTER %08x\n",
 525                         __func__, *params->filter);
 526
 527                 /* this call has a significant side effect:  it's
 528                  * what makes the packet flow start and stop, like
 529                  * activating the CDC Ethernet altsetting.
 530                  */
 531                 retval = 0;
 532                 if (*params->filter) {
 533                         params->state = RNDIS_DATA_INITIALIZED;
 534                         netif_carrier_on(params->dev);
 535                         if (netif_running(params->dev))
 536                                 netif_wake_queue (params->dev);
 537                 } else {
 538                         params->state = RNDIS_INITIALIZED;
 539                         netif_carrier_off (params->dev);
 540                         netif_stop_queue (params->dev);
 541                 }
 542                 break;
 543
 544         case OID_802_3_MULTICAST_LIST:
 545                 /* I think we can ignore this */
 546                 pr_debug("%s: OID_802_3_MULTICAST_LIST\n", __func__);
 547                 retval = 0;
 548                 break;
 549
 550         default:
 551                 pr_warning("%s: set unknown OID 0x%08X, size %d\n",
 552                          __func__, OID, buf_len);
 553         }
 554
 555         return retval;
 556 }
 557
 558 /*
 559  * Response Functions
 560  */
 561
 562 static int rndis_init_response (int configNr, rndis_init_msg_type *buf)
 563 {
 564         rndis_init_cmplt_type   *resp;
 565         rndis_resp_t            *r;
 566         struct rndis_params     *params = rndis_per_dev_params + configNr;
 567
 568         if (!params->dev)
 569                 return -ENOTSUPP;
 570
 571         r = rndis_add_response (configNr, sizeof (rndis_init_cmplt_type));
 572         if (!r)
 573                 return -ENOMEM;
 574         resp = (rndis_init_cmplt_type *) r->buf;
 575
 576         resp->MessageType = cpu_to_le32 (
 577                         REMOTE_NDIS_INITIALIZE_CMPLT);
 578         resp->MessageLength = cpu_to_le32 (52);
 579         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 580         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 581         resp->MajorVersion = cpu_to_le32 (RNDIS_MAJOR_VERSION);
 582         resp->MinorVersion = cpu_to_le32 (RNDIS_MINOR_VERSION);
 583         resp->DeviceFlags = cpu_to_le32 (RNDIS_DF_CONNECTIONLESS);
 584         resp->Medium = cpu_to_le32 (RNDIS_MEDIUM_802_3);
 585         resp->MaxPacketsPerTransfer = cpu_to_le32 (1);
 586         resp->MaxTransferSize = cpu_to_le32 (
 587                   params->dev->mtu
 588                 + sizeof (struct ethhdr)
 589                 + sizeof (struct rndis_packet_msg_type)
 590                 + 22);
 591         resp->PacketAlignmentFactor = cpu_to_le32 (0);
 592         resp->AFListOffset = cpu_to_le32 (0);
 593         resp->AFListSize = cpu_to_le32 (0);
 594
 595         params->resp_avail(params->v);
 596         return 0;
 597 }
 598
 599 static int rndis_query_response (int configNr, rndis_query_msg_type *buf)
 600 {
 601         rndis_query_cmplt_type *resp;
 602         rndis_resp_t            *r;
 603         struct rndis_params     *params = rndis_per_dev_params + configNr;
 604
 605         /* pr_debug("%s: OID = %08X\n", __func__, cpu_to_le32(buf->OID)); */
 606         if (!params->dev)
 607                 return -ENOTSUPP;
 608
 609         /*
 610          * we need more memory:
 611          * gen_ndis_query_resp expects enough space for
 612          * rndis_query_cmplt_type followed by data.
 613          * oid_supported_list is the largest data reply
 614          */
 615         r = rndis_add_response (configNr,
 616                 sizeof (oid_supported_list) + sizeof(rndis_query_cmplt_type));
 617         if (!r)
 618                 return -ENOMEM;
 619         resp = (rndis_query_cmplt_type *) r->buf;
 620
 621         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_QUERY_CMPLT);
 622         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 623
 624         if (gen_ndis_query_resp (configNr, le32_to_cpu (buf->OID),
 625                         le32_to_cpu(buf->InformationBufferOffset)
 626                                         + 8 + (u8 *) buf,
 627                         le32_to_cpu(buf->InformationBufferLength),
 628                         r)) {
 629                 /* OID not supported */
 630                 resp->Status = cpu_to_le32 (
 631                                 RNDIS_STATUS_NOT_SUPPORTED);
 632                 resp->MessageLength = cpu_to_le32 (sizeof *resp);
 633                 resp->InformationBufferLength = cpu_to_le32 (0);
 634                 resp->InformationBufferOffset = cpu_to_le32 (0);
 635         } else
 636                 resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 637
 638         params->resp_avail(params->v);
 639         return 0;
 640 }
 641
 642 static int rndis_set_response (int configNr, rndis_set_msg_type *buf)
 643 {
 644         u32                     BufLength, BufOffset;
 645         rndis_set_cmplt_type    *resp;
 646         rndis_resp_t            *r;
 647         struct rndis_params     *params = rndis_per_dev_params + configNr;
 648
 649         r = rndis_add_response (configNr, sizeof (rndis_set_cmplt_type));
 650         if (!r)
 651                 return -ENOMEM;
 652         resp = (rndis_set_cmplt_type *) r->buf;
 653
 654         BufLength = le32_to_cpu (buf->InformationBufferLength);
 655         BufOffset = le32_to_cpu (buf->InformationBufferOffset);
 656
 657 #ifdef  VERBOSE_DEBUG
 658         pr_debug("%s: Length: %d\n", __func__, BufLength);
 659         pr_debug("%s: Offset: %d\n", __func__, BufOffset);
 660         pr_debug("%s: InfoBuffer: ", __func__);
 661
 662         for (i = 0; i < BufLength; i++) {
 663                 pr_debug("%02x ", *(((u8 *) buf) + i + 8 + BufOffset));
 664         }
 665
 666         pr_debug("\n");
 667 #endif
 668
 669         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_SET_CMPLT);
 670         resp->MessageLength = cpu_to_le32 (16);
 671         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 672         if (gen_ndis_set_resp (configNr, le32_to_cpu (buf->OID),
 673                         ((u8 *) buf) + 8 + BufOffset, BufLength, r))
 674                 resp->Status = cpu_to_le32 (RNDIS_STATUS_NOT_SUPPORTED);
 675         else
 676                 resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 677
 678         params->resp_avail(params->v);
 679         return 0;
 680 }
 681
 682 static int rndis_reset_response (int configNr, rndis_reset_msg_type *buf)
 683 {
 684         rndis_reset_cmplt_type  *resp;
 685         rndis_resp_t            *r;
 686         struct rndis_params     *params = rndis_per_dev_params + configNr;
 687
 688         r = rndis_add_response (configNr, sizeof (rndis_reset_cmplt_type));
 689         if (!r)
 690                 return -ENOMEM;
 691         resp = (rndis_reset_cmplt_type *) r->buf;
 692
 693         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_RESET_CMPLT);
 694         resp->MessageLength = cpu_to_le32 (16);
 695         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 696         /* resent information */
 697         resp->AddressingReset = cpu_to_le32 (1);
 698
 699         params->resp_avail(params->v);
 700         return 0;
 701 }
 702
 703 static int rndis_keepalive_response (int configNr,
 704                                 rndis_keepalive_msg_type *buf)
 705 {
 706         rndis_keepalive_cmplt_type      *resp;
 707         rndis_resp_t                    *r;
 708         struct rndis_params     *params = rndis_per_dev_params + configNr;
 709
 710         /* host "should" check only in RNDIS_DATA_INITIALIZED state */
 711
 712         r = rndis_add_response (configNr, sizeof (rndis_keepalive_cmplt_type));
 713         if (!r)
 714                 return -ENOMEM;
 715         resp = (rndis_keepalive_cmplt_type *) r->buf;
 716
 717         resp->MessageType = cpu_to_le32 (
 718                         REMOTE_NDIS_KEEPALIVE_CMPLT);
 719         resp->MessageLength = cpu_to_le32 (16);
 720         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
 721         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
 722
 723         params->resp_avail(params->v);
 724         return 0;
 725 }
 726
 727
 728 /*
 729  * Device to Host Comunication
 730  */
 731 static int rndis_indicate_status_msg (int configNr, u32 status)
 732 {
 733         rndis_indicate_status_msg_type  *resp;
 734         rndis_resp_t                    *r;
 735         struct rndis_params     *params = rndis_per_dev_params + configNr;
 736
 737         if (params->state == RNDIS_UNINITIALIZED)
 738                 return -ENOTSUPP;
 739
 740         r = rndis_add_response (configNr,
 741                                 sizeof (rndis_indicate_status_msg_type));
 742         if (!r)
 743                 return -ENOMEM;
 744         resp = (rndis_indicate_status_msg_type *) r->buf;
 745
 746         resp->MessageType = cpu_to_le32 (
 747                         REMOTE_NDIS_INDICATE_STATUS_MSG);
 748         resp->MessageLength = cpu_to_le32 (20);
 749         resp->Status = cpu_to_le32 (status);
 750         resp->StatusBufferLength = cpu_to_le32 (0);
 751         resp->StatusBufferOffset = cpu_to_le32 (0);
 752
 753         params->resp_avail(params->v);
 754         return 0;
 755 }
 756
 757 int rndis_signal_connect (int configNr)
 758 {
 759         rndis_per_dev_params [configNr].media_state
 760                         = NDIS_MEDIA_STATE_CONNECTED;
 761         return rndis_indicate_status_msg (configNr,
 762                                           RNDIS_STATUS_MEDIA_CONNECT);
 763 }
 764
 765 int rndis_signal_disconnect (int configNr)
 766 {
 767         rndis_per_dev_params [configNr].media_state
 768                         = NDIS_MEDIA_STATE_DISCONNECTED;
 769         return rndis_indicate_status_msg (configNr,
 770                                           RNDIS_STATUS_MEDIA_DISCONNECT);
 771 }
 772
 773 void rndis_uninit (int configNr)
 774 {
 775         u8 *buf;
 776         u32 length;
 777
 778         if (configNr >= RNDIS_MAX_CONFIGS)
 779                 return;
 780         rndis_per_dev_params [configNr].state = RNDIS_UNINITIALIZED;
 781
 782         /* drain the response queue */
 783         while ((buf = rndis_get_next_response(configNr, &length)))
 784                 rndis_free_response(configNr, buf);
 785 }
 786
 787 void rndis_set_host_mac (int configNr, const u8 *addr)
 788 {
 789         rndis_per_dev_params [configNr].host_mac = addr;
 790 }
 791
 792 /*
 793  * Message Parser
 794  */
 795 int rndis_msg_parser (u8 configNr, u8 *buf)
 796 {
 797         u32 MsgType, MsgLength;
 798         __le32 *tmp;
 799         struct rndis_params             *params;
 800
 801         if (!buf)
 802                 return -ENOMEM;
 803
 804         tmp = (__le32 *) buf;
 805         MsgType   = get_unaligned_le32(tmp++);
 806         MsgLength = get_unaligned_le32(tmp++);
 807
 808         if (configNr >= RNDIS_MAX_CONFIGS)
 809                 return -ENOTSUPP;
 810         params = &rndis_per_dev_params [configNr];
 811
 812         /* NOTE: RNDIS is *EXTREMELY* chatty ... Windows constantly polls for
 813          * rx/tx statistics and link status, in addition to KEEPALIVE traffic
 814          * and normal HC level polling to see if there's any IN traffic.
 815          */
 816
 817         /* For USB: responses may take up to 10 seconds */
 818         switch (MsgType) {
 819         case REMOTE_NDIS_INITIALIZE_MSG:
 820                 pr_debug("%s: REMOTE_NDIS_INITIALIZE_MSG\n",
 821                         __func__ );
 822                 params->state = RNDIS_INITIALIZED;
 823                 return  rndis_init_response (configNr,
 824                                         (rndis_init_msg_type *) buf);
 825
 826         case REMOTE_NDIS_HALT_MSG:
 827                 pr_debug("%s: REMOTE_NDIS_HALT_MSG\n",
 828                         __func__ );
 829                 params->state = RNDIS_UNINITIALIZED;
 830                 if (params->dev) {
 831                         netif_carrier_off (params->dev);
 832                         netif_stop_queue (params->dev);
 833                 }
 834                 return 0;
 835
 836         case REMOTE_NDIS_QUERY_MSG:
 837                 return rndis_query_response (configNr,
 838                                         (rndis_query_msg_type *) buf);
 839
 840         case REMOTE_NDIS_SET_MSG:
 841                 return rndis_set_response (configNr,
 842                                         (rndis_set_msg_type *) buf);
 843
 844         case REMOTE_NDIS_RESET_MSG:
 845                 pr_debug("%s: REMOTE_NDIS_RESET_MSG\n",
 846                         __func__ );
 847                 return rndis_reset_response (configNr,
 848                                         (rndis_reset_msg_type *) buf);
 849
 850         case REMOTE_NDIS_KEEPALIVE_MSG:
 851                 /* For USB: host does this every 5 seconds */
 852                 if (rndis_debug > 1)
 853                         pr_debug("%s: REMOTE_NDIS_KEEPALIVE_MSG\n",
 854                                 __func__ );
 855                 return rndis_keepalive_response (configNr,
 856                                                  (rndis_keepalive_msg_type *)
 857                                                  buf);
 858
 859         default:
 860                 /* At least Windows XP emits some undefined RNDIS messages.
 861                  * In one case those messages seemed to relate to the host
 862                  * suspending itself.
 863                  */
 864                 pr_warning("%s: unknown RNDIS message 0x%08X len %d\n",
 865                         __func__ , MsgType, MsgLength);
 866                 {
 867                         unsigned i;
 868                         for (i = 0; i < MsgLength; i += 16) {
 869                                 pr_debug("%03d: "
 870                                         " %02x %02x %02x %02x"
 871                                         " %02x %02x %02x %02x"
 872                                         " %02x %02x %02x %02x"
 873                                         " %02x %02x %02x %02x"
 874                                         "\n",
 875                                         i,
 876                                         buf[i], buf [i+1],
 877                                                 buf[i+2], buf[i+3],
 878                                         buf[i+4], buf [i+5],
 879                                                 buf[i+6], buf[i+7],
 880                                         buf[i+8], buf [i+9],
 881                                                 buf[i+10], buf[i+11],
 882                                         buf[i+12], buf [i+13],
 883                                                 buf[i+14], buf[i+15]);
 884                         }
 885                 }
 886                 break;
 887         }
 888
 889         return -ENOTSUPP;
 890 }
 891
 892 int rndis_register(void (*resp_avail)(void *v), void *v)
 893 {
 894         u8 i;
 895
 896         if (!resp_avail)
 897                 return -EINVAL;
 898
 899         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
 900                 if (!rndis_per_dev_params [i].used) {
 901                         rndis_per_dev_params [i].used = 1;
 902                         rndis_per_dev_params [i].resp_avail = resp_avail;
 903                         rndis_per_dev_params [i].v = v;
 904                         pr_debug("%s: configNr = %d\n", __func__, i);
 905                         return i;
 906                 }
 907         }
 908         pr_debug("failed\n");
 909
 910         return -ENODEV;
 911 }
 912
 913 void rndis_deregister (int configNr)
 914 {
 915         pr_debug("%s: \n", __func__);
 916
 917         if (configNr >= RNDIS_MAX_CONFIGS) return;
 918         rndis_per_dev_params [configNr].used = 0;
 919 }
 920
 921 int rndis_set_param_dev(u8 configNr, struct net_device *dev, u16 *cdc_filter)
 922 {
 923         pr_debug("%s:\n", __func__);
 924         if (!dev)
 925                 return -EINVAL;
 926         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
 927
 928         rndis_per_dev_params [configNr].dev = dev;
 929         rndis_per_dev_params [configNr].filter = cdc_filter;
 930
 931         return 0;
 932 }
 933
 934 int rndis_set_param_vendor (u8 configNr, u32 vendorID, const char *vendorDescr)
 935 {
 936         pr_debug("%s:\n", __func__);
 937         if (!vendorDescr) return -1;
 938         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
 939
 940         rndis_per_dev_params [configNr].vendorID = vendorID;
 941         rndis_per_dev_params [configNr].vendorDescr = vendorDescr;
 942
 943         return 0;
 944 }
 945
 946 int rndis_set_param_medium (u8 configNr, u32 medium, u32 speed)
 947 {
 948         pr_debug("%s: %u %u\n", __func__, medium, speed);
 949         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
 950
 951         rndis_per_dev_params [configNr].medium = medium;
 952         rndis_per_dev_params [configNr].speed = speed;
 953
 954         return 0;
 955 }
 956
 957 void rndis_add_hdr (struct sk_buff *skb)
 958 {
 959         struct rndis_packet_msg_type    *header;
 960
 961         if (!skb)
 962                 return;
 963         header = (void *) skb_push (skb, sizeof *header);
 964         memset (header, 0, sizeof *header);
 965         header->MessageType = cpu_to_le32(REMOTE_NDIS_PACKET_MSG);
 966         header->MessageLength = cpu_to_le32(skb->len);
 967         header->DataOffset = cpu_to_le32 (36);
 968         header->DataLength = cpu_to_le32(skb->len - sizeof *header);
 969 }
 970
 971 void rndis_free_response (int configNr, u8 *buf)
 972 {
 973         rndis_resp_t            *r;
 974         struct list_head        *act, *tmp;
 975
 976         list_for_each_safe (act, tmp,
 977                         &(rndis_per_dev_params [configNr].resp_queue))
 978         {
 979                 r = list_entry (act, rndis_resp_t, list);
 980                 if (r && r->buf == buf) {
 981                         list_del (&r->list);
 982                         kfree (r);
 983                 }
 984         }
 985 }
 986
 987 u8 *rndis_get_next_response (int configNr, u32 *length)
 988 {
 989         rndis_resp_t            *r;
 990         struct list_head        *act, *tmp;
 991
 992         if (!length) return NULL;
 993
 994         list_for_each_safe (act, tmp,
 995                         &(rndis_per_dev_params [configNr].resp_queue))
 996         {
 997                 r = list_entry (act, rndis_resp_t, list);
 998                 if (!r->send) {
 999                         r->send = 1;
1000                         *length = r->length;
1001                         return r->buf;
1002                 }
1003         }
1004
1005         return NULL;
1006 }
1007
1008 static rndis_resp_t *rndis_add_response (int configNr, u32 length)
1009 {
1010         rndis_resp_t    *r;
1011
1012         /* NOTE:  this gets copied into ether.c USB_BUFSIZ bytes ... */
1013         r = kmalloc (sizeof (rndis_resp_t) + length, GFP_ATOMIC);
1014         if (!r) return NULL;
1015
1016         r->buf = (u8 *) (r + 1);
1017         r->length = length;
1018         r->send = 0;
1019
1020         list_add_tail (&r->list,
1021                 &(rndis_per_dev_params [configNr].resp_queue));
1022         return r;
1023 }
1024
1025 int rndis_rm_hdr(struct gether *port,
1026                         struct sk_buff *skb,
1027                         struct sk_buff_head *list)
1028 {
1029         /* tmp points to a struct rndis_packet_msg_type */
1030         __le32          *tmp = (void *) skb->data;
1031
1032         /* MessageType, MessageLength */
1033         if (cpu_to_le32(REMOTE_NDIS_PACKET_MSG)
1034                         != get_unaligned(tmp++)) {
1035                 dev_kfree_skb_any(skb);
1036                 return -EINVAL;
1037         }
1038         tmp++;
1039
1040         /* DataOffset, DataLength */
1041         if (!skb_pull(skb, get_unaligned_le32(tmp++) + 8)) {
1042                 dev_kfree_skb_any(skb);
1043                 return -EOVERFLOW;
1044         }
1045         skb_trim(skb, get_unaligned_le32(tmp++));
1046
1047         skb_queue_tail(list, skb);
1048         return 0;
1049 }
1050
1051 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1052
1053 static int rndis_proc_show(struct seq_file *m, void *v)
1054 {
1055         rndis_params *param = m->private;
1056
1057         seq_printf(m,
1058                          "Config Nr. %d\n"
1059                          "used      : %s\n"
1060                          "state     : %s\n"
1061                          "medium    : 0x%08X\n"
1062                          "speed     : %d\n"
1063                          "cable     : %s\n"
1064                          "vendor ID : 0x%08X\n"
1065                          "vendor    : %s\n",
1066                          param->confignr, (param->used) ? "y" : "n",
1067                          ({ char *s = "?";
1068                          switch (param->state) {
1069                          case RNDIS_UNINITIALIZED:
1070                                 s = "RNDIS_UNINITIALIZED"; break;
1071                          case RNDIS_INITIALIZED:
1072                                 s = "RNDIS_INITIALIZED"; break;
1073                          case RNDIS_DATA_INITIALIZED:
1074                                 s = "RNDIS_DATA_INITIALIZED"; break;
1075                         }; s; }),
1076                          param->medium,
1077                          (param->media_state) ? 0 : param->speed*100,
1078                          (param->media_state) ? "disconnected" : "connected",
1079                          param->vendorID, param->vendorDescr);
1080         return 0;
1081 }
1082
1083 static ssize_t rndis_proc_write(struct file *file, const char __user *buffer,
1084                 size_t count, loff_t *ppos)
1085 {
1086         rndis_params *p = PDE(file->f_path.dentry->d_inode)->data;
1087         u32 speed = 0;
1088         int i, fl_speed = 0;
1089
1090         for (i = 0; i < count; i++) {
1091                 char c;
1092                 if (get_user(c, buffer))
1093                         return -EFAULT;
1094                 switch (c) {
1095                 case '0':
1096                 case '1':
1097                 case '2':
1098                 case '3':
1099                 case '4':
1100                 case '5':
1101                 case '6':
1102                 case '7':
1103                 case '8':
1104                 case '9':
1105                         fl_speed = 1;
1106                         speed = speed*10 + c - '0';
1107                         break;
1108                 case 'C':
1109                 case 'c':
1110                         rndis_signal_connect (p->confignr);
1111                         break;
1112                 case 'D':
1113                 case 'd':
1114                         rndis_signal_disconnect(p->confignr);
1115                         break;
1116                 default:
1117                         if (fl_speed) p->speed = speed;
1118                         else pr_debug("%c is not valid\n", c);
1119                         break;
1120                 }
1121
1122                 buffer++;
1123         }
1124
1125         return count;
1126 }
1127
1128 static int rndis_proc_open(struct inode *inode, struct file *file)
1129 {
1130         return single_open(file, rndis_proc_show, PDE(inode)->data);
1131 }
1132
1133 static const struct file_operations rndis_proc_fops = {
1134         .owner          = THIS_MODULE,
1135         .open           = rndis_proc_open,
1136         .read           = seq_read,
1137         .llseek         = seq_lseek,
1138         .release        = single_release,
1139         .write          = rndis_proc_write,
1140 };
1141
1142 #define NAME_TEMPLATE   "driver/rndis-%03d"
1143
1144 static struct proc_dir_entry *rndis_connect_state [RNDIS_MAX_CONFIGS];
1145
1146 #endif  /* CONFIG_USB_GADGET_DEBUG_FILES */
1147
1148
1149 int __init rndis_init (void)
1150 {
1151         u8 i;
1152
1153         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1154 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1155                 char name [20];
1156
1157                 sprintf (name, NAME_TEMPLATE, i);
1158                 if (!(rndis_connect_state [i]
1159                                 = proc_create_data(name, 0660, NULL,
1160                                         &rndis_proc_fops,
1161                                         (void *)(rndis_per_dev_params + i))))
1162                 {
1163                         pr_debug("%s :remove entries", __func__);
1164                         while (i) {
1165                                 sprintf (name, NAME_TEMPLATE, --i);
1166                                 remove_proc_entry (name, NULL);
1167                         }
1168                         pr_debug("\n");
1169                         return -EIO;
1170                 }
1171 #endif
1172                 rndis_per_dev_params [i].confignr = i;
1173                 rndis_per_dev_params [i].used = 0;
1174                 rndis_per_dev_params [i].state = RNDIS_UNINITIALIZED;
1175                 rndis_per_dev_params [i].media_state
1176                                 = NDIS_MEDIA_STATE_DISCONNECTED;
1177                 INIT_LIST_HEAD (&(rndis_per_dev_params [i].resp_queue));
1178         }
1179
1180         return 0;
1181 }
1182
1183 void rndis_exit (void)
1184 {
1185 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1186         u8 i;
1187         char name [20];
1188
1189         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1190                 sprintf (name, NAME_TEMPLATE, i);
1191                 remove_proc_entry (name, NULL);
1192         }
1193 #endif
1194 }
1195