]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - android-sdk/kernel-video.git/blob - drivers/usb/gadget/rndis.c
Merge branch 'p-ti-linux-3.8.y' into p-ti-android-3.8.y
[android-sdk/kernel-video.git] / 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  */
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>
35 #include <asm/io.h>
36 #include <asm/byteorder.h>
37 #include <asm/unaligned.h>
40 #undef  VERBOSE_DEBUG
42 #include "rndis.h"
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  */
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
60 #define RNDIS_MAX_CONFIGS       1
63 static rndis_params rndis_per_dev_params[RNDIS_MAX_CONFIGS];
65 /* Driver Version */
66 static const __le32 rndis_driver_version = cpu_to_le32(1);
68 /* Function Prototypes */
69 static rndis_resp_t *rndis_add_response(int configNr, u32 length);
72 /* supported OIDs */
73 static const u32 oid_supported_list[] =
74 {
75         /* the general stuff */
76         RNDIS_OID_GEN_SUPPORTED_LIST,
77         RNDIS_OID_GEN_HARDWARE_STATUS,
78         RNDIS_OID_GEN_MEDIA_SUPPORTED,
79         RNDIS_OID_GEN_MEDIA_IN_USE,
80         RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE,
81         RNDIS_OID_GEN_LINK_SPEED,
82         RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE,
83         RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE,
84         RNDIS_OID_GEN_VENDOR_ID,
85         RNDIS_OID_GEN_VENDOR_DESCRIPTION,
86         RNDIS_OID_GEN_VENDOR_DRIVER_VERSION,
87         RNDIS_OID_GEN_CURRENT_PACKET_FILTER,
88         RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE,
89         RNDIS_OID_GEN_MEDIA_CONNECT_STATUS,
90         RNDIS_OID_GEN_PHYSICAL_MEDIUM,
92         /* the statistical stuff */
93         RNDIS_OID_GEN_XMIT_OK,
94         RNDIS_OID_GEN_RCV_OK,
95         RNDIS_OID_GEN_XMIT_ERROR,
96         RNDIS_OID_GEN_RCV_ERROR,
97         RNDIS_OID_GEN_RCV_NO_BUFFER,
98 #ifdef  RNDIS_OPTIONAL_STATS
99         RNDIS_OID_GEN_DIRECTED_BYTES_XMIT,
100         RNDIS_OID_GEN_DIRECTED_FRAMES_XMIT,
101         RNDIS_OID_GEN_MULTICAST_BYTES_XMIT,
102         RNDIS_OID_GEN_MULTICAST_FRAMES_XMIT,
103         RNDIS_OID_GEN_BROADCAST_BYTES_XMIT,
104         RNDIS_OID_GEN_BROADCAST_FRAMES_XMIT,
105         RNDIS_OID_GEN_DIRECTED_BYTES_RCV,
106         RNDIS_OID_GEN_DIRECTED_FRAMES_RCV,
107         RNDIS_OID_GEN_MULTICAST_BYTES_RCV,
108         RNDIS_OID_GEN_MULTICAST_FRAMES_RCV,
109         RNDIS_OID_GEN_BROADCAST_BYTES_RCV,
110         RNDIS_OID_GEN_BROADCAST_FRAMES_RCV,
111         RNDIS_OID_GEN_RCV_CRC_ERROR,
112         RNDIS_OID_GEN_TRANSMIT_QUEUE_LENGTH,
113 #endif  /* RNDIS_OPTIONAL_STATS */
115         /* mandatory 802.3 */
116         /* the general stuff */
117         RNDIS_OID_802_3_PERMANENT_ADDRESS,
118         RNDIS_OID_802_3_CURRENT_ADDRESS,
119         RNDIS_OID_802_3_MULTICAST_LIST,
120         RNDIS_OID_802_3_MAC_OPTIONS,
121         RNDIS_OID_802_3_MAXIMUM_LIST_SIZE,
123         /* the statistical stuff */
124         RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT,
125         RNDIS_OID_802_3_XMIT_ONE_COLLISION,
126         RNDIS_OID_802_3_XMIT_MORE_COLLISIONS,
127 #ifdef  RNDIS_OPTIONAL_STATS
128         RNDIS_OID_802_3_XMIT_DEFERRED,
129         RNDIS_OID_802_3_XMIT_MAX_COLLISIONS,
130         RNDIS_OID_802_3_RCV_OVERRUN,
131         RNDIS_OID_802_3_XMIT_UNDERRUN,
132         RNDIS_OID_802_3_XMIT_HEARTBEAT_FAILURE,
133         RNDIS_OID_802_3_XMIT_TIMES_CRS_LOST,
134         RNDIS_OID_802_3_XMIT_LATE_COLLISIONS,
135 #endif  /* RNDIS_OPTIONAL_STATS */
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          */
147         /* power management */
148         OID_PNP_CAPABILITIES,
149         OID_PNP_QUERY_POWER,
150         OID_PNP_SET_POWER,
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 };
162 /* NDIS Functions */
163 static int gen_ndis_query_resp(int configNr, u32 OID, u8 *buf,
164                                unsigned buf_len, rndis_resp_t *r)
166         int retval = -ENOTSUPP;
167         u32 length = 4; /* usually */
168         __le32 *outbuf;
169         int i, count;
170         rndis_query_cmplt_type *resp;
171         struct net_device *net;
172         struct rtnl_link_stats64 temp;
173         const struct rtnl_link_stats64 *stats;
175         if (!r) return -ENOMEM;
176         resp = (rndis_query_cmplt_type *)r->buf;
178         if (!resp) return -ENOMEM;
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         }
191         /* response goes here, right after the header */
192         outbuf = (__le32 *)&resp[1];
193         resp->InformationBufferOffset = cpu_to_le32(16);
195         net = rndis_per_dev_params[configNr].dev;
196         stats = dev_get_stats(net, &temp);
198         switch (OID) {
200         /* general oids (table 4-1) */
202         /* mandatory */
203         case RNDIS_OID_GEN_SUPPORTED_LIST:
204                 pr_debug("%s: RNDIS_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;
212         /* mandatory */
213         case RNDIS_OID_GEN_HARDWARE_STATUS:
214                 pr_debug("%s: RNDIS_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;
225         /* mandatory */
226         case RNDIS_OID_GEN_MEDIA_SUPPORTED:
227                 pr_debug("%s: RNDIS_OID_GEN_MEDIA_SUPPORTED\n", __func__);
228                 *outbuf = cpu_to_le32(rndis_per_dev_params[configNr].medium);
229                 retval = 0;
230                 break;
232         /* mandatory */
233         case RNDIS_OID_GEN_MEDIA_IN_USE:
234                 pr_debug("%s: RNDIS_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;
240         /* mandatory */
241         case RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE:
242                 pr_debug("%s: RNDIS_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;
250         /* mandatory */
251         case RNDIS_OID_GEN_LINK_SPEED:
252                 if (rndis_debug > 1)
253                         pr_debug("%s: RNDIS_OID_GEN_LINK_SPEED\n", __func__);
254                 if (rndis_per_dev_params[configNr].media_state
255                                 == RNDIS_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;
263         /* mandatory */
264         case RNDIS_OID_GEN_TRANSMIT_BLOCK_SIZE:
265                 pr_debug("%s: RNDIS_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;
273         /* mandatory */
274         case RNDIS_OID_GEN_RECEIVE_BLOCK_SIZE:
275                 pr_debug("%s: RNDIS_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;
283         /* mandatory */
284         case RNDIS_OID_GEN_VENDOR_ID:
285                 pr_debug("%s: RNDIS_OID_GEN_VENDOR_ID\n", __func__);
286                 *outbuf = cpu_to_le32(
287                         rndis_per_dev_params[configNr].vendorID);
288                 retval = 0;
289                 break;
291         /* mandatory */
292         case RNDIS_OID_GEN_VENDOR_DESCRIPTION:
293                 pr_debug("%s: RNDIS_OID_GEN_VENDOR_DESCRIPTION\n", __func__);
294                 if (rndis_per_dev_params[configNr].vendorDescr) {
295                         length = strlen(rndis_per_dev_params[configNr].
296                                         vendorDescr);
297                         memcpy(outbuf,
298                                 rndis_per_dev_params[configNr].vendorDescr,
299                                 length);
300                 } else {
301                         outbuf[0] = 0;
302                 }
303                 retval = 0;
304                 break;
306         case RNDIS_OID_GEN_VENDOR_DRIVER_VERSION:
307                 pr_debug("%s: RNDIS_OID_GEN_VENDOR_DRIVER_VERSION\n", __func__);
308                 /* Created as LE */
309                 *outbuf = rndis_driver_version;
310                 retval = 0;
311                 break;
313         /* mandatory */
314         case RNDIS_OID_GEN_CURRENT_PACKET_FILTER:
315                 pr_debug("%s: RNDIS_OID_GEN_CURRENT_PACKET_FILTER\n", __func__);
316                 *outbuf = cpu_to_le32(*rndis_per_dev_params[configNr].filter);
317                 retval = 0;
318                 break;
320         /* mandatory */
321         case RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE:
322                 pr_debug("%s: RNDIS_OID_GEN_MAXIMUM_TOTAL_SIZE\n", __func__);
323                 *outbuf = cpu_to_le32(RNDIS_MAX_TOTAL_SIZE);
324                 retval = 0;
325                 break;
327         /* mandatory */
328         case RNDIS_OID_GEN_MEDIA_CONNECT_STATUS:
329                 if (rndis_debug > 1)
330                         pr_debug("%s: RNDIS_OID_GEN_MEDIA_CONNECT_STATUS\n", __func__);
331                 *outbuf = cpu_to_le32(rndis_per_dev_params[configNr]
332                                                 .media_state);
333                 retval = 0;
334                 break;
336         case RNDIS_OID_GEN_PHYSICAL_MEDIUM:
337                 pr_debug("%s: RNDIS_OID_GEN_PHYSICAL_MEDIUM\n", __func__);
338                 *outbuf = cpu_to_le32(0);
339                 retval = 0;
340                 break;
342         /* The RNDIS specification is incomplete/wrong.   Some versions
343          * of MS-Windows expect OIDs that aren't specified there.  Other
344          * versions emit undefined RNDIS messages. DOCUMENT ALL THESE!
345          */
346         case RNDIS_OID_GEN_MAC_OPTIONS:         /* from WinME */
347                 pr_debug("%s: RNDIS_OID_GEN_MAC_OPTIONS\n", __func__);
348                 *outbuf = cpu_to_le32(
349                           RNDIS_MAC_OPTION_RECEIVE_SERIALIZED
350                         | RNDIS_MAC_OPTION_FULL_DUPLEX);
351                 retval = 0;
352                 break;
354         /* statistics OIDs (table 4-2) */
356         /* mandatory */
357         case RNDIS_OID_GEN_XMIT_OK:
358                 if (rndis_debug > 1)
359                         pr_debug("%s: RNDIS_OID_GEN_XMIT_OK\n", __func__);
360                 if (stats) {
361                         *outbuf = cpu_to_le32(stats->tx_packets
362                                 - stats->tx_errors - stats->tx_dropped);
363                         retval = 0;
364                 }
365                 break;
367         /* mandatory */
368         case RNDIS_OID_GEN_RCV_OK:
369                 if (rndis_debug > 1)
370                         pr_debug("%s: RNDIS_OID_GEN_RCV_OK\n", __func__);
371                 if (stats) {
372                         *outbuf = cpu_to_le32(stats->rx_packets
373                                 - stats->rx_errors - stats->rx_dropped);
374                         retval = 0;
375                 }
376                 break;
378         /* mandatory */
379         case RNDIS_OID_GEN_XMIT_ERROR:
380                 if (rndis_debug > 1)
381                         pr_debug("%s: RNDIS_OID_GEN_XMIT_ERROR\n", __func__);
382                 if (stats) {
383                         *outbuf = cpu_to_le32(stats->tx_errors);
384                         retval = 0;
385                 }
386                 break;
388         /* mandatory */
389         case RNDIS_OID_GEN_RCV_ERROR:
390                 if (rndis_debug > 1)
391                         pr_debug("%s: RNDIS_OID_GEN_RCV_ERROR\n", __func__);
392                 if (stats) {
393                         *outbuf = cpu_to_le32(stats->rx_errors);
394                         retval = 0;
395                 }
396                 break;
398         /* mandatory */
399         case RNDIS_OID_GEN_RCV_NO_BUFFER:
400                 pr_debug("%s: RNDIS_OID_GEN_RCV_NO_BUFFER\n", __func__);
401                 if (stats) {
402                         *outbuf = cpu_to_le32(stats->rx_dropped);
403                         retval = 0;
404                 }
405                 break;
407         /* ieee802.3 OIDs (table 4-3) */
409         /* mandatory */
410         case RNDIS_OID_802_3_PERMANENT_ADDRESS:
411                 pr_debug("%s: RNDIS_OID_802_3_PERMANENT_ADDRESS\n", __func__);
412                 if (rndis_per_dev_params[configNr].dev) {
413                         length = ETH_ALEN;
414                         memcpy(outbuf,
415                                 rndis_per_dev_params[configNr].host_mac,
416                                 length);
417                         retval = 0;
418                 }
419                 break;
421         /* mandatory */
422         case RNDIS_OID_802_3_CURRENT_ADDRESS:
423                 pr_debug("%s: RNDIS_OID_802_3_CURRENT_ADDRESS\n", __func__);
424                 if (rndis_per_dev_params[configNr].dev) {
425                         length = ETH_ALEN;
426                         memcpy(outbuf,
427                                 rndis_per_dev_params [configNr].host_mac,
428                                 length);
429                         retval = 0;
430                 }
431                 break;
433         /* mandatory */
434         case RNDIS_OID_802_3_MULTICAST_LIST:
435                 pr_debug("%s: RNDIS_OID_802_3_MULTICAST_LIST\n", __func__);
436                 /* Multicast base address only */
437                 *outbuf = cpu_to_le32(0xE0000000);
438                 retval = 0;
439                 break;
441         /* mandatory */
442         case RNDIS_OID_802_3_MAXIMUM_LIST_SIZE:
443                 pr_debug("%s: RNDIS_OID_802_3_MAXIMUM_LIST_SIZE\n", __func__);
444                 /* Multicast base address only */
445                 *outbuf = cpu_to_le32(1);
446                 retval = 0;
447                 break;
449         case RNDIS_OID_802_3_MAC_OPTIONS:
450                 pr_debug("%s: RNDIS_OID_802_3_MAC_OPTIONS\n", __func__);
451                 *outbuf = cpu_to_le32(0);
452                 retval = 0;
453                 break;
455         /* ieee802.3 statistics OIDs (table 4-4) */
457         /* mandatory */
458         case RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT:
459                 pr_debug("%s: RNDIS_OID_802_3_RCV_ERROR_ALIGNMENT\n", __func__);
460                 if (stats) {
461                         *outbuf = cpu_to_le32(stats->rx_frame_errors);
462                         retval = 0;
463                 }
464                 break;
466         /* mandatory */
467         case RNDIS_OID_802_3_XMIT_ONE_COLLISION:
468                 pr_debug("%s: RNDIS_OID_802_3_XMIT_ONE_COLLISION\n", __func__);
469                 *outbuf = cpu_to_le32(0);
470                 retval = 0;
471                 break;
473         /* mandatory */
474         case RNDIS_OID_802_3_XMIT_MORE_COLLISIONS:
475                 pr_debug("%s: RNDIS_OID_802_3_XMIT_MORE_COLLISIONS\n", __func__);
476                 *outbuf = cpu_to_le32(0);
477                 retval = 0;
478                 break;
480         default:
481                 pr_warning("%s: query unknown OID 0x%08X\n",
482                          __func__, OID);
483         }
484         if (retval < 0)
485                 length = 0;
487         resp->InformationBufferLength = cpu_to_le32(length);
488         r->length = length + sizeof(*resp);
489         resp->MessageLength = cpu_to_le32(r->length);
490         return retval;
493 static int gen_ndis_set_resp(u8 configNr, u32 OID, u8 *buf, u32 buf_len,
494                              rndis_resp_t *r)
496         rndis_set_cmplt_type *resp;
497         int i, retval = -ENOTSUPP;
498         struct rndis_params *params;
500         if (!r)
501                 return -ENOMEM;
502         resp = (rndis_set_cmplt_type *)r->buf;
503         if (!resp)
504                 return -ENOMEM;
506         if (buf_len && rndis_debug > 1) {
507                 pr_debug("set OID %08x value, len %d:\n", OID, buf_len);
508                 for (i = 0; i < buf_len; i += 16) {
509                         pr_debug("%03d: %08x %08x %08x %08x\n", i,
510                                 get_unaligned_le32(&buf[i]),
511                                 get_unaligned_le32(&buf[i + 4]),
512                                 get_unaligned_le32(&buf[i + 8]),
513                                 get_unaligned_le32(&buf[i + 12]));
514                 }
515         }
517         params = &rndis_per_dev_params[configNr];
518         switch (OID) {
519         case RNDIS_OID_GEN_CURRENT_PACKET_FILTER:
521                 /* these NDIS_PACKET_TYPE_* bitflags are shared with
522                  * cdc_filter; it's not RNDIS-specific
523                  * NDIS_PACKET_TYPE_x == USB_CDC_PACKET_TYPE_x for x in:
524                  *      PROMISCUOUS, DIRECTED,
525                  *      MULTICAST, ALL_MULTICAST, BROADCAST
526                  */
527                 *params->filter = (u16)get_unaligned_le32(buf);
528                 pr_debug("%s: RNDIS_OID_GEN_CURRENT_PACKET_FILTER %08x\n",
529                         __func__, *params->filter);
531                 /* this call has a significant side effect:  it's
532                  * what makes the packet flow start and stop, like
533                  * activating the CDC Ethernet altsetting.
534                  */
535                 retval = 0;
536                 if (*params->filter) {
537                         params->state = RNDIS_DATA_INITIALIZED;
538                         netif_carrier_on(params->dev);
539                         if (netif_running(params->dev))
540                                 netif_wake_queue(params->dev);
541                 } else {
542                         params->state = RNDIS_INITIALIZED;
543                         netif_carrier_off(params->dev);
544                         netif_stop_queue(params->dev);
545                 }
546                 break;
548         case RNDIS_OID_802_3_MULTICAST_LIST:
549                 /* I think we can ignore this */
550                 pr_debug("%s: RNDIS_OID_802_3_MULTICAST_LIST\n", __func__);
551                 retval = 0;
552                 break;
554         default:
555                 pr_warning("%s: set unknown OID 0x%08X, size %d\n",
556                          __func__, OID, buf_len);
557         }
559         return retval;
562 /*
563  * Response Functions
564  */
566 static int rndis_init_response(int configNr, rndis_init_msg_type *buf)
568         rndis_init_cmplt_type *resp;
569         rndis_resp_t *r;
570         struct rndis_params *params = rndis_per_dev_params + configNr;
572         if (!params->dev)
573                 return -ENOTSUPP;
575         r = rndis_add_response(configNr, sizeof(rndis_init_cmplt_type));
576         if (!r)
577                 return -ENOMEM;
578         resp = (rndis_init_cmplt_type *)r->buf;
580         resp->MessageType = cpu_to_le32(RNDIS_MSG_INIT_C);
581         resp->MessageLength = cpu_to_le32(52);
582         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
583         resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
584         resp->MajorVersion = cpu_to_le32(RNDIS_MAJOR_VERSION);
585         resp->MinorVersion = cpu_to_le32(RNDIS_MINOR_VERSION);
586         resp->DeviceFlags = cpu_to_le32(RNDIS_DF_CONNECTIONLESS);
587         resp->Medium = cpu_to_le32(RNDIS_MEDIUM_802_3);
588         resp->MaxPacketsPerTransfer = cpu_to_le32(1);
589         resp->MaxTransferSize = cpu_to_le32(
590                   params->dev->mtu
591                 + sizeof(struct ethhdr)
592                 + sizeof(struct rndis_packet_msg_type)
593                 + 22);
594         resp->PacketAlignmentFactor = cpu_to_le32(0);
595         resp->AFListOffset = cpu_to_le32(0);
596         resp->AFListSize = cpu_to_le32(0);
598         params->resp_avail(params->v);
599         return 0;
602 static int rndis_query_response(int configNr, rndis_query_msg_type *buf)
604         rndis_query_cmplt_type *resp;
605         rndis_resp_t *r;
606         struct rndis_params *params = rndis_per_dev_params + configNr;
608         /* pr_debug("%s: OID = %08X\n", __func__, cpu_to_le32(buf->OID)); */
609         if (!params->dev)
610                 return -ENOTSUPP;
612         /*
613          * we need more memory:
614          * gen_ndis_query_resp expects enough space for
615          * rndis_query_cmplt_type followed by data.
616          * oid_supported_list is the largest data reply
617          */
618         r = rndis_add_response(configNr,
619                 sizeof(oid_supported_list) + sizeof(rndis_query_cmplt_type));
620         if (!r)
621                 return -ENOMEM;
622         resp = (rndis_query_cmplt_type *)r->buf;
624         resp->MessageType = cpu_to_le32(RNDIS_MSG_QUERY_C);
625         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
627         if (gen_ndis_query_resp(configNr, le32_to_cpu(buf->OID),
628                         le32_to_cpu(buf->InformationBufferOffset)
629                                         + 8 + (u8 *)buf,
630                         le32_to_cpu(buf->InformationBufferLength),
631                         r)) {
632                 /* OID not supported */
633                 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
634                 resp->MessageLength = cpu_to_le32(sizeof *resp);
635                 resp->InformationBufferLength = cpu_to_le32(0);
636                 resp->InformationBufferOffset = cpu_to_le32(0);
637         } else
638                 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
640         params->resp_avail(params->v);
641         return 0;
644 static int rndis_set_response(int configNr, rndis_set_msg_type *buf)
646         u32 BufLength, BufOffset;
647         rndis_set_cmplt_type *resp;
648         rndis_resp_t *r;
649         struct rndis_params *params = rndis_per_dev_params + configNr;
651         r = rndis_add_response(configNr, sizeof(rndis_set_cmplt_type));
652         if (!r)
653                 return -ENOMEM;
654         resp = (rndis_set_cmplt_type *)r->buf;
656         BufLength = le32_to_cpu(buf->InformationBufferLength);
657         BufOffset = le32_to_cpu(buf->InformationBufferOffset);
659 #ifdef  VERBOSE_DEBUG
660         pr_debug("%s: Length: %d\n", __func__, BufLength);
661         pr_debug("%s: Offset: %d\n", __func__, BufOffset);
662         pr_debug("%s: InfoBuffer: ", __func__);
664         for (i = 0; i < BufLength; i++) {
665                 pr_debug("%02x ", *(((u8 *) buf) + i + 8 + BufOffset));
666         }
668         pr_debug("\n");
669 #endif
671         resp->MessageType = cpu_to_le32(RNDIS_MSG_SET_C);
672         resp->MessageLength = cpu_to_le32(16);
673         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
674         if (gen_ndis_set_resp(configNr, le32_to_cpu(buf->OID),
675                         ((u8 *)buf) + 8 + BufOffset, BufLength, r))
676                 resp->Status = cpu_to_le32(RNDIS_STATUS_NOT_SUPPORTED);
677         else
678                 resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
680         params->resp_avail(params->v);
681         return 0;
684 static int rndis_reset_response(int configNr, rndis_reset_msg_type *buf)
686         rndis_reset_cmplt_type *resp;
687         rndis_resp_t *r;
688         struct rndis_params *params = rndis_per_dev_params + configNr;
690         r = rndis_add_response(configNr, sizeof(rndis_reset_cmplt_type));
691         if (!r)
692                 return -ENOMEM;
693         resp = (rndis_reset_cmplt_type *)r->buf;
695         resp->MessageType = cpu_to_le32(RNDIS_MSG_RESET_C);
696         resp->MessageLength = cpu_to_le32(16);
697         resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
698         /* resent information */
699         resp->AddressingReset = cpu_to_le32(1);
701         params->resp_avail(params->v);
702         return 0;
705 static int rndis_keepalive_response(int configNr,
706                                     rndis_keepalive_msg_type *buf)
708         rndis_keepalive_cmplt_type *resp;
709         rndis_resp_t *r;
710         struct rndis_params *params = rndis_per_dev_params + configNr;
712         /* host "should" check only in RNDIS_DATA_INITIALIZED state */
714         r = rndis_add_response(configNr, sizeof(rndis_keepalive_cmplt_type));
715         if (!r)
716                 return -ENOMEM;
717         resp = (rndis_keepalive_cmplt_type *)r->buf;
719         resp->MessageType = cpu_to_le32(RNDIS_MSG_KEEPALIVE_C);
720         resp->MessageLength = cpu_to_le32(16);
721         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
722         resp->Status = cpu_to_le32(RNDIS_STATUS_SUCCESS);
724         params->resp_avail(params->v);
725         return 0;
729 /*
730  * Device to Host Comunication
731  */
732 static int rndis_indicate_status_msg(int configNr, u32 status)
734         rndis_indicate_status_msg_type *resp;
735         rndis_resp_t *r;
736         struct rndis_params *params = rndis_per_dev_params + configNr;
738         if (params->state == RNDIS_UNINITIALIZED)
739                 return -ENOTSUPP;
741         r = rndis_add_response(configNr,
742                                 sizeof(rndis_indicate_status_msg_type));
743         if (!r)
744                 return -ENOMEM;
745         resp = (rndis_indicate_status_msg_type *)r->buf;
747         resp->MessageType = cpu_to_le32(RNDIS_MSG_INDICATE);
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);
753         params->resp_avail(params->v);
754         return 0;
757 int rndis_signal_connect(int configNr)
759         rndis_per_dev_params[configNr].media_state
760                         = RNDIS_MEDIA_STATE_CONNECTED;
761         return rndis_indicate_status_msg(configNr,
762                                           RNDIS_STATUS_MEDIA_CONNECT);
765 int rndis_signal_disconnect(int configNr)
767         rndis_per_dev_params[configNr].media_state
768                         = RNDIS_MEDIA_STATE_DISCONNECTED;
769         return rndis_indicate_status_msg(configNr,
770                                           RNDIS_STATUS_MEDIA_DISCONNECT);
773 void rndis_uninit(int configNr)
775         u8 *buf;
776         u32 length;
778         if (configNr >= RNDIS_MAX_CONFIGS)
779                 return;
780         rndis_per_dev_params[configNr].state = RNDIS_UNINITIALIZED;
782         /* drain the response queue */
783         while ((buf = rndis_get_next_response(configNr, &length)))
784                 rndis_free_response(configNr, buf);
787 void rndis_set_host_mac(int configNr, const u8 *addr)
789         rndis_per_dev_params[configNr].host_mac = addr;
792 /*
793  * Message Parser
794  */
795 int rndis_msg_parser(u8 configNr, u8 *buf)
797         u32 MsgType, MsgLength;
798         __le32 *tmp;
799         struct rndis_params *params;
801         if (!buf)
802                 return -ENOMEM;
804         tmp = (__le32 *)buf;
805         MsgType   = get_unaligned_le32(tmp++);
806         MsgLength = get_unaligned_le32(tmp++);
808         if (configNr >= RNDIS_MAX_CONFIGS)
809                 return -ENOTSUPP;
810         params = &rndis_per_dev_params[configNr];
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          */
817         /* For USB: responses may take up to 10 seconds */
818         switch (MsgType) {
819         case RNDIS_MSG_INIT:
820                 pr_debug("%s: RNDIS_MSG_INIT\n",
821                         __func__);
822                 params->state = RNDIS_INITIALIZED;
823                 return rndis_init_response(configNr,
824                                         (rndis_init_msg_type *)buf);
826         case RNDIS_MSG_HALT:
827                 pr_debug("%s: RNDIS_MSG_HALT\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;
836         case RNDIS_MSG_QUERY:
837                 return rndis_query_response(configNr,
838                                         (rndis_query_msg_type *)buf);
840         case RNDIS_MSG_SET:
841                 return rndis_set_response(configNr,
842                                         (rndis_set_msg_type *)buf);
844         case RNDIS_MSG_RESET:
845                 pr_debug("%s: RNDIS_MSG_RESET\n",
846                         __func__);
847                 return rndis_reset_response(configNr,
848                                         (rndis_reset_msg_type *)buf);
850         case RNDIS_MSG_KEEPALIVE:
851                 /* For USB: host does this every 5 seconds */
852                 if (rndis_debug > 1)
853                         pr_debug("%s: RNDIS_MSG_KEEPALIVE\n",
854                                 __func__);
855                 return rndis_keepalive_response(configNr,
856                                                  (rndis_keepalive_msg_type *)
857                                                  buf);
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                 print_hex_dump_bytes(__func__, DUMP_PREFIX_OFFSET,
867                                      buf, MsgLength);
868                 break;
869         }
871         return -ENOTSUPP;
874 int rndis_register(void (*resp_avail)(void *v), void *v)
876         u8 i;
878         if (!resp_avail)
879                 return -EINVAL;
881         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
882                 if (!rndis_per_dev_params[i].used) {
883                         rndis_per_dev_params[i].used = 1;
884                         rndis_per_dev_params[i].resp_avail = resp_avail;
885                         rndis_per_dev_params[i].v = v;
886                         pr_debug("%s: configNr = %d\n", __func__, i);
887                         return i;
888                 }
889         }
890         pr_debug("failed\n");
892         return -ENODEV;
895 void rndis_deregister(int configNr)
897         pr_debug("%s:\n", __func__);
899         if (configNr >= RNDIS_MAX_CONFIGS) return;
900         rndis_per_dev_params[configNr].used = 0;
903 int rndis_set_param_dev(u8 configNr, struct net_device *dev, u16 *cdc_filter)
905         pr_debug("%s:\n", __func__);
906         if (!dev)
907                 return -EINVAL;
908         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
910         rndis_per_dev_params[configNr].dev = dev;
911         rndis_per_dev_params[configNr].filter = cdc_filter;
913         return 0;
916 int rndis_set_param_vendor(u8 configNr, u32 vendorID, const char *vendorDescr)
918         pr_debug("%s:\n", __func__);
919         if (!vendorDescr) return -1;
920         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
922         rndis_per_dev_params[configNr].vendorID = vendorID;
923         rndis_per_dev_params[configNr].vendorDescr = vendorDescr;
925         return 0;
928 int rndis_set_param_medium(u8 configNr, u32 medium, u32 speed)
930         pr_debug("%s: %u %u\n", __func__, medium, speed);
931         if (configNr >= RNDIS_MAX_CONFIGS) return -1;
933         rndis_per_dev_params[configNr].medium = medium;
934         rndis_per_dev_params[configNr].speed = speed;
936         return 0;
939 void rndis_add_hdr(struct sk_buff *skb)
941         struct rndis_packet_msg_type *header;
943         if (!skb)
944                 return;
945         header = (void *)skb_push(skb, sizeof(*header));
946         memset(header, 0, sizeof *header);
947         header->MessageType = cpu_to_le32(RNDIS_MSG_PACKET);
948         header->MessageLength = cpu_to_le32(skb->len);
949         header->DataOffset = cpu_to_le32(36);
950         header->DataLength = cpu_to_le32(skb->len - sizeof(*header));
953 void rndis_free_response(int configNr, u8 *buf)
955         rndis_resp_t *r;
956         struct list_head *act, *tmp;
958         list_for_each_safe(act, tmp,
959                         &(rndis_per_dev_params[configNr].resp_queue))
960         {
961                 r = list_entry(act, rndis_resp_t, list);
962                 if (r && r->buf == buf) {
963                         list_del(&r->list);
964                         kfree(r);
965                 }
966         }
969 u8 *rndis_get_next_response(int configNr, u32 *length)
971         rndis_resp_t *r;
972         struct list_head *act, *tmp;
974         if (!length) return NULL;
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->send) {
981                         r->send = 1;
982                         *length = r->length;
983                         return r->buf;
984                 }
985         }
987         return NULL;
990 static rndis_resp_t *rndis_add_response(int configNr, u32 length)
992         rndis_resp_t *r;
994         /* NOTE: this gets copied into ether.c USB_BUFSIZ bytes ... */
995         r = kmalloc(sizeof(rndis_resp_t) + length, GFP_ATOMIC);
996         if (!r) return NULL;
998         r->buf = (u8 *)(r + 1);
999         r->length = length;
1000         r->send = 0;
1002         list_add_tail(&r->list,
1003                 &(rndis_per_dev_params[configNr].resp_queue));
1004         return r;
1007 int rndis_rm_hdr(struct gether *port,
1008                         struct sk_buff *skb,
1009                         struct sk_buff_head *list)
1011         /* tmp points to a struct rndis_packet_msg_type */
1012         __le32 *tmp = (void *)skb->data;
1014         /* MessageType, MessageLength */
1015         if (cpu_to_le32(RNDIS_MSG_PACKET)
1016                         != get_unaligned(tmp++)) {
1017                 dev_kfree_skb_any(skb);
1018                 return -EINVAL;
1019         }
1020         tmp++;
1022         /* DataOffset, DataLength */
1023         if (!skb_pull(skb, get_unaligned_le32(tmp++) + 8)) {
1024                 dev_kfree_skb_any(skb);
1025                 return -EOVERFLOW;
1026         }
1027         skb_trim(skb, get_unaligned_le32(tmp++));
1029         skb_queue_tail(list, skb);
1030         return 0;
1033 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1035 static int rndis_proc_show(struct seq_file *m, void *v)
1037         rndis_params *param = m->private;
1039         seq_printf(m,
1040                          "Config Nr. %d\n"
1041                          "used      : %s\n"
1042                          "state     : %s\n"
1043                          "medium    : 0x%08X\n"
1044                          "speed     : %d\n"
1045                          "cable     : %s\n"
1046                          "vendor ID : 0x%08X\n"
1047                          "vendor    : %s\n",
1048                          param->confignr, (param->used) ? "y" : "n",
1049                          ({ char *s = "?";
1050                          switch (param->state) {
1051                          case RNDIS_UNINITIALIZED:
1052                                 s = "RNDIS_UNINITIALIZED"; break;
1053                          case RNDIS_INITIALIZED:
1054                                 s = "RNDIS_INITIALIZED"; break;
1055                          case RNDIS_DATA_INITIALIZED:
1056                                 s = "RNDIS_DATA_INITIALIZED"; break;
1057                         }; s; }),
1058                          param->medium,
1059                          (param->media_state) ? 0 : param->speed*100,
1060                          (param->media_state) ? "disconnected" : "connected",
1061                          param->vendorID, param->vendorDescr);
1062         return 0;
1065 static ssize_t rndis_proc_write(struct file *file, const char __user *buffer,
1066                                 size_t count, loff_t *ppos)
1068         rndis_params *p = PDE(file->f_path.dentry->d_inode)->data;
1069         u32 speed = 0;
1070         int i, fl_speed = 0;
1072         for (i = 0; i < count; i++) {
1073                 char c;
1074                 if (get_user(c, buffer))
1075                         return -EFAULT;
1076                 switch (c) {
1077                 case '0':
1078                 case '1':
1079                 case '2':
1080                 case '3':
1081                 case '4':
1082                 case '5':
1083                 case '6':
1084                 case '7':
1085                 case '8':
1086                 case '9':
1087                         fl_speed = 1;
1088                         speed = speed * 10 + c - '0';
1089                         break;
1090                 case 'C':
1091                 case 'c':
1092                         rndis_signal_connect(p->confignr);
1093                         break;
1094                 case 'D':
1095                 case 'd':
1096                         rndis_signal_disconnect(p->confignr);
1097                         break;
1098                 default:
1099                         if (fl_speed) p->speed = speed;
1100                         else pr_debug("%c is not valid\n", c);
1101                         break;
1102                 }
1104                 buffer++;
1105         }
1107         return count;
1110 static int rndis_proc_open(struct inode *inode, struct file *file)
1112         return single_open(file, rndis_proc_show, PDE(inode)->data);
1115 static const struct file_operations rndis_proc_fops = {
1116         .owner          = THIS_MODULE,
1117         .open           = rndis_proc_open,
1118         .read           = seq_read,
1119         .llseek         = seq_lseek,
1120         .release        = single_release,
1121         .write          = rndis_proc_write,
1122 };
1124 #define NAME_TEMPLATE "driver/rndis-%03d"
1126 static struct proc_dir_entry *rndis_connect_state [RNDIS_MAX_CONFIGS];
1128 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
1130 static bool rndis_initialized;
1132 int rndis_init(void)
1134         u8 i;
1136         if (rndis_initialized)
1137                 return 0;
1139         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1140 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1141                 char name [20];
1143                 sprintf(name, NAME_TEMPLATE, i);
1144                 rndis_connect_state[i] = proc_create_data(name, 0660, NULL,
1145                                         &rndis_proc_fops,
1146                                         (void *)(rndis_per_dev_params + i));
1147                 if (!rndis_connect_state[i]) {
1148                         pr_debug("%s: remove entries", __func__);
1149                         while (i) {
1150                                 sprintf(name, NAME_TEMPLATE, --i);
1151                                 remove_proc_entry(name, NULL);
1152                         }
1153                         pr_debug("\n");
1154                         return -EIO;
1155                 }
1156 #endif
1157                 rndis_per_dev_params[i].confignr = i;
1158                 rndis_per_dev_params[i].used = 0;
1159                 rndis_per_dev_params[i].state = RNDIS_UNINITIALIZED;
1160                 rndis_per_dev_params[i].media_state
1161                                 = RNDIS_MEDIA_STATE_DISCONNECTED;
1162                 INIT_LIST_HEAD(&(rndis_per_dev_params[i].resp_queue));
1163         }
1165         rndis_initialized = true;
1166         return 0;
1169 void rndis_exit(void)
1171 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1172         u8 i;
1173         char name[20];
1174 #endif
1176         if (!rndis_initialized)
1177                 return;
1178         rndis_initialized = false;
1180 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1181         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1182                 sprintf(name, NAME_TEMPLATE, i);
1183                 remove_proc_entry(name, NULL);
1184         }
1185 #endif