1 Assumptions made on source code:
2 * looks like USB block is [FUSB200](http://www.faraday-tech.com/techDocument/FUSB200_ProductBrief_v1_2.pdf).
3 * We have 15 Enddpoints and 15 FIFO buffers.
4 * **FIFO0 - FIFO13, 512 Byte each? FIFO14 - FIFO15 - 64 Byte each?**
5 * location of usb descriptor target_firmware/magpie_fw_dev/build/magpie_1_1/sboot/hif/usb/src/usb_table.c
7 # EP layout vs software/reg layout
9 * EP 1 OUT; Bulk; = LP (Low priority downstream); RX0;
10 * EP 2 IN; Bulk; = US (upstream)
12 * EP 4 OUT; Interrupt;
13 * EP 5 OUT; Bulk; = HP (High priority downstream); RX1;
14 * EP 6 OUT; Bulk; = MP (Medium priority downstream); RX2;
17 # 0x00 ZM_MAIN_CTRL_OFFSET
19 * BIT6 - 1 = HighSpeed is set (read only?)
21 * BIT4 - sfrst. soft reset?
23 * BIT2 - 1 = enable global Int
25 * BIT0 - 1 = set Remote Wake Up;
27 # 0x01 ZM_DEVICE_ADDRESS_OFFSET
28 * BIT7 - usb config? (r/w)
38 * BIT0 - 1 ?? set on usb 2.0 init
40 # 0x08 ZM_PHY_TEST_SELECT_OFFSET
44 * BIT4 - TEST_PKY - Test packed.
50 According to FUSB200 doc:
51 DM(D-) DP(D+) Description
56 0: Control PHY to turn off 1.5K Ohm pull-up resistor
57 1: Control PHY to turn on 1.5K Ohm pull-up resistor
58 If TEST_PKY is set, the test packet must be filled into FIFO by DMA first.
61 # 0x0A ZM_VDR_SPECIFIC_MODE_OFFSET
63 # 0x0B ZM_CX_CONFIG_STATUS_OFFSET
66 * BIT5 - indicator that frame was transmitted.
68 * BIT3 - set to drom the fram?
69 * BIT2 - set CX_STL to stall Endpoint0 & will also clear FIFO0
71 * BIT0 - set CX_DONE to indicate the transmistion of control frame
73 # 0x0C ZM_EP0_DATA_OFFSET
74 * Write 32bit data to fifo
76 # 0x11 ZM_INTR_MASK_BYTE_0_OFFSET
77 Theoretically INTR_MASK_BYTE should control INTR_SOURCE. Is it correct?
79 # 0x12 ZM_INTR_MASK_BYTE_1_OFFSET
82 # 0x13 ZM_INTR_MASK_BYTE_2_OFFSET
85 # 0x14 ZM_INTR_MASK_BYTE_3_OFFSET
88 # 0x15 ZM_INTR_MASK_BYTE_4_OFFSET
90 #define mUSB_REG_OUT_INT_ENABLE() USB_BYTE_REG_WRITE(ZM_INTR_MASK_BYTE_4_OFFSET, \
91 USB_BYTE_REG_READ(ZM_INTR_MASK_BYTE_4_OFFSET)&0x3f)
92 #define mUSB_REG_OUT_INT_DISABLE() USB_BYTE_REG_WRITE(ZM_INTR_MASK_BYTE_4_OFFSET, \
93 USB_BYTE_REG_READ(ZM_INTR_MASK_BYTE_4_OFFSET)&0xc0)
95 # 0x16 ZM_INTR_MASK_BYTE_5_OFFSET
98 # 0x17 ZM_INTR_MASK_BYTE_6_OFFSET
101 #define mUSB_STATUS_IN_INT_ENABLE() USB_BYTE_REG_WRITE(ZM_INTR_MASK_BYTE_6_OFFSET, \
102 USB_BYTE_REG_READ(ZM_INTR_MASK_BYTE_6_OFFSET)&0xbf)
103 #define mUSB_STATUS_IN_INT_DISABLE() USB_BYTE_REG_WRITE(ZM_INTR_MASK_BYTE_6_OFFSET, \
104 USB_BYTE_REG_READ(ZM_INTR_MASK_BYTE_6_OFFSET)|0xc0)
106 # 0x18 ZM_INTR_MASK_BYTE_7_OFFSET
108 # 0x20 ZM_INTR_GROUP_OFFSET
109 * BIT7 - group INTR 7
110 * BIT6 - group INTR 6
111 * BIT5 - group INTR 5
112 * BIT4 - group INTR 4
113 * BIT3 - group INTR 3
114 * BIT2 - group INTR 2
115 * BIT1 - group INTR 1
116 * BIT0 - group INTR 0
117 These bits indicate if fallowing groups got some interrupt.
119 # 0x21 ZM_INTR_SOURCE_0_OFFSET
120 * BIT7 - abort interrupt? should be cleared first?
123 * BIT4 - ep0 CMD_FAIL
125 * BIT2 - USB EP0 OUT/rx interrupt
126 * BIT1 - USB EP0 IN/tx interrupt
129 # 0x22 ZM_INTR_SOURCE_1_OFFSET
130 # 0x23 ZM_INTR_SOURCE_2_OFFSET
131 short packed interrupts?
133 # 0x24 ZM_INTR_SOURCE_3_OFFSET
134 # 0x25 ZM_INTR_SOURCE_4_OFFSET
135 * BIT7 - End of data.
136 * BIT6 - vUsb_Reg_Out(). Pending data in fifo for EP4. We need to read it out.
137 Comments: we can read only 64bytes per time. If pending data is less then 64bytes or it is end of packet, then BIT6 and BIT7 will be set. If not, then only BIT6 is set.
139 # 0x26 ZM_INTR_SOURCE_5_OFFSET
140 these endpoints are handled by DMA
142 # 0x27 ZM_INTR_SOURCE_6_OFFSET
143 * BIT6 - vUsb_Status_In()?
145 # 0x28 ZM_INTR_SOURCE_7_OFFSET
148 * BIT5 - ISO seq abort
149 * BIT4 - ISO seq error
152 * BIT1 - USB reset interrupt.
156 code use: ZM_FUSB_BASE+0x30+(EPn-1)
157 (0x0F | FIFOn << 4) = OUT
159 **probably incorrect interpretation. It should be FUSB_REG_IDLE_CNT
160 set suspend delay in ms**
162 for FIFOn see mUsbFIFOMap registers.
164 Current configuration:
166 * 0x30 0x0f <- EP1 = OUT + Start FIFO0
167 * 0x31 0xf2 <- EP2 = IN + Start FIFO2
168 * 0x32 0xfe <- EP3 = IN + Start FIFO14
169 * 0x33 0xff <- EP4 = OUT + Start FIFO15
190 # 0x39 mUsbEPMap EP10
191 # 0x3a mUsbEPMap EP11
192 # 0x3b mUsbEPMap EP12
193 # 0x3c mUsbEPMap EP13
194 # 0x3d mUsbEPMap EP14
196 # 0x3E ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP0
197 * BIT0 - BIT7; low size regs. Max size 0x7ff (ZM_EP_IN_MAX_SIZE_LOW_OFFSET + ZM_EP_IN_MAX_SIZE_HIGH_OFFSET)
199 Current configuration:
218 # 0x3F ZM_EP_IN_MAX_SIZE_HIGH_OFFSET EP0
222 * BIT4 - mUsbEPinRsTgSet
223 * BIT3 - mUsbEPinStallSet
224 * BIT0 - BIT2; High size regs
225 These offset + 2 Byte step for each endpoint.
226 For example EP0 = +0x00; EP1 = +0x02; or offset+(EPn << 1). In these address space will fit 15 endpoints.
245 # 0x40 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP1
246 # 0x42 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP2
247 # 0x44 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP3
248 # 0x46 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP4
249 # 0x48 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP5
250 # 0x4A ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP6
251 # 0x4C ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP7
252 # 0x4E ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP8
253 # 0x50 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP9
254 # 0x52 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP10
255 # 0x54 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP11
256 # 0x56 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP12
257 # 0x58 ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP13
258 # 0x5A ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP14
259 # 0x5C ZM_EP_IN_MAX_SIZE_LOW_OFFSET EP15
261 # 0x5E ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP0
262 * BIT0 - BIT7; low size regs. Max size 0x7ff (ZM_EP_OUT_MAX_SIZE_LOW_OFFSET + ZM_EP_OUT_MAX_SIZE_HIGH_OFFSET)
264 # 0x5F ZM_EP_OUT_MAX_SIZE_HIGH_OFFSET EP0
268 * BIT4 - mUsbEPoutRsTgSet
269 * BIT3 - mUsbEPoutStallSet
270 * BIT0 - BIT2; High size regs
272 These offset + 2 Byte step for each endpoint.
273 For example EP0 = +0x00; EP1 = +0x02; or offset+(EPn << 1). In these address space will fit 15 endpoints.
275 # 0x60 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP1
276 # 0x62 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP2
277 # 0x64 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP3
278 # 0x66 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP4
279 # 0x68 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP5
280 # 0x6A ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP6
281 # 0x6C ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP7
282 # 0x6E ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP8
283 # 0x70 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP9
284 # 0x72 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP10
285 # 0x74 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP11
286 # 0x76 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP12
287 # 0x78 ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP13
288 # 0x7A ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP14
289 # 0x7C ZM_EP_OUT_MAX_SIZE_LOW_OFFSET EP15
291 # 0x80 mUsbFIFOMap FIFO0
295 * BIT4 - Direction: 0 - OUT; 1 - IN.
296 * BIT0 - BIT3: assigned EP number.
299 * 0x80 0x01 - EP1 OUT
300 * 0x81 0x01 - EP1 OUT
316 # 0x81 mUsbFIFOMap FIFO1
317 # 0x82 mUsbFIFOMap FIFO2
318 # 0x83 mUsbFIFOMap FIFO3
319 # 0x84 mUsbFIFOMap FIFO4
320 # 0x85 mUsbFIFOMap FIFO5
321 # 0x86 mUsbFIFOMap FIFO6
322 # 0x87 mUsbFIFOMap FIFO7
323 # 0x88 mUsbFIFOMap FIFO8
324 # 0x89 mUsbFIFOMap FIFO9
325 # 0x8a mUsbFIFOMap FIFO10
326 # 0x8b mUsbFIFOMap FIFO11
327 # 0x8c mUsbFIFOMap FIFO12
328 # 0x8d mUsbFIFOMap FIFO13
329 # 0x8e mUsbFIFOMap FIFO14
330 # 0x8f mUsbFIFOMap FIFO15
332 # 0x90 mUsbFIFOConfig FIFO0
333 * BIT7 - If EPn use more then one FIFO, then this bit should be on the first
336 * BIT4 - Block size: 0 - 64/512; 1 - 128/1024. It depends on initial FIFO size.
337 * BIT2 - BIT3; number of FIFO blocks or better to say extra blocks? 0 - no more blocks; 1 - one block; 2 - two blocks.
338 * BIT0 - BIT1; EP type: 0x1 - Iso; 0x2 - Bulk, 0x3 - Intr;
340 * 0x90 0x86 <- FIFO0: Bulk | + one block (0x91) | size 512
357 # 0x91 mUsbFIFOConfig FIFO1
358 # 0x92 mUsbFIFOConfig FIFO2
359 # 0x93 mUsbFIFOConfig FIFO3
360 # 0x94 mUsbFIFOConfig FIFO4
361 # 0x95 mUsbFIFOConfig FIFO5
362 # 0x96 mUsbFIFOConfig FIFO6
363 # 0x97 mUsbFIFOConfig FIFO7
364 # 0x98 mUsbFIFOConfig FIFO8
365 # 0x99 mUsbFIFOConfig FIFO9
366 # 0x9a mUsbFIFOConfig FIFO10
367 # 0x9b mUsbFIFOConfig FIFO11
368 # 0x9c mUsbFIFOConfig FIFO12
369 # 0x9d mUsbFIFOConfig FIFO13
370 # 0x9e mUsbFIFOConfig FIFO14
371 # 0x9f mUsbFIFOConfig FIFO15
373 # 0xa0 FUSB_REG_FIFO0_INS
374 * BIT0 - BIT2 - high offset of byte count in fifo.
376 # 0xa1 FUSB_REG_FIFO1_INS
377 # 0xa2 FUSB_REG_FIFO2_INS
378 # 0xa3 FUSB_REG_FIFO3_INS
379 # 0xa4 FUSB_REG_FIFO4_INS
380 # 0xa5 FUSB_REG_FIFO5_INS
381 # 0xa6 FUSB_REG_FIFO6_INS
382 # 0xa7 FUSB_REG_FIFO7_INS
383 # 0xa8 FUSB_REG_FIFO8_INS
384 # 0xa9 FUSB_REG_FIFO9_INS
385 # 0xaa FUSB_REG_FIFO10_INS
386 # 0xab FUSB_REG_FIFO11_INS
387 # 0xac FUSB_REG_FIFO12_INS
388 # 0xad FUSB_REG_FIFO13_INS
389 # 0xae FUSB_REG_FIFO14_INS
390 or known as ZM_EP3_BYTE_COUNT_HIGH_OFFSET
392 comments: after sending data from target to host, set BIT3
394 # 0xaf FUSB_REG_FIFO15_INS
395 or known ZM_EP4_BYTE_COUNT_HIGH_OFFSET
396 BIT4 - 1 - reset fifo; 0 - disable reset?
397 comments: probably compatible with ZM_EP3_BYTE_COUNT_HIGH_OFFSET.
398 **These name reg do not fit to pattern!!!** Compare with 0x3e, 0x3f and 0x5e, 0x5f.
399 If we have 0x3e, 0x3f and 0x5e, 0x5f, why do we need this register?
401 # 0xb0 FUSB_REG_FIFO0_BCNT
402 # 0xb1 FUSB_REG_FIFO1_BCNT
403 # 0xb2 FUSB_REG_FIFO2_BCNT
404 # 0xb3 FUSB_REG_FIFO3_BCNT
405 # 0xb4 FUSB_REG_FIFO4_BCNT
406 # 0xb5 FUSB_REG_FIFO5_BCNT
407 # 0xb6 FUSB_REG_FIFO6_BCNT
408 # 0xb7 FUSB_REG_FIFO7_BCNT
409 # 0xb8 FUSB_REG_FIFO8_BCNT
410 # 0xb9 FUSB_REG_FIFO9_BCNT
411 # 0xba FUSB_REG_FIFO10_BCNT
412 # 0xbb FUSB_REG_FIFO11_BCNT
413 # 0xbc FUSB_REG_FIFO12_BCNT
414 # 0xbd FUSB_REG_FIFO13_BCNT
415 # 0xbe FUSB_REG_FIFO14_BCNT
416 or known as ZM_EP3_BYTE_COUNT_LOW_OFFSET
417 size of data in fifo buffer? never used?
419 # 0xbf FUSB_REG_FIFO15_BCNT
420 or known as ZM_EP4_BYTE_COUNT_LOW_OFFSET
421 size of data in fifo buffer. Maximum size of EP4 should be 64 Bytes. If reported value is bigger, then buffer is defiantly corrupt.
423 # 0xc0 FIFO0 DATA OFFSET?
424 or known as FUSB_REG_FIFO0_DP
426 # 0xc4 FIFO1 DATA OFFSET?
427 # 0xc8 FIFO2 DATA OFFSET?
428 # 0xcc FIFO3 DATA OFFSET?
429 # 0xd0 FIFO4 DATA OFFSET?
430 # 0xd4 FIFO5 DATA OFFSET?
431 # 0xd8 FIFO6 DATA OFFSET?
432 # 0xdc FIFO7 DATA OFFSET?
433 # 0xe0 FIFO8 DATA OFFSET?
434 # 0xe4 FIFO9 DATA OFFSET?
435 # 0xe8 FIFO10 DATA OFFSET?
436 # 0xec FIFO11 DATA OFFSET?
437 # 0xf0 FIFO12 DATA OFFSET?
438 # 0xf4 FIFO13 DATA OFFSET?
439 # 0xf8 FIFO14 DATA OFFSET?
440 # 0xfc FIFO15 DATA OFFSET?
442 # 0xF8 ZM_EP3_DATA_OFFSET
443 32bit data. Probably FIFO14 offset.. not EP
445 # 0xFC ZM_EP4_DATA_OFFSET
446 32bit data. Probably FIFO15 offset.. not EP
448 # 0x100 ZM_CBUS_FIFO_SIZE_REG
449 0x1 - 1 Byte, 0x3 - 2 Byte, 0x7 - 3 Byte; 0xf - 4 Byte.
451 **we miss 7 bytes here**
453 # 0x108 ZM_SOC_USB_MODE_CTRL_OFFSET
454 BIT10 - 1 - enable MP (EP6) downstream stream mode
455 BIT9 - 1 - enable MP (EP6) downstream DMA mode
456 BIT8 - 1 - enable HP (EP5) downstream DMA mode
457 BIT7 - 1 - enable HP (EP5) downstream stream mode
458 BIT6 - 1 - enable LP downstream stream mode
459 BIT5 - define the host dma buffer size - 4096(00) 8192 (01) 16384(10) 32768(11) bytes
461 BIT3 - 0 - enable upstream stream mode: 1 - enable upstream packed mode;
462 BIT2 - 0 - Set into 64 byte mode (full speed) 1 - Set into 512 byte mode (usb highspeed)
463 BIT1 - 0 - disable upstream dma mode; 1 - enable upstream dma mode
464 BIT0 - 0 - disable LP down stream dma mode; 1 - eanble LP down stream dma mode
466 ryan: 04/01: bit0 could disable lpdn dma, which is good at debugging while async_fifo have problem, we could disable this and check the fifo_rcv_size to see if we have correct at fifo or not
467 LP - lo priotiry; MP - middle priority; HP - High priority;
470 # 0x110 ZM_SOC_USB_MAX_AGGREGATE_OFFSET
471 set stream mode packet buffer critirea
472 0x0 = disable stream mode or 1 packet. So 0x9 is 10 packets?
473 # 0x114 ZM_SOC_USB_TIME_CTRL_OFFSET
474 set stream mode timeout critirea. the unit is 32 USB (30Mhz) clock cycles.
476 # 0x1f0 ZM_CBUS_CTRL_REG