[people/ms/u-boot.git] / include / usb_defs.h

/*
 * (C) Copyright 2001
 * Denis Peter, MPL AG Switzerland
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 * Note: Part of this code has been derived from linux
 *
 */
#ifndef _USB_DEFS_H_
#define _USB_DEFS_H_


/* Everything is aribtrary */
#define USB_ALTSETTINGALLOC          4
#define USB_MAXALTSETTING	           128  /* Hard limit */

#define USB_MAX_DEVICE              32
#define USB_MAXCONFIG		            8
#define USB_MAXINTERFACES	          8
#define USB_MAXENDPOINTS	          16
#define USB_MAXCHILDREN  						8 	/* This is arbitrary */
#define USB_MAX_HUB									16

#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */

/* USB constants */

/* Device and/or Interface Class codes */
#define USB_CLASS_PER_INTERFACE  0	/* for DeviceClass */
#define USB_CLASS_AUDIO          1
#define USB_CLASS_COMM           2
#define USB_CLASS_HID            3
#define USB_CLASS_PRINTER	       7
#define USB_CLASS_MASS_STORAGE   8
#define USB_CLASS_HUB            9
#define USB_CLASS_DATA           10
#define USB_CLASS_VENDOR_SPEC    0xff

/* some HID sub classes */
#define USB_SUB_HID_NONE        0
#define USB_SUB_HID_BOOT        1

/* some UID Protocols */
#define USB_PROT_HID_NONE       0
#define USB_PROT_HID_KEYBOARD   1
#define USB_PROT_HID_MOUSE      2


/* Sub STORAGE Classes */
#define US_SC_RBC              1		/* Typically, flash devices */
#define US_SC_8020             2		/* CD-ROM */
#define US_SC_QIC              3		/* QIC-157 Tapes */
#define US_SC_UFI              4		/* Floppy */
#define US_SC_8070             5		/* Removable media */
#define US_SC_SCSI             6		/* Transparent */
#define US_SC_MIN              US_SC_RBC
#define US_SC_MAX              US_SC_SCSI

/* STORAGE Protocols */
#define US_PR_CB               1		/* Control/Bulk w/o interrupt */
#define US_PR_CBI              0		/* Control/Bulk/Interrupt */
#define US_PR_BULK             0x50		/* bulk only */

/* USB types */
#define USB_TYPE_STANDARD   (0x00 << 5)
#define USB_TYPE_CLASS      (0x01 << 5)
#define USB_TYPE_VENDOR     (0x02 << 5)
#define USB_TYPE_RESERVED   (0x03 << 5)

/* USB recipients */
#define USB_RECIP_DEVICE      0x00
#define USB_RECIP_INTERFACE   0x01
#define USB_RECIP_ENDPOINT    0x02
#define USB_RECIP_OTHER       0x03

/* USB directions */
#define USB_DIR_OUT           0
#define USB_DIR_IN            0x80

/* Descriptor types */
#define USB_DT_DEVICE        0x01
#define USB_DT_CONFIG        0x02
#define USB_DT_STRING        0x03
#define USB_DT_INTERFACE     0x04
#define USB_DT_ENDPOINT      0x05

#define USB_DT_HID          (USB_TYPE_CLASS | 0x01)
#define USB_DT_REPORT       (USB_TYPE_CLASS | 0x02)
#define USB_DT_PHYSICAL     (USB_TYPE_CLASS | 0x03)
#define USB_DT_HUB          (USB_TYPE_CLASS | 0x09)

/* Descriptor sizes per descriptor type */
#define USB_DT_DEVICE_SIZE      18
#define USB_DT_CONFIG_SIZE      9
#define USB_DT_INTERFACE_SIZE   9
#define USB_DT_ENDPOINT_SIZE    7
#define USB_DT_ENDPOINT_AUDIO_SIZE  9	/* Audio extension */
#define USB_DT_HUB_NONVAR_SIZE  7
#define USB_DT_HID_SIZE         9

/* Endpoints */
#define USB_ENDPOINT_NUMBER_MASK  0x0f	/* in bEndpointAddress */
#define USB_ENDPOINT_DIR_MASK     0x80

#define USB_ENDPOINT_XFERTYPE_MASK 0x03	/* in bmAttributes */
#define USB_ENDPOINT_XFER_CONTROL  0
#define USB_ENDPOINT_XFER_ISOC     1
#define USB_ENDPOINT_XFER_BULK     2
#define USB_ENDPOINT_XFER_INT      3

/* USB Packet IDs (PIDs) */
#define USB_PID_UNDEF_0             0xf0
#define USB_PID_OUT                 0xe1
#define USB_PID_ACK                 0xd2
#define USB_PID_DATA0               0xc3
#define USB_PID_UNDEF_4             0xb4
#define USB_PID_SOF                 0xa5
#define USB_PID_UNDEF_6             0x96
#define USB_PID_UNDEF_7             0x87
#define USB_PID_UNDEF_8             0x78
#define USB_PID_IN                  0x69
#define USB_PID_NAK                 0x5a
#define USB_PID_DATA1               0x4b
#define USB_PID_PREAMBLE            0x3c
#define USB_PID_SETUP               0x2d
#define USB_PID_STALL               0x1e
#define USB_PID_UNDEF_F             0x0f

/* Standard requests */
#define USB_REQ_GET_STATUS          0x00
#define USB_REQ_CLEAR_FEATURE       0x01
#define USB_REQ_SET_FEATURE         0x03
#define USB_REQ_SET_ADDRESS         0x05
#define USB_REQ_GET_DESCRIPTOR      0x06
#define USB_REQ_SET_DESCRIPTOR      0x07
#define USB_REQ_GET_CONFIGURATION   0x08
#define USB_REQ_SET_CONFIGURATION   0x09
#define USB_REQ_GET_INTERFACE       0x0A
#define USB_REQ_SET_INTERFACE       0x0B
#define USB_REQ_SYNCH_FRAME         0x0C

/* HID requests */
#define USB_REQ_GET_REPORT          0x01
#define USB_REQ_GET_IDLE            0x02
#define USB_REQ_GET_PROTOCOL        0x03
#define USB_REQ_SET_REPORT          0x09
#define USB_REQ_SET_IDLE            0x0A
#define USB_REQ_SET_PROTOCOL        0x0B


/* "pipe" definitions */

#define PIPE_ISOCHRONOUS    0
#define PIPE_INTERRUPT      1
#define PIPE_CONTROL        2
#define PIPE_BULK           3
#define PIPE_DEVEP_MASK     0x0007ff00

#define USB_ISOCHRONOUS    0
#define USB_INTERRUPT      1
#define USB_CONTROL        2
#define USB_BULK           3

/* USB-status codes: */
#define USB_ST_ACTIVE           0x1		/* TD is active */
#define USB_ST_STALLED          0x2		/* TD is stalled */
#define USB_ST_BUF_ERR          0x4		/* buffer error */
#define USB_ST_BABBLE_DET       0x8		/* Babble detected */
#define USB_ST_NAK_REC          0x10	/* NAK Received*/
#define USB_ST_CRC_ERR          0x20	/* CRC/timeout Error */
#define USB_ST_BIT_ERR          0x40	/* Bitstuff error */
#define USB_ST_NOT_PROC         0x80000000L	/* Not yet processed */


/*************************************************************************
 * Hub defines
 */

/*
 * Hub request types
 */

#define USB_RT_HUB	(USB_TYPE_CLASS | USB_RECIP_DEVICE)
#define USB_RT_PORT	(USB_TYPE_CLASS | USB_RECIP_OTHER)

/*
 * Hub Class feature numbers
 */
#define C_HUB_LOCAL_POWER   0
#define C_HUB_OVER_CURRENT  1

/*
 * Port feature numbers
 */
#define USB_PORT_FEAT_CONNECTION     0
#define USB_PORT_FEAT_ENABLE         1
#define USB_PORT_FEAT_SUSPEND        2
#define USB_PORT_FEAT_OVER_CURRENT   3
#define USB_PORT_FEAT_RESET          4
#define USB_PORT_FEAT_POWER          8
#define USB_PORT_FEAT_LOWSPEED       9
#define USB_PORT_FEAT_C_CONNECTION   16
#define USB_PORT_FEAT_C_ENABLE       17
#define USB_PORT_FEAT_C_SUSPEND      18
#define USB_PORT_FEAT_C_OVER_CURRENT 19
#define USB_PORT_FEAT_C_RESET        20

/* wPortStatus bits */
#define USB_PORT_STAT_CONNECTION    0x0001
#define USB_PORT_STAT_ENABLE        0x0002
#define USB_PORT_STAT_SUSPEND       0x0004
#define USB_PORT_STAT_OVERCURRENT   0x0008
#define USB_PORT_STAT_RESET         0x0010
#define USB_PORT_STAT_POWER         0x0100
#define USB_PORT_STAT_LOW_SPEED     0x0200

/* wPortChange bits */
#define USB_PORT_STAT_C_CONNECTION  0x0001
#define USB_PORT_STAT_C_ENABLE      0x0002
#define USB_PORT_STAT_C_SUSPEND     0x0004
#define USB_PORT_STAT_C_OVERCURRENT 0x0008
#define USB_PORT_STAT_C_RESET       0x0010

/* wHubCharacteristics (masks) */
#define HUB_CHAR_LPSM               0x0003
#define HUB_CHAR_COMPOUND           0x0004
#define HUB_CHAR_OCPM               0x0018

/*
 *Hub Status & Hub Change bit masks
 */
#define HUB_STATUS_LOCAL_POWER	0x0001
#define HUB_STATUS_OVERCURRENT	0x0002

#define HUB_CHANGE_LOCAL_POWER	0x0001
#define HUB_CHANGE_OVERCURRENT	0x0002

#endif /*_USB_DEFS_H_ */
Commit	Line	Data
012771d8 WD	1	/*
	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
	29
	30	/* Everything is aribtrary */
	31	#define USB_ALTSETTINGALLOC 4
	32	#define USB_MAXALTSETTING 128 /* Hard limit */
	33
	34	#define USB_MAX_DEVICE 32
	35	#define USB_MAXCONFIG 8
	36	#define USB_MAXINTERFACES 8
	37	#define USB_MAXENDPOINTS 16
	38	#define USB_MAXCHILDREN 8 /* This is arbitrary */
	39	#define USB_MAX_HUB 16
	40
	41	#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
	42
	43	/* USB constants */
	44
	45	/* Device and/or Interface Class codes */
	46	#define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
	47	#define USB_CLASS_AUDIO 1
	48	#define USB_CLASS_COMM 2
	49	#define USB_CLASS_HID 3
	50	#define USB_CLASS_PRINTER 7
	51	#define USB_CLASS_MASS_STORAGE 8
	52	#define USB_CLASS_HUB 9
	53	#define USB_CLASS_DATA 10
	54	#define USB_CLASS_VENDOR_SPEC 0xff
	55
	56	/* some HID sub classes */
	57	#define USB_SUB_HID_NONE 0
	58	#define USB_SUB_HID_BOOT 1
	59
	60	/* some UID Protocols */
	61	#define USB_PROT_HID_NONE 0
	62	#define USB_PROT_HID_KEYBOARD 1
	63	#define USB_PROT_HID_MOUSE 2
	64
65
66	/* Sub STORAGE Classes */
67	#define US_SC_RBC 1 /* Typically, flash devices */
68	#define US_SC_8020 2 /* CD-ROM */
69	#define US_SC_QIC 3 /* QIC-157 Tapes */
70	#define US_SC_UFI 4 /* Floppy */
71	#define US_SC_8070 5 /* Removable media */
72	#define US_SC_SCSI 6 /* Transparent */
73	#define US_SC_MIN US_SC_RBC
74	#define US_SC_MAX US_SC_SCSI
75
76	/* STORAGE Protocols */
77	#define US_PR_CB 1 /* Control/Bulk w/o interrupt */
78	#define US_PR_CBI 0 /* Control/Bulk/Interrupt */
79	#define US_PR_BULK 0x50 /* bulk only */
80
81	/* USB types */
82	#define USB_TYPE_STANDARD (0x00 << 5)
83	#define USB_TYPE_CLASS (0x01 << 5)
84	#define USB_TYPE_VENDOR (0x02 << 5)
85	#define USB_TYPE_RESERVED (0x03 << 5)
86
87	/* USB recipients */
88	#define USB_RECIP_DEVICE 0x00
89	#define USB_RECIP_INTERFACE 0x01
90	#define USB_RECIP_ENDPOINT 0x02
91	#define USB_RECIP_OTHER 0x03
92
93	/* USB directions */
94	#define USB_DIR_OUT 0
95	#define USB_DIR_IN 0x80
96
97	/* Descriptor types */
98	#define USB_DT_DEVICE 0x01
99	#define USB_DT_CONFIG 0x02
100	#define USB_DT_STRING 0x03
101	#define USB_DT_INTERFACE 0x04
102	#define USB_DT_ENDPOINT 0x05
103
104	#define USB_DT_HID (USB_TYPE_CLASS \| 0x01)
105	#define USB_DT_REPORT (USB_TYPE_CLASS \| 0x02)
106	#define USB_DT_PHYSICAL (USB_TYPE_CLASS \| 0x03)
107	#define USB_DT_HUB (USB_TYPE_CLASS \| 0x09)
108
109	/* Descriptor sizes per descriptor type */
110	#define USB_DT_DEVICE_SIZE 18
111	#define USB_DT_CONFIG_SIZE 9
112	#define USB_DT_INTERFACE_SIZE 9
113	#define USB_DT_ENDPOINT_SIZE 7
114	#define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
115	#define USB_DT_HUB_NONVAR_SIZE 7
116	#define USB_DT_HID_SIZE 9
117
118	/* Endpoints */
119	#define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
120	#define USB_ENDPOINT_DIR_MASK 0x80
121
122	#define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
123	#define USB_ENDPOINT_XFER_CONTROL 0
124	#define USB_ENDPOINT_XFER_ISOC 1
125	#define USB_ENDPOINT_XFER_BULK 2
126	#define USB_ENDPOINT_XFER_INT 3
127
128	/* USB Packet IDs (PIDs) */
129	#define USB_PID_UNDEF_0 0xf0
130	#define USB_PID_OUT 0xe1
131	#define USB_PID_ACK 0xd2
132	#define USB_PID_DATA0 0xc3
133	#define USB_PID_UNDEF_4 0xb4
134	#define USB_PID_SOF 0xa5
135	#define USB_PID_UNDEF_6 0x96
136	#define USB_PID_UNDEF_7 0x87
137	#define USB_PID_UNDEF_8 0x78
138	#define USB_PID_IN 0x69
139	#define USB_PID_NAK 0x5a
140	#define USB_PID_DATA1 0x4b
141	#define USB_PID_PREAMBLE 0x3c
142	#define USB_PID_SETUP 0x2d
143	#define USB_PID_STALL 0x1e
144	#define USB_PID_UNDEF_F 0x0f
145
146	/* Standard requests */
147	#define USB_REQ_GET_STATUS 0x00
148	#define USB_REQ_CLEAR_FEATURE 0x01
149	#define USB_REQ_SET_FEATURE 0x03
150	#define USB_REQ_SET_ADDRESS 0x05
151	#define USB_REQ_GET_DESCRIPTOR 0x06
152	#define USB_REQ_SET_DESCRIPTOR 0x07
153	#define USB_REQ_GET_CONFIGURATION 0x08
154	#define USB_REQ_SET_CONFIGURATION 0x09
155	#define USB_REQ_GET_INTERFACE 0x0A
156	#define USB_REQ_SET_INTERFACE 0x0B
157	#define USB_REQ_SYNCH_FRAME 0x0C
158
159	/* HID requests */
160	#define USB_REQ_GET_REPORT 0x01
161	#define USB_REQ_GET_IDLE 0x02
162	#define USB_REQ_GET_PROTOCOL 0x03
163	#define USB_REQ_SET_REPORT 0x09
164	#define USB_REQ_SET_IDLE 0x0A
165	#define USB_REQ_SET_PROTOCOL 0x0B
166
167
168	/* "pipe" definitions */
169
170	#define PIPE_ISOCHRONOUS 0
171	#define PIPE_INTERRUPT 1
172	#define PIPE_CONTROL 2
173	#define PIPE_BULK 3
174	#define PIPE_DEVEP_MASK 0x0007ff00
175
176	#define USB_ISOCHRONOUS 0
177	#define USB_INTERRUPT 1
178	#define USB_CONTROL 2
179	#define USB_BULK 3
180
181	/* USB-status codes: */
182	#define USB_ST_ACTIVE 0x1 /* TD is active */
183	#define USB_ST_STALLED 0x2 /* TD is stalled */
184	#define USB_ST_BUF_ERR 0x4 /* buffer error */
185	#define USB_ST_BABBLE_DET 0x8 /* Babble detected */
186	#define USB_ST_NAK_REC 0x10 /* NAK Received*/
187	#define USB_ST_CRC_ERR 0x20 /* CRC/timeout Error */
188	#define USB_ST_BIT_ERR 0x40 /* Bitstuff error */
189	#define USB_ST_NOT_PROC 0x80000000L /* Not yet processed */
190
191
192
193	/*************************************************************************
194	* Hub defines
195	*/
196
197	/*
198	* Hub request types
199	*/
200
201	#define USB_RT_HUB (USB_TYPE_CLASS \| USB_RECIP_DEVICE)
202	#define USB_RT_PORT (USB_TYPE_CLASS \| USB_RECIP_OTHER)
203
204	/*
205	* Hub Class feature numbers
206	*/
207	#define C_HUB_LOCAL_POWER 0
208	#define C_HUB_OVER_CURRENT 1
209
210	/*
211	* Port feature numbers
212	*/
213	#define USB_PORT_FEAT_CONNECTION 0
214	#define USB_PORT_FEAT_ENABLE 1
215	#define USB_PORT_FEAT_SUSPEND 2
216	#define USB_PORT_FEAT_OVER_CURRENT 3
217	#define USB_PORT_FEAT_RESET 4
218	#define USB_PORT_FEAT_POWER 8
219	#define USB_PORT_FEAT_LOWSPEED 9
220	#define USB_PORT_FEAT_C_CONNECTION 16
221	#define USB_PORT_FEAT_C_ENABLE 17
222	#define USB_PORT_FEAT_C_SUSPEND 18
223	#define USB_PORT_FEAT_C_OVER_CURRENT 19
224	#define USB_PORT_FEAT_C_RESET 20
225
226	/* wPortStatus bits */
227	#define USB_PORT_STAT_CONNECTION 0x0001
228	#define USB_PORT_STAT_ENABLE 0x0002
229	#define USB_PORT_STAT_SUSPEND 0x0004
230	#define USB_PORT_STAT_OVERCURRENT 0x0008
231	#define USB_PORT_STAT_RESET 0x0010
232	#define USB_PORT_STAT_POWER 0x0100
233	#define USB_PORT_STAT_LOW_SPEED 0x0200
234
235	/* wPortChange bits */
236	#define USB_PORT_STAT_C_CONNECTION 0x0001
237	#define USB_PORT_STAT_C_ENABLE 0x0002
238	#define USB_PORT_STAT_C_SUSPEND 0x0004
239	#define USB_PORT_STAT_C_OVERCURRENT 0x0008
240	#define USB_PORT_STAT_C_RESET 0x0010
241
242	/* wHubCharacteristics (masks) */
243	#define HUB_CHAR_LPSM 0x0003
244	#define HUB_CHAR_COMPOUND 0x0004
245	#define HUB_CHAR_OCPM 0x0018
246
247	/*
248	*Hub Status & Hub Change bit masks
249	*/
250	#define HUB_STATUS_LOCAL_POWER 0x0001
251	#define HUB_STATUS_OVERCURRENT 0x0002
252
253	#define HUB_CHANGE_LOCAL_POWER 0x0001
254	#define HUB_CHANGE_OVERCURRENT 0x0002
255
256	#endif /_USB_DEFS_H_ /