blob: 4f3601a16c3a487a05b6bcf8c31cda2d3bc27894 [file] [log] [blame]
wdenk012771d2002-03-08 21:31:05 +00001/*
2 * (C) Copyright 2001
3 * Denis Peter, MPL AG Switzerland
4 *
5 * See file CREDITS for list of people who contributed to this
6 * project.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 * MA 02111-1307 USA
22 *
23 * Note: Part of this code has been derived from linux
24 *
25 */
26#ifndef _USB_DEFS_H_
27#define _USB_DEFS_H_
28
wdenk012771d2002-03-08 21:31:05 +000029/* USB constants */
30
31/* Device and/or Interface Class codes */
32#define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
33#define USB_CLASS_AUDIO 1
34#define USB_CLASS_COMM 2
35#define USB_CLASS_HID 3
36#define USB_CLASS_PRINTER 7
37#define USB_CLASS_MASS_STORAGE 8
38#define USB_CLASS_HUB 9
39#define USB_CLASS_DATA 10
40#define USB_CLASS_VENDOR_SPEC 0xff
41
42/* some HID sub classes */
43#define USB_SUB_HID_NONE 0
44#define USB_SUB_HID_BOOT 1
45
46/* some UID Protocols */
47#define USB_PROT_HID_NONE 0
48#define USB_PROT_HID_KEYBOARD 1
49#define USB_PROT_HID_MOUSE 2
50
51
52/* Sub STORAGE Classes */
53#define US_SC_RBC 1 /* Typically, flash devices */
54#define US_SC_8020 2 /* CD-ROM */
55#define US_SC_QIC 3 /* QIC-157 Tapes */
56#define US_SC_UFI 4 /* Floppy */
57#define US_SC_8070 5 /* Removable media */
58#define US_SC_SCSI 6 /* Transparent */
59#define US_SC_MIN US_SC_RBC
60#define US_SC_MAX US_SC_SCSI
61
62/* STORAGE Protocols */
63#define US_PR_CB 1 /* Control/Bulk w/o interrupt */
64#define US_PR_CBI 0 /* Control/Bulk/Interrupt */
65#define US_PR_BULK 0x50 /* bulk only */
66
67/* USB types */
68#define USB_TYPE_STANDARD (0x00 << 5)
69#define USB_TYPE_CLASS (0x01 << 5)
70#define USB_TYPE_VENDOR (0x02 << 5)
71#define USB_TYPE_RESERVED (0x03 << 5)
72
73/* USB recipients */
74#define USB_RECIP_DEVICE 0x00
75#define USB_RECIP_INTERFACE 0x01
76#define USB_RECIP_ENDPOINT 0x02
77#define USB_RECIP_OTHER 0x03
78
79/* USB directions */
80#define USB_DIR_OUT 0
81#define USB_DIR_IN 0x80
82
83/* Descriptor types */
84#define USB_DT_DEVICE 0x01
85#define USB_DT_CONFIG 0x02
86#define USB_DT_STRING 0x03
87#define USB_DT_INTERFACE 0x04
88#define USB_DT_ENDPOINT 0x05
89
90#define USB_DT_HID (USB_TYPE_CLASS | 0x01)
91#define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
92#define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
93#define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
94
95/* Descriptor sizes per descriptor type */
96#define USB_DT_DEVICE_SIZE 18
97#define USB_DT_CONFIG_SIZE 9
98#define USB_DT_INTERFACE_SIZE 9
99#define USB_DT_ENDPOINT_SIZE 7
100#define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
101#define USB_DT_HUB_NONVAR_SIZE 7
102#define USB_DT_HID_SIZE 9
103
104/* Endpoints */
105#define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
106#define USB_ENDPOINT_DIR_MASK 0x80
107
108#define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
109#define USB_ENDPOINT_XFER_CONTROL 0
110#define USB_ENDPOINT_XFER_ISOC 1
111#define USB_ENDPOINT_XFER_BULK 2
112#define USB_ENDPOINT_XFER_INT 3
113
114/* USB Packet IDs (PIDs) */
115#define USB_PID_UNDEF_0 0xf0
116#define USB_PID_OUT 0xe1
117#define USB_PID_ACK 0xd2
118#define USB_PID_DATA0 0xc3
119#define USB_PID_UNDEF_4 0xb4
120#define USB_PID_SOF 0xa5
121#define USB_PID_UNDEF_6 0x96
122#define USB_PID_UNDEF_7 0x87
123#define USB_PID_UNDEF_8 0x78
124#define USB_PID_IN 0x69
125#define USB_PID_NAK 0x5a
126#define USB_PID_DATA1 0x4b
127#define USB_PID_PREAMBLE 0x3c
128#define USB_PID_SETUP 0x2d
129#define USB_PID_STALL 0x1e
130#define USB_PID_UNDEF_F 0x0f
131
132/* Standard requests */
133#define USB_REQ_GET_STATUS 0x00
134#define USB_REQ_CLEAR_FEATURE 0x01
135#define USB_REQ_SET_FEATURE 0x03
136#define USB_REQ_SET_ADDRESS 0x05
137#define USB_REQ_GET_DESCRIPTOR 0x06
138#define USB_REQ_SET_DESCRIPTOR 0x07
139#define USB_REQ_GET_CONFIGURATION 0x08
140#define USB_REQ_SET_CONFIGURATION 0x09
141#define USB_REQ_GET_INTERFACE 0x0A
142#define USB_REQ_SET_INTERFACE 0x0B
143#define USB_REQ_SYNCH_FRAME 0x0C
144
145/* HID requests */
146#define USB_REQ_GET_REPORT 0x01
147#define USB_REQ_GET_IDLE 0x02
148#define USB_REQ_GET_PROTOCOL 0x03
149#define USB_REQ_SET_REPORT 0x09
150#define USB_REQ_SET_IDLE 0x0A
151#define USB_REQ_SET_PROTOCOL 0x0B
152
Julius Werner7d9aa8f2013-02-28 18:08:40 +0000153/* Device features */
154#define USB_FEAT_HALT 0x00
155#define USB_FEAT_WAKEUP 0x01
156#define USB_FEAT_TEST 0x02
157
158/* Test modes */
159#define USB_TEST_MODE_J 0x01
160#define USB_TEST_MODE_K 0x02
161#define USB_TEST_MODE_SE0_NAK 0x03
162#define USB_TEST_MODE_PACKET 0x04
163#define USB_TEST_MODE_FORCE_ENABLE 0x05
164
wdenk012771d2002-03-08 21:31:05 +0000165
166/* "pipe" definitions */
167
168#define PIPE_ISOCHRONOUS 0
169#define PIPE_INTERRUPT 1
170#define PIPE_CONTROL 2
171#define PIPE_BULK 3
172#define PIPE_DEVEP_MASK 0x0007ff00
173
174#define USB_ISOCHRONOUS 0
175#define USB_INTERRUPT 1
176#define USB_CONTROL 2
177#define USB_BULK 3
178
179/* USB-status codes: */
180#define USB_ST_ACTIVE 0x1 /* TD is active */
181#define USB_ST_STALLED 0x2 /* TD is stalled */
182#define USB_ST_BUF_ERR 0x4 /* buffer error */
183#define USB_ST_BABBLE_DET 0x8 /* Babble detected */
184#define USB_ST_NAK_REC 0x10 /* NAK Received*/
185#define USB_ST_CRC_ERR 0x20 /* CRC/timeout Error */
186#define USB_ST_BIT_ERR 0x40 /* Bitstuff error */
187#define USB_ST_NOT_PROC 0x80000000L /* Not yet processed */
188
189
wdenk012771d2002-03-08 21:31:05 +0000190/*************************************************************************
191 * Hub defines
192 */
193
194/*
195 * Hub request types
196 */
197
198#define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE)
199#define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER)
200
201/*
202 * Hub Class feature numbers
203 */
204#define C_HUB_LOCAL_POWER 0
205#define C_HUB_OVER_CURRENT 1
206
207/*
208 * Port feature numbers
209 */
210#define USB_PORT_FEAT_CONNECTION 0
211#define USB_PORT_FEAT_ENABLE 1
212#define USB_PORT_FEAT_SUSPEND 2
213#define USB_PORT_FEAT_OVER_CURRENT 3
214#define USB_PORT_FEAT_RESET 4
215#define USB_PORT_FEAT_POWER 8
216#define USB_PORT_FEAT_LOWSPEED 9
Michael Trimarchi3e126482008-11-28 13:19:19 +0100217#define USB_PORT_FEAT_HIGHSPEED 10
wdenk012771d2002-03-08 21:31:05 +0000218#define USB_PORT_FEAT_C_CONNECTION 16
219#define USB_PORT_FEAT_C_ENABLE 17
220#define USB_PORT_FEAT_C_SUSPEND 18
221#define USB_PORT_FEAT_C_OVER_CURRENT 19
222#define USB_PORT_FEAT_C_RESET 20
Julius Werner7d9aa8f2013-02-28 18:08:40 +0000223#define USB_PORT_FEAT_TEST 21
wdenk012771d2002-03-08 21:31:05 +0000224
Vivek Gautam55f4b572013-04-24 02:50:12 +0000225/*
226 * Changes to Port feature numbers for Super speed,
227 * from USB 3.0 spec Table 10-8
228 */
229#define USB_SS_PORT_FEAT_U1_TIMEOUT 23
230#define USB_SS_PORT_FEAT_U2_TIMEOUT 24
231#define USB_SS_PORT_FEAT_C_LINK_STATE 25
232#define USB_SS_PORT_FEAT_C_CONFIG_ERROR 26
233#define USB_SS_PORT_FEAT_BH_RESET 28
234#define USB_SS_PORT_FEAT_C_BH_RESET 29
235
wdenk012771d2002-03-08 21:31:05 +0000236/* wPortStatus bits */
237#define USB_PORT_STAT_CONNECTION 0x0001
238#define USB_PORT_STAT_ENABLE 0x0002
239#define USB_PORT_STAT_SUSPEND 0x0004
240#define USB_PORT_STAT_OVERCURRENT 0x0008
241#define USB_PORT_STAT_RESET 0x0010
242#define USB_PORT_STAT_POWER 0x0100
243#define USB_PORT_STAT_LOW_SPEED 0x0200
Michael Trimarchi3e126482008-11-28 13:19:19 +0100244#define USB_PORT_STAT_HIGH_SPEED 0x0400 /* support for EHCI */
Vivek Gautam55f4b572013-04-24 02:50:12 +0000245#define USB_PORT_STAT_SUPER_SPEED 0x0600 /* faking support to XHCI */
246#define USB_PORT_STAT_SPEED_MASK \
247 (USB_PORT_STAT_LOW_SPEED | USB_PORT_STAT_HIGH_SPEED)
Vivek Gautam6497c662013-04-12 16:34:38 +0530248
249/*
Vivek Gautam55f4b572013-04-24 02:50:12 +0000250 * Changes to wPortStatus bit field in USB 3.0
251 * See USB 3.0 spec Table 10-11
Vivek Gautam6497c662013-04-12 16:34:38 +0530252 */
Vivek Gautam55f4b572013-04-24 02:50:12 +0000253#define USB_SS_PORT_STAT_LINK_STATE 0x01e0
Vivek Gautam6497c662013-04-12 16:34:38 +0530254#define USB_SS_PORT_STAT_POWER 0x0200
255#define USB_SS_PORT_STAT_SPEED 0x1c00
Vivek Gautam55f4b572013-04-24 02:50:12 +0000256#define USB_SS_PORT_STAT_SPEED_5GBPS 0x0000
wdenk012771d2002-03-08 21:31:05 +0000257
258/* wPortChange bits */
259#define USB_PORT_STAT_C_CONNECTION 0x0001
260#define USB_PORT_STAT_C_ENABLE 0x0002
261#define USB_PORT_STAT_C_SUSPEND 0x0004
262#define USB_PORT_STAT_C_OVERCURRENT 0x0008
263#define USB_PORT_STAT_C_RESET 0x0010
264
Vivek Gautam6497c662013-04-12 16:34:38 +0530265/*
Vivek Gautam55f4b572013-04-24 02:50:12 +0000266 * Changes to wPortChange bit fields in USB 3.0
267 * See USB 3.0 spec Table 10-12
Vivek Gautam6497c662013-04-12 16:34:38 +0530268 */
Vivek Gautam55f4b572013-04-24 02:50:12 +0000269#define USB_SS_PORT_STAT_C_BH_RESET 0x0020
270#define USB_SS_PORT_STAT_C_LINK_STATE 0x0040
271#define USB_SS_PORT_STAT_C_CONFIG_ERROR 0x0080
Vivek Gautam6497c662013-04-12 16:34:38 +0530272
wdenk012771d2002-03-08 21:31:05 +0000273/* wHubCharacteristics (masks) */
274#define HUB_CHAR_LPSM 0x0003
275#define HUB_CHAR_COMPOUND 0x0004
276#define HUB_CHAR_OCPM 0x0018
277
278/*
Vivek Gautam605bd752013-04-12 16:34:34 +0530279 * Hub Status & Hub Change bit masks
wdenk012771d2002-03-08 21:31:05 +0000280 */
281#define HUB_STATUS_LOCAL_POWER 0x0001
282#define HUB_STATUS_OVERCURRENT 0x0002
283
284#define HUB_CHANGE_LOCAL_POWER 0x0001
285#define HUB_CHANGE_OVERCURRENT 0x0002
286
287#endif /*_USB_DEFS_H_ */