xref: /freebsd/sys/dev/usb/usb_cdc.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1 /*	$NetBSD: usbcdc.h,v 1.9 2004/10/23 13:24:24 augustss Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause
5  *
6  * Copyright (c) 1998 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Lennart Augustsson (lennart@augustsson.net) at
11  * Carlstedt Research & Technology.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef _USB_CDC_H_
36 #define	_USB_CDC_H_
37 
38 #define	UDESCSUB_CDC_HEADER	0
39 #define	UDESCSUB_CDC_CM		1	/* Call Management */
40 #define	UDESCSUB_CDC_ACM	2	/* Abstract Control Model */
41 #define	UDESCSUB_CDC_DLM	3	/* Direct Line Management */
42 #define	UDESCSUB_CDC_TRF	4	/* Telephone Ringer */
43 #define	UDESCSUB_CDC_TCLSR	5	/* Telephone Call */
44 #define	UDESCSUB_CDC_UNION	6
45 #define	UDESCSUB_CDC_CS		7	/* Country Selection */
46 #define	UDESCSUB_CDC_TOM	8	/* Telephone Operational Modes */
47 #define	UDESCSUB_CDC_USBT	9	/* USB Terminal */
48 #define	UDESCSUB_CDC_NCT	10
49 #define	UDESCSUB_CDC_PUF	11
50 #define	UDESCSUB_CDC_EUF	12
51 #define	UDESCSUB_CDC_MCMF	13
52 #define	UDESCSUB_CDC_CCMF	14
53 #define	UDESCSUB_CDC_ENF	15
54 #define	UDESCSUB_CDC_ANF	16
55 
56 struct usb_cdc_header_descriptor {
57 	uByte	bLength;
58 	uByte	bDescriptorType;
59 	uByte	bDescriptorSubtype;
60 	uWord	bcdCDC;
61 } __packed;
62 
63 struct usb_cdc_cm_descriptor {
64 	uByte	bLength;
65 	uByte	bDescriptorType;
66 	uByte	bDescriptorSubtype;
67 	uByte	bmCapabilities;
68 #define	USB_CDC_CM_DOES_CM		0x01
69 #define	USB_CDC_CM_OVER_DATA		0x02
70 	uByte	bDataInterface;
71 } __packed;
72 
73 struct usb_cdc_acm_descriptor {
74 	uByte	bLength;
75 	uByte	bDescriptorType;
76 	uByte	bDescriptorSubtype;
77 	uByte	bmCapabilities;
78 #define	USB_CDC_ACM_HAS_FEATURE		0x01
79 #define	USB_CDC_ACM_HAS_LINE		0x02
80 #define	USB_CDC_ACM_HAS_BREAK		0x04
81 #define	USB_CDC_ACM_HAS_NETWORK_CONN	0x08
82 } __packed;
83 
84 struct usb_cdc_union_descriptor {
85 	uByte	bLength;
86 	uByte	bDescriptorType;
87 	uByte	bDescriptorSubtype;
88 	uByte	bMasterInterface;
89 	uByte	bSlaveInterface[1];
90 } __packed;
91 
92 struct usb_cdc_ethernet_descriptor {
93 	uByte	bLength;
94 	uByte	bDescriptorType;
95 	uByte	bDescriptorSubtype;
96 	uByte	iMacAddress;
97 	uDWord	bmEthernetStatistics;
98 	uWord	wMaxSegmentSize;
99 	uWord	wNumberMCFilters;
100 	uByte	bNumberPowerFilters;
101 } __packed;
102 
103 #define	UCDC_SEND_ENCAPSULATED_COMMAND	0x00
104 #define	UCDC_GET_ENCAPSULATED_RESPONSE	0x01
105 #define	UCDC_SET_COMM_FEATURE		0x02
106 #define	UCDC_GET_COMM_FEATURE		0x03
107 #define	UCDC_ABSTRACT_STATE		0x01
108 #define	UCDC_COUNTRY_SETTING		0x02
109 #define	UCDC_CLEAR_COMM_FEATURE		0x04
110 #define	UCDC_SET_LINE_CODING		0x20
111 #define	UCDC_GET_LINE_CODING		0x21
112 #define	UCDC_SET_CONTROL_LINE_STATE	0x22
113 #define	UCDC_LINE_DTR			0x0001
114 #define	UCDC_LINE_RTS			0x0002
115 #define	UCDC_SEND_BREAK			0x23
116 #define	UCDC_BREAK_ON			0xffff
117 #define	UCDC_BREAK_OFF			0x0000
118 
119 struct usb_cdc_abstract_state {
120 	uWord	wState;
121 #define	UCDC_IDLE_SETTING		0x0001
122 #define	UCDC_DATA_MULTIPLEXED		0x0002
123 } __packed;
124 
125 #define	UCDC_ABSTRACT_STATE_LENGTH	2
126 
127 struct usb_cdc_line_state {
128 	uDWord	dwDTERate;
129 	uByte	bCharFormat;
130 #define	UCDC_STOP_BIT_1			0
131 #define	UCDC_STOP_BIT_1_5		1
132 #define	UCDC_STOP_BIT_2			2
133 	uByte	bParityType;
134 #define	UCDC_PARITY_NONE		0
135 #define	UCDC_PARITY_ODD			1
136 #define	UCDC_PARITY_EVEN		2
137 #define	UCDC_PARITY_MARK		3
138 #define	UCDC_PARITY_SPACE		4
139 	uByte	bDataBits;
140 } __packed;
141 
142 #define	UCDC_LINE_STATE_LENGTH		7
143 
144 struct usb_cdc_notification {
145 	uByte	bmRequestType;
146 #define	UCDC_NOTIFICATION		0xa1
147 	uByte	bNotification;
148 #define	UCDC_N_NETWORK_CONNECTION	0x00
149 #define	UCDC_N_RESPONSE_AVAILABLE	0x01
150 #define	UCDC_N_AUX_JACK_HOOK_STATE	0x08
151 #define	UCDC_N_RING_DETECT		0x09
152 #define	UCDC_N_SERIAL_STATE		0x20
153 #define	UCDC_N_CALL_STATE_CHANGED	0x28
154 #define	UCDC_N_LINE_STATE_CHANGED	0x29
155 #define	UCDC_N_CONNECTION_SPEED_CHANGE	0x2a
156 	uWord	wValue;
157 	uWord	wIndex;
158 	uWord	wLength;
159 	uByte	data[16];
160 } __packed;
161 
162 #define	UCDC_NOTIFICATION_LENGTH	8
163 
164 /*
165  * Bits set in the SERIAL STATE notification (first byte of data)
166  */
167 
168 #define	UCDC_N_SERIAL_OVERRUN		0x40
169 #define	UCDC_N_SERIAL_PARITY		0x20
170 #define	UCDC_N_SERIAL_FRAMING		0x10
171 #define	UCDC_N_SERIAL_RI		0x08
172 #define	UCDC_N_SERIAL_BREAK		0x04
173 #define	UCDC_N_SERIAL_DSR		0x02
174 #define	UCDC_N_SERIAL_DCD		0x01
175 
176 /* Serial state bit masks */
177 #define	UCDC_MDM_RXCARRIER		0x01
178 #define	UCDC_MDM_TXCARRIER		0x02
179 #define	UCDC_MDM_BREAK			0x04
180 #define	UCDC_MDM_RING			0x08
181 #define	UCDC_MDM_FRAMING_ERR		0x10
182 #define	UCDC_MDM_PARITY_ERR		0x20
183 #define	UCDC_MDM_OVERRUN_ERR		0x40
184 
185 /*
186  * Network Control Model, NCM16 + NCM32, protocol definitions
187  */
188 struct usb_ncm16_hdr {
189 	uDWord	dwSignature;
190 	uWord	wHeaderLength;
191 	uWord	wSequence;
192 	uWord	wBlockLength;
193 	uWord	wDptIndex;
194 } __packed;
195 
196 struct usb_ncm16_dp {
197 	uWord	wFrameIndex;
198 	uWord	wFrameLength;
199 } __packed;
200 
201 struct usb_ncm16_dpt {
202 	uDWord	dwSignature;
203 	uWord	wLength;
204 	uWord	wNextNdpIndex;
205 	struct usb_ncm16_dp dp[0];
206 } __packed;
207 
208 struct usb_ncm32_hdr {
209 	uDWord	dwSignature;
210 	uWord	wHeaderLength;
211 	uWord	wSequence;
212 	uDWord	dwBlockLength;
213 	uDWord	dwDptIndex;
214 } __packed;
215 
216 struct usb_ncm32_dp {
217 	uDWord	dwFrameIndex;
218 	uDWord	dwFrameLength;
219 } __packed;
220 
221 struct usb_ncm32_dpt {
222 	uDWord	dwSignature;
223 	uWord	wLength;
224 	uWord	wReserved6;
225 	uDWord	dwNextNdpIndex;
226 	uDWord	dwReserved12;
227 	struct usb_ncm32_dp dp[0];
228 } __packed;
229 
230 /* Communications interface class specific descriptors */
231 
232 #define	UCDC_NCM_FUNC_DESC_SUBTYPE	0x1A
233 
234 struct usb_ncm_func_descriptor {
235 	uByte	bLength;
236 	uByte	bDescriptorType;
237 	uByte	bDescriptorSubtype;
238 	uByte	bcdNcmVersion[2];
239 	uByte	bmNetworkCapabilities;
240 #define	UCDC_NCM_CAP_FILTER	0x01
241 #define	UCDC_NCM_CAP_MAC_ADDR	0x02
242 #define	UCDC_NCM_CAP_ENCAP	0x04
243 #define	UCDC_NCM_CAP_MAX_DATA	0x08
244 #define	UCDC_NCM_CAP_CRCMODE	0x10
245 #define	UCDC_NCM_CAP_MAX_DGRAM	0x20
246 } __packed;
247 
248 /* Communications interface specific class request codes */
249 
250 #define	UCDC_NCM_SET_ETHERNET_MULTICAST_FILTERS			0x40
251 #define	UCDC_NCM_SET_ETHERNET_POWER_MGMT_PATTERN_FILTER		0x41
252 #define	UCDC_NCM_GET_ETHERNET_POWER_MGMT_PATTERN_FILTER		0x42
253 #define	UCDC_NCM_SET_ETHERNET_PACKET_FILTER			0x43
254 #define	UCDC_NCM_GET_ETHERNET_STATISTIC				0x44
255 #define	UCDC_NCM_GET_NTB_PARAMETERS				0x80
256 #define	UCDC_NCM_GET_NET_ADDRESS				0x81
257 #define	UCDC_NCM_SET_NET_ADDRESS				0x82
258 #define	UCDC_NCM_GET_NTB_FORMAT					0x83
259 #define	UCDC_NCM_SET_NTB_FORMAT					0x84
260 #define	UCDC_NCM_GET_NTB_INPUT_SIZE				0x85
261 #define	UCDC_NCM_SET_NTB_INPUT_SIZE				0x86
262 #define	UCDC_NCM_GET_MAX_DATAGRAM_SIZE				0x87
263 #define	UCDC_NCM_SET_MAX_DATAGRAM_SIZE				0x88
264 #define	UCDC_NCM_GET_CRC_MODE					0x89
265 #define	UCDC_NCM_SET_CRC_MODE					0x8A
266 
267 struct usb_ncm_parameters {
268 	uWord	wLength;
269 	uWord	bmNtbFormatsSupported;
270 #define	UCDC_NCM_FORMAT_NTB16	0x0001
271 #define	UCDC_NCM_FORMAT_NTB32	0x0002
272 	uDWord	dwNtbInMaxSize;
273 	uWord	wNdpInDivisor;
274 	uWord	wNdpInPayloadRemainder;
275 	uWord	wNdpInAlignment;
276 	uWord	wReserved14;
277 	uDWord	dwNtbOutMaxSize;
278 	uWord	wNdpOutDivisor;
279 	uWord	wNdpOutPayloadRemainder;
280 	uWord	wNdpOutAlignment;
281 	uWord	wNtbOutMaxDatagrams;
282 } __packed;
283 
284 /* Communications interface specific class notification codes */
285 #define	UCDC_NCM_NOTIF_NETWORK_CONNECTION	0x00
286 #define	UCDC_NCM_NOTIF_RESPONSE_AVAILABLE	0x01
287 #define	UCDC_NCM_NOTIF_CONNECTION_SPEED_CHANGE	0x2A
288 
289 #endif					/* _USB_CDC_H_ */
290