drivers/net/usb/rndis_host.h

   1 /*
   2  * Host Side support for RNDIS Networking Links
   3  * Copyright (C) 2005 by David Brownell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20
  21 #ifndef __RNDIS_HOST_H
  22 #define __RNDIS_HOST_H
  23
  24
  25 /*
  26  * CONTROL uses CDC "encapsulated commands" with funky notifications.
  27  *  - control-out:  SEND_ENCAPSULATED
  28  *  - interrupt-in:  RESPONSE_AVAILABLE
  29  *  - control-in:  GET_ENCAPSULATED
  30  *
  31  * We'll try to ignore the RESPONSE_AVAILABLE notifications.
  32  *
  33  * REVISIT some RNDIS implementations seem to have curious issues still
  34  * to be resolved.
  35  */
  36 struct rndis_msg_hdr {
  37         __le32  msg_type;                       /* RNDIS_MSG_* */
  38         __le32  msg_len;
  39         // followed by data that varies between messages
  40         __le32  request_id;
  41         __le32  status;
  42         // ... and more
  43 } __attribute__ ((packed));
  44
  45 /* MS-Windows uses this strange size, but RNDIS spec says 1024 minimum */
  46 #define CONTROL_BUFFER_SIZE             1025
  47
  48 /* RNDIS defines an (absurdly huge) 10 second control timeout,
  49  * but ActiveSync seems to use a more usual 5 second timeout
  50  * (which matches the USB 2.0 spec).
  51  */
  52 #define RNDIS_CONTROL_TIMEOUT_MS        (5 * 1000)
  53
  54
  55 #define ccpu2 __constant_cpu_to_le32
  56
  57 #define RNDIS_MSG_COMPLETION    ccpu2(0x80000000)
  58
  59 /* codes for "msg_type" field of rndis messages;
  60  * only the data channel uses packet messages (maybe batched);
  61  * everything else goes on the control channel.
  62  */
  63 #define RNDIS_MSG_PACKET        ccpu2(0x00000001)       /* 1-N packets */
  64 #define RNDIS_MSG_INIT          ccpu2(0x00000002)
  65 #define RNDIS_MSG_INIT_C        (RNDIS_MSG_INIT|RNDIS_MSG_COMPLETION)
  66 #define RNDIS_MSG_HALT          ccpu2(0x00000003)
  67 #define RNDIS_MSG_QUERY         ccpu2(0x00000004)
  68 #define RNDIS_MSG_QUERY_C       (RNDIS_MSG_QUERY|RNDIS_MSG_COMPLETION)
  69 #define RNDIS_MSG_SET           ccpu2(0x00000005)
  70 #define RNDIS_MSG_SET_C         (RNDIS_MSG_SET|RNDIS_MSG_COMPLETION)
  71 #define RNDIS_MSG_RESET         ccpu2(0x00000006)
  72 #define RNDIS_MSG_RESET_C       (RNDIS_MSG_RESET|RNDIS_MSG_COMPLETION)
  73 #define RNDIS_MSG_INDICATE      ccpu2(0x00000007)
  74 #define RNDIS_MSG_KEEPALIVE     ccpu2(0x00000008)
  75 #define RNDIS_MSG_KEEPALIVE_C   (RNDIS_MSG_KEEPALIVE|RNDIS_MSG_COMPLETION)
  76
  77 /* codes for "status" field of completion messages */
  78 #define RNDIS_STATUS_SUCCESS            ccpu2(0x00000000)
  79 #define RNDIS_STATUS_FAILURE            ccpu2(0xc0000001)
  80 #define RNDIS_STATUS_INVALID_DATA       ccpu2(0xc0010015)
  81 #define RNDIS_STATUS_NOT_SUPPORTED      ccpu2(0xc00000bb)
  82 #define RNDIS_STATUS_MEDIA_CONNECT      ccpu2(0x4001000b)
  83 #define RNDIS_STATUS_MEDIA_DISCONNECT   ccpu2(0x4001000c)
  84
  85
  86 struct rndis_data_hdr {
  87         __le32  msg_type;               /* RNDIS_MSG_PACKET */
  88         __le32  msg_len;                // rndis_data_hdr + data_len + pad
  89         __le32  data_offset;            // 36 -- right after header
  90         __le32  data_len;               // ... real packet size
  91
  92         __le32  oob_data_offset;        // zero
  93         __le32  oob_data_len;           // zero
  94         __le32  num_oob;                // zero
  95         __le32  packet_data_offset;     // zero
  96
  97         __le32  packet_data_len;        // zero
  98         __le32  vc_handle;              // zero
  99         __le32  reserved;               // zero
 100 } __attribute__ ((packed));
 101
 102 struct rndis_init {             /* OUT */
 103         // header and:
 104         __le32  msg_type;                       /* RNDIS_MSG_INIT */
 105         __le32  msg_len;                        // 24
 106         __le32  request_id;
 107         __le32  major_version;                  // of rndis (1.0)
 108         __le32  minor_version;
 109         __le32  max_transfer_size;
 110 } __attribute__ ((packed));
 111
 112 struct rndis_init_c {           /* IN */
 113         // header and:
 114         __le32  msg_type;                       /* RNDIS_MSG_INIT_C */
 115         __le32  msg_len;
 116         __le32  request_id;
 117         __le32  status;
 118         __le32  major_version;                  // of rndis (1.0)
 119         __le32  minor_version;
 120         __le32  device_flags;
 121         __le32  medium;                         // zero == 802.3
 122         __le32  max_packets_per_message;
 123         __le32  max_transfer_size;
 124         __le32  packet_alignment;               // max 7; (1<<n) bytes
 125         __le32  af_list_offset;                 // zero
 126         __le32  af_list_size;                   // zero
 127 } __attribute__ ((packed));
 128
 129 struct rndis_halt {             /* OUT (no reply) */
 130         // header and:
 131         __le32  msg_type;                       /* RNDIS_MSG_HALT */
 132         __le32  msg_len;
 133         __le32  request_id;
 134 } __attribute__ ((packed));
 135
 136 struct rndis_query {            /* OUT */
 137         // header and:
 138         __le32  msg_type;                       /* RNDIS_MSG_QUERY */
 139         __le32  msg_len;
 140         __le32  request_id;
 141         __le32  oid;
 142         __le32  len;
 143         __le32  offset;
 144 /*?*/   __le32  handle;                         // zero
 145 } __attribute__ ((packed));
 146
 147 struct rndis_query_c {          /* IN */
 148         // header and:
 149         __le32  msg_type;                       /* RNDIS_MSG_QUERY_C */
 150         __le32  msg_len;
 151         __le32  request_id;
 152         __le32  status;
 153         __le32  len;
 154         __le32  offset;
 155 } __attribute__ ((packed));
 156
 157 struct rndis_set {              /* OUT */
 158         // header and:
 159         __le32  msg_type;                       /* RNDIS_MSG_SET */
 160         __le32  msg_len;
 161         __le32  request_id;
 162         __le32  oid;
 163         __le32  len;
 164         __le32  offset;
 165 /*?*/   __le32  handle;                         // zero
 166 } __attribute__ ((packed));
 167
 168 struct rndis_set_c {            /* IN */
 169         // header and:
 170         __le32  msg_type;                       /* RNDIS_MSG_SET_C */
 171         __le32  msg_len;
 172         __le32  request_id;
 173         __le32  status;
 174 } __attribute__ ((packed));
 175
 176 struct rndis_reset {            /* IN */
 177         // header and:
 178         __le32  msg_type;                       /* RNDIS_MSG_RESET */
 179         __le32  msg_len;
 180         __le32  reserved;
 181 } __attribute__ ((packed));
 182
 183 struct rndis_reset_c {          /* OUT */
 184         // header and:
 185         __le32  msg_type;                       /* RNDIS_MSG_RESET_C */
 186         __le32  msg_len;
 187         __le32  status;
 188         __le32  addressing_lost;
 189 } __attribute__ ((packed));
 190
 191 struct rndis_indicate {         /* IN (unrequested) */
 192         // header and:
 193         __le32  msg_type;                       /* RNDIS_MSG_INDICATE */
 194         __le32  msg_len;
 195         __le32  status;
 196         __le32  length;
 197         __le32  offset;
 198 /**/    __le32  diag_status;
 199         __le32  error_offset;
 200 /**/    __le32  message;
 201 } __attribute__ ((packed));
 202
 203 struct rndis_keepalive {        /* OUT (optionally IN) */
 204         // header and:
 205         __le32  msg_type;                       /* RNDIS_MSG_KEEPALIVE */
 206         __le32  msg_len;
 207         __le32  request_id;
 208 } __attribute__ ((packed));
 209
 210 struct rndis_keepalive_c {      /* IN (optionally OUT) */
 211         // header and:
 212         __le32  msg_type;                       /* RNDIS_MSG_KEEPALIVE_C */
 213         __le32  msg_len;
 214         __le32  request_id;
 215         __le32  status;
 216 } __attribute__ ((packed));
 217
 218 /* NOTE:  about 30 OIDs are "mandatory" for peripherals to support ... and
 219  * there are gobs more that may optionally be supported.  We'll avoid as much
 220  * of that mess as possible.
 221  */
 222 #define OID_802_3_PERMANENT_ADDRESS     ccpu2(0x01010101)
 223 #define OID_GEN_MAXIMUM_FRAME_SIZE      ccpu2(0x00010106)
 224 #define OID_GEN_CURRENT_PACKET_FILTER   ccpu2(0x0001010e)
 225
 226 /* packet filter bits used by OID_GEN_CURRENT_PACKET_FILTER */
 227 #define RNDIS_PACKET_TYPE_DIRECTED              ccpu2(0x00000001)
 228 #define RNDIS_PACKET_TYPE_MULTICAST             ccpu2(0x00000002)
 229 #define RNDIS_PACKET_TYPE_ALL_MULTICAST         ccpu2(0x00000004)
 230 #define RNDIS_PACKET_TYPE_BROADCAST             ccpu2(0x00000008)
 231 #define RNDIS_PACKET_TYPE_SOURCE_ROUTING        ccpu2(0x00000010)
 232 #define RNDIS_PACKET_TYPE_PROMISCUOUS           ccpu2(0x00000020)
 233 #define RNDIS_PACKET_TYPE_SMT                   ccpu2(0x00000040)
 234 #define RNDIS_PACKET_TYPE_ALL_LOCAL             ccpu2(0x00000080)
 235 #define RNDIS_PACKET_TYPE_GROUP                 ccpu2(0x00001000)
 236 #define RNDIS_PACKET_TYPE_ALL_FUNCTIONAL        ccpu2(0x00002000)
 237 #define RNDIS_PACKET_TYPE_FUNCTIONAL            ccpu2(0x00004000)
 238 #define RNDIS_PACKET_TYPE_MAC_FRAME             ccpu2(0x00008000)
 239
 240 /* default filter used with RNDIS devices */
 241 #define RNDIS_DEFAULT_FILTER ( \
 242         RNDIS_PACKET_TYPE_DIRECTED | \
 243         RNDIS_PACKET_TYPE_BROADCAST | \
 244         RNDIS_PACKET_TYPE_ALL_MULTICAST | \
 245         RNDIS_PACKET_TYPE_PROMISCUOUS)
 246
 247 #endif  /* __RNDIS_HOST_H */
 248