release/src-rt/linux/linux-2.6/include/linux/usb/cdc.h

   1 /*
   2  * USB Communications Device Class (CDC) definitions
   3  *
   4  * CDC says how to talk to lots of different types of network adapters,
   5  * notably ethernet adapters and various modems.  It's used mostly with
   6  * firmware based USB peripherals.
   7  */
   8 #ifndef __LINUX_USB_CDC_H
   9 #define __LINUX_USB_CDC_H
  10
  11 #include <linux/types.h>
  12
  13 #define USB_CDC_SUBCLASS_ACM                    0x02
  14 #define USB_CDC_SUBCLASS_ETHERNET               0x06
  15 #define USB_CDC_SUBCLASS_WHCM                   0x08
  16 #define USB_CDC_SUBCLASS_DMM                    0x09
  17 #define USB_CDC_SUBCLASS_MDLM                   0x0a
  18 #define USB_CDC_SUBCLASS_OBEX                   0x0b
  19 #define USB_CDC_SUBCLASS_EEM                    0x0c
  20 #define USB_CDC_SUBCLASS_NCM                    0x0d
  21 #define USB_CDC_SUBCLASS_MBIM                   0x0e
  22
  23 #define USB_CDC_PROTO_NONE                      0
  24
  25 #define USB_CDC_ACM_PROTO_AT_V25TER             1
  26 #define USB_CDC_ACM_PROTO_AT_PCCA101            2
  27 #define USB_CDC_ACM_PROTO_AT_PCCA101_WAKE       3
  28 #define USB_CDC_ACM_PROTO_AT_GSM                4
  29 #define USB_CDC_ACM_PROTO_AT_3G                 5
  30 #define USB_CDC_ACM_PROTO_AT_CDMA               6
  31 #define USB_CDC_ACM_PROTO_VENDOR                0xff
  32
  33 #define USB_CDC_PROTO_EEM                       7
  34
  35 #define USB_CDC_NCM_PROTO_NTB                   1
  36 #define USB_CDC_MBIM_PROTO_NTB                  2
  37
  38 /*-------------------------------------------------------------------------*/
  39
  40 /*
  41  * Class-Specific descriptors ... there are a couple dozen of them
  42  */
  43
  44 #define USB_CDC_HEADER_TYPE             0x00            /* header_desc */
  45 #define USB_CDC_CALL_MANAGEMENT_TYPE    0x01            /* call_mgmt_descriptor */
  46 #define USB_CDC_ACM_TYPE                0x02            /* acm_descriptor */
  47 #define USB_CDC_UNION_TYPE              0x06            /* union_desc */
  48 #define USB_CDC_COUNTRY_TYPE            0x07
  49 #define USB_CDC_NETWORK_TERMINAL_TYPE   0x0a            /* network_terminal_desc */
  50 #define USB_CDC_ETHERNET_TYPE           0x0f            /* ether_desc */
  51 #define USB_CDC_WHCM_TYPE               0x11
  52 #define USB_CDC_MDLM_TYPE               0x12            /* mdlm_desc */
  53 #define USB_CDC_MDLM_DETAIL_TYPE        0x13            /* mdlm_detail_desc */
  54 #define USB_CDC_DMM_TYPE                0x14
  55 #define USB_CDC_OBEX_TYPE               0x15
  56 #define USB_CDC_NCM_TYPE                0x1a
  57 #define USB_CDC_MBIM_TYPE               0x1b
  58
  59 /* "Header Functional Descriptor" from CDC spec  5.2.3.1 */
  60 struct usb_cdc_header_desc {
  61         __u8    bLength;
  62         __u8    bDescriptorType;
  63         __u8    bDescriptorSubType;
  64
  65         __le16  bcdCDC;
  66 } __attribute__ ((packed));
  67
  68 /* "Call Management Descriptor" from CDC spec  5.2.3.2 */
  69 struct usb_cdc_call_mgmt_descriptor {
  70         __u8    bLength;
  71         __u8    bDescriptorType;
  72         __u8    bDescriptorSubType;
  73
  74         __u8    bmCapabilities;
  75 #define USB_CDC_CALL_MGMT_CAP_CALL_MGMT         0x01
  76 #define USB_CDC_CALL_MGMT_CAP_DATA_INTF         0x02
  77
  78         __u8    bDataInterface;
  79 } __attribute__ ((packed));
  80
  81 /* "Abstract Control Management Descriptor" from CDC spec  5.2.3.3 */
  82 struct usb_cdc_acm_descriptor {
  83         __u8    bLength;
  84         __u8    bDescriptorType;
  85         __u8    bDescriptorSubType;
  86
  87         __u8    bmCapabilities;
  88 } __attribute__ ((packed));
  89
  90 /* capabilities from 5.2.3.3 */
  91
  92 #define USB_CDC_COMM_FEATURE    0x01
  93 #define USB_CDC_CAP_LINE        0x02
  94 #define USB_CDC_CAP_BRK         0x04
  95 #define USB_CDC_CAP_NOTIFY      0x08
  96
  97 /* "Union Functional Descriptor" from CDC spec 5.2.3.8 */
  98 struct usb_cdc_union_desc {
  99         __u8    bLength;
 100         __u8    bDescriptorType;
 101         __u8    bDescriptorSubType;
 102
 103         __u8    bMasterInterface0;
 104         __u8    bSlaveInterface0;
 105         /* ... and there could be other slave interfaces */
 106 } __attribute__ ((packed));
 107
 108 /* "Country Selection Functional Descriptor" from CDC spec 5.2.3.9 */
 109 struct usb_cdc_country_functional_desc {
 110         __u8    bLength;
 111         __u8    bDescriptorType;
 112         __u8    bDescriptorSubType;
 113
 114         __u8    iCountryCodeRelDate;
 115         __le16  wCountyCode0;
 116         /* ... and there can be a lot of country codes */
 117 } __attribute__ ((packed));
 118
 119 /* "Network Channel Terminal Functional Descriptor" from CDC spec 5.2.3.11 */
 120 struct usb_cdc_network_terminal_desc {
 121         __u8    bLength;
 122         __u8    bDescriptorType;
 123         __u8    bDescriptorSubType;
 124
 125         __u8    bEntityId;
 126         __u8    iName;
 127         __u8    bChannelIndex;
 128         __u8    bPhysicalInterface;
 129 } __attribute__ ((packed));
 130
 131 /* "Ethernet Networking Functional Descriptor" from CDC spec 5.2.3.16 */
 132 struct usb_cdc_ether_desc {
 133         __u8    bLength;
 134         __u8    bDescriptorType;
 135         __u8    bDescriptorSubType;
 136
 137         __u8    iMACAddress;
 138         __le32  bmEthernetStatistics;
 139         __le16  wMaxSegmentSize;
 140         __le16  wNumberMCFilters;
 141         __u8    bNumberPowerFilters;
 142 } __attribute__ ((packed));
 143
 144 /* "Telephone Control Model Functional Descriptor" from CDC WMC spec 6.3..3 */
 145 struct usb_cdc_dmm_desc {
 146         __u8    bFunctionLength;
 147         __u8    bDescriptorType;
 148         __u8    bDescriptorSubtype;
 149         __u16   bcdVersion;
 150         __le16  wMaxCommand;
 151 } __attribute__ ((packed));
 152
 153 /* "MDLM Functional Descriptor" from CDC WMC spec 6.7.2.3 */
 154 struct usb_cdc_mdlm_desc {
 155         __u8    bLength;
 156         __u8    bDescriptorType;
 157         __u8    bDescriptorSubType;
 158
 159         __le16  bcdVersion;
 160         __u8    bGUID[16];
 161 } __attribute__ ((packed));
 162
 163 /* "MDLM Detail Functional Descriptor" from CDC WMC spec 6.7.2.4 */
 164 struct usb_cdc_mdlm_detail_desc {
 165         __u8    bLength;
 166         __u8    bDescriptorType;
 167         __u8    bDescriptorSubType;
 168
 169         /* type is associated with mdlm_desc.bGUID */
 170         __u8    bGuidDescriptorType;
 171         __u8    bDetailData[0];
 172 } __attribute__ ((packed));
 173
 174 /* "OBEX Control Model Functional Descriptor" */
 175 struct usb_cdc_obex_desc {
 176         __u8    bLength;
 177         __u8    bDescriptorType;
 178         __u8    bDescriptorSubType;
 179
 180         __le16  bcdVersion;
 181 } __attribute__ ((packed));
 182
 183 /* "NCM Control Model Functional Descriptor" */
 184 struct usb_cdc_ncm_desc {
 185         __u8    bLength;
 186         __u8    bDescriptorType;
 187         __u8    bDescriptorSubType;
 188
 189         __le16  bcdNcmVersion;
 190         __u8    bmNetworkCapabilities;
 191 } __attribute__ ((packed));
 192
 193 /* "MBIM Control Model Functional Descriptor" */
 194 struct usb_cdc_mbim_desc {
 195         __u8    bLength;
 196         __u8    bDescriptorType;
 197         __u8    bDescriptorSubType;
 198
 199         __le16  bcdMBIMVersion;
 200         __le16  wMaxControlMessage;
 201         __u8    bNumberFilters;
 202         __u8    bMaxFilterSize;
 203         __le16  wMaxSegmentSize;
 204         __u8    bmNetworkCapabilities;
 205 } __attribute__ ((packed));
 206 /*-------------------------------------------------------------------------*/
 207
 208 /*
 209  * Class-Specific Control Requests (6.2)
 210  *
 211  * section 3.6.2.1 table 4 has the ACM profile, for modems.
 212  * section 3.8.2 table 10 has the ethernet profile.
 213  *
 214  * Microsoft's RNDIS stack for Ethernet is a vendor-specific CDC ACM variant,
 215  * heavily dependent on the encapsulated (proprietary) command mechanism.
 216  */
 217
 218 #define USB_CDC_SEND_ENCAPSULATED_COMMAND       0x00
 219 #define USB_CDC_GET_ENCAPSULATED_RESPONSE       0x01
 220 #define USB_CDC_REQ_SET_LINE_CODING             0x20
 221 #define USB_CDC_REQ_GET_LINE_CODING             0x21
 222 #define USB_CDC_REQ_SET_CONTROL_LINE_STATE      0x22
 223 #define USB_CDC_REQ_SEND_BREAK                  0x23
 224 #define USB_CDC_SET_ETHERNET_MULTICAST_FILTERS  0x40
 225 #define USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER  0x41
 226 #define USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER  0x42
 227 #define USB_CDC_SET_ETHERNET_PACKET_FILTER      0x43
 228 #define USB_CDC_GET_ETHERNET_STATISTIC          0x44
 229 #define USB_CDC_GET_NTB_PARAMETERS              0x80
 230 #define USB_CDC_GET_NET_ADDRESS                 0x81
 231 #define USB_CDC_SET_NET_ADDRESS                 0x82
 232 #define USB_CDC_GET_NTB_FORMAT                  0x83
 233 #define USB_CDC_SET_NTB_FORMAT                  0x84
 234 #define USB_CDC_GET_NTB_INPUT_SIZE              0x85
 235 #define USB_CDC_SET_NTB_INPUT_SIZE              0x86
 236 #define USB_CDC_GET_MAX_DATAGRAM_SIZE           0x87
 237 #define USB_CDC_SET_MAX_DATAGRAM_SIZE           0x88
 238 #define USB_CDC_GET_CRC_MODE                    0x89
 239 #define USB_CDC_SET_CRC_MODE                    0x8a
 240
 241 /* Line Coding Structure from CDC spec 6.2.13 */
 242 struct usb_cdc_line_coding {
 243         __le32  dwDTERate;
 244         __u8    bCharFormat;
 245 #define USB_CDC_1_STOP_BITS                     0
 246 #define USB_CDC_1_5_STOP_BITS                   1
 247 #define USB_CDC_2_STOP_BITS                     2
 248
 249         __u8    bParityType;
 250 #define USB_CDC_NO_PARITY                       0
 251 #define USB_CDC_ODD_PARITY                      1
 252 #define USB_CDC_EVEN_PARITY                     2
 253 #define USB_CDC_MARK_PARITY                     3
 254 #define USB_CDC_SPACE_PARITY                    4
 255
 256         __u8    bDataBits;
 257 } __attribute__ ((packed));
 258
 259 /* table 62; bits in multicast filter */
 260 #define USB_CDC_PACKET_TYPE_PROMISCUOUS         (1 << 0)
 261 #define USB_CDC_PACKET_TYPE_ALL_MULTICAST       (1 << 1) /* no filter */
 262 #define USB_CDC_PACKET_TYPE_DIRECTED            (1 << 2)
 263 #define USB_CDC_PACKET_TYPE_BROADCAST           (1 << 3)
 264 #define USB_CDC_PACKET_TYPE_MULTICAST           (1 << 4) /* filtered */
 265
 266
 267 /*-------------------------------------------------------------------------*/
 268
 269 /*
 270  * Class-Specific Notifications (6.3) sent by interrupt transfers
 271  *
 272  * section 3.8.2 table 11 of the CDC spec lists Ethernet notifications
 273  * section 3.6.2.1 table 5 specifies ACM notifications, accepted by RNDIS
 274  * RNDIS also defines its own bit-incompatible notifications
 275  */
 276
 277 #define USB_CDC_NOTIFY_NETWORK_CONNECTION       0x00
 278 #define USB_CDC_NOTIFY_RESPONSE_AVAILABLE       0x01
 279 #define USB_CDC_NOTIFY_SERIAL_STATE             0x20
 280 #define USB_CDC_NOTIFY_SPEED_CHANGE             0x2a
 281
 282 struct usb_cdc_notification {
 283         __u8    bmRequestType;
 284         __u8    bNotificationType;
 285         __le16  wValue;
 286         __le16  wIndex;
 287         __le16  wLength;
 288 } __attribute__ ((packed));
 289
 290 struct usb_cdc_speed_change {
 291         __le32  DLBitRRate;     /* contains the downlink bit rate (IN pipe) */
 292         __le32  ULBitRate;      /* contains the uplink bit rate (OUT pipe) */
 293 } __attribute__ ((packed));
 294
 295 /*-------------------------------------------------------------------------*/
 296
 297 /*
 298  * Class Specific structures and constants
 299  *
 300  * CDC NCM NTB parameters structure, CDC NCM subclass 6.2.1
 301  *
 302  */
 303
 304 struct usb_cdc_ncm_ntb_parameters {
 305         __le16  wLength;
 306         __le16  bmNtbFormatsSupported;
 307         __le32  dwNtbInMaxSize;
 308         __le16  wNdpInDivisor;
 309         __le16  wNdpInPayloadRemainder;
 310         __le16  wNdpInAlignment;
 311         __le16  wPadding1;
 312         __le32  dwNtbOutMaxSize;
 313         __le16  wNdpOutDivisor;
 314         __le16  wNdpOutPayloadRemainder;
 315         __le16  wNdpOutAlignment;
 316         __le16  wNtbOutMaxDatagrams;
 317 } __attribute__ ((packed));
 318
 319 /*
 320  * CDC NCM transfer headers, CDC NCM subclass 3.2
 321  */
 322
 323 #define USB_CDC_NCM_NTH16_SIGN          0x484D434E /* NCMH */
 324 #define USB_CDC_NCM_NTH32_SIGN          0x686D636E /* ncmh */
 325
 326 struct usb_cdc_ncm_nth16 {
 327         __le32  dwSignature;
 328         __le16  wHeaderLength;
 329         __le16  wSequence;
 330         __le16  wBlockLength;
 331         __le16  wNdpIndex;
 332 } __attribute__ ((packed));
 333
 334 struct usb_cdc_ncm_nth32 {
 335         __le32  dwSignature;
 336         __le16  wHeaderLength;
 337         __le16  wSequence;
 338         __le32  dwBlockLength;
 339         __le32  dwNdpIndex;
 340 } __attribute__ ((packed));
 341
 342 /*
 343  * CDC NCM datagram pointers, CDC NCM subclass 3.3
 344  */
 345
 346 #define USB_CDC_NCM_NDP16_CRC_SIGN      0x314D434E /* NCM1 */
 347 #define USB_CDC_NCM_NDP16_NOCRC_SIGN    0x304D434E /* NCM0 */
 348 #define USB_CDC_NCM_NDP32_CRC_SIGN      0x316D636E /* ncm1 */
 349 #define USB_CDC_NCM_NDP32_NOCRC_SIGN    0x306D636E /* ncm0 */
 350
 351 #define USB_CDC_MBIM_NDP16_IPS_SIGN     0x00535049 /* IPS<sessionID> : IPS0 for now */
 352 #define USB_CDC_MBIM_NDP32_IPS_SIGN     0x00737069 /* ips<sessionID> : ips0 for now */
 353 #define USB_CDC_MBIM_NDP16_DSS_SIGN     0x00535344 /* DSS<sessionID> */
 354 #define USB_CDC_MBIM_NDP32_DSS_SIGN     0x00737364 /* dss<sessionID> */
 355
 356 /* 16-bit NCM Datagram Pointer Entry */
 357 struct usb_cdc_ncm_dpe16 {
 358         __le16  wDatagramIndex;
 359         __le16  wDatagramLength;
 360 } __attribute__((__packed__));
 361
 362 /* 16-bit NCM Datagram Pointer Table */
 363 struct usb_cdc_ncm_ndp16 {
 364         __le32  dwSignature;
 365         __le16  wLength;
 366         __le16  wNextNdpIndex;
 367         struct  usb_cdc_ncm_dpe16 dpe16[0];
 368 } __attribute__ ((packed));
 369
 370 /* 32-bit NCM Datagram Pointer Entry */
 371 struct usb_cdc_ncm_dpe32 {
 372         __le32  dwDatagramIndex;
 373         __le32  dwDatagramLength;
 374 } __attribute__((__packed__));
 375
 376 /* 32-bit NCM Datagram Pointer Table */
 377 struct usb_cdc_ncm_ndp32 {
 378         __le32  dwSignature;
 379         __le16  wLength;
 380         __le16  wReserved6;
 381         __le32  dwNextNdpIndex;
 382         __le32  dwReserved12;
 383         struct  usb_cdc_ncm_dpe32 dpe32[0];
 384 } __attribute__ ((packed));
 385
 386 /* CDC NCM subclass 3.2.1 and 3.2.2 */
 387 #define USB_CDC_NCM_NDP16_INDEX_MIN                     0x000C
 388 #define USB_CDC_NCM_NDP32_INDEX_MIN                     0x0010
 389
 390 /* CDC NCM subclass 3.3.3 Datagram Formatting */
 391 #define USB_CDC_NCM_DATAGRAM_FORMAT_CRC                 0x30
 392 #define USB_CDC_NCM_DATAGRAM_FORMAT_NOCRC               0X31
 393
 394 /* CDC NCM subclass 4.2 NCM Communications Interface Protocol Code */
 395 #define USB_CDC_NCM_PROTO_CODE_NO_ENCAP_COMMANDS        0x00
 396 #define USB_CDC_NCM_PROTO_CODE_EXTERN_PROTO             0xFE
 397
 398 /* CDC NCM subclass 5.2.1 NCM Functional Descriptor, bmNetworkCapabilities */
 399 #define USB_CDC_NCM_NCAP_ETH_FILTER                     (1 << 0)
 400 #define USB_CDC_NCM_NCAP_NET_ADDRESS                    (1 << 1)
 401 #define USB_CDC_NCM_NCAP_ENCAP_COMMAND                  (1 << 2)
 402 #define USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE              (1 << 3)
 403 #define USB_CDC_NCM_NCAP_CRC_MODE                       (1 << 4)
 404 #define USB_CDC_NCM_NCAP_NTB_INPUT_SIZE                 (1 << 5)
 405
 406 /* CDC NCM subclass Table 6-3: NTB Parameter Structure */
 407 #define USB_CDC_NCM_NTB16_SUPPORTED                     (1 << 0)
 408 #define USB_CDC_NCM_NTB32_SUPPORTED                     (1 << 1)
 409
 410 /* CDC NCM subclass Table 6-3: NTB Parameter Structure */
 411 #define USB_CDC_NCM_NDP_ALIGN_MIN_SIZE                  0x04
 412 #define USB_CDC_NCM_NTB_MAX_LENGTH                      0x1C
 413
 414 /* CDC NCM subclass 6.2.5 SetNtbFormat */
 415 #define USB_CDC_NCM_NTB16_FORMAT                        0x00
 416 #define USB_CDC_NCM_NTB32_FORMAT                        0x01
 417
 418 /* CDC NCM subclass 6.2.7 SetNtbInputSize */
 419 #define USB_CDC_NCM_NTB_MIN_IN_SIZE                     2048
 420 #define USB_CDC_NCM_NTB_MIN_OUT_SIZE                    2048
 421
 422 /* NTB Input Size Structure */
 423 struct usb_cdc_ncm_ndp_input_size {
 424         __le32  dwNtbInMaxSize;
 425         __le16  wNtbInMaxDatagrams;
 426         __le16  wReserved;
 427 } __attribute__ ((packed));
 428
 429 /* CDC NCM subclass 6.2.11 SetCrcMode */
 430 #define USB_CDC_NCM_CRC_NOT_APPENDED                    0x00
 431 #define USB_CDC_NCM_CRC_APPENDED                        0x01
 432
 433 #endif /* __LINUX_USB_CDC_H */