Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
Version: [ 2.6.11.8 ] [ 2.6.25 ] [ 2.6.25.8 ] [ 2.6.31.13 ] Architecture: [ i386 ]
  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                 *outbuf = cpu_to_le32(0);
446                 retval = 0;
447                 break;
448 
449         /* ieee802.3 statistics OIDs (table 4-4) */
450 
451         /* mandatory */
452         case OID_802_3_RCV_ERROR_ALIGNMENT:
453                 pr_debug("%s: OID_802_3_RCV_ERROR_ALIGNMENT\n", __func__);
454                 if (stats) {
455                         *outbuf = cpu_to_le32(stats->rx_frame_errors);
456                         retval = 0;
457                 }
458                 break;
459 
460         /* mandatory */
461         case OID_802_3_XMIT_ONE_COLLISION:
462                 pr_debug("%s: OID_802_3_XMIT_ONE_COLLISION\n", __func__);
463                 *outbuf = cpu_to_le32 (0);
464                 retval = 0;
465                 break;
466 
467         /* mandatory */
468         case OID_802_3_XMIT_MORE_COLLISIONS:
469                 pr_debug("%s: OID_802_3_XMIT_MORE_COLLISIONS\n", __func__);
470                 *outbuf = cpu_to_le32 (0);
471                 retval = 0;
472                 break;
473 
474         default:
475                 pr_warning("%s: query unknown OID 0x%08X\n",
476                          __func__, OID);
477         }
478         if (retval < 0)
479                 length = 0;
480 
481         resp->InformationBufferLength = cpu_to_le32 (length);
482         r->length = length + sizeof *resp;
483         resp->MessageLength = cpu_to_le32 (r->length);
484         return retval;
485 }
486 
487 static int gen_ndis_set_resp (u8 configNr, u32 OID, u8 *buf, u32 buf_len,
488                         rndis_resp_t *r)
489 {
490         rndis_set_cmplt_type            *resp;
491         int                             i, retval = -ENOTSUPP;
492         struct rndis_params             *params;
493 
494         if (!r)
495                 return -ENOMEM;
496         resp = (rndis_set_cmplt_type *) r->buf;
497         if (!resp)
498                 return -ENOMEM;
499 
500         if (buf_len && rndis_debug > 1) {
501                 pr_debug("set OID %08x value, len %d:\n", OID, buf_len);
502                 for (i = 0; i < buf_len; i += 16) {
503                         pr_debug("%03d: %08x %08x %08x %08x\n", i,
504                                 get_unaligned_le32(&buf[i]),
505                                 get_unaligned_le32(&buf[i + 4]),
506                                 get_unaligned_le32(&buf[i + 8]),
507                                 get_unaligned_le32(&buf[i + 12]));
508                 }
509         }
510 
511         params = &rndis_per_dev_params [configNr];
512         switch (OID) {
513         case OID_GEN_CURRENT_PACKET_FILTER:
514 
515                 /* these NDIS_PACKET_TYPE_* bitflags are shared with
516                  * cdc_filter; it's not RNDIS-specific
517                  * NDIS_PACKET_TYPE_x == USB_CDC_PACKET_TYPE_x for x in:
518                  *      PROMISCUOUS, DIRECTED,
519                  *      MULTICAST, ALL_MULTICAST, BROADCAST
520                  */
521                 *params->filter = (u16)get_unaligned_le32(buf);
522                 pr_debug("%s: OID_GEN_CURRENT_PACKET_FILTER %08x\n",
523                         __func__, *params->filter);
524 
525                 /* this call has a significant side effect:  it's
526                  * what makes the packet flow start and stop, like
527                  * activating the CDC Ethernet altsetting.
528                  */
529                 retval = 0;
530                 if (*params->filter) {
531                         params->state = RNDIS_DATA_INITIALIZED;
532                         netif_carrier_on(params->dev);
533                         if (netif_running(params->dev))
534                                 netif_wake_queue (params->dev);
535                 } else {
536                         params->state = RNDIS_INITIALIZED;
537                         netif_carrier_off (params->dev);
538                         netif_stop_queue (params->dev);
539                 }
540                 break;
541 
542         case OID_802_3_MULTICAST_LIST:
543                 /* I think we can ignore this */
544                 pr_debug("%s: OID_802_3_MULTICAST_LIST\n", __func__);
545                 retval = 0;
546                 break;
547 
548         default:
549                 pr_warning("%s: set unknown OID 0x%08X, size %d\n",
550                          __func__, OID, buf_len);
551         }
552 
553         return retval;
554 }
555 
556 /*
557  * Response Functions
558  */
559 
560 static int rndis_init_response (int configNr, rndis_init_msg_type *buf)
561 {
562         rndis_init_cmplt_type   *resp;
563         rndis_resp_t            *r;
564         struct rndis_params     *params = rndis_per_dev_params + configNr;
565 
566         if (!params->dev)
567                 return -ENOTSUPP;
568 
569         r = rndis_add_response (configNr, sizeof (rndis_init_cmplt_type));
570         if (!r)
571                 return -ENOMEM;
572         resp = (rndis_init_cmplt_type *) r->buf;
573 
574         resp->MessageType = cpu_to_le32 (
575                         REMOTE_NDIS_INITIALIZE_CMPLT);
576         resp->MessageLength = cpu_to_le32 (52);
577         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
578         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
579         resp->MajorVersion = cpu_to_le32 (RNDIS_MAJOR_VERSION);
580         resp->MinorVersion = cpu_to_le32 (RNDIS_MINOR_VERSION);
581         resp->DeviceFlags = cpu_to_le32 (RNDIS_DF_CONNECTIONLESS);
582         resp->Medium = cpu_to_le32 (RNDIS_MEDIUM_802_3);
583         resp->MaxPacketsPerTransfer = cpu_to_le32 (1);
584         resp->MaxTransferSize = cpu_to_le32 (
585                   params->dev->mtu
586                 + sizeof (struct ethhdr)
587                 + sizeof (struct rndis_packet_msg_type)
588                 + 22);
589         resp->PacketAlignmentFactor = cpu_to_le32 (0);
590         resp->AFListOffset = cpu_to_le32 (0);
591         resp->AFListSize = cpu_to_le32 (0);
592 
593         params->resp_avail(params->v);
594         return 0;
595 }
596 
597 static int rndis_query_response (int configNr, rndis_query_msg_type *buf)
598 {
599         rndis_query_cmplt_type *resp;
600         rndis_resp_t            *r;
601         struct rndis_params     *params = rndis_per_dev_params + configNr;
602 
603         /* pr_debug("%s: OID = %08X\n", __func__, cpu_to_le32(buf->OID)); */
604         if (!params->dev)
605                 return -ENOTSUPP;
606 
607         /*
608          * we need more memory:
609          * gen_ndis_query_resp expects enough space for
610          * rndis_query_cmplt_type followed by data.
611          * oid_supported_list is the largest data reply
612          */
613         r = rndis_add_response (configNr,
614                 sizeof (oid_supported_list) + sizeof(rndis_query_cmplt_type));
615         if (!r)
616                 return -ENOMEM;
617         resp = (rndis_query_cmplt_type *) r->buf;
618 
619         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_QUERY_CMPLT);
620         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
621 
622         if (gen_ndis_query_resp (configNr, le32_to_cpu (buf->OID),
623                         le32_to_cpu(buf->InformationBufferOffset)
624                                         + 8 + (u8 *) buf,
625                         le32_to_cpu(buf->InformationBufferLength),
626                         r)) {
627                 /* OID not supported */
628                 resp->Status = cpu_to_le32 (
629                                 RNDIS_STATUS_NOT_SUPPORTED);
630                 resp->MessageLength = cpu_to_le32 (sizeof *resp);
631                 resp->InformationBufferLength = cpu_to_le32 (0);
632                 resp->InformationBufferOffset = cpu_to_le32 (0);
633         } else
634                 resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
635 
636         params->resp_avail(params->v);
637         return 0;
638 }
639 
640 static int rndis_set_response (int configNr, rndis_set_msg_type *buf)
641 {
642         u32                     BufLength, BufOffset;
643         rndis_set_cmplt_type    *resp;
644         rndis_resp_t            *r;
645         struct rndis_params     *params = rndis_per_dev_params + configNr;
646 
647         r = rndis_add_response (configNr, sizeof (rndis_set_cmplt_type));
648         if (!r)
649                 return -ENOMEM;
650         resp = (rndis_set_cmplt_type *) r->buf;
651 
652         BufLength = le32_to_cpu (buf->InformationBufferLength);
653         BufOffset = le32_to_cpu (buf->InformationBufferOffset);
654 
655 #ifdef  VERBOSE_DEBUG
656         pr_debug("%s: Length: %d\n", __func__, BufLength);
657         pr_debug("%s: Offset: %d\n", __func__, BufOffset);
658         pr_debug("%s: InfoBuffer: ", __func__);
659 
660         for (i = 0; i < BufLength; i++) {
661                 pr_debug("%02x ", *(((u8 *) buf) + i + 8 + BufOffset));
662         }
663 
664         pr_debug("\n");
665 #endif
666 
667         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_SET_CMPLT);
668         resp->MessageLength = cpu_to_le32 (16);
669         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
670         if (gen_ndis_set_resp (configNr, le32_to_cpu (buf->OID),
671                         ((u8 *) buf) + 8 + BufOffset, BufLength, r))
672                 resp->Status = cpu_to_le32 (RNDIS_STATUS_NOT_SUPPORTED);
673         else
674                 resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
675 
676         params->resp_avail(params->v);
677         return 0;
678 }
679 
680 static int rndis_reset_response (int configNr, rndis_reset_msg_type *buf)
681 {
682         rndis_reset_cmplt_type  *resp;
683         rndis_resp_t            *r;
684         struct rndis_params     *params = rndis_per_dev_params + configNr;
685 
686         r = rndis_add_response (configNr, sizeof (rndis_reset_cmplt_type));
687         if (!r)
688                 return -ENOMEM;
689         resp = (rndis_reset_cmplt_type *) r->buf;
690 
691         resp->MessageType = cpu_to_le32 (REMOTE_NDIS_RESET_CMPLT);
692         resp->MessageLength = cpu_to_le32 (16);
693         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
694         /* resent information */
695         resp->AddressingReset = cpu_to_le32 (1);
696 
697         params->resp_avail(params->v);
698         return 0;
699 }
700 
701 static int rndis_keepalive_response (int configNr,
702                                 rndis_keepalive_msg_type *buf)
703 {
704         rndis_keepalive_cmplt_type      *resp;
705         rndis_resp_t                    *r;
706         struct rndis_params     *params = rndis_per_dev_params + configNr;
707 
708         /* host "should" check only in RNDIS_DATA_INITIALIZED state */
709 
710         r = rndis_add_response (configNr, sizeof (rndis_keepalive_cmplt_type));
711         if (!r)
712                 return -ENOMEM;
713         resp = (rndis_keepalive_cmplt_type *) r->buf;
714 
715         resp->MessageType = cpu_to_le32 (
716                         REMOTE_NDIS_KEEPALIVE_CMPLT);
717         resp->MessageLength = cpu_to_le32 (16);
718         resp->RequestID = buf->RequestID; /* Still LE in msg buffer */
719         resp->Status = cpu_to_le32 (RNDIS_STATUS_SUCCESS);
720 
721         params->resp_avail(params->v);
722         return 0;
723 }
724 
725 
726 /*
727  * Device to Host Comunication
728  */
729 static int rndis_indicate_status_msg (int configNr, u32 status)
730 {
731         rndis_indicate_status_msg_type  *resp;
732         rndis_resp_t                    *r;
733         struct rndis_params     *params = rndis_per_dev_params + configNr;
734 
735         if (params->state == RNDIS_UNINITIALIZED)
736                 return -ENOTSUPP;
737 
738         r = rndis_add_response (configNr,
739                                 sizeof (rndis_indicate_status_msg_type));
740         if (!r)
741                 return -ENOMEM;
742         resp = (rndis_indicate_status_msg_type *) r->buf;
743 
744         resp->MessageType = cpu_to_le32 (
745                         REMOTE_NDIS_INDICATE_STATUS_MSG);
746         resp->MessageLength = cpu_to_le32 (20);
747         resp->Status = cpu_to_le32 (status);
748         resp->StatusBufferLength = cpu_to_le32 (0);
749         resp->StatusBufferOffset = cpu_to_le32 (0);
750 
751         params->resp_avail(params->v);
752         return 0;
753 }
754 
755 int rndis_signal_connect (int configNr)
756 {
757         rndis_per_dev_params [configNr].media_state
758                         = NDIS_MEDIA_STATE_CONNECTED;
759         return rndis_indicate_status_msg (configNr,
760                                           RNDIS_STATUS_MEDIA_CONNECT);
761 }
762 
763 int rndis_signal_disconnect (int configNr)
764 {
765         rndis_per_dev_params [configNr].media_state
766                         = NDIS_MEDIA_STATE_DISCONNECTED;
767         return rndis_indicate_status_msg (configNr,
768                                           RNDIS_STATUS_MEDIA_DISCONNECT);
769 }
770 
771 void rndis_uninit (int configNr)
772 {
773         u8 *buf;
774         u32 length;
775 
776         if (configNr >= RNDIS_MAX_CONFIGS)
777                 return;
778         rndis_per_dev_params [configNr].state = RNDIS_UNINITIALIZED;
779 
780         /* drain the response queue */
781         while ((buf = rndis_get_next_response(configNr, &length)))
782                 rndis_free_response(configNr, buf);
783 }
784 
785 void rndis_set_host_mac (int configNr, const u8 *addr)
786 {
787         rndis_per_dev_params [configNr].host_mac = addr;
788 }
789 
790 /*
791  * Message Parser
792  */
793 int rndis_msg_parser (u8 configNr, u8 *buf)
794 {
795         u32 MsgType, MsgLength;
796         __le32 *tmp;
797         struct rndis_params             *params;
798 
799         if (!buf)
800                 return -ENOMEM;
801 
802         tmp = (__le32 *) buf;
803         MsgType   = get_unaligned_le32(tmp++);
804         MsgLength = get_unaligned_le32(tmp++);
805 
806         if (configNr >= RNDIS_MAX_CONFIGS)
807                 return -ENOTSUPP;
808         params = &rndis_per_dev_params [configNr];
809 
810         /* NOTE: RNDIS is *EXTREMELY* chatty ... Windows constantly polls for
811          * rx/tx statistics and link status, in addition to KEEPALIVE traffic
812          * and normal HC level polling to see if there's any IN traffic.
813          */
814 
815         /* For USB: responses may take up to 10 seconds */
816         switch (MsgType) {
817         case REMOTE_NDIS_INITIALIZE_MSG:
818                 pr_debug("%s: REMOTE_NDIS_INITIALIZE_MSG\n",
819                         __func__ );
820                 params->state = RNDIS_INITIALIZED;
821                 return  rndis_init_response (configNr,
822                                         (rndis_init_msg_type *) buf);
823 
824         case REMOTE_NDIS_HALT_MSG:
825                 pr_debug("%s: REMOTE_NDIS_HALT_MSG\n",
826                         __func__ );
827                 params->state = RNDIS_UNINITIALIZED;
828                 if (params->dev) {
829                         netif_carrier_off (params->dev);
830                         netif_stop_queue (params->dev);
831                 }
832                 return 0;
833 
834         case REMOTE_NDIS_QUERY_MSG:
835                 return rndis_query_response (configNr,
836                                         (rndis_query_msg_type *) buf);
837 
838         case REMOTE_NDIS_SET_MSG:
839                 return rndis_set_response (configNr,
840                                         (rndis_set_msg_type *) buf);
841 
842         case REMOTE_NDIS_RESET_MSG:
843                 pr_debug("%s: REMOTE_NDIS_RESET_MSG\n",
844                         __func__ );
845                 return rndis_reset_response (configNr,
846                                         (rndis_reset_msg_type *) buf);
847 
848         case REMOTE_NDIS_KEEPALIVE_MSG:
849                 /* For USB: host does this every 5 seconds */
850                 if (rndis_debug > 1)
851                         pr_debug("%s: REMOTE_NDIS_KEEPALIVE_MSG\n",
852                                 __func__ );
853                 return rndis_keepalive_response (configNr,
854                                                  (rndis_keepalive_msg_type *)
855                                                  buf);
856 
857         default:
858                 /* At least Windows XP emits some undefined RNDIS messages.
859                  * In one case those messages seemed to relate to the host
860                  * suspending itself.
861                  */
862                 pr_warning("%s: unknown RNDIS message 0x%08X len %d\n",
863                         __func__ , MsgType, MsgLength);
864                 {
865                         unsigned i;
866                         for (i = 0; i < MsgLength; i += 16) {
867                                 pr_debug("%03d: "
868                                         " %02x %02x %02x %02x"
869                                         " %02x %02x %02x %02x"
870                                         " %02x %02x %02x %02x"
871                                         " %02x %02x %02x %02x"
872                                         "\n",
873                                         i,
874                                         buf[i], buf [i+1],
875                                                 buf[i+2], buf[i+3],
876                                         buf[i+4], buf [i+5],
877                                                 buf[i+6], buf[i+7],
878                                         buf[i+8], buf [i+9],
879                                                 buf[i+10], buf[i+11],
880                                         buf[i+12], buf [i+13],
881                                                 buf[i+14], buf[i+15]);
882                         }
883                 }
884                 break;
885         }
886 
887         return -ENOTSUPP;
888 }
889 
890 int rndis_register(void (*resp_avail)(void *v), void *v)
891 {
892         u8 i;
893 
894         if (!resp_avail)
895                 return -EINVAL;
896 
897         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
898                 if (!rndis_per_dev_params [i].used) {
899                         rndis_per_dev_params [i].used = 1;
900                         rndis_per_dev_params [i].resp_avail = resp_avail;
901                         rndis_per_dev_params [i].v = v;
902                         pr_debug("%s: configNr = %d\n", __func__, i);
903                         return i;
904                 }
905         }
906         pr_debug("failed\n");
907 
908         return -ENODEV;
909 }
910 
911 void rndis_deregister (int configNr)
912 {
913         pr_debug("%s: \n", __func__);
914 
915         if (configNr >= RNDIS_MAX_CONFIGS) return;
916         rndis_per_dev_params [configNr].used = 0;
917 
918         return;
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 sk_buff *skb)
1026 {
1027         /* tmp points to a struct rndis_packet_msg_type */
1028         __le32          *tmp = (void *) skb->data;
1029 
1030         /* MessageType, MessageLength */
1031         if (cpu_to_le32(REMOTE_NDIS_PACKET_MSG)
1032                         != get_unaligned(tmp++))
1033                 return -EINVAL;
1034         tmp++;
1035 
1036         /* DataOffset, DataLength */
1037         if (!skb_pull(skb, get_unaligned_le32(tmp++) + 8))
1038                 return -EOVERFLOW;
1039         skb_trim(skb, get_unaligned_le32(tmp++));
1040 
1041         return 0;
1042 }
1043 
1044 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1045 
1046 static int rndis_proc_show(struct seq_file *m, void *v)
1047 {
1048         rndis_params *param = m->private;
1049 
1050         seq_printf(m,
1051                          "Config Nr. %d\n"
1052                          "used      : %s\n"
1053                          "state     : %s\n"
1054                          "medium    : 0x%08X\n"
1055                          "speed     : %d\n"
1056                          "cable     : %s\n"
1057                          "vendor ID : 0x%08X\n"
1058                          "vendor    : %s\n",
1059                          param->confignr, (param->used) ? "y" : "n",
1060                          ({ char *s = "?";
1061                          switch (param->state) {
1062                          case RNDIS_UNINITIALIZED:
1063                                 s = "RNDIS_UNINITIALIZED"; break;
1064                          case RNDIS_INITIALIZED:
1065                                 s = "RNDIS_INITIALIZED"; break;
1066                          case RNDIS_DATA_INITIALIZED:
1067                                 s = "RNDIS_DATA_INITIALIZED"; break;
1068                         }; s; }),
1069                          param->medium,
1070                          (param->media_state) ? 0 : param->speed*100,
1071                          (param->media_state) ? "disconnected" : "connected",
1072                          param->vendorID, param->vendorDescr);
1073         return 0;
1074 }
1075 
1076 static ssize_t rndis_proc_write(struct file *file, const char __user *buffer,
1077                 size_t count, loff_t *ppos)
1078 {
1079         rndis_params *p = PDE(file->f_path.dentry->d_inode)->data;
1080         u32 speed = 0;
1081         int i, fl_speed = 0;
1082 
1083         for (i = 0; i < count; i++) {
1084                 char c;
1085                 if (get_user(c, buffer))
1086                         return -EFAULT;
1087                 switch (c) {
1088                 case '':
1089                 case '1':
1090                 case '2':
1091                 case '3':
1092                 case '4':
1093                 case '5':
1094                 case '6':
1095                 case '7':
1096                 case '8':
1097                 case '9':
1098                         fl_speed = 1;
1099                         speed = speed*10 + c - '';
1100                         break;
1101                 case 'C':
1102                 case 'c':
1103                         rndis_signal_connect (p->confignr);
1104                         break;
1105                 case 'D':
1106                 case 'd':
1107                         rndis_signal_disconnect(p->confignr);
1108                         break;
1109                 default:
1110                         if (fl_speed) p->speed = speed;
1111                         else pr_debug("%c is not valid\n", c);
1112                         break;
1113                 }
1114 
1115                 buffer++;
1116         }
1117 
1118         return count;
1119 }
1120 
1121 static int rndis_proc_open(struct inode *inode, struct file *file)
1122 {
1123         return single_open(file, rndis_proc_show, PDE(inode)->data);
1124 }
1125 
1126 static const struct file_operations rndis_proc_fops = {
1127         .owner          = THIS_MODULE,
1128         .open           = rndis_proc_open,
1129         .read           = seq_read,
1130         .llseek         = seq_lseek,
1131         .release        = single_release,
1132         .write          = rndis_proc_write,
1133 };
1134 
1135 #define NAME_TEMPLATE   "driver/rndis-%03d"
1136 
1137 static struct proc_dir_entry *rndis_connect_state [RNDIS_MAX_CONFIGS];
1138 
1139 #endif  /* CONFIG_USB_GADGET_DEBUG_FILES */
1140 
1141 
1142 int __init rndis_init (void)
1143 {
1144         u8 i;
1145 
1146         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1147 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1148                 char name [20];
1149 
1150                 sprintf (name, NAME_TEMPLATE, i);
1151                 if (!(rndis_connect_state [i]
1152                                 = proc_create_data(name, 0660, NULL,
1153                                         &rndis_proc_fops,
1154                                         (void *)(rndis_per_dev_params + i))))
1155                 {
1156                         pr_debug("%s :remove entries", __func__);
1157                         while (i) {
1158                                 sprintf (name, NAME_TEMPLATE, --i);
1159                                 remove_proc_entry (name, NULL);
1160                         }
1161                         pr_debug("\n");
1162                         return -EIO;
1163                 }
1164 #endif
1165                 rndis_per_dev_params [i].confignr = i;
1166                 rndis_per_dev_params [i].used = 0;
1167                 rndis_per_dev_params [i].state = RNDIS_UNINITIALIZED;
1168                 rndis_per_dev_params [i].media_state
1169                                 = NDIS_MEDIA_STATE_DISCONNECTED;
1170                 INIT_LIST_HEAD (&(rndis_per_dev_params [i].resp_queue));
1171         }
1172 
1173         return 0;
1174 }
1175 
1176 void rndis_exit (void)
1177 {
1178 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1179         u8 i;
1180         char name [20];
1181 
1182         for (i = 0; i < RNDIS_MAX_CONFIGS; i++) {
1183                 sprintf (name, NAME_TEMPLATE, i);
1184                 remove_proc_entry (name, NULL);
1185         }
1186 #endif
1187 }
1188 
1189 
  This page was automatically generated by the LXR engine.