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