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