diff options
Diffstat (limited to 'share')
| -rw-r--r-- | share/docs/hw/et131x.txt | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/share/docs/hw/et131x.txt b/share/docs/hw/et131x.txt new file mode 100644 index 0000000..43d7c4f --- /dev/null +++ b/share/docs/hw/et131x.txt @@ -0,0 +1,215 @@ +-------------------------------------- +Unofficial ET131X datasheet. If Agere +doesn't give you shit, OSMORA will + +Author: Ian Marco Moffett +-------------------------------------- + +-- PCI information + +VENDOR ID: 0x11C1 (Agere) +Device ID: 0xED00 + +The ET131X exposes its register interface through +PCI BAR 0. + +-- Device register map (register set list) +| +++ GLOBAL REGS (GLOBAL): + // JAGCore register map (offset BAR[0] + 0x0000) + TX_queue_start_addr [dword] (BAR[0] + 0x0000) + TX_queue_end_addr [dword] (BAR[0] + 0x0004) + RX_queue_start_addr [dword] (BAR[0] + 0x0008) + RX_queue_end_addr [dword] (BAR[0] + 0x000C) + PM_CSR [dword] (BAR[0] + 0x0010) + unused [dword] (BAR[0] + 0x0014) + int_status [dword] (BAR[0] + 0x0018) + int_mask [dword] (BAR[0] + 0x001C) + int_alias_clr_en [dword] (BAR[0] + 0x0020) + int_status_alias [dword] (BAR[0] + 0x0024) + sw_reset [dword] (BAR[0] + 0x0028) + slv_timer [dword] (BAR[0] + 0x002C) + msi_config [dword] (BAR[0] + 0x0030) + loopback [dword] (BAR[0] + 0x0034) + watchdog_timer [dword] (BAR[0] + 0x0038) + ---------------------------------------- + NOTES: + [REGISTER INFORMATION] + - TX_queue_start_addr: + Address of transmit queue start in internal RAM. + - TX_queue_end_addr: + Address of transmit queue end in internal RAM. + - RX_queue_start_addr: + Address of receive queue start in internal RAM. + - RX_queue_end_addr: + Address of receive queue end in internal RAM. + - PM_CSR: + Power management control/status register. + - unused: + Not used, leave alone. + - int_status: + Interrupt status register. + - int_mask: + Interrupt mask register + - int_alias_clr_en: + ???? + - int_status_alias: + ???? + - slv_timer: + ???? - for some sort of timeout + - loopback: + Loopback control register + [0x00000001] -> LOOP MAC + [0x00000002] -> LOOP DMA + - watchdog_timer: + Watchdog timer regieter (nanoseconds) +| [0] -> DISABLED +++ MAC REGISTERS (MAC_REGS): + // JAGCore MAC registers (offset BAR[0] + 0x5000) + cfg1 [dword] (BAR[0] + 0x5000) + cfg2 [dword] (BAR[0] + 0x5004) + ipg [dword] (BAR[0] + 0x5008) + hfdp [dword] (BAR[0] + 0x500C) + max_fm_len [dword] (BAR[0] + 0x5010) + reserved1 [dword] (BAR[0] + 0x5014) + reserved2 [dword] (BAR[0] + 0x5018) + mac_test [dword] (BAR[0] + 0x501C) + mii_mgmt_cfg [dword] (BAR[0] + 0x5020) + mii_mgmt_cmd [dword] (BAR[0] + 0x5024) + mii_mgmt_addr [dword] (BAR[0] + 0x5028) + mii_mgmt_ctrl [dword] (BAR[0] + 0x502C) + mii_mgmt_stat [dword] (BAR[0] + 0x5030) + mii_mgmt_indicator [dword] (BAR[0] + 0x5034) + if_ctrl [dword] (BAR[0] + 0x5038) + if_stat [dword] (BAR[0] + 0x503C) + station_addr1 [dword] (BAR[0] + 0x5040) + station_addr2 [dword] (BAR[0] + 0x5044) + NOTES: + [REGISTER INFORMATION] + - cfg1: + First MAC configuration register. + - cfg2: + Second MAC configuration register. + - ipg: + MAC Interpacket Gap configuration register. + - hfdp: + MAC Half Duplex configuration register. + - max_fm_len: + Max packet length (bytes) sent through MAC without + truncation. + - mac_test: + MAC test registers + - mii_mgmt_cfg: + MAC MII Management Config register. + - mii_mgmt_cmd: + MAC MII Management Command register. + - mii_mgmt_ctrl: + MAC MII Management Control register. + - mii_mgmt_stat: + MAC MII Management Status register. + - mii_mgmt_indicator: + MAC MII Management Indicator register. + - if_ctrl: + MAC interface control register. + - station_addr1: + First MAC station address register. + - station_addr2: + Second MAC station address register. + [BITS] + ------------------------------------- + @ cfg1: + [bits 0]: TX enable + [bits 1]: Syncd TX enable + [bits 2]: RX enable + [bits 3]: Syncd TX enable + [bits 4]: TX flow + [bits 5]: RX flow + [bits 7:6]: Reserved + [bits 8]: Loopback + [bits 15:9]: Reserved + [bits 16]: Reset TX func + [bits 17]: Reset RX func + [bits 18]: Reset TX MC + [bits 19]: Reset RX MC + [bits 29:20]: Reserved + [bits 30]: Sim reset + [bits 31]: Soft reset + @ cfg2: + [bits 0]: Full-duplex + [bits 1]: CRC enable + [bits 2]: Pad CRC + [bits 3]: Unused (undefined) + [bits 4]: Length check + [bits 5]: Huge frame + [bits 7:6]: Reserved + [bits 9:8]: Interface mode + [bits 11:10]: Reserved + [bits 15:12]: Preamble + [bits 31:16]: Reserved + @ ipg: + [bits 7:0]: B2B IPG + [bits 15:8]: Minimum IFG enforce + [bits 22:16]: Non B2B IPG 2 + [bits 23]: Unused (undefined) + [bits 30:24]: Non B2B IPG 1 + [bits 31]: Reserved + @ hfdp: + [bits 9:0]: Collision window + [bits 11:10]: Reserved + [bits 15:12]: Re-transmit max + [bits 16]: Excess defer + [bits 17]: No backoff + [bits 18]: BP no backoff + [bits 19]: Alt BEB enable [1] + [bits 23-20]: Alt BEB trunc [1] + [bits 31-24]: Reserved + | + ++ [1]: BEB refers to Binary Exponential Backoff which is + a method to mitigate collisions by doubling the TX + backoff window (throttling TX rate) per collision. + ------------------------------------- + + +------------------------------------------------------------------ +ET131X REGISTER SPACE NOTES: +------------------------------------------------------------------ +[Padding]: + Each register set exists within a 4096 byte region and some + register sets do not fully span that full length. Therefore + when defining the register space within a struct, one must + be sure to account for such gaps by including 'n' bytes of + padding after each register set. Where 'n' is how many bytes + left to fully span 4096 bytes in other words, '4096 - regset_len'. + +------------------------------------------------------------------ +SOFTWARE RESET PROCCESS: +------------------------------------------------------------------ +#define MAC_CFG1_SOFTRST 0x80000000 /* Soft reset */ +#define MAC_CFG1_SIMRST 0x40000000 /* SIM reset */ +#define MAC_CFG1_RESET_RXMC 0x00080000 /* RX MC reset */ +#define MAC_CFG1_RESET_TXMC 0x00040000 /* TX MC reset */ +#define MAC_CFG1_RESET_RXFUNC 0x00020000 /* RX func reset */ +#define MAC_CFG1_RESET_TXFUNC 0x00010000 /* TX func reset */ +#define GBL_RESET_ALL 0x007F /* Global reset */ +------------------------------------------------------------------ +To perform a software reset, one must write the value of MAC_CFG1_SOFTRST, +MAC_CFG1_SIMRST, MAC_CFG1_RESET_RXMC, MAC_CFG1_RESET_TXMC, MAC_CFG1_RESET_RXFUNC, +and MAC_CFG1_RESET_TXMC combined together with a bitwise OR to the 'cfg1' register +of the 'MAC_REGS' register set. + +This results in the MAC core (aka JAGCore) resetting all internal state +and being brought to halt. + +Once the MAC core is reset, you must be sure to also reset the rest of the card, +(I know, just when you thought you were done). This may be done by writing the +value of GBL_RESET_ALL to the 'sw_reset' register of the 'GLOBAL' register set. +This results in the reset of further state such as state machines for TX DMA, RX DMA, +MAC TX, MAC RX, etc cetera. + +To ensure the TX/RX paths of the MAC core are in a known state, one +must write the value of MAC_CFG1_RESET_RXMC, MAC_CFG1_RESET_TXMC, MAC_CFG1_RESET_RXFUNC, +and MAC_CFG1_RESET_TXMC combined together with a bitwise OR to the 'cfg1' register +of the 'MAC_REGS' register set. + +And finally, you must also make sure the 'cfg1' register of the 'MAC_REGS' register +set is also in a known state by clearing it to 0x00000000. |