]> git.ipfire.org Git - people/ms/u-boot.git/blob - include/usb/fotg210.h
Add GPL-2.0+ SPDX-License-Identifier to source files
[people/ms/u-boot.git] / include / usb / fotg210.h
1 /*
2 * Faraday USB 2.0 OTG Controller
3 *
4 * (C) Copyright 2010 Faraday Technology
5 * Dante Su <dantesu@faraday-tech.com>
6 *
7 * SPDX-License-Identifier: GPL-2.0+
8 */
9
10 #ifndef _FOTG210_H
11 #define _FOTG210_H
12
13 struct fotg210_regs {
14 /* USB Host Controller */
15 struct {
16 uint32_t data[4];
17 } hccr; /* 0x00 - 0x0f: hccr */
18 struct {
19 uint32_t data[9];
20 } hcor; /* 0x10 - 0x33: hcor */
21 uint32_t rsvd1[3];
22 uint32_t miscr; /* 0x40: Miscellaneous Register */
23 uint32_t rsvd2[15];
24 /* USB OTG Controller */
25 uint32_t otgcsr;/* 0x80: OTG Control Status Register */
26 uint32_t otgisr;/* 0x84: OTG Interrupt Status Register */
27 uint32_t otgier;/* 0x88: OTG Interrupt Enable Register */
28 uint32_t rsvd3[13];
29 uint32_t isr; /* 0xC0: Global Interrupt Status Register */
30 uint32_t imr; /* 0xC4: Global Interrupt Mask Register */
31 uint32_t rsvd4[14];
32 /* USB Device Controller */
33 uint32_t dev_ctrl;/* 0x100: Device Control Register */
34 uint32_t dev_addr;/* 0x104: Device Address Register */
35 uint32_t dev_test;/* 0x108: Device Test Register */
36 uint32_t sof_fnr; /* 0x10c: SOF Frame Number Register */
37 uint32_t sof_mtr; /* 0x110: SOF Mask Timer Register */
38 uint32_t phy_tmsr;/* 0x114: PHY Test Mode Selector Register */
39 uint32_t rsvd5[2];
40 uint32_t cxfifo;/* 0x120: CX FIFO Register */
41 uint32_t idle; /* 0x124: IDLE Counter Register */
42 uint32_t rsvd6[2];
43 uint32_t gimr; /* 0x130: Group Interrupt Mask Register */
44 uint32_t gimr0; /* 0x134: Group Interrupt Mask Register 0 */
45 uint32_t gimr1; /* 0x138: Group Interrupt Mask Register 1 */
46 uint32_t gimr2; /* 0x13c: Group Interrupt Mask Register 2 */
47 uint32_t gisr; /* 0x140: Group Interrupt Status Register */
48 uint32_t gisr0; /* 0x144: Group Interrupt Status Register 0 */
49 uint32_t gisr1; /* 0x148: Group Interrupt Status Register 1 */
50 uint32_t gisr2; /* 0x14c: Group Interrupt Status Register 2 */
51 uint32_t rxzlp; /* 0x150: Receive Zero-Length-Packet Register */
52 uint32_t txzlp; /* 0x154: Transfer Zero-Length-Packet Register */
53 uint32_t isoeasr;/* 0x158: ISOC Error/Abort Status Register */
54 uint32_t rsvd7[1];
55 uint32_t iep[8]; /* 0x160 - 0x17f: IN Endpoint Register */
56 uint32_t oep[8]; /* 0x180 - 0x19f: OUT Endpoint Register */
57 uint32_t epmap14;/* 0x1a0: Endpoint Map Register (EP1 ~ 4) */
58 uint32_t epmap58;/* 0x1a4: Endpoint Map Register (EP5 ~ 8) */
59 uint32_t fifomap;/* 0x1a8: FIFO Map Register */
60 uint32_t fifocfg; /* 0x1ac: FIFO Configuration Register */
61 uint32_t fifocsr[4];/* 0x1b0 - 0x1bf: FIFO Control Status Register */
62 uint32_t dma_fifo; /* 0x1c0: DMA Target FIFO Register */
63 uint32_t rsvd8[1];
64 uint32_t dma_ctrl; /* 0x1c8: DMA Control Register */
65 uint32_t dma_addr; /* 0x1cc: DMA Address Register */
66 uint32_t ep0_data; /* 0x1d0: EP0 Setup Packet PIO Register */
67 };
68
69 /* Miscellaneous Register */
70 #define MISCR_SUSPEND (1 << 6) /* Put transceiver in suspend mode */
71 #define MISCR_EOF2(x) (((x) & 0x3) << 4) /* EOF 2 Timing */
72 #define MISCR_EOF1(x) (((x) & 0x3) << 2) /* EOF 1 Timing */
73 #define MISCR_ASST(x) (((x) & 0x3) << 0) /* Async. Sched. Sleep Timer */
74
75 /* OTG Control Status Register */
76 #define OTGCSR_SPD_HIGH (2 << 22) /* Speed of the attached device (host) */
77 #define OTGCSR_SPD_LOW (1 << 22)
78 #define OTGCSR_SPD_FULL (0 << 22)
79 #define OTGCSR_SPD_MASK (3 << 22)
80 #define OTGCSR_SPD_SHIFT 22
81 #define OTGCSR_SPD(x) (((x) >> 22) & 0x03)
82 #define OTGCSR_DEV_A (0 << 21) /* Acts as A-device */
83 #define OTGCSR_DEV_B (1 << 21) /* Acts as B-device */
84 #define OTGCSR_ROLE_H (0 << 20) /* Acts as Host */
85 #define OTGCSR_ROLE_D (1 << 20) /* Acts as Device */
86 #define OTGCSR_A_VBUS_VLD (1 << 19) /* A-device VBUS Valid */
87 #define OTGCSR_A_SESS_VLD (1 << 18) /* A-device Session Valid */
88 #define OTGCSR_B_SESS_VLD (1 << 17) /* B-device Session Valid */
89 #define OTGCSR_B_SESS_END (1 << 16) /* B-device Session End */
90 #define OTGCSR_HFT_LONG (1 << 11) /* HDISCON noise filter = 270 us*/
91 #define OTGCSR_HFT (0 << 11) /* HDISCON noise filter = 135 us*/
92 #define OTGCSR_VFT_LONG (1 << 10) /* VBUS noise filter = 472 us*/
93 #define OTGCSR_VFT (0 << 10) /* VBUS noise filter = 135 us*/
94 #define OTGCSR_IDFT_LONG (1 << 9) /* ID noise filter = 4 ms*/
95 #define OTGCSR_IDFT (0 << 9) /* ID noise filter = 3 ms*/
96 #define OTGCSR_A_SRPR_VBUS (0 << 8) /* A-device: SRP responds to VBUS */
97 #define OTGCSR_A_SRPR_DATA (1 << 8) /* A-device: SRP responds to DATA-LINE */
98 #define OTGCSR_A_SRP_EN (1 << 7) /* A-device SRP detection enabled */
99 #define OTGCSR_A_HNP (1 << 6) /* Set role=A-device with HNP enabled */
100 #define OTGCSR_A_BUSDROP (1 << 5) /* A-device drop bus (power-down) */
101 #define OTGCSR_A_BUSREQ (1 << 4) /* A-device request bus */
102 #define OTGCSR_B_VBUS_DISC (1 << 2) /* B-device discharges VBUS */
103 #define OTGCSR_B_HNP (1 << 1) /* B-device enable HNP */
104 #define OTGCSR_B_BUSREQ (1 << 0) /* B-device request bus */
105
106 /* OTG Interrupt Status Register */
107 #define OTGISR_APRM (1 << 12) /* Mini-A plug removed */
108 #define OTGISR_BPRM (1 << 11) /* Mini-B plug removed */
109 #define OTGISR_OVD (1 << 10) /* over-current detected */
110 #define OTGISR_IDCHG (1 << 9) /* ID(A/B) changed */
111 #define OTGISR_RLCHG (1 << 8) /* Role(Host/Device) changed */
112 #define OTGISR_BSESSEND (1 << 6) /* B-device Session End */
113 #define OTGISR_AVBUSERR (1 << 5) /* A-device VBUS Error */
114 #define OTGISR_ASRP (1 << 4) /* A-device SRP detected */
115 #define OTGISR_BSRP (1 << 0) /* B-device SRP complete */
116
117 /* OTG Interrupt Enable Register */
118 #define OTGIER_APRM (1 << 12) /* Mini-A plug removed */
119 #define OTGIER_BPRM (1 << 11) /* Mini-B plug removed */
120 #define OTGIER_OVD (1 << 10) /* over-current detected */
121 #define OTGIER_IDCHG (1 << 9) /* ID(A/B) changed */
122 #define OTGIER_RLCHG (1 << 8) /* Role(Host/Device) changed */
123 #define OTGIER_BSESSEND (1 << 6) /* B-device Session End */
124 #define OTGIER_AVBUSERR (1 << 5) /* A-device VBUS Error */
125 #define OTGIER_ASRP (1 << 4) /* A-device SRP detected */
126 #define OTGIER_BSRP (1 << 0) /* B-device SRP complete */
127
128 /* Global Interrupt Status Register (W1C) */
129 #define ISR_HOST (1 << 2) /* USB Host interrupt */
130 #define ISR_OTG (1 << 1) /* USB OTG interrupt */
131 #define ISR_DEV (1 << 0) /* USB Device interrupt */
132 #define ISR_MASK 0x07
133
134 /* Global Interrupt Mask Register */
135 #define IMR_IRQLH (1 << 3) /* Interrupt triggered at level-high */
136 #define IMR_IRQLL (0 << 3) /* Interrupt triggered at level-low */
137 #define IMR_HOST (1 << 2) /* USB Host interrupt */
138 #define IMR_OTG (1 << 1) /* USB OTG interrupt */
139 #define IMR_DEV (1 << 0) /* USB Device interrupt */
140 #define IMR_MASK 0x0f
141
142 /* Device Control Register */
143 #define DEVCTRL_FS_FORCED (1 << 9) /* Forced to be Full-Speed Mode */
144 #define DEVCTRL_HS (1 << 6) /* High Speed Mode */
145 #define DEVCTRL_FS (0 << 6) /* Full Speed Mode */
146 #define DEVCTRL_EN (1 << 5) /* Chip Enable */
147 #define DEVCTRL_RESET (1 << 4) /* Chip Software Reset */
148 #define DEVCTRL_SUSPEND (1 << 3) /* Enter Suspend Mode */
149 #define DEVCTRL_GIRQ_EN (1 << 2) /* Global Interrupt Enabled */
150 #define DEVCTRL_HALFSPD (1 << 1) /* Half speed mode for FPGA test */
151 #define DEVCTRL_RWAKEUP (1 << 0) /* Enable remote wake-up */
152
153 /* Device Address Register */
154 #define DEVADDR_CONF (1 << 7) /* SET_CONFIGURATION has been executed */
155 #define DEVADDR_ADDR(x) ((x) & 0x7f)
156 #define DEVADDR_ADDR_MASK 0x7f
157
158 /* Device Test Register */
159 #define DEVTEST_NOSOF (1 << 6) /* Do not generate SOF */
160 #define DEVTEST_TST_MODE (1 << 5) /* Enter Test Mode */
161 #define DEVTEST_TST_NOTS (1 << 4) /* Do not toggle sequence */
162 #define DEVTEST_TST_NOCRC (1 << 3) /* Do not append CRC */
163 #define DEVTEST_TST_CLREA (1 << 2) /* Clear External Side Address */
164 #define DEVTEST_TST_CXLP (1 << 1) /* EP0 loopback test */
165 #define DEVTEST_TST_CLRFF (1 << 0) /* Clear FIFO */
166
167 /* SOF Frame Number Register */
168 #define SOFFNR_UFN(x) (((x) >> 11) & 0x7) /* SOF Micro-Frame Number */
169 #define SOFFNR_FNR(x) ((x) & 0x7ff) /* SOF Frame Number */
170
171 /* SOF Mask Timer Register */
172 #define SOFMTR_TMR(x) ((x) & 0xffff)
173
174 /* PHY Test Mode Selector Register */
175 #define PHYTMSR_TST_PKT (1 << 4) /* Packet send test */
176 #define PHYTMSR_TST_SE0NAK (1 << 3) /* High-Speed quiescent state */
177 #define PHYTMSR_TST_KSTA (1 << 2) /* High-Speed K state */
178 #define PHYTMSR_TST_JSTA (1 << 1) /* High-Speed J state */
179 #define PHYTMSR_UNPLUG (1 << 0) /* Enable soft-detachment */
180
181 /* CX FIFO Register */
182 #define CXFIFO_BYTES(x) (((x) >> 24) & 0x7f) /* CX/EP0 FIFO byte count */
183 #define CXFIFO_FIFOE(x) (1 << (((x) & 0x03) + 8)) /* EPx FIFO empty */
184 #define CXFIFO_FIFOE_FIFO0 (1 << 8)
185 #define CXFIFO_FIFOE_FIFO1 (1 << 9)
186 #define CXFIFO_FIFOE_FIFO2 (1 << 10)
187 #define CXFIFO_FIFOE_FIFO3 (1 << 11)
188 #define CXFIFO_FIFOE_MASK (0x0f << 8)
189 #define CXFIFO_CXFIFOE (1 << 5) /* CX FIFO empty */
190 #define CXFIFO_CXFIFOF (1 << 4) /* CX FIFO full */
191 #define CXFIFO_CXFIFOCLR (1 << 3) /* CX FIFO clear */
192 #define CXFIFO_CXSTALL (1 << 2) /* CX Stall */
193 #define CXFIFO_TSTPKTFIN (1 << 1) /* Test packet data transfer finished */
194 #define CXFIFO_CXFIN (1 << 0) /* CX data transfer finished */
195
196 /* IDLE Counter Register */
197 #define IDLE_MS(x) ((x) & 0x07) /* PHY suspend delay = x ms */
198
199 /* Group Interrupt Mask(Disable) Register */
200 #define GIMR_GRP2 (1 << 2) /* Disable interrupt group 2 */
201 #define GIMR_GRP1 (1 << 1) /* Disable interrupt group 1 */
202 #define GIMR_GRP0 (1 << 0) /* Disable interrupt group 0 */
203 #define GIMR_MASK 0x07
204
205 /* Group Interrupt Mask(Disable) Register 0 (CX) */
206 #define GIMR0_CXABORT (1 << 5) /* CX command abort interrupt */
207 #define GIMR0_CXERR (1 << 4) /* CX command error interrupt */
208 #define GIMR0_CXEND (1 << 3) /* CX command end interrupt */
209 #define GIMR0_CXOUT (1 << 2) /* EP0-OUT packet interrupt */
210 #define GIMR0_CXIN (1 << 1) /* EP0-IN packet interrupt */
211 #define GIMR0_CXSETUP (1 << 0) /* EP0-SETUP packet interrupt */
212 #define GIMR0_MASK 0x3f
213
214 /* Group Interrupt Mask(Disable) Register 1 (FIFO) */
215 #define GIMR1_FIFO_IN(x) (1 << (((x) & 3) + 16)) /* FIFOx IN */
216 #define GIMR1_FIFO_TX(x) GIMR1_FIFO_IN(x)
217 #define GIMR1_FIFO_OUT(x) (1 << (((x) & 3) * 2)) /* FIFOx OUT */
218 #define GIMR1_FIFO_SPK(x) (1 << (((x) & 3) * 2 + 1)) /* FIFOx SHORT PACKET */
219 #define GIMR1_FIFO_RX(x) (GIMR1_FIFO_OUT(x) | GIMR1_FIFO_SPK(x))
220 #define GIMR1_MASK 0xf00ff
221
222 /* Group Interrupt Mask(Disable) Register 2 (Device) */
223 #define GIMR2_WAKEUP (1 << 10) /* Device waked up */
224 #define GIMR2_IDLE (1 << 9) /* Device idle */
225 #define GIMR2_DMAERR (1 << 8) /* DMA error */
226 #define GIMR2_DMAFIN (1 << 7) /* DMA finished */
227 #define GIMR2_ZLPRX (1 << 6) /* Zero-Length-Packet Rx Interrupt */
228 #define GIMR2_ZLPTX (1 << 5) /* Zero-Length-Packet Tx Interrupt */
229 #define GIMR2_ISOCABT (1 << 4) /* ISOC Abort Interrupt */
230 #define GIMR2_ISOCERR (1 << 3) /* ISOC Error Interrupt */
231 #define GIMR2_RESUME (1 << 2) /* Resume state change Interrupt */
232 #define GIMR2_SUSPEND (1 << 1) /* Suspend state change Interrupt */
233 #define GIMR2_RESET (1 << 0) /* Reset Interrupt */
234 #define GIMR2_MASK 0x7ff
235
236 /* Group Interrupt Status Register */
237 #define GISR_GRP2 (1 << 2) /* Interrupt group 2 */
238 #define GISR_GRP1 (1 << 1) /* Interrupt group 1 */
239 #define GISR_GRP0 (1 << 0) /* Interrupt group 0 */
240
241 /* Group Interrupt Status Register 0 (CX) */
242 #define GISR0_CXABORT (1 << 5) /* CX command abort interrupt */
243 #define GISR0_CXERR (1 << 4) /* CX command error interrupt */
244 #define GISR0_CXEND (1 << 3) /* CX command end interrupt */
245 #define GISR0_CXOUT (1 << 2) /* EP0-OUT packet interrupt */
246 #define GISR0_CXIN (1 << 1) /* EP0-IN packet interrupt */
247 #define GISR0_CXSETUP (1 << 0) /* EP0-SETUP packet interrupt */
248
249 /* Group Interrupt Status Register 1 (FIFO) */
250 #define GISR1_IN_FIFO(x) (1 << (((x) & 0x03) + 16)) /* FIFOx IN */
251 #define GISR1_OUT_FIFO(x) (1 << (((x) & 0x03) * 2)) /* FIFOx OUT */
252 #define GISR1_SPK_FIFO(x) (1 << (((x) & 0x03) * 2 + 1)) /* FIFOx SPK */
253 #define GISR1_RX_FIFO(x) (3 << (((x) & 0x03) * 2)) /* FIFOx OUT/SPK */
254
255 /* Group Interrupt Status Register 2 (Device) */
256 #define GISR2_WAKEUP (1 << 10) /* Device waked up */
257 #define GISR2_IDLE (1 << 9) /* Device idle */
258 #define GISR2_DMAERR (1 << 8) /* DMA error */
259 #define GISR2_DMAFIN (1 << 7) /* DMA finished */
260 #define GISR2_ZLPRX (1 << 6) /* Zero-Length-Packet Rx Interrupt */
261 #define GISR2_ZLPTX (1 << 5) /* Zero-Length-Packet Tx Interrupt */
262 #define GISR2_ISOCABT (1 << 4) /* ISOC Abort Interrupt */
263 #define GISR2_ISOCERR (1 << 3) /* ISOC Error Interrupt */
264 #define GISR2_RESUME (1 << 2) /* Resume state change Interrupt */
265 #define GISR2_SUSPEND (1 << 1) /* Suspend state change Interrupt */
266 #define GISR2_RESET (1 << 0) /* Reset Interrupt */
267
268 /* Receive Zero-Length-Packet Register */
269 #define RXZLP_EP(x) (1 << ((x) - 1)) /* EPx ZLP rx interrupt */
270
271 /* Transfer Zero-Length-Packet Register */
272 #define TXZLP_EP(x) (1 << ((x) - 1)) /* EPx ZLP tx interrupt */
273
274 /* ISOC Error/Abort Status Register */
275 #define ISOEASR_EP(x) (0x10001 << ((x) - 1)) /* EPx ISOC Error/Abort */
276
277 /* IN Endpoint Register */
278 #define IEP_SENDZLP (1 << 15) /* Send Zero-Length-Packet */
279 #define IEP_TNRHB(x) (((x) & 0x03) << 13) \
280 /* Transaction Number for High-Bandwidth EP(ISOC) */
281 #define IEP_RESET (1 << 12) /* Reset Toggle Sequence */
282 #define IEP_STALL (1 << 11) /* Stall */
283 #define IEP_MAXPS(x) ((x) & 0x7ff) /* Max. packet size */
284
285 /* OUT Endpoint Register */
286 #define OEP_RESET (1 << 12) /* Reset Toggle Sequence */
287 #define OEP_STALL (1 << 11) /* Stall */
288 #define OEP_MAXPS(x) ((x) & 0x7ff) /* Max. packet size */
289
290 /* Endpoint Map Register (EP1 ~ EP4) */
291 #define EPMAP14_SET_IN(ep, fifo) \
292 ((fifo) & 3) << (((ep) - 1) << 3 + 0)
293 #define EPMAP14_SET_OUT(ep, fifo) \
294 ((fifo) & 3) << (((ep) - 1) << 3 + 4)
295 #define EPMAP14_SET(ep, in, out) \
296 do { \
297 EPMAP14_SET_IN(ep, in); \
298 EPMAP14_SET_OUT(ep, out); \
299 } while (0)
300
301 #define EPMAP14_DEFAULT 0x33221100 /* EP1->FIFO0, EP2->FIFO1... */
302
303 /* Endpoint Map Register (EP5 ~ EP8) */
304 #define EPMAP58_SET_IN(ep, fifo) \
305 ((fifo) & 3) << (((ep) - 5) << 3 + 0)
306 #define EPMAP58_SET_OUT(ep, fifo) \
307 ((fifo) & 3) << (((ep) - 5) << 3 + 4)
308 #define EPMAP58_SET(ep, in, out) \
309 do { \
310 EPMAP58_SET_IN(ep, in); \
311 EPMAP58_SET_OUT(ep, out); \
312 } while (0)
313
314 #define EPMAP58_DEFAULT 0x00000000 /* All EPx->FIFO0 */
315
316 /* FIFO Map Register */
317 #define FIFOMAP_BIDIR (2 << 4)
318 #define FIFOMAP_IN (1 << 4)
319 #define FIFOMAP_OUT (0 << 4)
320 #define FIFOMAP_DIR_MASK 0x30
321 #define FIFOMAP_EP(x) ((x) & 0x0f)
322 #define FIFOMAP_EP_MASK 0x0f
323 #define FIFOMAP_CFG_MASK 0x3f
324 #define FIFOMAP_DEFAULT 0x04030201 /* FIFO0->EP1, FIFO1->EP2... */
325 #define FIFOMAP(fifo, cfg) (((cfg) & 0x3f) << (((fifo) & 3) << 3))
326
327 /* FIFO Configuration Register */
328 #define FIFOCFG_EN (1 << 5)
329 #define FIFOCFG_BLKSZ_1024 (1 << 4)
330 #define FIFOCFG_BLKSZ_512 (0 << 4)
331 #define FIFOCFG_3BLK (2 << 2)
332 #define FIFOCFG_2BLK (1 << 2)
333 #define FIFOCFG_1BLK (0 << 2)
334 #define FIFOCFG_NBLK_MASK 3
335 #define FIFOCFG_NBLK_SHIFT 2
336 #define FIFOCFG_INTR (3 << 0)
337 #define FIFOCFG_BULK (2 << 0)
338 #define FIFOCFG_ISOC (1 << 0)
339 #define FIFOCFG_RSVD (0 << 0) /* Reserved */
340 #define FIFOCFG_TYPE_MASK 3
341 #define FIFOCFG_TYPE_SHIFT 0
342 #define FIFOCFG_CFG_MASK 0x3f
343 #define FIFOCFG(fifo, cfg) (((cfg) & 0x3f) << (((fifo) & 3) << 3))
344
345 /* FIFO Control Status Register */
346 #define FIFOCSR_RESET (1 << 12) /* FIFO Reset */
347 #define FIFOCSR_BYTES(x) ((x) & 0x7ff) /* Length(bytes) for OUT-EP/FIFO */
348
349 /* DMA Target FIFO Register */
350 #define DMAFIFO_CX (1 << 4) /* DMA FIFO = CX FIFO */
351 #define DMAFIFO_FIFO(x) (1 << ((x) & 0x3)) /* DMA FIFO = FIFOx */
352
353 /* DMA Control Register */
354 #define DMACTRL_LEN(x) (((x) & 0x1ffff) << 8) /* DMA length (Bytes) */
355 #define DMACTRL_LEN_SHIFT 8
356 #define DMACTRL_CLRFF (1 << 4) /* Clear FIFO upon DMA abort */
357 #define DMACTRL_ABORT (1 << 3) /* DMA abort */
358 #define DMACTRL_IO2IO (1 << 2) /* IO to IO */
359 #define DMACTRL_FIFO2MEM (0 << 1) /* FIFO to Memory */
360 #define DMACTRL_MEM2FIFO (1 << 1) /* Memory to FIFO */
361 #define DMACTRL_START (1 << 0) /* DMA start */
362
363 #endif