3 * Denis Peter, MPL AG Switzerland
5 * See file CREDITS for list of people who contributed to this
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.
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.
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,
23 * Note: Part of this code has been derived from linux
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
42 /* some HID sub classes */
43 #define USB_SUB_HID_NONE 0
44 #define USB_SUB_HID_BOOT 1
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
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
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 */
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)
74 #define USB_RECIP_DEVICE 0x00
75 #define USB_RECIP_INTERFACE 0x01
76 #define USB_RECIP_ENDPOINT 0x02
77 #define USB_RECIP_OTHER 0x03
81 #define USB_DIR_IN 0x80
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
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)
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
105 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
106 #define USB_ENDPOINT_DIR_MASK 0x80
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
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
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
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
154 /* "pipe" definitions */
156 #define PIPE_ISOCHRONOUS 0
157 #define PIPE_INTERRUPT 1
158 #define PIPE_CONTROL 2
160 #define PIPE_DEVEP_MASK 0x0007ff00
162 #define USB_ISOCHRONOUS 0
163 #define USB_INTERRUPT 1
164 #define USB_CONTROL 2
167 /* USB-status codes: */
168 #define USB_ST_ACTIVE 0x1 /* TD is active */
169 #define USB_ST_STALLED 0x2 /* TD is stalled */
170 #define USB_ST_BUF_ERR 0x4 /* buffer error */
171 #define USB_ST_BABBLE_DET 0x8 /* Babble detected */
172 #define USB_ST_NAK_REC 0x10 /* NAK Received*/
173 #define USB_ST_CRC_ERR 0x20 /* CRC/timeout Error */
174 #define USB_ST_BIT_ERR 0x40 /* Bitstuff error */
175 #define USB_ST_NOT_PROC 0x80000000L /* Not yet processed */
178 /*************************************************************************
186 #define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE)
187 #define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER)
190 * Hub Class feature numbers
192 #define C_HUB_LOCAL_POWER 0
193 #define C_HUB_OVER_CURRENT 1
196 * Port feature numbers
198 #define USB_PORT_FEAT_CONNECTION 0
199 #define USB_PORT_FEAT_ENABLE 1
200 #define USB_PORT_FEAT_SUSPEND 2
201 #define USB_PORT_FEAT_OVER_CURRENT 3
202 #define USB_PORT_FEAT_RESET 4
203 #define USB_PORT_FEAT_POWER 8
204 #define USB_PORT_FEAT_LOWSPEED 9
205 #define USB_PORT_FEAT_C_CONNECTION 16
206 #define USB_PORT_FEAT_C_ENABLE 17
207 #define USB_PORT_FEAT_C_SUSPEND 18
208 #define USB_PORT_FEAT_C_OVER_CURRENT 19
209 #define USB_PORT_FEAT_C_RESET 20
211 /* wPortStatus bits */
212 #define USB_PORT_STAT_CONNECTION 0x0001
213 #define USB_PORT_STAT_ENABLE 0x0002
214 #define USB_PORT_STAT_SUSPEND 0x0004
215 #define USB_PORT_STAT_OVERCURRENT 0x0008
216 #define USB_PORT_STAT_RESET 0x0010
217 #define USB_PORT_STAT_POWER 0x0100
218 #define USB_PORT_STAT_LOW_SPEED 0x0200
220 /* wPortChange bits */
221 #define USB_PORT_STAT_C_CONNECTION 0x0001
222 #define USB_PORT_STAT_C_ENABLE 0x0002
223 #define USB_PORT_STAT_C_SUSPEND 0x0004
224 #define USB_PORT_STAT_C_OVERCURRENT 0x0008
225 #define USB_PORT_STAT_C_RESET 0x0010
227 /* wHubCharacteristics (masks) */
228 #define HUB_CHAR_LPSM 0x0003
229 #define HUB_CHAR_COMPOUND 0x0004
230 #define HUB_CHAR_OCPM 0x0018
233 *Hub Status & Hub Change bit masks
235 #define HUB_STATUS_LOCAL_POWER 0x0001
236 #define HUB_STATUS_OVERCURRENT 0x0002
238 #define HUB_CHANGE_LOCAL_POWER 0x0001
239 #define HUB_CHANGE_OVERCURRENT 0x0002
241 #endif /*_USB_DEFS_H_ */