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