summaryrefslogtreecommitdiff
path: root/drivers/usb/musbhdrc.h
blob: fba253e40b17b354cfaa0f7c8206e657a9f1f023 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
/******************************************************************
 * Copyright 2005 Mentor Graphics Corporation
 * Copyright (C) 2005-2006 by Texas Instruments
 *
 * This file is part of the Inventra Controller Driver for Linux.
 *
 * The Inventra Controller Driver for Linux is free software; you
 * can redistribute it and/or modify it under the terms of the GNU
 * General Public License version 2 as published by the Free Software
 * Foundation.
 *
 * The Inventra Controller Driver for Linux 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 The Inventra Controller Driver for Linux ; if not,
 * write to the Free Software Foundation, Inc., 59 Temple Place,
 * Suite 330, Boston, MA  02111-1307  USA
 *
 * ANY DOWNLOAD, USE, REPRODUCTION, MODIFICATION OR DISTRIBUTION
 * OF THIS DRIVER INDICATES YOUR COMPLETE AND UNCONDITIONAL ACCEPTANCE
 * OF THOSE TERMS.THIS DRIVER IS PROVIDED "AS IS" AND MENTOR GRAPHICS
 * MAKES NO WARRANTIES, EXPRESS OR IMPLIED, RELATED TO THIS DRIVER.
 * MENTOR GRAPHICS SPECIFICALLY DISCLAIMS ALL IMPLIED WARRANTIES
 * OF MERCHANTABILITY; FITNESS FOR A PARTICULAR PURPOSE AND
 * NON-INFRINGEMENT.  MENTOR GRAPHICS DOES NOT PROVIDE SUPPORT
 * SERVICES OR UPDATES FOR THIS DRIVER, EVEN IF YOU ARE A MENTOR
 * GRAPHICS SUPPORT CUSTOMER.
 ******************************************************************/

#ifndef __MUSB_HDRC_DEFS_H__
#define __MUSB_HDRC_DEFS_H__

/*
 * HDRC-specific definitions
 */

#define MGC_MAX_USB_ENDS	   4

#define MGC_END0_FIFOSIZE	   64	/* this is non-configurable */

/*
 *	   MUSBMHDRC Register map
 */

/* Common USB registers */

#define MGC_O_HDRC_FADDR	0x00	/* 8-bit */
#define MGC_O_HDRC_POWER	0x01	/* 8-bit */

#define MGC_O_HDRC_INTRTX	0x02	/* 16-bit */
#define MGC_O_HDRC_INTRRX		0x04
#define MGC_O_HDRC_INTRTXE		0x06
#define MGC_O_HDRC_INTRRXE		0x08
#define MGC_O_HDRC_INTRUSB		0x0A	/* 8 bit */
#define MGC_O_HDRC_INTRUSBE 	0x0B	/* 8 bit */
#define MGC_O_HDRC_FRAME		0x0C
#define MGC_O_HDRC_INDEX		0x0E	/* 8 bit */
#define MGC_O_HDRC_TESTMODE 	0x0F	/* 8 bit */

/* Get offset for a given FIFO from musb->pRegs */
#ifdef	CONFIG_USB_TUSB6010
#define MUSB_FIFO_OFFSET(epnum) (0x200 + ((epnum) * 0x20))
#else
#define MUSB_FIFO_OFFSET(epnum) (epnum * 4)
#endif

/* Additional Control Registers */

#define MGC_O_HDRC_DEVCTL	0x60	/* 8 bit */

/* These are always controlled through the INDEX register */
#define MGC_O_HDRC_TXFIFOSZ 0x62	/* 8-bit (see masks) */
#define MGC_O_HDRC_RXFIFOSZ 0x63	/* 8-bit (see masks) */
#define MGC_O_HDRC_TXFIFOADD	0x64	/* 16-bit offset shifted right 3 */
#define MGC_O_HDRC_RXFIFOADD	0x66	/* 16-bit offset shifted right 3 */

// vctrl/vstatus:  optional vendor utmi+phy register at 0x68
#define MGC_O_HDRC_HWVERS	0x6C	/* 8 bit */

#define MGC_O_HDRC_EPINFO	0x78	/* 8 bit */
#define MGC_O_HDRC_RAMINFO	0x79	/* 8 bit */
#define MGC_O_HDRC_LINKINFO 0x7a	/* 8 bit */
#define MGC_O_HDRC_VPLEN	0x7b	/* 8 bit */
#define MGC_O_HDRC_HS_EOF1	0x7c	/* 8 bit */
#define MGC_O_HDRC_FS_EOF1	0x7d	/* 8 bit */
#define MGC_O_HDRC_LS_EOF1	0x7e	/* 8 bit */

/* offsets to endpoint registers */
#define MGC_O_HDRC_TXMAXP	0x00
#define MGC_O_HDRC_TXCSR	0x02
#define MGC_O_HDRC_CSR0 	MGC_O_HDRC_TXCSR	/* re-used for EP0 */
#define MGC_O_HDRC_RXMAXP	0x04
#define MGC_O_HDRC_RXCSR	0x06
#define MGC_O_HDRC_RXCOUNT	0x08
#define MGC_O_HDRC_COUNT0	MGC_O_HDRC_RXCOUNT	/* re-used for EP0 */
#define MGC_O_HDRC_TXTYPE	0x0A
#define MGC_O_HDRC_TYPE0	MGC_O_HDRC_TXTYPE	/* re-used for EP0 */
#define MGC_O_HDRC_TXINTERVAL	0x0B
#define MGC_O_HDRC_NAKLIMIT0	MGC_O_HDRC_TXINTERVAL	/* re-used for EP0 */
#define MGC_O_HDRC_RXTYPE	0x0C
#define MGC_O_HDRC_RXINTERVAL	0x0D
#define MGC_O_HDRC_FIFOSIZE 0x0F
#define MGC_O_HDRC_CONFIGDATA	MGC_O_HDRC_FIFOSIZE /* re-used for EP0 */

/* offsets to endpoint registers in indexed model (using INDEX register) */
#define MGC_INDEXED_OFFSET(_bOffset)	\
	(0x10 + (_bOffset))

/* offsets to endpoint registers in flat models */
#define MGC_FLAT_OFFSET(_bEnd, _bOffset)	\
	(0x100 + (0x10*(_bEnd)) + (_bOffset))

#ifdef CONFIG_USB_TUSB6010
/* TUSB6010 EP0 configuration register is special */
#define MGC_TUSB_OFFSET(_bEnd, _bOffset)	\
	(0x10 + _bOffset)
#include "tusb6010.h"		/* needed "only" for TUSB_EP0_CONF */
#endif

/* "bus control"/target registers, for host side multipoint (external hubs) */
#define MGC_O_HDRC_TXFUNCADDR	0x00
#define MGC_O_HDRC_TXHUBADDR	0x02
#define MGC_O_HDRC_TXHUBPORT	0x03

#define MGC_O_HDRC_RXFUNCADDR	0x04
#define MGC_O_HDRC_RXHUBADDR	0x06
#define MGC_O_HDRC_RXHUBPORT	0x07

#define MGC_BUSCTL_OFFSET(_bEnd, _bOffset) \
	(0x80 + (8*(_bEnd)) + (_bOffset))

/*
 *	   MUSBHDRC Register bit masks
 */

/* POWER */

#define MGC_M_POWER_ISOUPDATE	0x80
#define MGC_M_POWER_SOFTCONN	0x40
#define MGC_M_POWER_HSENAB	0x20
#define MGC_M_POWER_HSMODE	0x10
#define MGC_M_POWER_RESET		0x08
#define MGC_M_POWER_RESUME		0x04
#define MGC_M_POWER_SUSPENDM	0x02
#define MGC_M_POWER_ENSUSPEND	0x01

/* INTRUSB */
#define MGC_M_INTR_SUSPEND	  0x01
#define MGC_M_INTR_RESUME	  0x02
#define MGC_M_INTR_RESET	  0x04
#define MGC_M_INTR_BABBLE	  0x04
#define MGC_M_INTR_SOF		  0x08
#define MGC_M_INTR_CONNECT	  0x10
#define MGC_M_INTR_DISCONNECT 0x20
#define MGC_M_INTR_SESSREQ	  0x40
#define MGC_M_INTR_VBUSERROR  0x80	/* FOR SESSION END */

/* DEVCTL */
#define MGC_M_DEVCTL_BDEVICE	0x80
#define MGC_M_DEVCTL_FSDEV		0x40
#define MGC_M_DEVCTL_LSDEV		0x20
#define MGC_M_DEVCTL_VBUS		0x18
#define MGC_S_DEVCTL_VBUS		3
#define MGC_M_DEVCTL_HM 		0x04
#define MGC_M_DEVCTL_HR 		0x02
#define MGC_M_DEVCTL_SESSION	0x01

/* TESTMODE */

#define MGC_M_TEST_FORCE_HOST	0x80
#define MGC_M_TEST_FIFO_ACCESS	0x40
#define MGC_M_TEST_FORCE_FS 	0x20
#define MGC_M_TEST_FORCE_HS 	0x10
#define MGC_M_TEST_PACKET		0x08
#define MGC_M_TEST_K			0x04
#define MGC_M_TEST_J			0x02
#define MGC_M_TEST_SE0_NAK		0x01

/* allocate for double-packet buffering (effectively doubles assigned _SIZE) */
#define MGC_M_FIFOSZ_DPB	0x10
/* allocation size (8, 16, 32, ... 4096) */
#define MGC_M_FIFOSZ_SIZE	0x0f

/* CSR0 */
#define MGC_M_CSR0_FLUSHFIFO	  0x0100
#define MGC_M_CSR0_TXPKTRDY 	  0x0002
#define MGC_M_CSR0_RXPKTRDY 	  0x0001

/* CSR0 in Peripheral mode */
#define MGC_M_CSR0_P_SVDSETUPEND  0x0080
#define MGC_M_CSR0_P_SVDRXPKTRDY  0x0040
#define MGC_M_CSR0_P_SENDSTALL	  0x0020
#define MGC_M_CSR0_P_SETUPEND	  0x0010
#define MGC_M_CSR0_P_DATAEND	  0x0008
#define MGC_M_CSR0_P_SENTSTALL	  0x0004

/* CSR0 in Host mode */
#define MGC_M_CSR0_H_DIS_PING	0x0800
#define MGC_M_CSR0_H_WR_DATATOGGLE	 0x0400 /* set to allow setting: */
#define MGC_M_CSR0_H_DATATOGGLE 	0x0200	/* data toggle control */
#define MGC_M_CSR0_H_NAKTIMEOUT   0x0080
#define MGC_M_CSR0_H_STATUSPKT	  0x0040
#define MGC_M_CSR0_H_REQPKT 	  0x0020
#define MGC_M_CSR0_H_ERROR		  0x0010
#define MGC_M_CSR0_H_SETUPPKT	  0x0008
#define MGC_M_CSR0_H_RXSTALL	  0x0004

/* CSR0 bits to avoid zeroing (write zero clears, write 1 ignored) */
#define MGC_M_CSR0_P_WZC_BITS	\
	( MGC_M_CSR0_P_SENTSTALL )
#define MGC_M_CSR0_H_WZC_BITS	\
	( MGC_M_CSR0_H_NAKTIMEOUT | MGC_M_CSR0_H_RXSTALL \
	| MGC_M_CSR0_RXPKTRDY )


/* TxType/RxType */
#define MGC_M_TYPE_SPEED	0xc0
#define MGC_S_TYPE_SPEED	6
#define MGC_TYPE_SPEED_HIGH 1
#define MGC_TYPE_SPEED_FULL 2
#define MGC_TYPE_SPEED_LOW	3
#define MGC_M_TYPE_PROTO	0x30	/* implicitly zero for ep0 */
#define MGC_S_TYPE_PROTO	4
#define MGC_M_TYPE_REMOTE_END	0xf /* implicitly zero for ep0 */

/* CONFIGDATA */

#define MGC_M_CONFIGDATA_MPRXE		0x80	/* auto bulk pkt combining */
#define MGC_M_CONFIGDATA_MPTXE		0x40	/* auto bulk pkt splitting */
#define MGC_M_CONFIGDATA_BIGENDIAN	0x20
#define MGC_M_CONFIGDATA_HBRXE		0x10	/* HB-ISO for RX */
#define MGC_M_CONFIGDATA_HBTXE		0x08	/* HB-ISO for TX */
#define MGC_M_CONFIGDATA_DYNFIFO	0x04	/* dynamic FIFO sizing */
#define MGC_M_CONFIGDATA_SOFTCONE	0x02	/* SoftConnect */
#define MGC_M_CONFIGDATA_UTMIDW 	0x01	/* data width 0/1 => 8/16bits */

/* TXCSR in Peripheral and Host mode */

#define MGC_M_TXCSR_AUTOSET 	  0x8000
#define MGC_M_TXCSR_MODE		  0x2000
#define MGC_M_TXCSR_DMAENAB 	  0x1000
#define MGC_M_TXCSR_FRCDATATOG	  0x0800
#define MGC_M_TXCSR_DMAMODE 	  0x0400
#define MGC_M_TXCSR_CLRDATATOG	  0x0040
#define MGC_M_TXCSR_FLUSHFIFO	  0x0008
#define MGC_M_TXCSR_FIFONOTEMPTY  0x0002
#define MGC_M_TXCSR_TXPKTRDY	  0x0001

/* TXCSR in Peripheral mode */

#define MGC_M_TXCSR_P_ISO		  0x4000
#define MGC_M_TXCSR_P_INCOMPTX	  0x0080
#define MGC_M_TXCSR_P_SENTSTALL   0x0020
#define MGC_M_TXCSR_P_SENDSTALL   0x0010
#define MGC_M_TXCSR_P_UNDERRUN	  0x0004

/* TXCSR in Host mode */

#define MGC_M_TXCSR_H_WR_DATATOGGLE   0x0200
#define MGC_M_TXCSR_H_DATATOGGLE	  0x0100
#define MGC_M_TXCSR_H_NAKTIMEOUT  0x0080
#define MGC_M_TXCSR_H_RXSTALL	  0x0020
#define MGC_M_TXCSR_H_ERROR 	  0x0004

/* TXCSR bits to avoid zeroing (write zero clears, write 1 ignored) */
#define MGC_M_TXCSR_P_WZC_BITS	\
	( MGC_M_TXCSR_P_INCOMPTX | MGC_M_TXCSR_P_SENTSTALL \
	| MGC_M_TXCSR_P_UNDERRUN | MGC_M_TXCSR_FIFONOTEMPTY )
#define MGC_M_TXCSR_H_WZC_BITS	\
	( MGC_M_TXCSR_H_NAKTIMEOUT | MGC_M_TXCSR_H_RXSTALL \
	| MGC_M_TXCSR_H_ERROR | MGC_M_TXCSR_FIFONOTEMPTY )


/* RXCSR in Peripheral and Host mode */

#define MGC_M_RXCSR_AUTOCLEAR	  0x8000
#define MGC_M_RXCSR_DMAENAB 	  0x2000
#define MGC_M_RXCSR_DISNYET 	  0x1000
#define MGC_M_RXCSR_PID_ERR 	  0x1000
#define MGC_M_RXCSR_DMAMODE 	  0x0800
#define MGC_M_RXCSR_INCOMPRX	  0x0100
#define MGC_M_RXCSR_CLRDATATOG	  0x0080
#define MGC_M_RXCSR_FLUSHFIFO	  0x0010
#define MGC_M_RXCSR_DATAERROR	  0x0008
#define MGC_M_RXCSR_FIFOFULL	  0x0002
#define MGC_M_RXCSR_RXPKTRDY	  0x0001

/* RXCSR in Peripheral mode */

#define MGC_M_RXCSR_P_ISO		  0x4000
#define MGC_M_RXCSR_P_SENTSTALL   0x0040
#define MGC_M_RXCSR_P_SENDSTALL   0x0020
#define MGC_M_RXCSR_P_OVERRUN	  0x0004

/* RXCSR in Host mode */

#define MGC_M_RXCSR_H_AUTOREQ	  0x4000
#define MGC_M_RXCSR_H_WR_DATATOGGLE   0x0400
#define MGC_M_RXCSR_H_DATATOGGLE		0x0200
#define MGC_M_RXCSR_H_RXSTALL	  0x0040
#define MGC_M_RXCSR_H_REQPKT	  0x0020
#define MGC_M_RXCSR_H_ERROR 	  0x0004

/* RXCSR bits to avoid zeroing (write zero clears, write 1 ignored) */
#define MGC_M_RXCSR_P_WZC_BITS	\
	( MGC_M_RXCSR_P_SENTSTALL | MGC_M_RXCSR_P_OVERRUN \
	| MGC_M_RXCSR_RXPKTRDY )
#define MGC_M_RXCSR_H_WZC_BITS	\
	( MGC_M_RXCSR_H_RXSTALL | MGC_M_RXCSR_H_ERROR \
	| MGC_M_RXCSR_DATAERROR | MGC_M_RXCSR_RXPKTRDY )


/* HUBADDR */
#define MGC_M_HUBADDR_MULTI_TT		0x80


#endif	/* __MUSB_HDRC_DEFS_H__ */