[mirror_ubuntu-bionic-kernel.git] / include / uapi / linux / usb / cdc.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * USB Communications Device Class (CDC) definitions
 *
 * CDC says how to talk to lots of different types of network adapters,
 * notably ethernet adapters and various modems.  It's used mostly with
 * firmware based USB peripherals.
 */

#ifndef __UAPI_LINUX_USB_CDC_H
#define __UAPI_LINUX_USB_CDC_H

#include <linux/types.h>

#define USB_CDC_SUBCLASS_ACM			0x02
#define USB_CDC_SUBCLASS_ETHERNET		0x06
#define USB_CDC_SUBCLASS_WHCM			0x08
#define USB_CDC_SUBCLASS_DMM			0x09
#define USB_CDC_SUBCLASS_MDLM			0x0a
#define USB_CDC_SUBCLASS_OBEX			0x0b
#define USB_CDC_SUBCLASS_EEM			0x0c
#define USB_CDC_SUBCLASS_NCM			0x0d
#define USB_CDC_SUBCLASS_MBIM			0x0e

#define USB_CDC_PROTO_NONE			0

#define USB_CDC_ACM_PROTO_AT_V25TER		1
#define USB_CDC_ACM_PROTO_AT_PCCA101		2
#define USB_CDC_ACM_PROTO_AT_PCCA101_WAKE	3
#define USB_CDC_ACM_PROTO_AT_GSM		4
#define USB_CDC_ACM_PROTO_AT_3G			5
#define USB_CDC_ACM_PROTO_AT_CDMA		6
#define USB_CDC_ACM_PROTO_VENDOR		0xff

#define USB_CDC_PROTO_EEM			7

#define USB_CDC_NCM_PROTO_NTB			1
#define USB_CDC_MBIM_PROTO_NTB			2

/*-------------------------------------------------------------------------*/

/*
 * Class-Specific descriptors ... there are a couple dozen of them
 */

#define USB_CDC_HEADER_TYPE		0x00	/* header_desc */
#define USB_CDC_CALL_MANAGEMENT_TYPE	0x01	/* call_mgmt_descriptor */
#define USB_CDC_ACM_TYPE		0x02	/* acm_descriptor */
#define USB_CDC_UNION_TYPE		0x06	/* union_desc */
#define USB_CDC_COUNTRY_TYPE		0x07
#define USB_CDC_NETWORK_TERMINAL_TYPE	0x0a	/* network_terminal_desc */
#define USB_CDC_ETHERNET_TYPE		0x0f	/* ether_desc */
#define USB_CDC_WHCM_TYPE		0x11
#define USB_CDC_MDLM_TYPE		0x12	/* mdlm_desc */
#define USB_CDC_MDLM_DETAIL_TYPE	0x13	/* mdlm_detail_desc */
#define USB_CDC_DMM_TYPE		0x14
#define USB_CDC_OBEX_TYPE		0x15
#define USB_CDC_NCM_TYPE		0x1a
#define USB_CDC_MBIM_TYPE		0x1b
#define USB_CDC_MBIM_EXTENDED_TYPE	0x1c

/* "Header Functional Descriptor" from CDC spec  5.2.3.1 */
struct usb_cdc_header_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__le16	bcdCDC;
} __attribute__ ((packed));

/* "Call Management Descriptor" from CDC spec  5.2.3.2 */
struct usb_cdc_call_mgmt_descriptor {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__u8	bmCapabilities;
#define USB_CDC_CALL_MGMT_CAP_CALL_MGMT		0x01
#define USB_CDC_CALL_MGMT_CAP_DATA_INTF		0x02

	__u8	bDataInterface;
} __attribute__ ((packed));

/* "Abstract Control Management Descriptor" from CDC spec  5.2.3.3 */
struct usb_cdc_acm_descriptor {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__u8	bmCapabilities;
} __attribute__ ((packed));

/* capabilities from 5.2.3.3 */

#define USB_CDC_COMM_FEATURE	0x01
#define USB_CDC_CAP_LINE	0x02
#define USB_CDC_CAP_BRK		0x04
#define USB_CDC_CAP_NOTIFY	0x08

/* "Union Functional Descriptor" from CDC spec 5.2.3.8 */
struct usb_cdc_union_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__u8	bMasterInterface0;
	__u8	bSlaveInterface0;
	/* ... and there could be other slave interfaces */
} __attribute__ ((packed));

/* "Country Selection Functional Descriptor" from CDC spec 5.2.3.9 */
struct usb_cdc_country_functional_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__u8	iCountryCodeRelDate;
	__le16	wCountyCode0;
	/* ... and there can be a lot of country codes */
} __attribute__ ((packed));

/* "Network Channel Terminal Functional Descriptor" from CDC spec 5.2.3.11 */
struct usb_cdc_network_terminal_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__u8	bEntityId;
	__u8	iName;
	__u8	bChannelIndex;
	__u8	bPhysicalInterface;
} __attribute__ ((packed));

/* "Ethernet Networking Functional Descriptor" from CDC spec 5.2.3.16 */
struct usb_cdc_ether_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__u8	iMACAddress;
	__le32	bmEthernetStatistics;
	__le16	wMaxSegmentSize;
	__le16	wNumberMCFilters;
	__u8	bNumberPowerFilters;
} __attribute__ ((packed));

/* "Telephone Control Model Functional Descriptor" from CDC WMC spec 6.3..3 */
struct usb_cdc_dmm_desc {
	__u8	bFunctionLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubtype;
	__u16	bcdVersion;
	__le16	wMaxCommand;
} __attribute__ ((packed));

/* "MDLM Functional Descriptor" from CDC WMC spec 6.7.2.3 */
struct usb_cdc_mdlm_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__le16	bcdVersion;
	__u8	bGUID[16];
} __attribute__ ((packed));

/* "MDLM Detail Functional Descriptor" from CDC WMC spec 6.7.2.4 */
struct usb_cdc_mdlm_detail_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	/* type is associated with mdlm_desc.bGUID */
	__u8	bGuidDescriptorType;
	__u8	bDetailData[0];
} __attribute__ ((packed));

/* "OBEX Control Model Functional Descriptor" */
struct usb_cdc_obex_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__le16	bcdVersion;
} __attribute__ ((packed));

/* "NCM Control Model Functional Descriptor" */
struct usb_cdc_ncm_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__le16	bcdNcmVersion;
	__u8	bmNetworkCapabilities;
} __attribute__ ((packed));

/* "MBIM Control Model Functional Descriptor" */
struct usb_cdc_mbim_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__le16	bcdMBIMVersion;
	__le16  wMaxControlMessage;
	__u8    bNumberFilters;
	__u8    bMaxFilterSize;
	__le16  wMaxSegmentSize;
	__u8    bmNetworkCapabilities;
} __attribute__ ((packed));

/* "MBIM Extended Functional Descriptor" from CDC MBIM spec 1.0 errata-1 */
struct usb_cdc_mbim_extended_desc {
	__u8	bLength;
	__u8	bDescriptorType;
	__u8	bDescriptorSubType;

	__le16	bcdMBIMExtendedVersion;
	__u8	bMaxOutstandingCommandMessages;
	__le16	wMTU;
} __attribute__ ((packed));

/*-------------------------------------------------------------------------*/

/*
 * Class-Specific Control Requests (6.2)
 *
 * section 3.6.2.1 table 4 has the ACM profile, for modems.
 * section 3.8.2 table 10 has the ethernet profile.
 *
 * Microsoft's RNDIS stack for Ethernet is a vendor-specific CDC ACM variant,
 * heavily dependent on the encapsulated (proprietary) command mechanism.
 */

#define USB_CDC_SEND_ENCAPSULATED_COMMAND	0x00
#define USB_CDC_GET_ENCAPSULATED_RESPONSE	0x01
#define USB_CDC_REQ_SET_LINE_CODING		0x20
#define USB_CDC_REQ_GET_LINE_CODING		0x21
#define USB_CDC_REQ_SET_CONTROL_LINE_STATE	0x22
#define USB_CDC_REQ_SEND_BREAK			0x23
#define USB_CDC_SET_ETHERNET_MULTICAST_FILTERS	0x40
#define USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER	0x41
#define USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER	0x42
#define USB_CDC_SET_ETHERNET_PACKET_FILTER	0x43
#define USB_CDC_GET_ETHERNET_STATISTIC		0x44
#define USB_CDC_GET_NTB_PARAMETERS		0x80
#define USB_CDC_GET_NET_ADDRESS			0x81
#define USB_CDC_SET_NET_ADDRESS			0x82
#define USB_CDC_GET_NTB_FORMAT			0x83
#define USB_CDC_SET_NTB_FORMAT			0x84
#define USB_CDC_GET_NTB_INPUT_SIZE		0x85
#define USB_CDC_SET_NTB_INPUT_SIZE		0x86
#define USB_CDC_GET_MAX_DATAGRAM_SIZE		0x87
#define USB_CDC_SET_MAX_DATAGRAM_SIZE		0x88
#define USB_CDC_GET_CRC_MODE			0x89
#define USB_CDC_SET_CRC_MODE			0x8a

/* Line Coding Structure from CDC spec 6.2.13 */
struct usb_cdc_line_coding {
	__le32	dwDTERate;
	__u8	bCharFormat;
#define USB_CDC_1_STOP_BITS			0
#define USB_CDC_1_5_STOP_BITS			1
#define USB_CDC_2_STOP_BITS			2

	__u8	bParityType;
#define USB_CDC_NO_PARITY			0
#define USB_CDC_ODD_PARITY			1
#define USB_CDC_EVEN_PARITY			2
#define USB_CDC_MARK_PARITY			3
#define USB_CDC_SPACE_PARITY			4

	__u8	bDataBits;
} __attribute__ ((packed));

/* table 62; bits in multicast filter */
#define	USB_CDC_PACKET_TYPE_PROMISCUOUS		(1 << 0)
#define	USB_CDC_PACKET_TYPE_ALL_MULTICAST	(1 << 1) /* no filter */
#define	USB_CDC_PACKET_TYPE_DIRECTED		(1 << 2)
#define	USB_CDC_PACKET_TYPE_BROADCAST		(1 << 3)
#define	USB_CDC_PACKET_TYPE_MULTICAST		(1 << 4) /* filtered */


/*-------------------------------------------------------------------------*/

/*
 * Class-Specific Notifications (6.3) sent by interrupt transfers
 *
 * section 3.8.2 table 11 of the CDC spec lists Ethernet notifications
 * section 3.6.2.1 table 5 specifies ACM notifications, accepted by RNDIS
 * RNDIS also defines its own bit-incompatible notifications
 */

#define USB_CDC_NOTIFY_NETWORK_CONNECTION	0x00
#define USB_CDC_NOTIFY_RESPONSE_AVAILABLE	0x01
#define USB_CDC_NOTIFY_SERIAL_STATE		0x20
#define USB_CDC_NOTIFY_SPEED_CHANGE		0x2a

struct usb_cdc_notification {
	__u8	bmRequestType;
	__u8	bNotificationType;
	__le16	wValue;
	__le16	wIndex;
	__le16	wLength;
} __attribute__ ((packed));

struct usb_cdc_speed_change {
	__le32	DLBitRRate;	/* contains the downlink bit rate (IN pipe) */
	__le32	ULBitRate;	/* contains the uplink bit rate (OUT pipe) */
} __attribute__ ((packed));

/*-------------------------------------------------------------------------*/

/*
 * Class Specific structures and constants
 *
 * CDC NCM NTB parameters structure, CDC NCM subclass 6.2.1
 *
 */

struct usb_cdc_ncm_ntb_parameters {
	__le16	wLength;
	__le16	bmNtbFormatsSupported;
	__le32	dwNtbInMaxSize;
	__le16	wNdpInDivisor;
	__le16	wNdpInPayloadRemainder;
	__le16	wNdpInAlignment;
	__le16	wPadding1;
	__le32	dwNtbOutMaxSize;
	__le16	wNdpOutDivisor;
	__le16	wNdpOutPayloadRemainder;
	__le16	wNdpOutAlignment;
	__le16	wNtbOutMaxDatagrams;
} __attribute__ ((packed));

/*
 * CDC NCM transfer headers, CDC NCM subclass 3.2
 */

#define USB_CDC_NCM_NTH16_SIGN		0x484D434E /* NCMH */
#define USB_CDC_NCM_NTH32_SIGN		0x686D636E /* ncmh */

struct usb_cdc_ncm_nth16 {
	__le32	dwSignature;
	__le16	wHeaderLength;
	__le16	wSequence;
	__le16	wBlockLength;
	__le16	wNdpIndex;
} __attribute__ ((packed));

struct usb_cdc_ncm_nth32 {
	__le32	dwSignature;
	__le16	wHeaderLength;
	__le16	wSequence;
	__le32	dwBlockLength;
	__le32	dwNdpIndex;
} __attribute__ ((packed));

/*
 * CDC NCM datagram pointers, CDC NCM subclass 3.3
 */

#define USB_CDC_NCM_NDP16_CRC_SIGN	0x314D434E /* NCM1 */
#define USB_CDC_NCM_NDP16_NOCRC_SIGN	0x304D434E /* NCM0 */
#define USB_CDC_NCM_NDP32_CRC_SIGN	0x316D636E /* ncm1 */
#define USB_CDC_NCM_NDP32_NOCRC_SIGN	0x306D636E /* ncm0 */

#define USB_CDC_MBIM_NDP16_IPS_SIGN     0x00535049 /* IPS<sessionID> : IPS0 for now */
#define USB_CDC_MBIM_NDP32_IPS_SIGN     0x00737069 /* ips<sessionID> : ips0 for now */
#define USB_CDC_MBIM_NDP16_DSS_SIGN     0x00535344 /* DSS<sessionID> */
#define USB_CDC_MBIM_NDP32_DSS_SIGN     0x00737364 /* dss<sessionID> */

/* 16-bit NCM Datagram Pointer Entry */
struct usb_cdc_ncm_dpe16 {
	__le16	wDatagramIndex;
	__le16	wDatagramLength;
} __attribute__((__packed__));

/* 16-bit NCM Datagram Pointer Table */
struct usb_cdc_ncm_ndp16 {
	__le32	dwSignature;
	__le16	wLength;
	__le16	wNextNdpIndex;
	struct	usb_cdc_ncm_dpe16 dpe16[0];
} __attribute__ ((packed));

/* 32-bit NCM Datagram Pointer Entry */
struct usb_cdc_ncm_dpe32 {
	__le32	dwDatagramIndex;
	__le32	dwDatagramLength;
} __attribute__((__packed__));

/* 32-bit NCM Datagram Pointer Table */
struct usb_cdc_ncm_ndp32 {
	__le32	dwSignature;
	__le16	wLength;
	__le16	wReserved6;
	__le32	dwNextNdpIndex;
	__le32	dwReserved12;
	struct	usb_cdc_ncm_dpe32 dpe32[0];
} __attribute__ ((packed));

/* CDC NCM subclass 3.2.1 and 3.2.2 */
#define USB_CDC_NCM_NDP16_INDEX_MIN			0x000C
#define USB_CDC_NCM_NDP32_INDEX_MIN			0x0010

/* CDC NCM subclass 3.3.3 Datagram Formatting */
#define USB_CDC_NCM_DATAGRAM_FORMAT_CRC			0x30
#define USB_CDC_NCM_DATAGRAM_FORMAT_NOCRC		0X31

/* CDC NCM subclass 4.2 NCM Communications Interface Protocol Code */
#define USB_CDC_NCM_PROTO_CODE_NO_ENCAP_COMMANDS	0x00
#define USB_CDC_NCM_PROTO_CODE_EXTERN_PROTO		0xFE

/* CDC NCM subclass 5.2.1 NCM Functional Descriptor, bmNetworkCapabilities */
#define USB_CDC_NCM_NCAP_ETH_FILTER			(1 << 0)
#define USB_CDC_NCM_NCAP_NET_ADDRESS			(1 << 1)
#define USB_CDC_NCM_NCAP_ENCAP_COMMAND			(1 << 2)
#define USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE		(1 << 3)
#define USB_CDC_NCM_NCAP_CRC_MODE			(1 << 4)
#define	USB_CDC_NCM_NCAP_NTB_INPUT_SIZE			(1 << 5)

/* CDC NCM subclass Table 6-3: NTB Parameter Structure */
#define USB_CDC_NCM_NTB16_SUPPORTED			(1 << 0)
#define USB_CDC_NCM_NTB32_SUPPORTED			(1 << 1)

/* CDC NCM subclass Table 6-3: NTB Parameter Structure */
#define USB_CDC_NCM_NDP_ALIGN_MIN_SIZE			0x04
#define USB_CDC_NCM_NTB_MAX_LENGTH			0x1C

/* CDC NCM subclass 6.2.5 SetNtbFormat */
#define USB_CDC_NCM_NTB16_FORMAT			0x00
#define USB_CDC_NCM_NTB32_FORMAT			0x01

/* CDC NCM subclass 6.2.7 SetNtbInputSize */
#define USB_CDC_NCM_NTB_MIN_IN_SIZE			2048
#define USB_CDC_NCM_NTB_MIN_OUT_SIZE			2048

/* NTB Input Size Structure */
struct usb_cdc_ncm_ndp_input_size {
	__le32	dwNtbInMaxSize;
	__le16	wNtbInMaxDatagrams;
	__le16	wReserved;
} __attribute__ ((packed));

/* CDC NCM subclass 6.2.11 SetCrcMode */
#define USB_CDC_NCM_CRC_NOT_APPENDED			0x00
#define USB_CDC_NCM_CRC_APPENDED			0x01

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