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