2 * MUSB OTG driver register defines
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
25 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #ifndef __MUSB_REGS_H__
36 #define __MUSB_REGS_H__
38 #define MUSB_EP0_FIFOSIZE 64 /* This is non-configurable */
45 #define MUSB_POWER_ISOUPDATE 0x80
46 #define MUSB_POWER_SOFTCONN 0x40
47 #define MUSB_POWER_HSENAB 0x20
48 #define MUSB_POWER_HSMODE 0x10
49 #define MUSB_POWER_RESET 0x08
50 #define MUSB_POWER_RESUME 0x04
51 #define MUSB_POWER_SUSPENDM 0x02
52 #define MUSB_POWER_ENSUSPEND 0x01
55 #define MUSB_INTR_SUSPEND 0x01
56 #define MUSB_INTR_RESUME 0x02
57 #define MUSB_INTR_RESET 0x04
58 #define MUSB_INTR_BABBLE 0x04
59 #define MUSB_INTR_SOF 0x08
60 #define MUSB_INTR_CONNECT 0x10
61 #define MUSB_INTR_DISCONNECT 0x20
62 #define MUSB_INTR_SESSREQ 0x40
63 #define MUSB_INTR_VBUSERROR 0x80 /* For SESSION end */
66 #define MUSB_DEVCTL_BDEVICE 0x80
67 #define MUSB_DEVCTL_FSDEV 0x40
68 #define MUSB_DEVCTL_LSDEV 0x20
69 #define MUSB_DEVCTL_VBUS 0x18
70 #define MUSB_DEVCTL_VBUS_SHIFT 3
71 #define MUSB_DEVCTL_HM 0x04
72 #define MUSB_DEVCTL_HR 0x02
73 #define MUSB_DEVCTL_SESSION 0x01
76 #define MUSB_TEST_FORCE_HOST 0x80
77 #define MUSB_TEST_FIFO_ACCESS 0x40
78 #define MUSB_TEST_FORCE_FS 0x20
79 #define MUSB_TEST_FORCE_HS 0x10
80 #define MUSB_TEST_PACKET 0x08
81 #define MUSB_TEST_K 0x04
82 #define MUSB_TEST_J 0x02
83 #define MUSB_TEST_SE0_NAK 0x01
85 /* Allocate for double-packet buffering (effectively doubles assigned _SIZE) */
86 #define MUSB_FIFOSZ_DPB 0x10
87 /* Allocation size (8, 16, 32, ... 4096) */
88 #define MUSB_FIFOSZ_SIZE 0x0f
91 #define MUSB_CSR0_FLUSHFIFO 0x0100
92 #define MUSB_CSR0_TXPKTRDY 0x0002
93 #define MUSB_CSR0_RXPKTRDY 0x0001
95 /* CSR0 in Peripheral mode */
96 #define MUSB_CSR0_P_SVDSETUPEND 0x0080
97 #define MUSB_CSR0_P_SVDRXPKTRDY 0x0040
98 #define MUSB_CSR0_P_SENDSTALL 0x0020
99 #define MUSB_CSR0_P_SETUPEND 0x0010
100 #define MUSB_CSR0_P_DATAEND 0x0008
101 #define MUSB_CSR0_P_SENTSTALL 0x0004
103 /* CSR0 in Host mode */
104 #define MUSB_CSR0_H_DIS_PING 0x0800
105 #define MUSB_CSR0_H_WR_DATATOGGLE 0x0400 /* Set to allow setting: */
106 #define MUSB_CSR0_H_DATATOGGLE 0x0200 /* Data toggle control */
107 #define MUSB_CSR0_H_NAKTIMEOUT 0x0080
108 #define MUSB_CSR0_H_STATUSPKT 0x0040
109 #define MUSB_CSR0_H_REQPKT 0x0020
110 #define MUSB_CSR0_H_ERROR 0x0010
111 #define MUSB_CSR0_H_SETUPPKT 0x0008
112 #define MUSB_CSR0_H_RXSTALL 0x0004
114 /* CSR0 bits to avoid zeroing (write zero clears, write 1 ignored) */
115 #define MUSB_CSR0_P_WZC_BITS \
116 (MUSB_CSR0_P_SENTSTALL)
117 #define MUSB_CSR0_H_WZC_BITS \
118 (MUSB_CSR0_H_NAKTIMEOUT | MUSB_CSR0_H_RXSTALL \
119 | MUSB_CSR0_RXPKTRDY)
122 #define MUSB_TYPE_SPEED 0xc0
123 #define MUSB_TYPE_SPEED_SHIFT 6
124 #define MUSB_TYPE_PROTO 0x30 /* Implicitly zero for ep0 */
125 #define MUSB_TYPE_PROTO_SHIFT 4
126 #define MUSB_TYPE_REMOTE_END 0xf /* Implicitly zero for ep0 */
129 #define MUSB_CONFIGDATA_MPRXE 0x80 /* Auto bulk pkt combining */
130 #define MUSB_CONFIGDATA_MPTXE 0x40 /* Auto bulk pkt splitting */
131 #define MUSB_CONFIGDATA_BIGENDIAN 0x20
132 #define MUSB_CONFIGDATA_HBRXE 0x10 /* HB-ISO for RX */
133 #define MUSB_CONFIGDATA_HBTXE 0x08 /* HB-ISO for TX */
134 #define MUSB_CONFIGDATA_DYNFIFO 0x04 /* Dynamic FIFO sizing */
135 #define MUSB_CONFIGDATA_SOFTCONE 0x02 /* SoftConnect */
136 #define MUSB_CONFIGDATA_UTMIDW 0x01 /* Data width 0/1 => 8/16bits */
138 /* TXCSR in Peripheral and Host mode */
139 #define MUSB_TXCSR_AUTOSET 0x8000
140 #define MUSB_TXCSR_DMAENAB 0x1000
141 #define MUSB_TXCSR_FRCDATATOG 0x0800
142 #define MUSB_TXCSR_DMAMODE 0x0400
143 #define MUSB_TXCSR_CLRDATATOG 0x0040
144 #define MUSB_TXCSR_FLUSHFIFO 0x0008
145 #define MUSB_TXCSR_FIFONOTEMPTY 0x0002
146 #define MUSB_TXCSR_TXPKTRDY 0x0001
148 /* TXCSR in Peripheral mode */
149 #define MUSB_TXCSR_P_ISO 0x4000
150 #define MUSB_TXCSR_P_INCOMPTX 0x0080
151 #define MUSB_TXCSR_P_SENTSTALL 0x0020
152 #define MUSB_TXCSR_P_SENDSTALL 0x0010
153 #define MUSB_TXCSR_P_UNDERRUN 0x0004
155 /* TXCSR in Host mode */
156 #define MUSB_TXCSR_H_WR_DATATOGGLE 0x0200
157 #define MUSB_TXCSR_H_DATATOGGLE 0x0100
158 #define MUSB_TXCSR_H_NAKTIMEOUT 0x0080
159 #define MUSB_TXCSR_H_RXSTALL 0x0020
160 #define MUSB_TXCSR_H_ERROR 0x0004
162 /* TXCSR bits to avoid zeroing (write zero clears, write 1 ignored) */
163 #define MUSB_TXCSR_P_WZC_BITS \
164 (MUSB_TXCSR_P_INCOMPTX | MUSB_TXCSR_P_SENTSTALL \
165 | MUSB_TXCSR_P_UNDERRUN | MUSB_TXCSR_FIFONOTEMPTY)
166 #define MUSB_TXCSR_H_WZC_BITS \
167 (MUSB_TXCSR_H_NAKTIMEOUT | MUSB_TXCSR_H_RXSTALL \
168 | MUSB_TXCSR_H_ERROR | MUSB_TXCSR_FIFONOTEMPTY)
170 /* RXCSR in Peripheral and Host mode */
171 #define MUSB_RXCSR_AUTOCLEAR 0x8000
172 #define MUSB_RXCSR_DMAENAB 0x2000
173 #define MUSB_RXCSR_DISNYET 0x1000
174 #define MUSB_RXCSR_PID_ERR 0x1000
175 #define MUSB_RXCSR_DMAMODE 0x0800
176 #define MUSB_RXCSR_INCOMPRX 0x0100
177 #define MUSB_RXCSR_CLRDATATOG 0x0080
178 #define MUSB_RXCSR_FLUSHFIFO 0x0010
179 #define MUSB_RXCSR_DATAERROR 0x0008
180 #define MUSB_RXCSR_FIFOFULL 0x0002
181 #define MUSB_RXCSR_RXPKTRDY 0x0001
183 /* RXCSR in Peripheral mode */
184 #define MUSB_RXCSR_P_ISO 0x4000
185 #define MUSB_RXCSR_P_SENTSTALL 0x0040
186 #define MUSB_RXCSR_P_SENDSTALL 0x0020
187 #define MUSB_RXCSR_P_OVERRUN 0x0004
189 /* RXCSR in Host mode */
190 #define MUSB_RXCSR_H_AUTOREQ 0x4000
191 #define MUSB_RXCSR_H_WR_DATATOGGLE 0x0400
192 #define MUSB_RXCSR_H_DATATOGGLE 0x0200
193 #define MUSB_RXCSR_H_RXSTALL 0x0040
194 #define MUSB_RXCSR_H_REQPKT 0x0020
195 #define MUSB_RXCSR_H_ERROR 0x0004
197 /* RXCSR bits to avoid zeroing (write zero clears, write 1 ignored) */
198 #define MUSB_RXCSR_P_WZC_BITS \
199 (MUSB_RXCSR_P_SENTSTALL | MUSB_RXCSR_P_OVERRUN \
200 | MUSB_RXCSR_RXPKTRDY)
201 #define MUSB_RXCSR_H_WZC_BITS \
202 (MUSB_RXCSR_H_RXSTALL | MUSB_RXCSR_H_ERROR \
203 | MUSB_RXCSR_DATAERROR | MUSB_RXCSR_RXPKTRDY)
206 #define MUSB_HUBADDR_MULTI_TT 0x80
209 #ifndef CONFIG_BLACKFIN
212 * Common USB registers
215 #define MUSB_FADDR 0x00 /* 8-bit */
216 #define MUSB_POWER 0x01 /* 8-bit */
218 #define MUSB_INTRTX 0x02 /* 16-bit */
219 #define MUSB_INTRRX 0x04
220 #define MUSB_INTRTXE 0x06
221 #define MUSB_INTRRXE 0x08
222 #define MUSB_INTRUSB 0x0A /* 8 bit */
223 #define MUSB_INTRUSBE 0x0B /* 8 bit */
224 #define MUSB_FRAME 0x0C
225 #define MUSB_INDEX 0x0E /* 8 bit */
226 #define MUSB_TESTMODE 0x0F /* 8 bit */
228 /* Get offset for a given FIFO from musb->mregs */
229 #ifdef CONFIG_USB_TUSB6010
230 #define MUSB_FIFO_OFFSET(epnum) (0x200 + ((epnum) * 0x20))
232 #define MUSB_FIFO_OFFSET(epnum) (0x20 + ((epnum) * 4))
236 * Additional Control Registers
239 #define MUSB_DEVCTL 0x60 /* 8 bit */
241 /* These are always controlled through the INDEX register */
242 #define MUSB_TXFIFOSZ 0x62 /* 8-bit (see masks) */
243 #define MUSB_RXFIFOSZ 0x63 /* 8-bit (see masks) */
244 #define MUSB_TXFIFOADD 0x64 /* 16-bit offset shifted right 3 */
245 #define MUSB_RXFIFOADD 0x66 /* 16-bit offset shifted right 3 */
247 /* REVISIT: vctrl/vstatus: optional vendor utmi+phy register at 0x68 */
248 #define MUSB_HWVERS 0x6C /* 8 bit */
250 #define MUSB_EPINFO 0x78 /* 8 bit */
251 #define MUSB_RAMINFO 0x79 /* 8 bit */
252 #define MUSB_LINKINFO 0x7a /* 8 bit */
253 #define MUSB_VPLEN 0x7b /* 8 bit */
254 #define MUSB_HS_EOF1 0x7c /* 8 bit */
255 #define MUSB_FS_EOF1 0x7d /* 8 bit */
256 #define MUSB_LS_EOF1 0x7e /* 8 bit */
258 /* Offsets to endpoint registers */
259 #define MUSB_TXMAXP 0x00
260 #define MUSB_TXCSR 0x02
261 #define MUSB_CSR0 MUSB_TXCSR /* Re-used for EP0 */
262 #define MUSB_RXMAXP 0x04
263 #define MUSB_RXCSR 0x06
264 #define MUSB_RXCOUNT 0x08
265 #define MUSB_COUNT0 MUSB_RXCOUNT /* Re-used for EP0 */
266 #define MUSB_TXTYPE 0x0A
267 #define MUSB_TYPE0 MUSB_TXTYPE /* Re-used for EP0 */
268 #define MUSB_TXINTERVAL 0x0B
269 #define MUSB_NAKLIMIT0 MUSB_TXINTERVAL /* Re-used for EP0 */
270 #define MUSB_RXTYPE 0x0C
271 #define MUSB_RXINTERVAL 0x0D
272 #define MUSB_FIFOSIZE 0x0F
273 #define MUSB_CONFIGDATA MUSB_FIFOSIZE /* Re-used for EP0 */
275 /* Offsets to endpoint registers in indexed model (using INDEX register) */
276 #define MUSB_INDEXED_OFFSET(_epnum, _offset) \
279 /* Offsets to endpoint registers in flat models */
280 #define MUSB_FLAT_OFFSET(_epnum, _offset) \
281 (0x100 + (0x10*(_epnum)) + (_offset))
283 #ifdef CONFIG_USB_TUSB6010
284 /* TUSB6010 EP0 configuration register is special */
285 #define MUSB_TUSB_OFFSET(_epnum, _offset) \
287 #include "tusb6010.h" /* Needed "only" for TUSB_EP0_CONF */
290 #define MUSB_TXCSR_MODE 0x2000
292 /* "bus control"/target registers, for host side multipoint (external hubs) */
293 #define MUSB_TXFUNCADDR 0x00
294 #define MUSB_TXHUBADDR 0x02
295 #define MUSB_TXHUBPORT 0x03
297 #define MUSB_RXFUNCADDR 0x04
298 #define MUSB_RXHUBADDR 0x06
299 #define MUSB_RXHUBPORT 0x07
301 #define MUSB_BUSCTL_OFFSET(_epnum, _offset) \
302 (0x80 + (8*(_epnum)) + (_offset))
304 static inline void musb_write_txfifosz(void __iomem *mbase, u8 c_size)
306 musb_writeb(mbase, MUSB_TXFIFOSZ, c_size);
309 static inline void musb_write_txfifoadd(void __iomem *mbase, u16 c_off)
311 musb_writew(mbase, MUSB_TXFIFOADD, c_off);
314 static inline void musb_write_rxfifosz(void __iomem *mbase, u8 c_size)
316 musb_writeb(mbase, MUSB_RXFIFOSZ, c_size);
319 static inline void musb_write_rxfifoadd(void __iomem *mbase, u16 c_off)
321 musb_writew(mbase, MUSB_RXFIFOADD, c_off);
324 static inline u8 musb_read_configdata(void __iomem *mbase)
326 return musb_readb(mbase, 0x10 + MUSB_CONFIGDATA);
329 static inline u16 musb_read_hwvers(void __iomem *mbase)
331 return musb_readw(mbase, MUSB_HWVERS);
334 static inline void __iomem *musb_read_target_reg_base(u8 i, void __iomem *mbase)
336 return (MUSB_BUSCTL_OFFSET(i, 0) + mbase);
339 static inline void musb_write_rxfunaddr(void __iomem *ep_target_regs,
342 musb_writeb(ep_target_regs, MUSB_RXFUNCADDR, qh_addr_reg);
345 static inline void musb_write_rxhubaddr(void __iomem *ep_target_regs,
348 musb_writeb(ep_target_regs, MUSB_RXHUBADDR, qh_h_addr_reg);
351 static inline void musb_write_rxhubport(void __iomem *ep_target_regs,
354 musb_writeb(ep_target_regs, MUSB_RXHUBPORT, qh_h_port_reg);
357 static inline void musb_write_txfunaddr(void __iomem *mbase, u8 epnum,
360 musb_writeb(mbase, MUSB_BUSCTL_OFFSET(epnum, MUSB_TXFUNCADDR),
364 static inline void musb_write_txhubaddr(void __iomem *mbase, u8 epnum,
367 musb_writeb(mbase, MUSB_BUSCTL_OFFSET(epnum, MUSB_TXHUBADDR),
371 static inline void musb_write_txhubport(void __iomem *mbase, u8 epnum,
374 musb_writeb(mbase, MUSB_BUSCTL_OFFSET(epnum, MUSB_TXHUBPORT),
378 #else /* CONFIG_BLACKFIN */
380 #define USB_BASE USB_FADDR
381 #define USB_OFFSET(reg) (reg - USB_BASE)
384 * Common USB registers
386 #define MUSB_FADDR USB_OFFSET(USB_FADDR) /* 8-bit */
387 #define MUSB_POWER USB_OFFSET(USB_POWER) /* 8-bit */
388 #define MUSB_INTRTX USB_OFFSET(USB_INTRTX) /* 16-bit */
389 #define MUSB_INTRRX USB_OFFSET(USB_INTRRX)
390 #define MUSB_INTRTXE USB_OFFSET(USB_INTRTXE)
391 #define MUSB_INTRRXE USB_OFFSET(USB_INTRRXE)
392 #define MUSB_INTRUSB USB_OFFSET(USB_INTRUSB) /* 8 bit */
393 #define MUSB_INTRUSBE USB_OFFSET(USB_INTRUSBE)/* 8 bit */
394 #define MUSB_FRAME USB_OFFSET(USB_FRAME)
395 #define MUSB_INDEX USB_OFFSET(USB_INDEX) /* 8 bit */
396 #define MUSB_TESTMODE USB_OFFSET(USB_TESTMODE)/* 8 bit */
398 /* Get offset for a given FIFO from musb->mregs */
399 #define MUSB_FIFO_OFFSET(epnum) \
400 (USB_OFFSET(USB_EP0_FIFO) + ((epnum) * 8))
403 * Additional Control Registers
406 #define MUSB_DEVCTL USB_OFFSET(USB_OTG_DEV_CTL) /* 8 bit */
408 #define MUSB_LINKINFO USB_OFFSET(USB_LINKINFO)/* 8 bit */
409 #define MUSB_VPLEN USB_OFFSET(USB_VPLEN) /* 8 bit */
410 #define MUSB_HS_EOF1 USB_OFFSET(USB_HS_EOF1) /* 8 bit */
411 #define MUSB_FS_EOF1 USB_OFFSET(USB_FS_EOF1) /* 8 bit */
412 #define MUSB_LS_EOF1 USB_OFFSET(USB_LS_EOF1) /* 8 bit */
414 /* Offsets to endpoint registers */
415 #define MUSB_TXMAXP 0x00
416 #define MUSB_TXCSR 0x04
417 #define MUSB_CSR0 MUSB_TXCSR /* Re-used for EP0 */
418 #define MUSB_RXMAXP 0x08
419 #define MUSB_RXCSR 0x0C
420 #define MUSB_RXCOUNT 0x10
421 #define MUSB_COUNT0 MUSB_RXCOUNT /* Re-used for EP0 */
422 #define MUSB_TXTYPE 0x14
423 #define MUSB_TYPE0 MUSB_TXTYPE /* Re-used for EP0 */
424 #define MUSB_TXINTERVAL 0x18
425 #define MUSB_NAKLIMIT0 MUSB_TXINTERVAL /* Re-used for EP0 */
426 #define MUSB_RXTYPE 0x1C
427 #define MUSB_RXINTERVAL 0x20
428 #define MUSB_TXCOUNT 0x28
430 /* Offsets to endpoint registers in indexed model (using INDEX register) */
431 #define MUSB_INDEXED_OFFSET(_epnum, _offset) \
434 /* Offsets to endpoint registers in flat models */
435 #define MUSB_FLAT_OFFSET(_epnum, _offset) \
436 (USB_OFFSET(USB_EP_NI0_TXMAXP) + (0x40 * (_epnum)) + (_offset))
438 /* Not implemented - HW has seperate Tx/Rx FIFO */
439 #define MUSB_TXCSR_MODE 0x0000
442 * Dummy stub for clk framework, it will be removed
443 * until Blackfin supports clk framework
445 #define clk_get(dev, id) NULL
446 #define clk_put(clock) do {} while (0)
447 #define clk_enable(clock) do {} while (0)
448 #define clk_disable(clock) do {} while (0)
450 static inline void musb_write_txfifosz(void __iomem *mbase, u8 c_size)
454 static inline void musb_write_txfifoadd(void __iomem *mbase, u16 c_off)
458 static inline void musb_write_rxfifosz(void __iomem *mbase, u8 c_size)
462 static inline void musb_write_rxfifoadd(void __iomem *mbase, u16 c_off)
466 static inline u8 musb_read_configdata(void __iomem *mbase)
471 static inline u16 musb_read_hwvers(void __iomem *mbase)
476 static inline u16 musb_read_target_reg_base(u8 i, void __iomem *mbase)
481 static inline void musb_write_rxfunaddr(void __iomem *ep_target_regs,
486 static inline void musb_write_rxhubaddr(void __iomem *ep_target_regs,
491 static inline void musb_write_rxhubport(void __iomem *ep_target_regs,
496 static inline void musb_write_txfunaddr(void __iomem *mbase, u8 epnum,
501 static inline void musb_write_txhubaddr(void __iomem *mbase, u8 epnum,
506 static inline void musb_write_txhubport(void __iomem *mbase, u8 epnum,
511 #endif /* CONFIG_BLACKFIN */
513 #endif /* __MUSB_REGS_H__ */