usb.h revision 1.40 1 1.40 augustss /* $NetBSD: usb.h,v 1.40 2000/02/02 07:33:59 augustss Exp $ */
2 1.39 augustss /* $FreeBSD: src/sys/dev/usb/usb.h,v 1.14 1999/11/17 22:33:46 n_hibma Exp $ */
3 1.1 augustss
4 1.1 augustss /*
5 1.1 augustss * Copyright (c) 1998 The NetBSD Foundation, Inc.
6 1.1 augustss * All rights reserved.
7 1.1 augustss *
8 1.4 augustss * This code is derived from software contributed to The NetBSD Foundation
9 1.4 augustss * by Lennart Augustsson (augustss (at) carlstedt.se) at
10 1.4 augustss * Carlstedt Research & Technology.
11 1.1 augustss *
12 1.1 augustss * Redistribution and use in source and binary forms, with or without
13 1.1 augustss * modification, are permitted provided that the following conditions
14 1.1 augustss * are met:
15 1.1 augustss * 1. Redistributions of source code must retain the above copyright
16 1.1 augustss * notice, this list of conditions and the following disclaimer.
17 1.1 augustss * 2. Redistributions in binary form must reproduce the above copyright
18 1.1 augustss * notice, this list of conditions and the following disclaimer in the
19 1.1 augustss * documentation and/or other materials provided with the distribution.
20 1.1 augustss * 3. All advertising materials mentioning features or use of this software
21 1.1 augustss * must display the following acknowledgement:
22 1.1 augustss * This product includes software developed by the NetBSD
23 1.1 augustss * Foundation, Inc. and its contributors.
24 1.1 augustss * 4. Neither the name of The NetBSD Foundation nor the names of its
25 1.1 augustss * contributors may be used to endorse or promote products derived
26 1.1 augustss * from this software without specific prior written permission.
27 1.1 augustss *
28 1.1 augustss * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 1.1 augustss * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 1.1 augustss * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 1.1 augustss * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 1.1 augustss * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 1.1 augustss * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 1.1 augustss * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 1.1 augustss * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 1.1 augustss * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 1.1 augustss * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 1.1 augustss * POSSIBILITY OF SUCH DAMAGE.
39 1.1 augustss */
40 1.1 augustss
41 1.1 augustss
42 1.1 augustss #ifndef _USB_H_
43 1.1 augustss #define _USB_H_
44 1.1 augustss
45 1.1 augustss #include <sys/types.h>
46 1.37 augustss #include <sys/time.h>
47 1.36 augustss
48 1.25 augustss #if defined(__NetBSD__) || defined(__OpenBSD__)
49 1.1 augustss #include <sys/ioctl.h>
50 1.8 augustss
51 1.8 augustss #if defined(_KERNEL)
52 1.8 augustss #include <dev/usb/usb_port.h>
53 1.8 augustss #endif /* _KERNEL */
54 1.8 augustss
55 1.8 augustss #elif defined(__FreeBSD__)
56 1.36 augustss #if defined(KERNEL)
57 1.8 augustss #include <sys/malloc.h>
58 1.8 augustss
59 1.8 augustss MALLOC_DECLARE(M_USB);
60 1.8 augustss MALLOC_DECLARE(M_USBDEV);
61 1.23 augustss MALLOC_DECLARE(M_USBHC);
62 1.8 augustss
63 1.8 augustss #include <dev/usb/usb_port.h>
64 1.8 augustss #endif /* KERNEL */
65 1.8 augustss #endif /* __FreeBSD__ */
66 1.8 augustss
67 1.1 augustss
68 1.1 augustss #define USB_MAX_DEVICES 128
69 1.1 augustss #define USB_START_ADDR 0
70 1.1 augustss
71 1.1 augustss #define USB_CONTROL_ENDPOINT 0
72 1.1 augustss #define USB_MAX_ENDPOINTS 16
73 1.1 augustss
74 1.10 augustss #define USB_FRAMES_PER_SECOND 1000
75 1.10 augustss
76 1.1 augustss /*
77 1.1 augustss * The USB records contain some unaligned little-endian word
78 1.1 augustss * components. The U[SG]ETW macros take care of both the alignment
79 1.1 augustss * and endian problem and should always be used to access 16 bit
80 1.1 augustss * values.
81 1.1 augustss */
82 1.1 augustss typedef u_int8_t uByte;
83 1.1 augustss typedef u_int8_t uWord[2];
84 1.1 augustss #define UGETW(w) ((w)[0] | ((w)[1] << 8))
85 1.1 augustss #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8))
86 1.1 augustss #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h))
87 1.16 augustss typedef u_int8_t uDWord[4];
88 1.16 augustss #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24))
89 1.16 augustss #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \
90 1.16 augustss (w)[1] = (u_int8_t)((v) >> 8), \
91 1.16 augustss (w)[2] = (u_int8_t)((v) >> 16), \
92 1.16 augustss (w)[3] = (u_int8_t)((v) >> 24))
93 1.1 augustss /*
94 1.1 augustss * On little-endian machines that can handle unanliged accesses
95 1.1 augustss * (e.g. i386) these macros can be replaced by the following.
96 1.1 augustss */
97 1.1 augustss #if 0
98 1.1 augustss #define UGETW(w) (*(u_int16_t *)(w))
99 1.1 augustss #define USETW(w,v) (*(u_int16_t *)(w) = (v))
100 1.1 augustss #endif
101 1.1 augustss
102 1.1 augustss typedef struct {
103 1.1 augustss uByte bmRequestType;
104 1.1 augustss uByte bRequest;
105 1.1 augustss uWord wValue;
106 1.1 augustss uWord wIndex;
107 1.1 augustss uWord wLength;
108 1.1 augustss } usb_device_request_t;
109 1.1 augustss
110 1.1 augustss #define UT_WRITE 0x00
111 1.1 augustss #define UT_READ 0x80
112 1.1 augustss #define UT_STANDARD 0x00
113 1.1 augustss #define UT_CLASS 0x20
114 1.1 augustss #define UT_VENDOR 0x40
115 1.1 augustss #define UT_DEVICE 0x00
116 1.1 augustss #define UT_INTERFACE 0x01
117 1.1 augustss #define UT_ENDPOINT 0x02
118 1.1 augustss #define UT_OTHER 0x03
119 1.1 augustss
120 1.1 augustss #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE)
121 1.1 augustss #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE)
122 1.1 augustss #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT)
123 1.1 augustss #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE)
124 1.1 augustss #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE)
125 1.1 augustss #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
126 1.1 augustss #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE)
127 1.1 augustss #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE)
128 1.1 augustss #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER)
129 1.30 augustss #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT)
130 1.1 augustss #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE)
131 1.1 augustss #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
132 1.1 augustss #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER)
133 1.30 augustss #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
134 1.13 augustss #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE)
135 1.13 augustss #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE)
136 1.13 augustss #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER)
137 1.30 augustss #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT)
138 1.13 augustss #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE)
139 1.13 augustss #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
140 1.13 augustss #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER)
141 1.30 augustss #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
142 1.1 augustss
143 1.1 augustss /* Requests */
144 1.1 augustss #define UR_GET_STATUS 0x00
145 1.1 augustss #define UR_CLEAR_FEATURE 0x01
146 1.1 augustss #define UR_SET_FEATURE 0x03
147 1.1 augustss #define UR_SET_ADDRESS 0x05
148 1.1 augustss #define UR_GET_DESCRIPTOR 0x06
149 1.36 augustss #define UDESC_DEVICE 0x01
150 1.36 augustss #define UDESC_CONFIG 0x02
151 1.36 augustss #define UDESC_STRING 0x03
152 1.36 augustss #define UDESC_INTERFACE 0x04
153 1.36 augustss #define UDESC_ENDPOINT 0x05
154 1.36 augustss #define UDESC_CS_DEVICE 0x21 /* class specific */
155 1.36 augustss #define UDESC_CS_CONFIG 0x22
156 1.36 augustss #define UDESC_CS_STRING 0x23
157 1.36 augustss #define UDESC_CS_INTERFACE 0x24
158 1.36 augustss #define UDESC_CS_ENDPOINT 0x25
159 1.36 augustss #define UDESC_HUB 0x29
160 1.1 augustss #define UR_SET_DESCRIPTOR 0x07
161 1.1 augustss #define UR_GET_CONFIG 0x08
162 1.1 augustss #define UR_SET_CONFIG 0x09
163 1.1 augustss #define UR_GET_INTERFACE 0x0a
164 1.1 augustss #define UR_SET_INTERFACE 0x0b
165 1.1 augustss #define UR_SYNCH_FRAME 0x0c
166 1.1 augustss
167 1.1 augustss /* Feature numbers */
168 1.8 augustss #define UF_ENDPOINT_HALT 0
169 1.1 augustss #define UF_DEVICE_REMOTE_WAKEUP 1
170 1.1 augustss
171 1.1 augustss #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */
172 1.1 augustss
173 1.1 augustss typedef struct {
174 1.1 augustss uByte bLength;
175 1.1 augustss uByte bDescriptorType;
176 1.1 augustss uByte bDescriptorSubtype;
177 1.1 augustss } usb_descriptor_t;
178 1.1 augustss
179 1.1 augustss typedef struct {
180 1.1 augustss uByte bLength;
181 1.1 augustss uByte bDescriptorType;
182 1.1 augustss uWord bcdUSB;
183 1.1 augustss uByte bDeviceClass;
184 1.1 augustss uByte bDeviceSubClass;
185 1.1 augustss uByte bDeviceProtocol;
186 1.1 augustss uByte bMaxPacketSize;
187 1.1 augustss /* The fields below are not part of the initial descriptor. */
188 1.1 augustss uWord idVendor;
189 1.1 augustss uWord idProduct;
190 1.1 augustss uWord bcdDevice;
191 1.1 augustss uByte iManufacturer;
192 1.1 augustss uByte iProduct;
193 1.1 augustss uByte iSerialNumber;
194 1.1 augustss uByte bNumConfigurations;
195 1.1 augustss } usb_device_descriptor_t;
196 1.1 augustss #define USB_DEVICE_DESCRIPTOR_SIZE 18
197 1.1 augustss
198 1.1 augustss typedef struct {
199 1.1 augustss uByte bLength;
200 1.1 augustss uByte bDescriptorType;
201 1.1 augustss uWord wTotalLength;
202 1.1 augustss uByte bNumInterface;
203 1.1 augustss uByte bConfigurationValue;
204 1.1 augustss uByte iConfiguration;
205 1.1 augustss uByte bmAttributes;
206 1.1 augustss #define UC_BUS_POWERED 0x80
207 1.1 augustss #define UC_SELF_POWERED 0x40
208 1.1 augustss #define UC_REMOTE_WAKEUP 0x20
209 1.1 augustss uByte bMaxPower; /* max current in 2 mA units */
210 1.1 augustss #define UC_POWER_FACTOR 2
211 1.1 augustss } usb_config_descriptor_t;
212 1.1 augustss #define USB_CONFIG_DESCRIPTOR_SIZE 9
213 1.1 augustss
214 1.1 augustss typedef struct {
215 1.1 augustss uByte bLength;
216 1.1 augustss uByte bDescriptorType;
217 1.1 augustss uByte bInterfaceNumber;
218 1.1 augustss uByte bAlternateSetting;
219 1.1 augustss uByte bNumEndpoints;
220 1.1 augustss uByte bInterfaceClass;
221 1.1 augustss uByte bInterfaceSubClass;
222 1.1 augustss uByte bInterfaceProtocol;
223 1.1 augustss uByte iInterface;
224 1.1 augustss } usb_interface_descriptor_t;
225 1.1 augustss #define USB_INTERFACE_DESCRIPTOR_SIZE 9
226 1.1 augustss
227 1.1 augustss typedef struct {
228 1.1 augustss uByte bLength;
229 1.1 augustss uByte bDescriptorType;
230 1.1 augustss uByte bEndpointAddress;
231 1.31 augustss #define UE_GET_DIR(a) ((a) & 0x80)
232 1.36 augustss #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7))
233 1.31 augustss #define UE_DIR_IN 0x80
234 1.31 augustss #define UE_DIR_OUT 0x00
235 1.1 augustss #define UE_ADDR 0x0f
236 1.6 augustss #define UE_GET_ADDR(a) ((a) & UE_ADDR)
237 1.1 augustss uByte bmAttributes;
238 1.1 augustss #define UE_XFERTYPE 0x03
239 1.10 augustss #define UE_CONTROL 0x00
240 1.10 augustss #define UE_ISOCHRONOUS 0x01
241 1.10 augustss #define UE_BULK 0x02
242 1.10 augustss #define UE_INTERRUPT 0x03
243 1.36 augustss #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE)
244 1.10 augustss #define UE_ISO_TYPE 0x0c
245 1.10 augustss #define UE_ISO_ASYNC 0x04
246 1.10 augustss #define UE_ISO_ADAPT 0x08
247 1.10 augustss #define UE_ISO_SYNC 0x0c
248 1.38 augustss #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE)
249 1.1 augustss uWord wMaxPacketSize;
250 1.1 augustss uByte bInterval;
251 1.1 augustss } usb_endpoint_descriptor_t;
252 1.1 augustss #define USB_ENDPOINT_DESCRIPTOR_SIZE 7
253 1.1 augustss
254 1.1 augustss typedef struct {
255 1.1 augustss uByte bLength;
256 1.1 augustss uByte bDescriptorType;
257 1.1 augustss uWord bString[127];
258 1.1 augustss } usb_string_descriptor_t;
259 1.1 augustss #define USB_MAX_STRING_LEN 128
260 1.15 augustss #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */
261 1.1 augustss
262 1.1 augustss /* Hub specific request */
263 1.1 augustss #define UR_GET_BUS_STATE 0x02
264 1.1 augustss
265 1.1 augustss /* Hub features */
266 1.1 augustss #define UHF_C_HUB_LOCAL_POWER 0
267 1.1 augustss #define UHF_C_HUB_OVER_CURRENT 1
268 1.1 augustss #define UHF_PORT_CONNECTION 0
269 1.1 augustss #define UHF_PORT_ENABLE 1
270 1.1 augustss #define UHF_PORT_SUSPEND 2
271 1.1 augustss #define UHF_PORT_OVER_CURRENT 3
272 1.1 augustss #define UHF_PORT_RESET 4
273 1.1 augustss #define UHF_PORT_POWER 8
274 1.1 augustss #define UHF_PORT_LOW_SPEED 9
275 1.1 augustss #define UHF_C_PORT_CONNECTION 16
276 1.1 augustss #define UHF_C_PORT_ENABLE 17
277 1.1 augustss #define UHF_C_PORT_SUSPEND 18
278 1.1 augustss #define UHF_C_PORT_OVER_CURRENT 19
279 1.1 augustss #define UHF_C_PORT_RESET 20
280 1.1 augustss
281 1.1 augustss typedef struct {
282 1.1 augustss uByte bDescLength;
283 1.1 augustss uByte bDescriptorType;
284 1.1 augustss uByte bNbrPorts;
285 1.8 augustss uWord wHubCharacteristics;
286 1.1 augustss #define UHD_PWR 0x03
287 1.1 augustss #define UHD_PWR_GANGED 0x00
288 1.1 augustss #define UHD_PWR_INDIVIDUAL 0x01
289 1.1 augustss #define UHD_PWR_NO_SWITCH 0x02
290 1.1 augustss #define UHD_COMPOUND 0x04
291 1.1 augustss #define UHD_OC 0x18
292 1.1 augustss #define UHD_OC_GLOBAL 0x00
293 1.1 augustss #define UHD_OC_INDIVIDUAL 0x08
294 1.1 augustss #define UHD_OC_NONE 0x10
295 1.1 augustss uByte bPwrOn2PwrGood; /* delay in 2 ms units */
296 1.1 augustss #define UHD_PWRON_FACTOR 2
297 1.1 augustss uByte bHubContrCurrent;
298 1.8 augustss uByte DeviceRemovable[32]; /* max 255 ports */
299 1.8 augustss #define UHD_NOT_REMOV(desc, i) \
300 1.8 augustss (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
301 1.8 augustss /* deprecated uByte PortPowerCtrlMask[]; */
302 1.1 augustss } usb_hub_descriptor_t;
303 1.8 augustss #define USB_HUB_DESCRIPTOR_SIZE 8
304 1.1 augustss
305 1.1 augustss typedef struct {
306 1.1 augustss uWord wStatus;
307 1.1 augustss /* Device status flags */
308 1.1 augustss #define UDS_SELF_POWERED 0x0001
309 1.1 augustss #define UDS_REMOTE_WAKEUP 0x0002
310 1.8 augustss /* Endpoint status flags */
311 1.8 augustss #define UES_HALT 0x0001
312 1.1 augustss } usb_status_t;
313 1.1 augustss
314 1.1 augustss typedef struct {
315 1.1 augustss uWord wHubStatus;
316 1.1 augustss #define UHS_LOCAL_POWER 0x0001
317 1.1 augustss #define UHS_OVER_CURRENT 0x0002
318 1.1 augustss uWord wHubChange;
319 1.1 augustss } usb_hub_status_t;
320 1.1 augustss
321 1.1 augustss typedef struct {
322 1.1 augustss uWord wPortStatus;
323 1.1 augustss #define UPS_CURRENT_CONNECT_STATUS 0x0001
324 1.1 augustss #define UPS_PORT_ENABLED 0x0002
325 1.1 augustss #define UPS_SUSPEND 0x0004
326 1.1 augustss #define UPS_OVERCURRENT_INDICATOR 0x0008
327 1.1 augustss #define UPS_RESET 0x0010
328 1.1 augustss #define UPS_PORT_POWER 0x0100
329 1.1 augustss #define UPS_LOW_SPEED 0x0200
330 1.1 augustss uWord wPortChange;
331 1.1 augustss #define UPS_C_CONNECT_STATUS 0x0001
332 1.1 augustss #define UPS_C_PORT_ENABLED 0x0002
333 1.1 augustss #define UPS_C_SUSPEND 0x0004
334 1.1 augustss #define UPS_C_OVERCURRENT_INDICATOR 0x0008
335 1.1 augustss #define UPS_C_PORT_RESET 0x0010
336 1.1 augustss } usb_port_status_t;
337 1.1 augustss
338 1.1 augustss #define UCLASS_UNSPEC 0
339 1.1 augustss #define UCLASS_AUDIO 1
340 1.1 augustss #define USUBCLASS_AUDIOCONTROL 1
341 1.1 augustss #define USUBCLASS_AUDIOSTREAM 2
342 1.32 augustss #define USUBCLASS_MIDISTREAM 3
343 1.16 augustss #define UCLASS_CDC 2 /* communication */
344 1.21 thorpej #define USUBCLASS_DIRECT_LINE_CONTROL_MODEL 1
345 1.7 augustss #define USUBCLASS_ABSTRACT_CONTROL_MODEL 2
346 1.21 thorpej #define USUBCLASS_TELEPHONE_CONTROL_MODEL 3
347 1.21 thorpej #define USUBCLASS_MULTICHANNEL_CONTROL_MODEL 4
348 1.21 thorpej #define USUBCLASS_CAPI_CONTROLMODEL 5
349 1.21 thorpej #define USUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
350 1.21 thorpej #define USUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
351 1.7 augustss #define UPROTO_CDC_AT 1
352 1.1 augustss #define UCLASS_HID 3
353 1.1 augustss #define USUBCLASS_BOOT 1
354 1.1 augustss #define UCLASS_PRINTER 7
355 1.1 augustss #define USUBCLASS_PRINTER 1
356 1.1 augustss #define UPROTO_PRINTER_UNI 1
357 1.1 augustss #define UPROTO_PRINTER_BI 2
358 1.19 augustss #define UCLASS_MASS 8
359 1.19 augustss #define USUBCLASS_RBC 1
360 1.19 augustss #define USUBCLASS_SFF8020I 2
361 1.19 augustss #define USUBCLASS_QIC157 3
362 1.19 augustss #define USUBCLASS_UFI 4
363 1.19 augustss #define USUBCLASS_SFF8070I 5
364 1.19 augustss #define USUBCLASS_SCSI 6
365 1.28 augustss #define UPROTO_MASS_CBI_I 0
366 1.28 augustss #define UPROTO_MASS_CBI 1
367 1.34 augustss #define UPROTO_MASS_BULK 2
368 1.39 augustss #define UPROTO_MASS_BULK_P 80 /* 'P' for the Iomega Zip drive */
369 1.1 augustss #define UCLASS_HUB 9
370 1.8 augustss #define USUBCLASS_HUB 0
371 1.6 augustss #define UCLASS_DATA 10
372 1.36 augustss #define USUBCLASS_DATA 0
373 1.36 augustss #define UPROTO_DATA_ISDNBRI 0x30 /* Physical iface */
374 1.36 augustss #define UPROTO_DATA_HDLC 0x31 /* HDLC */
375 1.36 augustss #define UPROTO_DATA_TRANSPARENT 0x32 /* Transparent */
376 1.36 augustss #define UPROTO_DATA_Q921M 0x50 /* Management for Q921 */
377 1.36 augustss #define UPROTO_DATA_Q921 0x51 /* Data for Q921 */
378 1.36 augustss #define UPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */
379 1.36 augustss #define UPROTO_DATA_V42BIS 0x90 /* Data compression */
380 1.36 augustss #define UPROTO_DATA_Q931 0x91 /* Euro-ISDN */
381 1.36 augustss #define UPROTO_DATA_V120 0x92 /* V.24 rate adaption */
382 1.36 augustss #define UPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */
383 1.36 augustss #define UPROTO_DATA_HOST_BASED 0xfd /* Host based driver */
384 1.36 augustss #define UPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/
385 1.36 augustss #define UPROTO_DATA_VENDOR 0xff /* Vendor specific */
386 1.36 augustss
387 1.1 augustss
388 1.1 augustss #define USB_HUB_MAX_DEPTH 5
389 1.1 augustss
390 1.6 augustss /*
391 1.6 augustss * Minimum time a device needs to be powered down to go through
392 1.11 augustss * a power cycle. XXX Are these time in the spec?
393 1.6 augustss */
394 1.11 augustss #define USB_POWER_DOWN_TIME 200 /* ms */
395 1.9 augustss #define USB_PORT_POWER_DOWN_TIME 100 /* ms */
396 1.6 augustss
397 1.8 augustss #if 0
398 1.9 augustss /* These are the values from the spec. */
399 1.1 augustss #define USB_PORT_RESET_DELAY 10 /* ms */
400 1.8 augustss #define USB_PORT_RESET_SETTLE 10 /* ms */
401 1.1 augustss #define USB_PORT_POWERUP_DELAY 100 /* ms */
402 1.8 augustss #define USB_SET_ADDRESS_SETTLE 2 /* ms */
403 1.22 augustss #define USB_RESUME_TIME (20*5) /* ms */
404 1.22 augustss #define USB_RESUME_WAIT 10 /* ms */
405 1.22 augustss #define USB_RESUME_RECOVERY 10 /* ms */
406 1.8 augustss #else
407 1.9 augustss /* Allow for marginal (i.e. non-conforming) devices. */
408 1.18 augustss #define USB_PORT_RESET_DELAY 50 /* ms */
409 1.11 augustss #define USB_PORT_RESET_RECOVERY 50 /* ms */
410 1.8 augustss #define USB_PORT_POWERUP_DELAY 200 /* ms */
411 1.8 augustss #define USB_SET_ADDRESS_SETTLE 10 /* ms */
412 1.22 augustss #define USB_RESUME_DELAY (50*5) /* ms */
413 1.22 augustss #define USB_RESUME_WAIT 50 /* ms */
414 1.22 augustss #define USB_RESUME_RECOVERY 50 /* ms */
415 1.8 augustss #endif
416 1.1 augustss
417 1.1 augustss #define USB_MIN_POWER 100 /* mA */
418 1.1 augustss #define USB_MAX_POWER 500 /* mA */
419 1.1 augustss
420 1.11 augustss #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/
421 1.1 augustss
422 1.1 augustss /*** ioctl() related stuff ***/
423 1.1 augustss
424 1.1 augustss struct usb_ctl_request {
425 1.1 augustss int addr;
426 1.1 augustss usb_device_request_t request;
427 1.1 augustss void *data;
428 1.12 augustss int flags;
429 1.33 augustss #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */
430 1.17 augustss int actlen; /* actual length transferred */
431 1.1 augustss };
432 1.1 augustss
433 1.6 augustss struct usb_alt_interface {
434 1.7 augustss int config_index;
435 1.6 augustss int interface_index;
436 1.6 augustss int alt_no;
437 1.6 augustss };
438 1.6 augustss
439 1.6 augustss #define USB_CURRENT_CONFIG_INDEX (-1)
440 1.6 augustss #define USB_CURRENT_ALT_INDEX (-1)
441 1.6 augustss
442 1.6 augustss struct usb_config_desc {
443 1.6 augustss int config_index;
444 1.6 augustss usb_config_descriptor_t desc;
445 1.6 augustss };
446 1.6 augustss
447 1.6 augustss struct usb_interface_desc {
448 1.6 augustss int config_index;
449 1.6 augustss int interface_index;
450 1.6 augustss int alt_index;
451 1.6 augustss usb_interface_descriptor_t desc;
452 1.6 augustss };
453 1.6 augustss
454 1.6 augustss struct usb_endpoint_desc {
455 1.6 augustss int config_index;
456 1.6 augustss int interface_index;
457 1.6 augustss int alt_index;
458 1.6 augustss int endpoint_index;
459 1.6 augustss usb_endpoint_descriptor_t desc;
460 1.6 augustss };
461 1.6 augustss
462 1.6 augustss struct usb_full_desc {
463 1.6 augustss int config_index;
464 1.6 augustss u_int size;
465 1.6 augustss u_char *data;
466 1.1 augustss };
467 1.1 augustss
468 1.7 augustss struct usb_string_desc {
469 1.7 augustss int string_index;
470 1.7 augustss int language_id;
471 1.7 augustss usb_string_descriptor_t desc;
472 1.7 augustss };
473 1.7 augustss
474 1.1 augustss struct usb_ctl_report_desc {
475 1.1 augustss int size;
476 1.1 augustss u_char data[1024]; /* filled data size will vary */
477 1.1 augustss };
478 1.1 augustss
479 1.40 augustss typedef struct { u_int32_t cookie; } usb_event_cookie_t;
480 1.40 augustss
481 1.40 augustss #define USB_MAX_DEVNAMES 4
482 1.40 augustss #define USB_MAX_DEVNAMELEN 16
483 1.1 augustss struct usb_device_info {
484 1.40 augustss u_int8_t bus;
485 1.14 augustss u_int8_t addr; /* device address */
486 1.40 augustss usb_event_cookie_t cookie;
487 1.14 augustss char product[USB_MAX_STRING_LEN];
488 1.14 augustss char vendor[USB_MAX_STRING_LEN];
489 1.20 augustss char release[8];
490 1.14 augustss u_int16_t productNo;
491 1.14 augustss u_int16_t vendorNo;
492 1.40 augustss u_int16_t releaseNo;
493 1.14 augustss u_int8_t class;
494 1.40 augustss u_int8_t subclass;
495 1.40 augustss u_int8_t protocol;
496 1.14 augustss u_int8_t config;
497 1.14 augustss u_int8_t lowspeed;
498 1.14 augustss int power; /* power consumption in mA, 0 if selfpowered */
499 1.14 augustss int nports;
500 1.40 augustss char devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
501 1.14 augustss u_int8_t ports[16];/* hub only: addresses of devices on ports */
502 1.1 augustss #define USB_PORT_ENABLED 0xff
503 1.1 augustss #define USB_PORT_SUSPENDED 0xfe
504 1.1 augustss #define USB_PORT_POWERED 0xfd
505 1.1 augustss #define USB_PORT_DISABLED 0xfc
506 1.1 augustss };
507 1.1 augustss
508 1.2 augustss struct usb_ctl_report {
509 1.35 augustss int report;
510 1.2 augustss u_char data[1024]; /* filled data size will vary */
511 1.2 augustss };
512 1.2 augustss
513 1.3 augustss struct usb_device_stats {
514 1.3 augustss u_long requests[4]; /* indexed by transfer type UE_* */
515 1.35 augustss };
516 1.35 augustss
517 1.35 augustss /* Events that can be read from /dev/usb */
518 1.35 augustss struct usb_event {
519 1.35 augustss int ue_type;
520 1.40 augustss #define USB_EVENT_CTRLR_ATTACH 1
521 1.40 augustss #define USB_EVENT_CTRLR_DETACH 2
522 1.40 augustss #define USB_EVENT_DEVICE_ATTACH 3
523 1.40 augustss #define USB_EVENT_DEVICE_DETACH 4
524 1.40 augustss #define USB_EVENT_DRIVER_ATTACH 5
525 1.40 augustss #define USB_EVENT_DRIVER_DETACH 6
526 1.35 augustss struct timespec ue_time;
527 1.40 augustss union {
528 1.40 augustss struct {
529 1.40 augustss int ue_bus;
530 1.40 augustss } ue_ctrlr;
531 1.40 augustss struct usb_device_info ue_device;
532 1.40 augustss struct {
533 1.40 augustss usb_event_cookie_t ue_cookie;
534 1.40 augustss char ue_devname[16];
535 1.40 augustss } ue_driver;
536 1.40 augustss } u;
537 1.3 augustss };
538 1.3 augustss
539 1.1 augustss /* USB controller */
540 1.1 augustss #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
541 1.1 augustss #define USB_SETDEBUG _IOW ('U', 2, int)
542 1.1 augustss #define USB_DISCOVER _IO ('U', 3)
543 1.1 augustss #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
544 1.3 augustss #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
545 1.1 augustss
546 1.1 augustss /* Generic HID device */
547 1.1 augustss #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc)
548 1.2 augustss #define USB_SET_IMMED _IOW ('U', 22, int)
549 1.2 augustss #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report)
550 1.1 augustss
551 1.1 augustss /* Generic USB device */
552 1.6 augustss #define USB_GET_CONFIG _IOR ('U', 100, int)
553 1.6 augustss #define USB_SET_CONFIG _IOW ('U', 101, int)
554 1.6 augustss #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface)
555 1.7 augustss #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface)
556 1.6 augustss #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface)
557 1.6 augustss #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t)
558 1.7 augustss #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc)
559 1.6 augustss #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc)
560 1.6 augustss #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc)
561 1.7 augustss #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc)
562 1.7 augustss #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc)
563 1.7 augustss #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request)
564 1.7 augustss #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info)
565 1.16 augustss #define USB_SET_SHORT_XFER _IOW ('U', 113, int)
566 1.29 augustss #define USB_SET_TIMEOUT _IOW ('U', 114, int)
567 1.24 augustss
568 1.24 augustss /* Modem device */
569 1.24 augustss #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int)
570 1.24 augustss #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int)
571 1.1 augustss
572 1.1 augustss #endif /* _USB_H_ */
573