[mirror_ubuntu-artful-kernel.git] / include / linux / usb_cdc.h

/*
 * 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.
 */

#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_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

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

/*
 * 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_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

/* "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));

/* "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));

/* "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));

/* "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[];
} __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

/* 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));
Commit	Line	Data
1da177e4 LT	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	#define USB_CDC_SUBCLASS_ACM 0x02
	10	#define USB_CDC_SUBCLASS_ETHERNET 0x06
	11	#define USB_CDC_SUBCLASS_WHCM 0x08
	12	#define USB_CDC_SUBCLASS_DMM 0x09
	13	#define USB_CDC_SUBCLASS_MDLM 0x0a
	14	#define USB_CDC_SUBCLASS_OBEX 0x0b
	15
	16	#define USB_CDC_PROTO_NONE 0
	17
	18	#define USB_CDC_ACM_PROTO_AT_V25TER 1
	19	#define USB_CDC_ACM_PROTO_AT_PCCA101 2
	20	#define USB_CDC_ACM_PROTO_AT_PCCA101_WAKE 3
	21	#define USB_CDC_ACM_PROTO_AT_GSM 4
	22	#define USB_CDC_ACM_PROTO_AT_3G 5
	23	#define USB_CDC_ACM_PROTO_AT_CDMA 6
	24	#define USB_CDC_ACM_PROTO_VENDOR 0xff
	25
	26	/-------------------------------------------------------------------------/
	27
	28	/*
	29	* Class-Specific descriptors ... there are a couple dozen of them
	30	*/
	31
	32	#define USB_CDC_HEADER_TYPE 0x00 /* header_desc */
	33	#define USB_CDC_CALL_MANAGEMENT_TYPE 0x01 /* call_mgmt_descriptor */
	34	#define USB_CDC_ACM_TYPE 0x02 /* acm_descriptor */
	35	#define USB_CDC_UNION_TYPE 0x06 /* union_desc */
	36	#define USB_CDC_COUNTRY_TYPE 0x07
	37	#define USB_CDC_ETHERNET_TYPE 0x0f /* ether_desc */
	38	#define USB_CDC_WHCM_TYPE 0x11
	39	#define USB_CDC_MDLM_TYPE 0x12 /* mdlm_desc */
	40	#define USB_CDC_MDLM_DETAIL_TYPE 0x13 /* mdlm_detail_desc */
	41	#define USB_CDC_DMM_TYPE 0x14
	42	#define USB_CDC_OBEX_TYPE 0x15
	43
	44	/* "Header Functional Descriptor" from CDC spec 5.2.3.1 */
	45	struct usb_cdc_header_desc {
	46	__u8 bLength;
	47	__u8 bDescriptorType;
	48	__u8 bDescriptorSubType;
	49
	50	__le16 bcdCDC;
	51	} __attribute__ ((packed));
	52
	53	/* "Call Management Descriptor" from CDC spec 5.2.3.2 */
	54	struct usb_cdc_call_mgmt_descriptor {
	55	__u8 bLength;
	56	__u8 bDescriptorType;
	57	__u8 bDescriptorSubType;
	58
	59	__u8 bmCapabilities;
	60	#define USB_CDC_CALL_MGMT_CAP_CALL_MGMT 0x01
	61	#define USB_CDC_CALL_MGMT_CAP_DATA_INTF 0x02
	62
	63	__u8 bDataInterface;
	64	} __attribute__ ((packed));
65
66	/* "Abstract Control Management Descriptor" from CDC spec 5.2.3.3 */
67	struct usb_cdc_acm_descriptor {
68	__u8 bLength;
69	__u8 bDescriptorType;
70	__u8 bDescriptorSubType;
71
72	__u8 bmCapabilities;
73	} __attribute__ ((packed));
74
75	/* "Union Functional Descriptor" from CDC spec 5.2.3.8 */
76	struct usb_cdc_union_desc {
77	__u8 bLength;
78	__u8 bDescriptorType;
79	__u8 bDescriptorSubType;
80
81	__u8 bMasterInterface0;
82	__u8 bSlaveInterface0;
83	/* ... and there could be other slave interfaces */
84	} __attribute__ ((packed));
85
86	/* "Ethernet Networking Functional Descriptor" from CDC spec 5.2.3.16 */
87	struct usb_cdc_ether_desc {
88	__u8 bLength;
89	__u8 bDescriptorType;
90	__u8 bDescriptorSubType;
91
92	__u8 iMACAddress;
93	__le32 bmEthernetStatistics;
94	__le16 wMaxSegmentSize;
95	__le16 wNumberMCFilters;
96	__u8 bNumberPowerFilters;
97	} __attribute__ ((packed));
98
99	/* "MDLM Functional Descriptor" from CDC WMC spec 6.7.2.3 */
100	struct usb_cdc_mdlm_desc {
101	__u8 bLength;
102	__u8 bDescriptorType;
103	__u8 bDescriptorSubType;
104
105	__le16 bcdVersion;
106	__u8 bGUID[16];
107	} __attribute__ ((packed));
108
109	/* "MDLM Detail Functional Descriptor" from CDC WMC spec 6.7.2.4 */
110	struct usb_cdc_mdlm_detail_desc {
111	__u8 bLength;
112	__u8 bDescriptorType;
113	__u8 bDescriptorSubType;
114
115	/* type is associated with mdlm_desc.bGUID */
116	__u8 bGuidDescriptorType;
117	__u8 bDetailData[];
118	} __attribute__ ((packed));
119
120	/-------------------------------------------------------------------------/
121
122	/*
123	* Class-Specific Control Requests (6.2)
124	*
125	* section 3.6.2.1 table 4 has the ACM profile, for modems.
126	* section 3.8.2 table 10 has the ethernet profile.
127	*
128	* Microsoft's RNDIS stack for Ethernet is a vendor-specific CDC ACM variant,
129	* heavily dependent on the encapsulated (proprietary) command mechanism.
130	*/
131
132	#define USB_CDC_SEND_ENCAPSULATED_COMMAND 0x00
133	#define USB_CDC_GET_ENCAPSULATED_RESPONSE 0x01
134	#define USB_CDC_REQ_SET_LINE_CODING 0x20
135	#define USB_CDC_REQ_GET_LINE_CODING 0x21
136	#define USB_CDC_REQ_SET_CONTROL_LINE_STATE 0x22
137	#define USB_CDC_REQ_SEND_BREAK 0x23
138	#define USB_CDC_SET_ETHERNET_MULTICAST_FILTERS 0x40
139	#define USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER 0x41
140	#define USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER 0x42
141	#define USB_CDC_SET_ETHERNET_PACKET_FILTER 0x43
142	#define USB_CDC_GET_ETHERNET_STATISTIC 0x44
143
144	/* Line Coding Structure from CDC spec 6.2.13 */
145	struct usb_cdc_line_coding {
146	__le32 dwDTERate;
147	__u8 bCharFormat;
148	#define USB_CDC_1_STOP_BITS 0
149	#define USB_CDC_1_5_STOP_BITS 1
150	#define USB_CDC_2_STOP_BITS 2
151
152	__u8 bParityType;
153	#define USB_CDC_NO_PARITY 0
154	#define USB_CDC_ODD_PARITY 1
155	#define USB_CDC_EVEN_PARITY 2
156	#define USB_CDC_MARK_PARITY 3
157	#define USB_CDC_SPACE_PARITY 4
158
159	__u8 bDataBits;
160	} __attribute__ ((packed));
161
162	/* table 62; bits in multicast filter */
163	#define USB_CDC_PACKET_TYPE_PROMISCUOUS (1 << 0)
164	#define USB_CDC_PACKET_TYPE_ALL_MULTICAST (1 << 1) /* no filter */
165	#define USB_CDC_PACKET_TYPE_DIRECTED (1 << 2)
166	#define USB_CDC_PACKET_TYPE_BROADCAST (1 << 3)
167	#define USB_CDC_PACKET_TYPE_MULTICAST (1 << 4) /* filtered */
168
169
170	/-------------------------------------------------------------------------/
171
172	/*
173	* Class-Specific Notifications (6.3) sent by interrupt transfers
174	*
175	* section 3.8.2 table 11 of the CDC spec lists Ethernet notifications
176	* section 3.6.2.1 table 5 specifies ACM notifications, accepted by RNDIS
177	* RNDIS also defines its own bit-incompatible notifications
178	*/
179
180	#define USB_CDC_NOTIFY_NETWORK_CONNECTION 0x00
181	#define USB_CDC_NOTIFY_RESPONSE_AVAILABLE 0x01
182	#define USB_CDC_NOTIFY_SERIAL_STATE 0x20
183	#define USB_CDC_NOTIFY_SPEED_CHANGE 0x2a
184
185	struct usb_cdc_notification {
186	__u8 bmRequestType;
187	__u8 bNotificationType;
188	__le16 wValue;
189	__le16 wIndex;
190	__le16 wLength;
191	} __attribute__ ((packed));
192