SPEAR-07-NC03

SPEAR-07-NC03 Ethernet Communication Controller with USB-Host Features ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ Based on ARM720T (8K Caches and MMU included) Support a 10/100 Mbits/s Ethernet connection (IEEE802.3) Full-Speed USB Host Controller, supports 12Mbit/s Full Speed Devices UART Interface: 115KBaud I2C interface: Fast and Slow. IEEE1284 Host Controller Real Time Clock Timers and Watchdog peripherals Integrated PLL (25MHz Input, 48MHz Output) Up to 12 GPIOs (including IEEE1284 port) 8K SRAM shared with an External Microprocessor Static Memory Controller (up to 2 Banks, Max 16M each) LFBGA180 (12x12x1.7mm) ■ ■ ■ DRAM Controller SDRAM/EDO (up to 4 Banks, Max 32M each) External I/O Banks: 2 x 16KB. Package LFBGA 180 (12x12mm x1.7mm) Description SPEAR-07-NC03 is a smart Communication Controller for USB and Ethernet Communication. SPEAR-07-NC03 allows the sharing of a FullSpeed USB or IEEE1284 or a UART Peripherals inside an Ethernet System. SPEAR-07-NC03 is supported Operation Systems such as eCOS. by several Order codes Part number SPEAR-07-NC03 Op. Temp. range, °C -40 to +105 Package LFBGA180 Packing Tray May 2006 Rev 5 1/194 www.st.com 1 Table of Contents SPEAR-07-NC03 Table of Contents 1 Product overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 2 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11 2.12 2.13 2.14 2.15 Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 ARM720T RISC Processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 External Memory Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 IEEE802.3/Ethernet MAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 DMA Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 UART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Watchdog Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 GPIO (Programmable I/O) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Interrupt Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 IEEE1284 Host Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 USB Host Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Shared SRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Real Time Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Frequency Synthesizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3 4 Top-level Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Pin Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 4.1 4.2 Functional Pin Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 PAD Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 5 Memory Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1 5.2 Global MAP (AHB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 I/O MAP (APB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 6 Blocks description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 6.1 CPU SUBSYSTEM & AMBA BUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 2/194 SPEAR-07-NC03 6.1.1 6.1.2 6.1.3 6.1.4 6.1.5 6.1.6 Table of Contents ARM720 Processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 MMU Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Instruction and Data Cache overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Write Buffer Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Coprocessor Registers Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 6.2 MAC Ethernet Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Transfer Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Ethernet register map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Register description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Programming the DMA MAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 6.3 Full-Speed USB Host Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.3.6 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Host Controller Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Initialization of the HCI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Operational States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Operational Registers Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Register description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 6.4 IEEE1284 Host Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Communication modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Matrix of Protocol Signal Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Register MAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 IEEE1284 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 DMA Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Parallel Port register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 6.5 UART Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 6.5.1 6.5.2 6.5.3 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Registers Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Register description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 6.6 I2C Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 6.6.1 6.6.2 6.6.3 6.6.4 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Register Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 I2C Functional description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 3/194 Table of Contents SPEAR-07-NC03 Dynamic Memory Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 6.7.1 6.7.2 6.7.3 6.7.4 6.7.5 6.7.6 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Memory Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Address Mapping Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 External Bus Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Register MAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Register Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 6.7 6.8 Static Memory Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 6.8.1 6.8.2 SRAMC description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Registers Map and description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 6.9 Shared SRAM Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 6.9.1 6.9.2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 External Processor Timings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 6.10 DMA Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 6.10.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 6.10.2 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 6.10.3 Registers Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 6.11 RTC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 6.11.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 6.11.2 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 6.11.3 Register Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 6.12 Timer/Counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 6.12.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 6.12.2 Registers Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 6.12.3 Registers Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 6.13 Watch-Dog Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 6.13.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 6.13.2 Register map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 6.13.3 Register Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 6.14 Interrupt Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 6.14.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 6.14.2 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 6.14.3 Register Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 6.14.4 Interrupt Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 6.15 GPIO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 6.15.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 4/194 SPEAR-07-NC03 Table of Contents 6.15.2 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 6.15.3 Registers Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 6.16 6.17 RESET and Clock Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 6.16.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 PLL (Frequency synthesizer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 6.17.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 6.17.2 Global Configuration Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 6.17.3 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 6.17.4 Registers Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 7 Electrical Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 7.1 7.2 7.3 7.4 7.5 Absolute Maximum Rating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Recommended Operating Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 DC Electrical Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 7.3.1 POWERGOOD timing requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 AC Electrical characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 External Memory Bus Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 7.5.1 7.5.2 Timings for External CPU writing access . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Timings for External CPU reading access . . . . . . . . . . . . . . . . . . . . . . . . . . 190 8 9 10 Reference Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Package Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 5/194 List of tables SPEAR-07-NC03 List of tables Table 1. Table 2. Table 3. Table 4. Table 5. Table 6. Table 7. Table 8. Table 9. Table 10. Table 11. Table 12. Table 13. Table 14. Table 15. Table 16. Table 17. Table 18. Table 19. Table 20. Table 21. Table 22. Table 23. Table 24. Table 25. Table 26. Table 27. Pin Descriptions by Functional Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Pin Description by PAD Types (*LH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 PAD Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 AHB Memory Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 APB Memory Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 MRC and MCR (CP15) bit pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Control Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 TTB Register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 DAC Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 TLB Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Ethernet register map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 USB Host Controller Operational Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 IEEE1284 Register Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 DRAM Address Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Memory Bank Size Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Bank size field and its corresponding actual size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Register MAP and Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Pin mapping for IEEE1284 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Pin mapping for JTAG Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Pin mapping for nUSB_ENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Pin mapping for nI2C_ENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Absolute Maximum Ratings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Recommended Operating Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 DC Electrical Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Core power consumption (VDD = 1.8V, TA = 25°C) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Expected timings for external CPU writing access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Expected timings for external CPU reading access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 6/194 SPEAR-07-NC03 List of figures List of figures Figure 1. Figure 2. Figure 3. Figure 4. Figure 5. Figure 6. Figure 7. Figure 8. Figure 9. Figure 10. Figure 11. Figure 12. Figure 13. Figure 14. Figure 15. Figure 16. Figure 17. Figure 18. Figure 19. Figure 20. Figure 21. Figure 22. Figure 23. Figure 24. Figure 25. Figure 26. Figure 27. Figure 28. Figure 29. Figure 30. Figure 31. SPEAr Net Top level Bock Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 ARM720T Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Ethernet Controller Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Ethernet Frame Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 IEEE802.3 Frame Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 DMA Descriptor chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 USB Host Controller Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 USB Focus Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 IEEE1284 Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 IEEE1284 - DMA Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 UART Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 I2C Controller Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 I2C Bus Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Transfer sequencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 SDRAM Controller Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 SDRAM Access Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 EDO Access Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Shared SRAM Controller Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 SPEAr Net Write Timing Diagram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 SPEAr Net Read Timing Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 DMA Controller Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 RTC Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Timer/Counter Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Watch-Dog Timer Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Interrupt Controller Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 GPIO Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 PLL Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 POWERGOOD requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 External CPU writing timings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 External CPU reading timingss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 LFBGA180 Mechanical Data & Package Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 7/194 1 Product overview SPEAR-07-NC03 1 1.1 Product overview Overview The SPEAR-07-NC03 is based on ARM720T RISC core, cache and MMU. It provide a bridge between four different I/F : 1. IEEE802.3/Ethernet MAC core for network interface. Its base interface with PHY (physical layer) chip is capable of 10/100 Mbps MII (Medium Independent Interface) and 7-wire interface. USB host controller with both interrupt-based and DMA-based data handling method. IEEE1284 host controller offering Compatibility mode, Nibble mode and ECP mode. Shared RAM (Mail box method) for communication with other processors. I2C master controller. 2. 3. 4. 5. 8/194 SPEAR-07-NC03 2 Features 2 2.1 Features Architecture ● ● ● ● ● ● ● Integrated System For Ethernet Application 48MHz, 3.3V I/O and 1.8V Internal Core Voltage ARM720T RISC Processor Core AMBA Rev. 2.0 System Bus Architecture IEEE802.3/Ethernet Compliant MAC Core USB Interface Solution (Host) IEEE1284 Interface Solution (Master) 2.2 ARM720T RISC Processor ● ● ● ● ARM7TDMI RISC Core 8KB Unified Instruction/Data Cache Enlarged Write Buffer (8 words and 4 different addresses) Virtual Address Support with MMU 2.3 External Memory Interface ● ● ● ● ● ● 16bit/8bit Memory Bus Support ROM/SRAM/Flash Static Memory Controller SDRAM/EDO DRAM Controller External I/O Bank Controller Independent Configurable Memory and I/O Banks Replaceable Memory and I/O Bank Addresses 2.4 IEEE802.3/Ethernet MAC ● ● ● ● ● ● 10/100 MAC, MAC Host block, Station Management block, Address Compliant with IEEE 802.3 and 802.3u specifications Supports 10/100 Mb/s data transfer rates IEEE 802.3 Media Independent Interface (MII) Supports full and half duplex operations Check block and the Control Status Register (CSR) block 2.5 DMA Controller ● ● Dedicated Channels for MAC core, USB Host and IEEE1284 interface 2 Channels general purpose DMA (Memory To Memory) 9/194 2 Features ● ● ● SPEAR-07-NC03 2 Channels general purpose DMA dedicated to the external requests (I/O to Memory and Memory to I/O) Increments/Decrements of Source/Destination Address In 16/8bit(external), 32/16/ 8(internal) Data Transfers Burst Transfer Mode 2.6 UART ● ● ● ● ● Support For 8-Bit Serial Data Tx And Rx Selectable 2/1 Stop Bits Selectable Even, Odd and No Parity Parity, Overrun And Framing Error Detection Max Transfer rate:115KBaude 2.7 Timers ● Channel Programmable 16-Bit Timers with 8 bit pre-scaler 2.8 Watchdog Timer ● ● ● For Recovery from Unexpected System Hang-up One Programmable 16-Bit Watchdog Timer With Reset Output Signal (more than 200 system clock period to initial peripheral devices) Programmable period 1 ~ 10 sec 2.9 GPIO (Programmable I/O) ● ● ● 4 Dedicated Programmable I/O Ports (Pins) 2 Multiplexed Pins with I2C Bus Signals Pins Individually Configurable To Input, Output Or I/O Mode 2.10 Interrupt Controller ● ● ● ● ● 2 External Interrupt Sources Support 9 Internal interrupt sources. All channels can be individually rerouted to the Fast (nFIQ) or to the Normal (nIRQ) processor lines Level and edge (rise, fall and both) selectable Software Controlled Priority 2.11 IEEE1284 Host Controller ● Compatibility/Nibble/ECP/EPP Mode Host Support 10/194 SPEAR-07-NC03 ● ● 2 Features DMA-based Data Transfer Capability for ECP Fully Software Controllable Operation Mode 2.12 USB Host Controller ● ● ● ● ● Full-Speed USB compliant Supports Low Speed and Full Speed Devices Configuration data stored in Port Configurable Block Single 48 MHz input clock Integrated Digital PLL 2.13 Shared SRAM ● ● ● ● ● External Processor Communication Purpose Shared SRAM Bus Arbiter Same address can be accessed at the same time Separated from AHB Bus for Bus Traffic Reduce Interrupt Output Generation for Transfer Notification 2.14 Real Time Clock ● ● ● ● Real time clock-calendar (RTC) Clocked by 32.768MHz low power clock input Separated power supply (1.8 V) 14 digits (YYYY MM DD hh mm ss) precision 2.15 Frequency Synthesizer ● On-chip Frequency Synthesizer Provided – – Fin: 25 MHz. Fout: 48 MHz 11/194 3 Top-level Block Diagram SPEAR-07-NC03 3 Figure 1. Top-level Block Diagram SPEAr Net Top level Bock Diagram ARM720T Microprocessor Core & MMU WRAPPER FROM CPU TO AMBA 8 KByte cache (Instr & Data) MII & 7-wire PHY Interface MAC110 IEEE802.3/Ethernet MAC Contr. + DMA AHB Decoder & Arbiter, APB Bridge, MUX Master to Slave, MUX Slave to Master External Memory BUS ROM/FLASH 2 Banks USB Interface USB HOST HOST Contr. + DMA M1284H IEEE1284 Host Contr. + DMA DMA Controller 2 Memory to Memory 2 I/OToMem & MemToI/O DRAMC SDRAM/EDO DRAM Controller SRAM/EDO 4 Banks IEEE1284 Interface I/O AHB & APB SRAMC ROM/FLASH/SRAM External I/O Controller 2 Banks nDREQ[1:0] nDACK[1:0] nIRQ[1:0] INTC Interrupt Controller (16 ch) TIMER (2 channels) Shared SRAM Bus Arbiter text Ext Bus External Processor SPEAr Net 8KB Shared SRAM 32 KHz RTC XPAddr[12:0] XPData[15:0] nXPCS nXPWE nXPRE nXPWAIT nXPIRQ GPIO (6 channels) MI2C I2C Controller PLL Frequency Synthesizer 25 MHz PowerGood nResetOut RESET CONTROLLER WDT Watch-dog Timer TX RX UART (1 channel) 12/194 SPEAR-07-NC03 4 Pin Descriptions 4 4.1 Note: Table 1. Pin Descriptions Functional Pin Groups Note: symbol / means multiplexing modes Pin Descriptions by Functional Groups Pin Name MCLKI MCLKO Function Oscillator Clock Input Oscillator Clock Output System Reset Input Peripheral Chips Driving Reset Output Test Mode Selector Output Clock (25 MHz) Address Bus Add[10]/AP is the auto pre-charge control pin. The auto pre-charge command is issued at the same time as burst read or burst write by asserting high on Add[10]/ AP External, Bi-directional, 16 bit Data Bus Row Address Strobe for EDO DRAM/ nSDCS is chip select pin for SDRAM Row Address Strobe for SDRAM Column Address Strobe for SDRAM System Clock for SDRAM Clock enable signal for SDRAM Write Enable for external devices. Chip Select for external I/O Bank Not ROM/SRAM/FLASH Chip Select Not Output Enable for memory I/O Banks size: 16KB 48 MHz Synchronous with System Clock “1” → Test 25 MHz 25 MHz Remark Group Clocks, Reset and configuration. PowerGood nResetOut TMODE0 PCLK Add[22:11], Add[10]/AP, Add[9:0] ROM Banks: 16MB Max. DRAM Banks: 32MB Max. Data[15:0] nRAS[3:0]/ nSDCS[3:0] nSDRAS Memory Interface nSDCAS SDCLK CKE nWE nECS[1:0] nRCS[1:0] nOE nCAS is the Column Address Strobe for nCAS[1:0]/ DQM[1:0] EDO DQM is data mask signal for SDRAM. 13/194 4 Pin Descriptions SPEAR-07-NC03 Table 1. Group Pin Descriptions by Functional Groups (continued) Pin Name MDC MDIO COL/ COL_10M TX_CLK/ TXCLK_10M TXD[3:0]/ TXD_10M/ LOOP_10M Function Management Data Clock Management Data I/O Collision detected/collision detected for 10Mbps Transmit clock/ transmit clock for 10Mbps Remark Transmit data/ transmit data for 10Mbps Transmit enable/transmit enable for 10Mbps Carrier sense/carrier sense for 10Mbps Receive clock/receive clock for 10Mbps Receive data/receive data for 10Mbps Receive data valid Receive error Function UART receive data UART transmit data Test Clock Input Test Data Input Test Data Output Test Mode select Input Test Reset Line General Purpose I/O #5 and #4/ I2C Bus Controller SDA, SCL Serial Clock line Serial Data line Remark Ethernet Controller TX_EN/ TXEN_10M CRS/ CRS_10M RX_CLK/ RXCLK_10M RXD[3:0]/ RXD_10M RX_DV/ LINK_10M RX_ERR Group UART Pin Name RXData TXData TCK TDI JTAG Interface TDO TMS TRST GPI/O GPI/O[5:0] SCL SDA I2C Interface 14/194 SPEAR-07-NC03 Table 1. Group 4 Pin Descriptions Pin Descriptions by Functional Groups (continued) Pin Name XPData[15:0] XPAddr[12:0] nXPCS Function External Processor Data Bus High Byte External Processor Address Bus Shared SRAM CS from External Processor Shared SRAM Write Strobe from Ext. Proc. Shared SRAM Read Strobe from Ext. Proc. Wait Signal to External Processor Interrupt Request to External Processor USB Host differential Data signal high side USB Host differential Data signal low side Data Lines to/from peripheral Strobe Line to peripheral Ack line from peripheral Busy line from peripheral Paper Error line from peripheral Selection feedback from peripheral Auto Feed signal to peripheral Generic error line from peripheral Init (Reset) line to peripheral Select signal to peripheral Direction control for external transceiver RTC Oscillator Input line RTC Oscillator Output line External Interrupt request lines External request lines for DMA External Acknowledge lines from DMA DRAM type selection USB Transceiver Enable or Disable Pull-Up → SDRAMM Pull-up → Enabled 32.768 KHz 32.768 KHz Remark External Processor Interface nXPWE nXPRE nXPWAIT nXPIRQ USB UHD+ UHDPpData[7:0] nSTROBE nACK Busy PError IEEE1284 Select nAutoFD nFault nInit nSelectIn PpDataDir RTC RTCXI RTCXO nXIRQ[1:0] MISC. nXDRQ[1:0] nXDACK[1:0] Sdram/EDO USBEnable Configuration IEEE1284/ XProcessor BootRomBusWidth UART/JTAG GenConf[2:0] VDD_Core IEEE1284 or External Processor selection Pull-up → IEEE1284 Bus Width Selection for Rom 0 Debug interface selection General purpose Configuration lines Internal Logic Core VDD (1.8V 5%) I/O Pad VDD (3.3V 5%) RTC VDD (1.8V 5%) Ground Pull-up → 16 bits Pull-up → UART Power VDD_I/O VDD_RTC GND 15/194 4 Pin Descriptions SPEAR-07-NC03 4.2 Table 2. Ref. 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 PAD Types Pin Description by PAD Types (*LH) Ball B1 C1 F2 E4 D1 E3 F5 G4 G2 G1 G5 H4 H5 H1 H3 J4 J5 J2 J3 K5 K2 L1 K4 L2 M1 N1 M3 N2 P1 P3 N4 P4 N5 MCLKI MCLKO PowerGood nRESETOut TMODE0 PCLK Add0 Add1 Add2 Add3 Add4 Add5 Add6 Add7 Add8 Add9 Add10_AP Add11 Add12 Add13 Add14 Add15_GenConf0 Add16_GenConf1 Add17_GenConf2 Add18_UART/JTAG Add19_BootRomBusWidth Add20_IEEE1284/XProcessor Add21_USBEnable Add22_Sdram/EDO Data0 Data1 Data2 Data3 Name ANA OSCI27B SCHMITT_TC B4TR_TC SCHMITT_TC BD4TARP_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC B8TR_TC BD8STRP_TC BD8STRP_TC BD8STRP_TC BD8STRP_TC BD8STRP_TC BD8STRP_TC BD8STRP_TC BD8STRP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC Type Dir. I I O I O O O O O O O O O O O O O O O O I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O 16/194 SPEAR-07-NC03 Table 2. Ref. 34 35 36 37 38 39 40 41 42 Ref. 43 44 45 46 47 48 49 50 51 52 53 Ref. 54 55 56 57 58 59 60 61 62 63 64 65 66 P5 M6 N6 P6 L6 M7 N7 K7 L7 Ball M8 K8 P8 N8 M9 K9 P9 N9 M10 P2 N10 Ball P11 L10 P12 N11 P14 N12 N13 M12 M13 N14 M14 K12 L14 4 Pin Descriptions Pin Description by PAD Types (*LH) (continued) Ball Data4 Data5 Data6 Data7 Data8 Data9 Data10 Data11 Data12 Name Data13 Data14 Data15 nRAS0_nSDCS0 nRAS1_nSDCS1_TDI nRAS2_nSDCS2_TDO nRAS3_nSDCS3_nTRST nSDRAS nSDCAS SDCLK CKE Name nWE nECS0 nECS1 nRCS0 nRCS1 nOE nCAS0_DQM0 nCAS1_DQM1 MDC MDIO COL/COL10M TXClk/TXClk10M TXD0/TXD010M Name Type BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC Type BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC B4TR_TC BD4STRUQP_TC B4TR_TC BD4STRUQP_TC B4TR_TC B4TR_TC BD4TARP_TC B2TR_TC Type B8TR_TC B4TR_TC B4TR_TC B2TR_TC B2TR_TC B8TR_TC B4TR_TC B4TR_TC B4TR_TC BD4STRUQP_TC SCHMITT_TC SCHMITT_TC B4TR_TC Dir. I/O I/O I/O I/O I/O I/O I/O I/O I/O Dir. I/O I/O I/O O I/O O I/O O O O O Dir. O O O O O O O O O I/O I I O 17/194 4 Pin Descriptions SPEAR-07-NC03 Table 2. Ref. 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 Ref. 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 K13 K14 J12 K10 J13 J14 J10 H13 H11 H14 H10 G11 G10 G14 A3 B4 A2 A1 Ball B3 C3 F10 F14 E10 F12 E14 E13 E1 E2 D14 E11 D13 B14 C13 C12 Pin Description by PAD Types (*LH) (continued) Ball Name TXD1/TXD110M TXD2/TXD210M TXD3/TXD310M TXEN/TXEN10M CRS/CRS10M RXClk/RXClk10M RXD0/RXD010M RXD1/RXD110M RXD2/RXD210M RXD3/RXD310M RxDV/LINK10M RXERR RXData_TCK TXData_TMS GPIO0 GPIO1 GPIO2 GPIO3 Name GPIO4_SCL GPIO5_SDA nXIRQ0 nXIRQ1 nXDRQ0 nXDRQ1 nXDACK0 nXDACK1 RTCXO RTCXI XPData0_PpData0 XPData1_PpData1 XPData2_PpData2 XPData3_PpData3 XPData4_PpData4 XPData5_PpData5 B4TR_TC B4TR_TC B4TR_TC B4TR_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC BD4STRUQP_TC BD4STRUQP_TC BD4STRUQP_TC BD4STRUQP_TC BD4STRUQP_TC Type BD4STRUQP_TC BD4STRUQP_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC B4TR_TC B4TR_TC ANA OSCI32B BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC Type Dir. O O O O I I I I I I I I I I/O I/O I/O I/O I/O Dir. I/O I/O I I I I O O I I/O I/O I/O I/O I/O I/O 18/194 SPEAR-07-NC03 Table 2. Ref. 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 Ref. 128 129 130 131 B13 B12 A13 B11 C10 A11 B10 D10 B9 A9 D9 C9 A8 E8 D8 C8 E7 D7 B7 C7 A6 B6 D6 C6 D5 A5 A4 Ball C5 F11 G13 E6, A12, E12, G12, L13, P10, L8, K6, M5, M2, K1, H2, F4 4 Pin Descriptions Pin Description by PAD Types (*LH) (continued) Ball Name XPData6_PpData6 XPData7_PpData7 XPData8 XPData9 XPData10 XPData11 XPData12 XPData13 XPData14 XPData15 XPAddr0_nSTROBE XPAddr1_nACK XPAddr2_Busy XPAddr3_PError XPAddr4_Select XPAddr5_nAutoFd XPAddr6_nFault XPAddr7_nInit XPAddr8_SelectIn XPAddr9_PpDataDir XPAddr10 XPAddr11 XPAddr12 nXPCS nXPWE nXPRE nXPWAIT Name nXPIRQ UHD+ UHDVDD3I/O Type BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD8STRUQP_TC BD2STRUQP_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC BD2STRUQP_TC SCHMITT_TC BD2STRUQP_TC BD2STRUQP_TC BD2STRUQP_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC SCHMITT_TC B4TR_TC Type B4TR_TC USB_PAD USB_PAD Power Dir. I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O I I I I I/O I I/O I/O I/O I I I I I I O Dir. O I/O I/O - 19/194 4 Pin Descriptions SPEAR-07-NC03 Table 2. Ref. Pin Description by PAD Types (*LH) (continued) Ball Name Type Dir. 144 D2, G3, J1, K3, N3, L5, P7, L9, P13, K11, H12, C14, F13, A14, A10 F3 E5 B2 C2 F1, J11, E9 B8, A7, B5 VSS Power - 459 160 161 162 163 166 169 VDDRTC VSSRTC VDD3PLL VSSPLL VDD VSS Power Power Power Power Power Power Not Connected - - - C4, C11, D3, D4, D11, D12, L3, L4, L11, L12, NC M4, M11 Table 3. PAD Description Description Analog PAD Buffer TTL Output Pad Buffer, 3 V capable, 2mA drive capability TTL Output Pad Buffer, 3 V capable, 4mA drive capability TTL Output Pad Buffer, 3 V capable, 8mA drive capability TTL Schmitt Trigger Bidirectional Pad Buffer, 2mA drive capability, 3 V Capable, with Pull-Up TTL Schmitt Trigger Bidirectional Pad Buffer, 4mA drive capability, 3 V Capable with Pull-Up TTL Bidirectional Pad Buffer, 3 V capable, 4mA drive capability, Active Slew Rate TTL Schmitt Trigger Bidirectional Pad Buffer, 8mA drive capability, 3 V Capable TTL Schmitt Trigger Bidirectional Pad Buffer, 8mA drive capability, 3 V Capable with Pull-Up Oscillator (Max Frequency 27 MHz) Oscillator (32 KHz) TTL Schmitt Trigger Input Pad Buffer 3 V tolerant USB Transceiver Power Pad - Internal supply for 3.3 V level Power Pad - Internal supply for 1.8 V level Power Pad - Internal ground, for Core only Power Pad - Internal ground PAD Name ANA B2TR_TC B4TR_TC B8TR_TC BD2STRUQP_TC BD4STRUQP_TC BD4TARP_TC BD8STRP_TC BD8STRUQP_TC OSCI27B OSCI32B SCHMITT_TC USB_PAD VDD3IOCO VDDCO VSSCO VSSIOCO 20/194 SPEAR-07-NC03 5 Memory Map 5 5.1 Memory Map Global MAP (AHB) Table 4. AHB Memory Map End Address Description Two ROM/FLASH/SRAM Banks. – Bank size granularity: 64 KB – Max Bank size: 16 MB – The two banks are adjacent. Four SDRAM/EDO Banks. – Max Bank size: 32 MB – Bank size granularity: 64 KB – The four banks are adjacent. Two External I/O Banks Bank size: 16 KB 8 KB Shared SRAM IEEE1284 Interface & FIFOs ARM Slave Test Interface APB Bridge Starting Address 0x000.0000 0x01FF.FFFF 0x1000.0000 0x17FF.FFFF 0x2000.0000 0x2100.0000 0x2200.0000 0x2300.0000 0x3000.0000 0x2000.7FFF 0x2100.1FFF 0x2200.0BFF 0x2300.03FF 0x3000.37FF Note: The decoder will ignore the ADD31 lines. In this way will be possible to access all the devices trough cache in range 0x000.0000 - 0x7FFF.FFFF and without cache in range 0x8000.0000 0xFFFF.FFFF 5.2 I/O MAP (APB) Table 5. APB Memory Map End Address 0x3000.03FF 0x3000.07FF 0x3000.0BFF 0x3000.0FFF 0x3000.13FF 0x3000.17FF 0x3000.1BFF 0x3000.1FFF 0x3000.23FF 0x3000.27FF 0x3000.2BFF 0x3000.2FFF 0x3000.33FF 0x3000.37FF Interrupt Controller General Purpose Timers Watch Dog Timer Real Time Clock General Purpose I/O I2C Interface UART Configuration Registers DMA Controller General Purpose Static Memory Controller Dynamic Memory Controller USB Host Controller DMA MAC MAC Ethernet Controller Description Starting Address 0x3000.0000 0x3000.0400 0x3000.0800 0x3000.0C00 0x3000.1000 0x3000.1400 0x3000.1800 0x3000.1C00 0x3000.2000 0x3000.2400 0x3000.2800 0x3000.2C00 0x3000.3000 0x3000.3400 21/194 6 Blocks description SPEAR-07-NC03 6 6.1 Blocks description CPU SUBSYSTEM & AMBA BUS Figure 2. ARM720T Block Diagram MMU 8Kb Cache ARM7TDMI CPU Coprocessor Interface Data and Address Buffers AMBA Interface AMBA BUS Interface Control and clocking logic System Control Coprocessor 6.1.1 ARM720 Processor The ARM720T is a general purpose 32-bit RISC microprocessor with 8KB cache, enlarged write buffer and Memory Management Unit (MMU) combined in a single chip. The CPU within ARM720T is the ARM7TDMI. The on-chip mixed data and instruction cache, together with the write buffer, substantially raise the average execution speed and reduce the average amount of memory bandwidth required by the processor. The MMU supports a conventional two-level, page-table structure and the memory interface has been designed to allow the performance potential to be realized without incurring high costs in the memory system. 6.1.2 MMU Overview The Memory Management MMU performs two primary functions. It: ● translates virtual addresses into physical addresses ● controls memory access permissions The MMU hardware required to perform these functions consists of: ● a Translation Look-aside Buffer (TLB) ● access control logic ● translation-table-walking logic When the MMU is turned off (as happens on reset), the virtual address is output directly onto the physical address bus. 22/194 SPEAR-07-NC03 6 Blocks description 6.1.3 Instruction and Data Cache overview ARM720T contains an 8KB mixed instruction and data cache (IDC). The cache only operates on a write-through basis with a read-miss allocation policy and a random replacement algorithm. The IDC has 512 lines of 16 bytes (four words), arranged as a 4-way set-associative cache, and uses the virtual addresses generated by the processor core after relocation by the Process Identifier as appropriate. The IDC is always reloaded a line at a time (4 words). It may be enabled or disabled via the ARM720T Control Register and is disabled immediately after the Power-On Reset. The operation of the cache is further controlled by the Cacheable (C bit) stored in the Memory Management Page Table. For this reason, the MMU must be enabled in order to use the IDC. However, the two functions may be enabled simultaneously, with a single write to the Control Register. 6.1.4 Write Buffer Overview The ARM720T write buffer is provided to improve system performance. It can buffer up to eight words of data, and four independent addresses and may be enabled or disabled via the W bit (bit 3) in the ARM720T Control Register. The buffer is disabled and flushed on reset. The write buffer operation is further controlled by the Bufferable (B) bit, which is stored in the Memory Management Page Tables. For this reason, the MMU must be enabled so you can use the write buffer. The two functions may however be enabled simultaneously, with a single write to the Control Register. 6.1.5 Configuration The operation and configuration of ARM720T is controlled: ● directly via coprocessor instructions ● indirectly via the Memory Management Page tables The coprocessor instructions manipulate a number of on-chip registers which control the configuration of the following: ● Cache ● Write buffer ● MMU ● A number of other configuration options 23/194 6 Blocks description SPEAR-07-NC03 6.1.6 Coprocessor Registers Programming The ARM720T instruction set allows specialized additional instruction to be implemented using coprocessor. The Memory Unit in the ARM720T core is referred as Coprocessor 15 (CP15). Important: CP15 registers can only be accessed with MRC and MCR instructions in a Privileged mode. CDP, LDC and STC instructions, as well as unprivileged MRC and MCR instructions to CP15 cause the undefined instruction trap to be taken. The bit fields of the instruction are shown in the following table: Table 6. MRC and MCR (CP15) bit pattern 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 CRn Rd 1 1 1 1 Opcode_2 1 CRm Cond. 1 1 1 0 Opcode_1 L Symbol Description Cond: L: Condition Code Field Direction 0 Store to Coprocessor (MCR) 1 Load from Coprocessor (MRC) Rd: CRn: CRm: ARM register Coprocessor Register Should be zero except when accessing register 7, 8 and 13. opcode_1: Should be zero opcode_2: Should be zero except when accessing register 7, 8 and 13. Note that the CPID field, bit 11:8, is set to 15 (MMU Coprocessor). The assembler syntax is: {cond} p15, opcode_1, Rd, CRn, CRm, opcode_2 6.1.6.1 Registers Register 0, ID (RO) It is a read-only register. CRm and opcode_2 should be zero. Reading from this register return always 0x41807203. Last nibble is the revision number. Register 1, Control (R/W) CRm and opcode_2 should be zero. The control bits pattern is shown in Table 7. Control Register 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 UNP/SBZ V UNP/SBZ R S B L D P W C A M 24/194 SPEAR-07-NC03 6 Blocks description M A C W P D L B S R V UNP/SBZ MMU enable/disable bit ( 0= disable, 1 = enable) Alignment fault Enable/disable bit (0 = disable, 1 = enable) Cache enable/disable bit (0 = disable, 1 = enable) Write Buffer enable/disable bit (0 = disable, 1 = enable) When read return always 1. When written is ignored. When read return always 1. When written is ignored. When read return always 1. When written is ignored. Endianess bit ( 0 = Little Endian, 1 = Big Endian) System Protection (See Access Permission AP Bits) ROM Protection (See Access Permission Bits) Location of exception vectors (Windows CE) Unpredictable when read, Should Be Zero when written. Example: ldr r0, =0x0F MCR p15, 0, r0, 1, 0, 0 ; Enable MMU with cache, write buffer and ; alignment fault Register 2, Translation Table Base (R/W) CRm and opcode_2 should be zero. This is the currently active first-level translation table. Only bit 31:14 are valid. The others are unpredictable when read, should be zero if written. Table 8. TTB Register TranslationTaBle UNP/SBZ 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Register 3, Domain Access Control (R/W) CRm and opcode_2 should be zero. The Domain Access Control Register consists of 16 2-bit fields, each of which defines the access permissions for one of the 16 Domains (D15-D0). The meaning of this bit is described in the MMU translation mechanism. Table 9. D15 DAC Register D14 D13 D12 D11 D10 D9 D8 D7 D6 D5 D4 D3 D2 D1 D0 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Register 4 (Reserved) Register 5, Fault Status Register (FSR) Register 6, Fault Address Register (FAR) Register 7, Cache Operations (WO) 25/194 6 Blocks description SPEAR-07-NC03 For this operation opcode_2 must be 0x0b000 and CRm must be 0x0b0111. This operation invalidates all cache data. Use with caution. Reading from it is undefined. Example: MCR p15, 0, r0, c7, c7, 0 ; invalidate all the data inside cache Register 8, TLB Operations Two operation are defined as showed on the following table: Table 10. TLB Operation Function Invalidate entire TLB Invalidate TLB (Single entry) Opcode_2 0b000 0b001 CRm 0b0111 0b0111 (Rd) 0 Virtual Address Assembler Syntax MCR p15, 0, Rd, C8, C7, 0 MCR p15, 0, Rd, C8, C7, 1 The Invalidate TLB invalidates all of the unlocked entries in the TLB. The invalidate TLB single entry invalidates any TLB entry corresponding to the Virtual Address in Rd. Register 9 to 12 are Reserved Register 13, Oricess Identifier Not Used Register 14 to 15 are Reserved 6.2 MAC Ethernet Controller Figure 3. Ethernet Controller Block Diagram Local FIFO MII I/F AHB MASTER DMA RX & TX LOGIC DATA MAC BLOCK Configuration M I APB SLAVE Configuration Registers Array M 6.2.1 Overview The Ethernet Media Access Controller (MAC110) core incorporates the essential protocol requirements for operation of an Ethernet/IEEE 802.3 compliant node, and provides interface between the host subsystem and the Media Independent Interface (MII). The MAC110 core can 26/194 SPEAR-07-NC03 6 Blocks description operate either in 100Mbps mode or the 10Mbps mode based on the clock provided on the MII interface (25/2.5 MHz). The MAC110 core operates both in half-duplex mode and full-duplex modes. When operating in the half- duplex mode, the MAC110 core is fully compliant to Section 4 of ISO/IEC 8802-3 (ANSI/IEEE Standard) and ANSI/IEEE 802.3. When operating in the full-duplex mode, the MAC110 core is compliant to the IEEE 802.3x standard for full-duplex operations. It is also compatible with Home PNA 1.1. The MAC110 core provides programmable enhanced features designed to minimize host supervision, bus utilization, and pre- or post-message processing. These features include ability to disable retires after a collision, dynamic FCS generation on a frame-by-frame basis, automatic pad field insertion and deletion to enforce minimum frame size attributes, automatic retransmission and detection of collision frames. The MAC110 core can sustain transmission or reception of minimal-sized back -to-back packets at full line speed with an inter-packet gap (IPG) of 90.6 us for 10-Mb/s and 0.96 us for 100-Mb/s. The five primary attributes of the MAC block are: 1. Transmit and receive message data encapsulation – Framing (frame boundary delimitation, frame synchronization) – Error detection (physical medium transmission errors) 2. Media access management – Medium allocation (collision detection, except in full-duplex operation) – Contention resolution (collision handling, except in full-duplex operation) 3. Flow Control during Full Duplex mode – Decoding of Control frames (PAUSE Command) and disabling the transmitter – Generation of Control Frames 4. Interface to the PHY – Support of MII protocol to interface with a MII based PHY. 5. Management Interface support on MII – Generation of PHY Management frames on the MDC/MDI/MDO. To minimize the CPU load during the data transfer is available a local DMA with FIFO capable to fetch itself the descriptors for the data blocks and to manage the data according to the instruction included on the descriptor. 6.2.2 Transfer Logic 6.2.2.1 RX LOGIC The receive (RX) DMA block includes all the logic required to manage data transfers from the RX port of the MAC110 wrapper to an external AHB memory mapped device. It includes: ● RX wrapper interface ● RX FIFO ● RX DMA master SM ● DMA descriptor SM 27/194 6 Blocks description SPEAR-07-NC03 6.2.2.2 RX WRAPPER INTERFACE The wrapper interface is a simple synchronous interface with RX_nREQ, RX_nACK, RX_DATA signals for data handshake, plus some sideband signals for the MAC protocol support (see later). The data path (RX_DATA) is 32 bit wide. When the RX DMA logic has been enabled, after a valid descriptor fetch, the RX interface control logic starts driving the RX_nACK signal, de-asserting it when ● the internal FIFO becomes full or ● the DMA transfer completes. The wrapper logic will drive the RX_nREQ signal when it has data valid to be transferred: the transfer is done, and the data can be updated, if RX_nREQ and RX_nACK are both asserted on the same clock. RX FIFO The FIFO depth can be 2/4/8/16/32 entries, 32 bit each. The RX FIFO is loaded by the RX wrapper interface logic and read by the RX DMA master SM. The FIFO download is done with 32 bits operations (possibly burst type to optimize the bus bandwidth). If there are some incomplete words coming from the MAC core (this con occurs only at the end of the frame) the DMA adds some dummy bytes in order to complete the word and increase the performance. Added bytes have an undefined value. RX DMA MASTER SM The RX DMA block has a State Machine (SM) dedicated to the DMA master operation. When enabled via the RX configuration registers, it's able to manage the RX data transfer without further processor intervention. The DMA transfer can be: ● DMA continuous/fixed size: the DMA can be required to run indefinitely or to stop after a configured number of data bytes has been transferred ● fixed/incrementing address: the DMA address can be fixed (i.e. all the data are transferred to the same AHB word aligned address) or it can be updated after each data transfer ● linear incrementing or wrapping address: when the address is defined as incrementing, it can be required that, once reached a programmed value, the address counter wraps back to the initial address value (the address location, pointed by the wrapping address, is not modified) ● with FIFO entry threshold: the DMA SM starts transferring data on the AHB bus when a programmable number of 32 bit RX FIFO entries is valid When the DMA is enabled, as soon as data appears in the FIFO, the DMA may either initiate an AHB transfer immediately, or be delayed until X data bytes are available in the FIFO (FIFO entry threshold). The DMA can be configured to wrap-round the AHB address at some point to implement a circular buffer in CPU memory. The DMA can be configured to run indefinitely or to stop after DMA_XFERCOUNT data have been transferred. 28/194 SPEAR-07-NC03 6 Blocks description When the DMA completes, the master DMA SM can be required to assert an interrupt request to the processor and wait for new instruction, or to wake up the DMA descriptor SM to require a new DMA descriptor fetch. To save gates, the implementation limits the maximum DMA transfer count to 4 Kbytes, hence the XFER_COUNT field in the DMA control registers is limited to 12 bits. The DMA start address (DMA_ADDRESS) must be 32 bit word aligned. The DMA wrapping address point must be 32 bit word aligned. If an AHB error condition occurs, while the DMA is running, the SM activity is suspended, until the error interrupt bit (MERR_INT) is reset. When the error condition is removed the DMA makes the same request previously interrupted by the error response. DMA descriptor SM A dedicated SM has been implemented that, when required by the DMA master logic, starts some AHB master read operations to load from the external memory all the information (DMA descriptors) required to start the new DMA data transfer. The DMA descriptor consists of a VALID bit plus 3 registers: the DMA control (DMA_CTL), the DMA base address (DMA_ADDR) and the DMA next descriptor address register (DMA_NXT). The Host Processor must ensure that the descriptors are up to date in memory when the DMA descriptor SM loads them. The fetch order is: DMA_CTL, DMA_ADDR, DMA_NXT and VALID bit. If a fetched descriptor is not valid (VALID=0), then the DMA engine can be programmed to stop the operation (reset the DMA_EN bit in RX_DMA_START) and raise an interrupt (RX_DONE), or to repeat the descriptor fetch operation, until a valid descriptors is found. The interrupt register bit named RX_NEXT is always set when a not valid descriptor is loaded. In the first case, the DMA will then wait for the Host Processor to re-enable the DMA operation (START_FETCH bit in the RX_DMA_START register set to 1) before attempting anew descriptor fetch. While, when in polling mode, the DMA will keep reloading the descriptor, with an access frequency determined by the DFETCH_DLY field in the RX_DMA_START register. An AHB ERROR response suspends the descriptor SM activity and reset the DMA_EN bit in RX_DMA_START register. To help the error source understanding, the RX_DMA_CADDR register value is the address at which the error occurred. After clearing the error bit, the SW needs to reprogram the DMA registers, to start again a new descriptor fetch. 6.2.2.3 TX LOGIC The transmit (TX) DMA block includes all the logic required to manage data transfers from an external AHB memory mapped device to the TX port of the MAC110 wrapper. It includes: ● ● ● ● TX wrapper interface TX FIFO TX DMA master SM DMA descriptor SM 29/194 6 Blocks description SPEAR-07-NC03 TX WRAPPER INTERFACE The wrapper interface is a simple synchronous interface with TX_nREQ, TX_nACK, TX_DATA signals for data handshake, plus some sideband signals for the MAC protocol support (see later). The data path (TX_DATA) is 32 bit wide. When the TX DMA logic has been enabled, as soon as the internal FIFO is no more empty the TX interface control logic starts driving the TX_nACK signal, de-asserting it when the internal FIFO becomes empty again or the DMA transfer completes. The wrapper has to drive the TX_nREQ signal when it accept valid data to be transferred: the transfer is done and the data can be updated if TX_nREQ and TX_nACK are both asserted on the same clock. TX FIFO The FIFO depth can be 2/4/8/16/32 entries, 32 bit each. The TX FIFO is loaded by the TX DMA master SM and read by the TX wrapper interface. The FIFO load is usually done with 32 bits operations (possibly burst type to optimize the bus bandwidth), unless the DMA end has been reached and the DMA buffer size is not a multiple of 32 bits. TX DMA MASTER SM The TX DMA block has a State Machine (SM) dedicated to the DMA master operation. When enabled via the TX configuration registers, it's able to manage the TX data transfers without further processor intervention. The DMA transfer can be: DMA continuous/fixed size: the DMA can be required to run indefinitely or to stop after a configured number of data bytes has been transferred fixed/incrementing address: the DMA address can be fixed (i.e. all the data are transferred from the same AHB, word aligned, address) or it can be updated after each data transfer linear incrementing or wrapping address: when the address is defined as incrementing, it can be required that, once reached a programmed value, the address counter wraps back to the initial address value (the address location, pointed by the wrapping address, is not accessed) with FIFO entry threshold: the DMA SM starts transferring data on the AHB bus when a programmable number of 32 bit TX FIFO entries is empty When the DMA is enabled, as soon as one free entry is available in the FIFO, the DMA may initiate AHB transfers immediately, or can be delayed. The DMA may be delayed until X data entries are available in the FIFO (FIFO entry threshold). The DMA can be configured to wrap-round the AHB address at some point to implement a circular buffer in CPU memory. The DMA can be configured to run indefinitely or to stop after DMA_XFERCOUNT data have been transferred. When the DMA completes, the master DMA SM can be required to assert an interrupt request to the processor and wait for new instruction, or to wake up the DMA descriptor SM, to require a new DMA descriptor fetch. To save gates, the implementation limits the maximum DMA transfer count to 4Kbytes, hence the XFER_COUNT field in the DMA control registers is limited to 12 bits. The DMA start address (DMA_ADDRESS) must be 32 bit word aligned and the DMA wrapping address point must be 32 bit word aligned. 30/194 SPEAR-07-NC03 6 Blocks description If an AHB error condition occurs, while the DMA is running, the SM activity is suspended, until the error interrupt bit (MERR_INT) is reset. When the error condition is removed the DMA makes the same request previously interrupted by the error response. Special care must be taken when the FIFO entry to be read has 3 valid bytes: in this case, because the AHB protocol doesn't allow to 3 byte transfers, the AHB master splits the transfer in two single transfers (byte + half or half + byte) and sends an acknowledge signal to the FIFO only when the second one has been read. If the second read receives an error response then, when the error condition is removed, the DMA repeats even the first one (because the FIFO has not yet see the acknowledge). DMA DESCRIPTOR SM A dedicated SM has been implemented that, when required by the DMA master logic, starts some AHB master read operations to load from the external memory all the information (DMA descriptors) required to start the DMA data transfer. The DMA descriptor consists of a VALID bit plus 3 registers: the DMA control (DMA_CTL), the DMA base address (DMA_ADDR) and the DMA next descriptor address register (DMA_NXT). The Host Processor must ensure that the descriptors are up to date in memory when the DMA descriptor SM loads them. The fetch order is: DMA_CTL, DMA_ADDR, DMA_NXT and VALID bit. If a fetched descriptor is not valid (VALID=0), then the DMA engine can be programmed to stop the operation (reset the DMA_EN bit in TX_DMA_START) and raise an interrupt (TX_DONE), or to repeat the descriptor fetch operation, until a valid descriptors is found. The interrupt register bit named TX_NEXT is always set when a not valid descriptor is loaded. In the first case, the DMA will then wait for the HP to re-enable the DMA operation (START_FETCH bit in the TX_DMA_START register set to 1) before attempting a new descriptor fetch. While, when in polling mode, the DMA will keep reloading the descriptor, with an access frequency determined by the DFETCH_DLY field in the TX_DMA_START register. An AHB ERROR response suspends the descriptor SM activity and reset the DMA_EN bit in TX_DMA_START register. To help the error source understanding, the TX_DMA_CADDR register value is the address at which the error occurred. After clearing the error bit, the SW needs to reprogram the DMA registers, to start again a new descriptor fetch. 6.2.3 Table 11. Ethernet register map Ethernet register map Register Name DMA_STS_CNTL DMA_INT_EN DMA_INT_STS Reserved RX_DMA_START Description Ethernet DMA, status and control register Ethernet DMA, Interrupt sources enable register Ethernet DMA, Interrupt status register Ethernet DMA, RX start register Address 0x3000_3000 0x3000_3004 0x3000_3008 0x3000_300C 0x3000_3010 31/194 6 Blocks description SPEAR-07-NC03 Table 11. Ethernet register map (continued) Register Name RX_DMA_CNTL RX_DMA_ADDR RX_DMA_NXT RX_DMA_CADDR RX_DMA_CXFER RX_DMA_TO RX_DMA_FIFO TX_DMA_START TX_DMA_CNTL TX_DMA_ADDR TX_DMA_NXT TX_DMA_CADDR TX_DMA_CXFER TX_DMA_TO TX_DMA_FIFO reserved RX_FIFO Reserved TX_FIFO Reserved MAC_CNTL MAC_ADDH MAC_ADDL MAC_MCHTH MAC_MCHTL MII_ADDR MII_DATA FCR VLAN1 VLAN2 Reserved Description Ethernet DMA, RX control register Ethernet DMA, RX base address register Ethernet DMA, RX next descriptor address register Ethernet DMA, RX current address register Ethernet DMA, RX current transfer count register Ethernet DMA, RX time out register Ethernet DMA, RX FIFO status register Ethernet DMA, TX start register Ethernet DMA, TX control register Ethernet DMA, TX base address register Ethernet DMA, TX next descriptor address register Ethernet DMA, TX current address register Ethernet DMA, TX current transfer count register Ethernet DMA, TX time out register Ethernet DMA, TX FIFO status register RX local FIFO (32 double word = 128 byte) TX local FIFO (32 double word = 128 byte) MAC control register MAC address high register MAC address low register MAC, multi cast hash table high register MAC, multi cast hash table low register MII, address register MII, data register Flow control register VLAN1 tag register VLAN2 tag register - Address 0x3000_3014 0x3000_3018 0x3000_301C 0x3000_3020 0x3000_3024 0x3000_3028 0x3000_302C 0x3000_3030 0x3000_3034 0x3000_3038 0x3000_303C 0x3000_3040 0x3000_3044 0x3000_3048 0x300_304C 0x3000_3050 0x3000_30FC 0x3000_3100 0x3000_317C 0x3000_3180 0x3000_31FC 0x3000_3200 0x3000_327C 0x3000_3280 0x3000_33FC 0x3000_3400 0x3000_3404 0x3000_3408 0x3000_340C 0x3000_3410 0x3000_3414 0x3000_3418 0x3000_341C 0x3000_3420 0x3000_3424 0x3000_3428 0x3000_34FC 32/194 SPEAR-07-NC03 Table 11. Ethernet register map (continued) Register Name MMC_CTRL_REG MMC_INT_HI_REG MMC_INT_LO_REG MMC_INT_MSK_HI_RE G Description MMC Statistic Control Register MMC Statistic Interrupt High Register MMC Statistic Interrupt Low Register MMC Statistic Interrupt Mask High Register 6 Blocks description Address 0x3000_3500 0x3000_3504 0x3000_3508 0x3000_350C 0x3000_3510 MMC_INT_MSK_LO_RE MMC Statistic Interrupt Mask Low Register G RxNumFrmsAllCntr All frames received counter. This includes good and bad frames. Counter is incremented each time a frame is received. Good frame received counter. This includes good frames only, which are free from runt frame error, frame too long error, collision error, MII error, dribble bit error, CRC error, invalid length error and FIFO overflow error. Control frames received counter. This includes control frames, which are free from runt frame error, frame too long error, collision error, MII error, dribble bit error, CRC error, invalid length error and FIFO overflow error. Unsupported control frames received counter. This includes control frames, which are free from runt frame error, frame too long error, collision error, MII error, dribble bit error, CRC error, invalid length error and FIFO overflow error but whose length/ type field is not supported. No of bytes received counter. This includes all frames frame length added. Excludes preamble. No of bytes received counter. This includes all frames frame length added which are free from runt frame error, frame too long error, collision error, MII error, dribble bit error, CRC error, invalid length error and FIFO overflow error. Frame with length equal to 64 bytes counter. Includes good and bad frames. Frame with length from 65 to 127 bytes counter. Includes good and bad frames. Frame with length from 128 to 255 bytes counter. Includes good and bad frames. Frame with length from 256 to 511 bytes counter. Includes good and bad frames. Frame with length from 512 to 1023 bytes counter. Includes good and bad frames. Frame with length from 1024 to MaxPktSize bytes counter. Includes good and bad frames. 0x3000_3600 0x3000_3604 RxNumFrmsOkCntr 0x3000_3608 RxCntrlFrmsCntr 0x3000_360C RxUnsupCntrlCntr 0x3000_3610 RxNumBytsAllCntr 0x3000_3614 RxNumBytsOkCntr 0x3000_3618 0x3000_361C 0x3000_3620 0x3000_3624 0x3000_3628 0x3000_362C RxLenEqual64Cntr RxLen65_127Cntr RxLen128_255Cntr RxLen256_511Cntr RxLen512_1023Cntr RxLen1024_MaxCntr 33/194 6 Blocks description SPEAR-07-NC03 Table 11. Ethernet register map (continued) Register Name RxUnicastCntr RxMulticastCntr RxBroadcastCntr Description Unicast frames received counter. This includes good frames only. Multicast frames received counter. This includes good frames only. Broadcast frames received counter. This includes good frames only. Frames with FIFO error counter. Counter with Rx FIFO overflow error. This counter is incremented if the missed frame bit in receive status is set. Runt frame counter. Counter for frames with a minimum frame length violation. This counter is incremented if the runt frame bit in receive status is set. Long frames counter. Counter for frames with a maximum frame length violation. This counter is incremented if the Frame Too Long bit in receive status is set. Frame with a CRC error counter. This counter is incremented if the CRC error bit in receive status is set. Frames with a dribble bit counter. This counter is incremented if the dribble bit in receive status is set. Length error frames counter. This counter is incremented if the length error bit in receive status is set. Ethernet frames counter. This counter is incremented when the frame type bit in receive status is set. Address 0x3000_3630 0x3000_3634 0x3000_3638 0x3000_363C RxFifoOverflowCntr 0x3000_3640 RxMinLenCntr 0x3000_3644 RxMaxLenCntr 0x3000_3648 RxCrcErrorCntr 0x3000_364C RxAlignErrorCntr 0x3000_3650 RxLenghtErrCntr 0x3000_3654 0x3000_3658 0x3000_36FF 0x3000_3700 RxEthrTypFrmCntr Reserved No of frames transmitted counter. This includes good and bad frames but no retries. Counter is incremented each time the transmit status is received. No of control frames transmitted counter. Counter for good control frames only. Counter is incremented each time transmit status is received and if the frame transmitted is a control frame. Does not include retries. Total number of transmitted bytes counter. Counter is incremented each time transmit status is received. Includes good and bad frames but no retries. Total number of (well) transmitted bytes counter. Counter for bytes of a good frame transmitted. Does not include retries. The good frames are the ones for which the frame abort and packet retry bits in transmit status are reset. TxNumFrmsAllCntr 0x3000_3704 TxCntrlFrmsCntr 0x3000_3708 TxNumBytsAllCntr 0x3000_370C TxNumBytsOkCntr 34/194 SPEAR-07-NC03 Table 11. Ethernet register map (continued) Register Name Description 6 Blocks description Address 0x3000_3710 TxLenEqual64Cntr Frames with length equal to 64 counter. Counter for frames with length equal to 64. Includes good and bad frames but no retries. Frames with length from 65 to 127 counter. Counter for frames with length between 65 and 127 bytes. Includes good and bad frames but no retries. Frames with length from 128 to 255 counter. Counter for frames with length between 128 and 255 bytes. Includes good and bad frames but no retries. Frames with length from 256 to 511 counter. Counter for frames with length between 256 and 511 bytes. Includes good and bad frames but no retries. Frames with length from 512 to 1023 counter. Counter for frames with length between 512 and 1023 bytes. Includes good and bad frames but no retries. Frames with length from 1024 to MaxPktSize counter. Counter for frames with length between 1024 and maximum frame lenght bytes. Includes good and bad frames but no retries. No of Unicast frames transmitted counter. Includes good frames only, no retries. No of multicast frames transmitted counter. Includes good frames only, no retries. No of broadcast frames transmitted counter. Includes good frames only, no retries. No of frames aborted due to FIFO error counter. This counter is incremented when the under run bit in transmit status is set. No of frames aborted counter. This counter is incremented if either the frame aborted or the heart bit fail are set in transmit status. No of frames with single collision counter. The counter is incremented when the collisions count = 1 and packet retry set in transmit status. No of frames with multiple collisions counter. The counter is incremented when the collisions count > 1 and packet retry set in transmit status. No of frames deferred counter. This counter is incremented when the deferred bit in transmit status is set. No of frames with late collision counter. This counter is incremented when the late collision bit in transmit status is set. 0x3000_3714 TxLen65_127Cntr 0x3000_3718 TxLen128_255Cntr 0x3000_371C TxLen256_511Cntr 0x3000_3720 TxLen512_1023Cntr 0x3000_3724 TxLen1024_MaxCntr 0x3000_3728 0x3000_272C 0x3000_3730 TxUnicastCntr TxMulticastCntr TxBroadcastCntr 0x3000_3734 TxFifoUndFloCntr 0x3000_3738 TxNumBadFrmsCntr 0x3000_373C TxSingleColCntr 0x3000_3740 TxMultiColCntr 0x3000_3744 TxNumDeffredCntr 0x3000_3748 TxLateColCntr 35/194 6 Blocks description SPEAR-07-NC03 Table 11. Ethernet register map (continued) Register Name Description No of frames aborted counter. This counter is incremented when the frame aborted bit in transmit status is set. Number of frames with no carrier counter. This counter is incremented when either the no carrier or the loss of carrier bit in transmit status is set. No of frames with excessive deferral counter. This counter is incremented when the excessive deferral bit in transmit status is set. Address 0x3000_374C TxAbortedFrmsCntr 0x3000_3750 TxNoCrsCntr 0x3000_3754 0x3000_3758 0x3000_37FC TxXsDeferalCntr Reserved 36/194 SPEAR-07-NC03 6 Blocks description 6.2.4 Register description All the registers are 32 bit wide. 6.2.4.1 Ethernet DMA, Status and Control Register Mnemonic: DMA_STS_CNTL Address: 0x3000_3000 Default value: 4A4A0101 Bit 31 - 28 27 - 26 25 - 24 23 - 20 19 - 18 17 - 16 15 - 08 Bit 07 - 06 05 - 04 03 - 02 01 00 Field name TX_FIFO_SIZE TX_IO_DATA_WIDTH TX_CHANNEL_STATUS RX_FIFO_SIZE RX_IO_DATA_WIDTH RX_CHANNEL_STATUS REVISION Field name TX_MAX_BURST_SIZE RX_MAX_BURST_SIZE Reserved LOOPB SRESET Access RO RO RO RO RO RO RO Access RW RW RO RW RW TX_FIFO_SIZE: Size of transmitter data path FIFO. Value: 04 → 16 * 32 bit words. TX_IO_DATA_WIDTH: Width of the I/O bus transmit data path. Value: 2'b10 → 32 bit. TX_IO_CHANNEL_STATUS: TX channel status structure. Value: 2'b10 → High End TX channel capable of DMA descriptor fetch. RX_FIFO_SIZE: Size of receiver data path FIFO. Value: 04 → 16 * 32 bit words. RX_IO_DATA_WIDTH: Width of the I/O bus receiver data path. Value: 2'b10 → 32 bit. 37/194 6 Blocks description SPEAR-07-NC03 RX_IO_CHANNEL_STATUS: RX channel status structure. Value: 2'b10 → High End RX channel capable of DMA descriptor fetch. REVISION: Revision of the DMA block. Value: 0x01 TX_MAX_BURST_SIZE: Maximum value of defined length burst that the TX DMA_MAC logic will perform on the AHB bus to read data from the main memory. 2'b00 2'b01 2'b10 2'b11 16 beat incrementing burst (INCR16) 8 beat incrementing burst (INCR8) 4 beat incrementing burst (INCR4) Single transfer only (SINGLE) Descriptor fetch operation isn't affected by this field. RX_MAX_BURST_SIZE: Maximum value of defined length burst that the RX DMA_MAC logic will perform on the AHB bus to write data to the main memory. 2'b00 2'b01 2'b10 2'b11 16 beat incrementing burst (INCR16) 8 beat incrementing burst (INCR8) 4 beat incrementing burst (INCR4) Single transfer only (SINGLE) Descriptor fetch operation isn't affected by this field. LOOPB: Set to '1' to enable the DMA block loop_back mode. When set the RX DMA data are extracted by the TX FIFO and pushed in the RX one. SRESET: DMA soft reset. Set to '1' to hold the whole DMA_MAC and MAC110 logic in reset condition. Write '0' to exit from the reset phase. Note: After a HW reset, the DMA logic wakes up with the SRESET bit asserted ('1'), to keep all the DMA and MAC110 logic in the reset condition, until the SW is sure that clocks and the other MII signals, inputs to the MAC110 core, are stable. When this condition is met, the SW is allowed to clear the SRESET bit (write '0') to start the normal operation. Until the SRESET bit is set to '1', no operation is allowed on the DMA_MAC or MAC110 registers, except the SRESET bit clear. This signal has no effect on the AHB interface so, when asserted runtime, the whole DMA will be reset only when the last AHB transfer, in the AHB master queue, has been completed. 38/194 SPEAR-07-NC03 6 Blocks description 6.2.4.2 Ethernet DMA, Interrupt Sources Enable Register Mnemonic: DMA_INT_EN Address: 0x3000_3004 Default value: 0x0000_0000 Bit 31 30 - 29 28 27 - 26 25 24 23 22 21 - 20 19 18 17 16 15 14 - 10 09 08 07 06 05 04 03 02 01 00 Field name TX_CURR_DONE_EN Reserved MAC110_INT_EN Reserved TX_MERR_INT_EN Reserved TX_DONE_EN TX_NEXT_EN Reserved TX_TO_EN TX_ENTRY_EN TX_FULL_EN TX_EMPTY_EN RX_CURR_DONE_EN Reserved RX_MERR_INT_EN Reserved RX_DONE_EN RX_NEXT_EN PACKET_LOST_EN Reserved RX_TO_EN RX_ENTRY_EN RX_FULL_EN RX_EMPTY_EN Access RW RO RW RO RW RO RW RW RO RW RW RW RW RW RO RW RO RW RW RW RO RW RW RW RW The DMA Interrupt enable register allows the various sources of interrupt to be individually enabled. All the enabled sources will then be OR-ed to generate the global DMA interrupt. Setting a bit in DMA_INT_EN allows the corresponding interrupt described in DMA_INT_STAT to influence the global DMA Interrupt. If any bit position is set to '1' in BOTH DMA_INT_STAT and DMA_INT_EN, then the DMA Interrupt will be asserted. Refer to the DMA_INT_STAT for a description of interrupt sources. 39/194 6 Blocks description SPEAR-07-NC03 6.2.4.3 Ethernet DMA, Interrupt Status Register Mnemonic: DMA_INT_STS Address: 0x3000_3008 Default value: 0x0000_0000 Bit 31 30 - 29 28 27 - 26 25 24 23 22 21 - 20 19 18 17 16 15 14 - 10 09 08 07 06 05 04 03 02 01 00 Field name TX_CURR_DONE Reserved MAC110_INT Reserved TX_MERR_INT Reserved TX_DONE TX_NEXT Reserved TX_TO TX_ENTRY TX_FULL TX_EMPTY RX_CURR_DONE Reserved RX_MERR_INT Reserved RX_DONE RX_NEXT PACKET_LOST Reserved RX_TO RX_ENTRY RX_FULL RX_EMPTY Access RC RO RC RO RC RO RC RC RO RC RC RC RC RC RO RC RO RC RC RC RO RC RC RC RC DMA Interrupt Status Register reports the interrupt status of interrupts from the following sources: DMA RX, DMA TX, MAC110. All the register locations are read/clear (RC): they can be read, a write with '0' has no effect, while writing '1' reset the bit. TX_CURR_DONE: Set when the TX master DMA has completed the CURRENT DMA transfers. 40/194 SPEAR-07-NC03 6 Blocks description This bit differs from the TX_DONE because the TX_CURRENT_DONE will be set after a single DMA descriptor execution has been completed, the status register updated and the descriptor valid bit cleared, while the TX_DONE will be set only after all the descriptors in the descriptor chain have been fully executed. Write '1' to clear flag. MAC110_INT: Set when the external MAC110 device sets an interrupt request. Write '1' to clear flag. TX_MERR_INT: Set when the AHB master receives an error response from the selected slave and the internal arbiter is granting the TX FIFO. Write '1' to clear flag. TX_DONE: Set when the TX master DMA completes. Write '1' to clear flag. TX_NEXT: Set when a descriptor fetch operation loads an invalid entry. Write '1' to clear flag. TX_TO: Set when some data are stalled in the TX FIFO for too long. Write '1' to clear flag. TX_ENTRY: Set when the TX DMA is triggered by a number of empty TX FIFO entries bigger than the value set in the DMA_CNTL register. Write '1' to clear flag. TX_FULL: Set when the TX FIFO becomes full (< 4 byte entries available). Write '1' to clear flag. TX_EMPTY: Set when the TX FIFO becomes empty. Write '1' to clear flag. RX_CURR_DONE: Set when the RX master DMA has completed the CURRENT DMA transfers. This bit differs from the RX_DONE because the RX_CURRENT_DONE will be set after a single DMA descriptor execution has been completed, the status register updated and the descriptor valid bit cleared, while the RX_DONE will be set only after all the descriptors in the descriptor chain have been fully executed. Write '1' to clear flag. RX_MERR_INT: Set when the AHB master receives an error response from the selected slave and the internal arbiter is granting the RX FIFO. Write '1' to clear flag. RX_DONE: Set when the RX master DMA completes. Write '1' to clear flag. RX_NEXT: Set when the descriptor fetch operation loads an invalid entry. Write '1' to clear flag. 41/194 6 Blocks description SPEAR-07-NC03 PACKET_LOST: Set by the RX wrapper when there is an incoming frame but the RX DMA logic cannot service it because: the RX FIFO is not empty yet or the next descriptor fetch is still running Write '1' to clear flag. RX_TO: Set when some data are stalled in the RX FIFO for too long. Write '1' to clear flag. RX_ENTRY: Set when the RX DMA is triggered by a number of valid RX FIFO entries bigger than the value set in the DMA_CNTL register. Write '1' to clear flag. RX_FULL: Set when the RX FIFO becomes full and no more data can be accepted. Write '1' to clear flag. RX_EMPTY: Set when the RX FIFO becomes empty. Write '1' to clear flag. 6.2.4.4 Ethernet DMA, RX Start Register Mnemonic: RX_DMA_START Address: 0x3000_3010 Default value: 0x0000_0000 Bit 31 - 24 23 - 08 07 06 05 04 - 03 02 01 00 Field name Reserved DFETCH_DLY CALL_SEEN RUNT_FRAME FILTER_FAIL Reserved START_FETCH Reserved DMA_EN Access RO RW RW RW RW RO RS RO RC DFETCH_DLY: Descriptor fetch delay. This field specifies, in a bus clock periods, the delay between two descriptor fetches, in the event that the descriptor in main memory is not valid. When set to '0' it forces the DMA_MAC logic, in case of invalid descriptor, to wait for 2**16 system bus clocks before attempting a new fetch. 42/194 SPEAR-07-NC03 6 Blocks description COLL_SEEN: When '1' the Late Collision seen condition, reported by the MAC110 in the RX packet status word, will make the received frame to be discharged by the DMA_MAC, without any report to the CPU. When '0' no action will be taken by the DMA_MAC. RUNT_FRAME: When '1' the Damaged Frame condition (e.g. normal collision, frame too short, etc.), reported by the MAC110 in the RX packet status word, will make the received frame to be discharged by the DMA_MAC, without any report to the CPU. When '0' no action will be taken by the DMA_MAC. FILTER_FAIL: When '1' the Address Filtering Failed condition, reported by the MAC110 during the RX packet transmission, will make the received frame to be discharged by the DMA_MAC, without any report to the CPU. When '0' no action will be taken by the DMA_MAC. If this bit is set the data of packets that don't match the address filtering process (inside the MAC core) are not moved to the memory reducing the AHB bus utilization. START_FETCH: This bit is a Read/Set bit, that means it can be both read and written, but writing a '0' has no effect. The SW has to set this bit to '1' when the RX DMA has to start fetching the first descriptor. The DMA logic will reset to '0' this bit and set the DMA_EN to '1' as soon as the first fetch has been completed. Note: Before starting the DMA, the DMA_NXT register has to be loaded with the starting address of the descriptor to be fetched. DMA_EN: Read/Clear bit: a write with '1' reset to '0' the bit value, while a write with '0' has no effect. This bit, set to '1' by the DMA after the first descriptor fetch, can be reset to '0' by the SW to force a DMA abort and stop as soon as possible the data transfer, before the DMA completion. When all the DMA sequences complete normally, this bit is reset by the DMA_MAC logic and a new SW intervention is required to restart the DMA engine. Note: ● ● The DMA_EN 0->1 transition resets the FIFO content and the RX interrupts (DMA_INT_STAT(15:0)). The DMA_EN 1->0 transition forces the DMA to close immediately the transfers toward AHB bus and MAC core. When the AHB transfer completes the DMA_INT_STAT.RX_DONE interrupt is set and the processor can reprogram and reactivate the RX logic. 43/194 6 Blocks description SPEAR-07-NC03 6.2.4.5 Ethernet DMA, RX Control Register Mnemonic: RX_DMA_CNTL Address: 0x3000_3014 Default value: 0x0000_0000 Bit 32 - 22 21-17 16 15 14 13 12 11 - 00 Field name ADDR_WRAP ENTRY_TRIG Reserved DLY_EN NXT_EN Reserved CONT_EN DMA_XFERCOUNT Access RW RW RO RW RW RO RW RW ADDR_WRAP: Determines where the DMA address counter wraps by forcing the DMA address counter to retain the data originally written by the host in DMA_ADDR. As soon as the DMA has written the memory location prior to the value specified in ADD_WRAP the wrapping condition occurs. This can be used to restrict the address counter within an address window (e.g. circular buffer). The wrapping point MUST be 32 bit aligned, so the 10 bits of ADDR_WRAP are used to compare DMA address bits 11 to 2; if ADD_WRAP=DMA_ADDR(11:2) then a 4Kbyte buffer is defined. ADDRWRAP is ignored unless WRAP_EN is set. ENTRY_TRIG: Determines the amount of valid entries (in 32 BIT WORDs) required in the receive FIFO before the DMA is re-triggered. If the value is set to 0, as soon as one valid entry is present, the DMA logic starts the data transfer. DLY_EN: This bit enables (when '1') the DMA trigger delay feature: if a FIFO valid data resides in the FIFO more than a programmed period (DMA_TO), a time-out condition occurs that requires the DMA SM to empty the FIFO even if the number of valid words doesn't exceed the threshold value. NXT_EN: Next Descriptor Fetch Mode enable. Set to '1', this bit enables the next descriptor fetch mechanism. Whenever a DMA transfer is completed, if this field is set, a new DMA descriptor is fetched. If this field is '0' then no descriptor is fetched and an interrupt is raised as normal. Note when a descriptor is fetched RX_DMA_CTL is one of the registers updated CONT_EN: Continuos Mode Enable. This bit enables the DMA to run in continuo mode. If set the DMA runs indefinitely ignoring DMA_ XFERCOUNT. Note: "continuos mode" supersedes "next descriptor mode". 44/194 SPEAR-07-NC03 6 Blocks description DMA_XFERCOUNT: Block size (in bytes) of DMA data transfer, up to 4 Kbytes. If DMA_XFERCOUNT is set to '0', the DMA will transfer 4 Kbyte data. Note: RX_DMA_CNTL.XFERCOUNT is used to provide an upper limit to the number of bytes the system can accept for each frame (it's usually equal to the dedicated frame buffer size in main memory). When this limit is not exceeded, all the data received from the line, via the MAC110 core, are copied to the memory frame buffer, and the effective length of the transfer it's the real frame size. On the other side, if the packet exceeds the XFERCOUNT value it will be truncated. The XFERCOUNT value must be approximated to the next word aligned block size (i.e. if the desired transfer size is 123 bytes, then the programmed value should be 124). 6.2.4.6 Ethernet DMA, RX Base address Register Mnemonic: RX_DMA_ADDR Address: 0x3000_3018 Default value: 0x0000_0000 Bit 31 - 02 01 00 Field name DMA_ADDR FIX_ADDR WRAP_EN Access RW RW RW DMA_ADDR: Start address, 32 bit WORD ALIGNED, for master DMA transfer. This register is read by the DMA SM only before starting the DMA operation and when the wrap condition is met, so further updates of this register will have unpredictable effects on the running DMA. FIX_ADDR: Disables incrementing of DMA_ADDR: this means that all the DMA data transfer operation will be performed at the same AHB address, i.e. the DMA base address. WRAP_EN: Enables wrap of the DMA transfer address to DMA_ADDR when the memory location, specified in ADDR_WRAP, is reached. 6.2.4.7 Ethernet DMA, RX Next Descriptor Address Register Mnemonic: RX_DMA_NXT Address: 0x3000_301C Default value: 0x0000_0000 Bit 31 - 02 01 00 Field name DMA_DESCR_ADDR Reserved NPOL_EN Access RW RO RW 45/194 6 Blocks description SPEAR-07-NC03 DMA_DESCR_ADDR: When the DMA next descriptor fetch is enabled, this register points to the next descriptor starting address. The DMA descriptors are 32 bits, so the DMA_DESCR_ADDR MUST be 32 bit aligned. This register allows different DMA descriptors to be located in different memory area, because part of the current DMA descriptors, provides information to point to the next one (descriptor chaining). If the DMA descriptor fetch is not enabled, this register doesn't need to be updated. NPOL_EN: Next Descriptor Polling Enable. When in 'Next Descriptor Fetch Mode', the descriptor fetch logic can load a not jet valid descriptor: if the NPOL is enabled ('1'), the logic is required to keep polling the DMA descriptor in main memory, until it's found to be valid. Note: In case of not valid descriptor, DMA_MAC behavior will be different depending on the NPOL bit; we can have: ● ● NPOL=1 (polling enabled) -> the RX_NEXT bit will be set and a new descriptor fetch will be attempt after DFETCH_DLY clocks NPOL=0 (polling disabled) -> the RX_DONE bit will be set and the DMA_EN bit, in DMA_START register, will be cleared. 6.2.4.8 Ethernet DMA, RX Current Address Register Mnemonic: RX_DMA_CADDR Address: 0x3000_3020 Default value: 0x0000_0000 Bit 31 - 00 Field name DMA_CADDR Access RO DMA_CADDR: Current DMA address value, byte aligned. The value of this register will change while the DMA is running, reflecting the value driven by the core on the AHB bus. 6.2.4.9 Ethernet DMA, RX Current Transfer Count Register Mnemonic: RX_DMA_CXFER Address: 0x3000_3024 Default value: 0x0000_0000 Bit 31 - 12 11 - 00 Field name Reserved DMA_CXFER Access RO RO DMA_CXFER: Current DMA transfer count value. It's updated while the DMA is running, when one word data is moved from the MAC core to the DMA FIFO, reporting the number of bytes that can still be accepted. 46/194 SPEAR-07-NC03 6 Blocks description 6.2.4.10 Ethernet DMA, RX Time Out register Mnemonic: RX_DMA_TO Address: 0x3000_3028 Default value: 0x0000_0000 Bit 31 - 16 15 - 00 Field name Reserved TIME_OUT Access RO RW TIME_OUT: This value is used as initial value for the FIFO entry time_out counter (it's recommended not to use too low value, to avoid too frequent interrupts). The time-out counter starts as soon as one valid entry is present in the FIFO and is reset every time a data is pop out of the FIFO. The counter expires (FIFO time_out condition) if no FIFO data are pop for a period longer than the TIME_OUT register value; when this happens, depending on the control registers settings, an interrupt can be set. 6.2.4.11 Ethernet DMA, RX FIFO Status Register Mnemonic: RX_DMA_FIFO Address: 0x3000_342C Default value: 0x0000_0000 Bit 31-30 29-24 23-21 20-16 15-13 12-08 07-04 03 02 01 00 Field name Reserved ENTRIES Reserved DMA_POINTER Reserved IO_POINTER Reserved DELAY_T ENTRY_T FULL EMPTY Access RO RO RO RO RO RO RO RO RO RO RO ENTRIES: full entries (in 32 bit words) in FIFO. DMA_POINTER: FIFO DMA SM side pointer value. IO_POINTER: FIFO IO side pointer value. DELAY_T: Set to '1' when the DMA FIFO delay time_out is expired. ENTRY_T: Set to '1' when the DMA FIFO entry trigger threshold has been reached. 47/194 6 Blocks description SPEAR-07-NC03 FULL: Set to '1' when DMA FIFO is full. EMPTY: Set to '1' when the DMA FIFO is empty. 6.2.4.12 Ethernet DMA, TX Start Register Mnemonic: TX_DMA_START Address: 0x3000_3030 Default value: 0x0000_0000 Bit 31-24 23-08 07 06 05 04-03 02 01 00 Field name Reserved DFETCH_DELAY ADD_CRC_DIS PADDING_DIS UNDERRUN Reserved START_FETCH Reserved DMA_EN Access RO RW RW RW RW RO RS RO RC DFETCH_DLY: Descriptor fetch delay. This field specifies, in a bus clock periods, the delay between two descriptor fetches, in the event that the descriptor in main memory is not valid. When set to '0' it forces the DMA_MAC logic, in case of invalid descriptor, to wait for 2**16 system bus clocks before attempting a new fetch. ADD_CRC_DIS: This bit drives the MAC110 input pin ADD_CRC_DISABLE to tell the MAC110 core not to add the CRC field at the end of the frame. If its value is modified while the DMA is enabled, the results will be unpredictable. PADDING_DIS: This bit drives the MAC110 input pin DISABLE_PADDING, to avoid the MAC110 add the padding bits for frames too short. If its value is modified while the DMA is enabled, the results will be unpredictable. UNDERRUN: When '1', the Under Run condition, reported by the MAC in the TX packet status word, will enable the DMA logic to retransmit the same packet to the MAC110 core, without reporting any error condition to the CPU. START_FETCH: This bit is a Read/Set bit, that means it can be both read and written, but writing a '0' has no effect. The SW has to set this bit to '1' when the TX DMA has to start fetching the first descriptor. The DMA logic will reset to '0' this bit and set the DMA_EN to '1' as soon as the first fetch has been completed. Note: Before starting the DMA, the DMA_NXT register has to be loaded with the starting address of the descriptor to be fetched. DMA_EN: Read/Clear bit: a write with '1' reset to '0' the bit value, while a write with '0' has no effect. 48/194 SPEAR-07-NC03 6 Blocks description This bit, set to '1' by the DMA after the first descriptor fetch, can be reset to '0' by the SW to force a DMA abort and stop as soon as possible the data transfer, before the DMA completion. When all the DMA sequences complete normally, this bit is reset by the DMA_MAC logic and a new SW intervention is required to restart the DMA engine. Note: ● ● The DMA_EN 0->1 transition resets the FIFO content and the TX interrupts (DMA_INT_STAT (31:16)). The DMA_EN 1->0 transition forces the DMA to close immediately the transfers toward AHB bus and MAC core. When the AHB transfer completes the DMA_INT_STAT.TX_DONE interrupt is set and the processor can reprogram and reactivate the TX logic. 6.2.4.13 Ethernet DMA, TX Control register Mnemonic: TX_DMA_CNTL Address: 0x3000_3034 Default value: 0x0000_0000 Bit 31-22 21-17 16 15 14 13 12 11-00 Field name ADDR_WRAP ENTRY_TRIG Reserved DLY_EN NXT_EN Reserved CONT_EN DMA_XFER_COUNT Access RW RW RO RW RW RO RW RW ADDR_WRAP: Determines where the DMA address counter wraps by forcing the DMA address counter to retain the data originally written by the host in DMA_ADDR. As soon as the DMA has read the memory location prior to the value specified in ADD_WRAP the wrapping condition occurs. This can be used to restrict the address counter within an address window (e.g. circular buffer). The wrapping point MUST be 32 bit aligned, so the 10 bits of ADDR_WRAP are used to compare DMA address bits 11 to 2; if ADD_WRAP=DMA_ADDR(11:2) then a 4Kbyte buffer is defined. ADDRWRAP is ignored unless WRAP_EN is set. ENTRY_TRIG: Determines the amount of empty entries (in 32 BIT WORDs) required in the TX FIFO before the DMA is re-triggered. If the value is set to 0, as soon as one empty entry is present, the DMA logic starts the data request. DLY_EN: This bit enables (when '1') the DMA trigger delay feature: if a FIFO valid data resides in the FIFO more than a programmed period (DMA_TO), a time-out condition occurs and the related (TX_TO) interrupt will be set. 49/194 6 Blocks description SPEAR-07-NC03 NXT_EN: Next Descriptor Fetch Mode enable. Set to '1', this bit enables the next descriptor fetch mechanism. Whenever a DMA transfer is completed, if this field is set, a new DMA descriptor is fetched. If this field is '0' then no descriptor is fetched and an interrupt is raised as normal. Note: when a descriptor is fetched TX_DMA_CTL is one of the registers updated. CONT_EN: Continuos Mode Enable. This bit enables the DMA to run in continuos mode. If set the DMA runs indefinitely ignoring DMA_ XFERCOUNT. Note "continuos mode" supersedes "next descriptor mode". DMA_XFERCOUNT: Block size (in bytes) of DMA, maximum 4 Kbytes. If DMA_XFERCOUNT is set to '0', the DMA will transfer 4 Kbyte data. 6.2.4.14 Ethernet DMA, TX Base Address Register Mnemonic: TX_DMA_ADDR Address: 0x3000_3038 Default value: 0x0000_0000 Bit 31-02 01 00 Field name DMA_ADDR FIX_ADDR WRAP_EN Access RW RW RW DMA_ADDR: Start address, 32 bit WORD ALIGNED, for master DMA transfer. This register is read by the DMA SM only before starting the DMA operation and when the wrap condition is met, so further updates of this register will have unpredictable effects on the running DMA. FIX_ADDR: Disables incrementing of DMA_ADDR: this means that all the DMA data transfer operation will be performed at the same AHB address, i.e. the DMA base address. WRAP_EN: Enables wrap of the DMA transfer address to DMA_ADDR when the memory location, specified in ADDR_WRAP, is reached. 6.2.4.15 Ethernet DMA, TX Next Descriptor Address Register Mnemonic: TX_DMA_NXT Address: 0x3000_303C Default value: 0x0000_0000 Bit 31-02 01 00 Field name DMA_DESCR_ADDR Reserved NPOL_EN Access RW RO RW DMA_DESCR_ADDR: When the DMA next descriptor fetch is enabled, this register points to the next descriptor starting address. The DMA descriptors are 32 bits, so the DMA_DESCR_ADDR MUST be 32 bit aligned. 50/194 SPEAR-07-NC03 6 Blocks description This register allows different DMA descriptors to be located in different memory area, because part of the current DMA descriptors, provides information to point to the next one (descriptor chaining). If the DMA descriptor fetch is not enabled, this register doesn't need to be updated. NPOL_EN: Next Descriptor Polling Enable. When in 'Next Descriptor Fetch Mode', the descriptor fetch logic can load a not jet valid descriptor: if the NPOL is enabled ('1'), the logic is required to keep polling the DMA descriptor in main memory, until it's found to be valid. Note: In case of not valid descriptor, DMA_MAC behavior will be different depending on the NPOL bit; we can have: NPOL=1 (polling enabled) -> the TX_NEXT bit will be set and a new descriptor fetch will be attempt after DFETCH_DLY clocks NPOL=0 (polling disabled) -> the TX_DONE bit will be set and the DMA_EN bit, in DMA_START register, will be cleared. 6.2.4.16 Ethernet DMA, TX Current Address Register Mnemonic: TX_DMA_CADDR Address: 0x3000_3040 Default value: 0x0000_0000 Bit 31-02 Field name DMA_CADDR Access RO DMA_CADDR: Current DMA address value, byte aligned. The value of this register will change while the DMA is running, reflecting the value driven by the core on the AHB bus. 6.2.4.17 Ethernet DMA, TX Current Transfer Count Register Mnemonic: TX_DMA_CXFER Address: 0x3000_3044 Default value: 0x0000_0000 Bit 31-12 11-00 Field name Reserved DMA_CXFER Access RO RO DMA_CXFER: Current DMA transfer count value. It's updated while the DMA is running, when one data is moved from the main memory to the DMA FIFO, reflecting the number of bytes that must be still read. 51/194 6 Blocks description SPEAR-07-NC03 6.2.4.18 Ethernet DMA, TX Time Out Register Mnemonic: TX_DMA_TO Address: 0x3000_3048 Default value: 0x0000_0000 Bit 31-16 15-00 Field name Reserved TIME_OUT Access RO RW TIME_OUT: This value is used as initial value for the FIFO entry time_out counter (it's recommended not to use too low value, to avoid too frequent interrupts). This counter starts as soon as one valid entry is present in the FIFO and is reset every time a FIFO data is pop out of the FIFO. The counter expires (FIFO time_out condition) if no FIFO data are pop for a period longer than the TIME_OUT register value; when this happens, depending on the control registers settings, an interrupt can be set. 6.2.4.19 Ethernet DMA, TX FIFO Status Register Mnemonic: TX_DMA_FIFO Address: 0x3000_304C Default value: 0x0000_0000 Bit 31-30 29-24 23-21 20-16 15-13 12-08 07-04 03 02 01 00 Field name Reserved ENTRIES Reserved DMA_POINTER Reserved IO_POINTER Reserved DELAY_T ENTRY_T FULL EMPTY Access RO RO RO RO RO RO RO RO RO RO RO ENTRIES: free entries (in 32 bit words) in FIFO. DMA_POINTER: FIFO DMA SM side pointer value. IO_POINTER: FIFO IO side pointer value. DELAY_T: Set to '1' when the DMA FIFO delay time_out is expired. ENTRY_T: Set to '1' when the DMA FIFO entry trigger threshold has been reached. 52/194 SPEAR-07-NC03 FULL: Set to '1' when DMA FIFO is full. EMPTY: Set to '1' when the DMA FIFO is empty. 6 Blocks description 6.2.4.20 MAC Control Register Mnemonic: MAC_CNTL Address: 0x3000_3400 Default value: 32'b00000000_00000100_00000000_00000000 Bit 31 30 29 28 27 26 - 24 23 22 - 21 20 19 18 17 16 15 14 13 12 11 10 09 08 07 - 06 05 04 03 02 01 - 00 Field name RA BLE Reserved HBD PS Reserved DRO OM FDM PAM PRM IF PBF HOFM Reserved HPFM LCC DBF DRT Reserved ASTP BOLMT DC Reserved TXE RXE Reserved Access RW RW RO RW RW RO RW RW RW RW RW RW RW RW RO RW RW RW RW RO RW RW RW RO RW RW RO The MAC Control Register establishes the RX and TX operating modes and controls for address filtering and packet filtering. Table 5 describes the bit fields of the register. 53/194 6 Blocks description SPEAR-07-NC03 RA: Receive All. When set, all incoming packets will be received, regardless of the destination address. The address match checked according to Table 22, and is reported in Transmit Status. BLE: Endian mode. When BLE is set, the MAC operates in the big Endian mode. When BLE is reset, the MAC operates in the little Endian mode. The Endian mode is only for the data buffers. HBD: Heart Beat Disable. When set, the heartbeat signal quality (SQE) generator function is disabled. This bit should be set in the MII Mode. PS: Port Select. When reset, the MII port is selected and when set, the SRL (ENDEC) port is selected for transmit/receive operations on the Ethernet side. DRO: DRO-Disable Receive Own. When DRO is set, the MAC110 disables the reception of frames when the TXEN is asserted. The MAC110 will block the transmitted frame on the receive path. When DSO is reset, the MAC110 receives all the packets that are given by the PHY including those transmitted by the MAC100. This bit should be reset when the Full Duplex Mode bit is set or the Operating Mode is not set to 'Normal Mode'. OM: OM-Loop-Back Operating Mode. This bit selects the Loop-Back operation modes for the MAC110. This setting is only for Full Duplex Mode. OM Type 2’b00 2’b01 2’b10 2’b11 Normal. No feedback Internal. Through MII External. Through PHY Reserved. In the Internal Loop-Back mode, the TX frame is received by the MII, and turned around back to the MAC110. In the External mode however, the TX frame is sent up to the PHY. The PHY will then turn that TX frame back to be received by the MAC110. Note: that in the External mode the application has to set the PHY in Loop-Back mode by setting bit14 in the register space of the PHY. (IEEE802.3 sec.22.2.4.1) FDM: Full Duplex Mode. When Set, the MAC operates in a full-duplex mode where it can transmit and receive simultaneously. While in full-duplex mode: heartbeat check is disabled, heartbeat fail status should be ignored, and internal loop back is not allowed. PAM: Pass All Multicast. When set, indicates that all the incoming frames with a multicast destination address (first bit in the destination address field is '1' are received. Incoming frames with physical address destinations are filtered only if the address matches with the MAC Address. PRM: Promiscuous Mode. When set, indicates that any incoming valid frame is received regardless of its destination address. IF: IF-Inverse filtering. When IF is set, Address Check block operates in the inverse filtering mode. This is valid only during perfect filtering mode. PBF: Pass Bad Frames. When set, all incoming frames that passed the address filtering are received, including runt frames, collided frames, or truncated frames caused by Buffer underflow. HPFM: Hash/Perfect Filtering Mode. When reset, the Address Check block does a perfect address filter of incoming frames according the address specified in the MAC Address register. When set, the Address Check block does imperfect address filtering of multicast incoming frames according to the hash table specified in the multicast Hash Table Register. If the Hash 54/194 SPEAR-07-NC03 6 Blocks description Only (HO) is set, then physical addresses are imperfect filtered too. If Hash Only bit(HO) is reset, then physical addresses are perfect address filtered according to the MAC Address Register. LCC: Late Collision Control. When set, enables the retransmission of the collided frame even after the collision period (late collision). When LC is reset, the MAC110 core disables the frame transmission on a late collision. In any case the Late Collision Status is appropriately updated in the Transmit Packet Status. DBF: Disable Broadcast frames. When set, disables the reception of broadcast frames. When reset, forwards all the broadcast frames to the memory. DRTY: Disable Retry. When set, the MAC will attempt only one transmission. When a collision is seen on the bus, the MAC will ignore the current frame and goes to the next frame and a retry error is reported in the Transmit Status. When DRTY is reset, the MAC will attempt 16 transmissions before signaling a retry error. ASTP: Automatic Pad Stripping. When set the MAC will strip the pad field on all the incoming frames if the length field is less than 46 bytes. The FCS field will also be stripped since it is computed at the transmitting station based on the data and pad field characters, and will be invalid for a received frame that has had the pad characters stripped. Receive frames which have a length field of 46 bytes or greater will be passed to the host unmodified (FCS is not stripped). When reset, the MAC will pass all the incoming frames to the host unmodified. BOLMT: BackOff Limit. The BOLMT bits allow the user to set its Back Off limit in a relaxed or aggressive mode. According to IEEE 802.3, the MAC110 has to wait for a random number [r] of Slot-Times** after it detects a collision, where: 0 < r < 2K The number K is dependent on how many times the current Frame to be transmitted have been retried, as follows: K= min(n,10) where n is the current number of retries. If a frame has been retried for 3 times, then K = 3 and r= 8 Slot-Times maximum If it has been retried for 12 times, then K = 10, and r = 1024 Slot-Times maximum. A LFSR (linear feedback shift register) 20-bit counter is used to emulate a 20bit random number generator from which r is obtained. Once a collision is detected, the number of the current retry of the current frame is used to obtain K (eq.2). This value of K translates into the number of bits to use from the LFSR counter. If the value of k is 3, the MAC100 will take the value in the first 3 bits of the LFSR counter, and use it to count down till Zero on every SlotTime. This will effectively causes the MAC110 to wait 8 Slot-Times. To add more flexibility to the user the Value of the BOLMT will force the number of bits to be used from the LFSR counter to a predetermined value as in the table below. Eq. 1 BOLMT Value 2’b00 2’b01 2’b10 2’b11 # Bits Used from LFSR counter 10 8 4 1 55/194 6 Blocks description SPEAR-07-NC03 Thus if the value of k = 10, then the MAC110 will look at the BOLMT if it is 00 then it will use the lower 10bits of the LFSR counter for the wait countdown. If BOLMT is 10 then it will only use the value in the first 4bits for the wait countdown, and so on… **Slot-Time = 512 bit times. DC: Deferral Check. When DC is set, the deferral check is enabled in the MAC. The MAC will abort the transmission attempt if it has deferred for more than 24,288 bit times. Deferring starts when the transmitter is ready to transmit, but is prevented from doing so because CRS is active. Defer time is not cumulative. If the transmitter defers for 10,000 bit times, then transmits, collides, backs off, and then has to defer again after completion of BackOff, the deferral timer resets to 0 and restarts. When reset, the deferral check is disabled in the MAC and the MAC defers indefinitely. TE: Transmitter Enable. When set, the MAC's transmitter is enabled and it will transmit frames from the buffer on to the cable. When reset, the MAC's transmitter is disabled and will not transmit any frames. RE: Receiver Enable. When set, the MAC's receiver is enabled and will receive frames from the MII interface. When reset, the MAC's receiver is disabled and will not receive any frames from the MII interface. 6.2.4.21 MAC Address High Register Mnemonic: MAC_ADDH Address: 0x3000_3404 Default value: 0x0000_FFFF Bit 31 - 16 15 - 00 Field name Reserved PADDR[47:32] Access RO RW The MAC Address Hi Register contains the upper 16 bits of the physical address of the MAC. The contents of this register are normally loaded from the EEPROM at power on through the EEPROM Controller. PADDR[47:32]: Upper 16 bits (47:32) of the Physical Address of this MAC device. 56/194 SPEAR-07-NC03 6 Blocks description 6.2.4.22 MAC Address Low Register Mnemonic: MAC_ADDL Address: 0x3000_3408 Default value: 0xFFFF_FFFF Bit 31 - 00 Field name PADDR[31:00] Access RW The MAC Address Low Register contains the lower 32 bits of the physical address of the MAC. The contents of this register are normally loaded from the EEPROM at power on through the EEPROM Controller. PADDR[31:00]: Lower 32 bits (31:00) of the Physical Address of this MAC device. 6.2.4.23 MAC Multi Cast Hash Table High Register Mnemonic: MAC_MCHTH Address: 0x3000_340C Default value: 0x0000_0000 Bit 31 - 00 Field name HTABLE[63:32] Access RW 6.2.4.24 MAC Multi Cast Hash Table Low Register Mnemonic: MAC_MCHTL Address: 0x3000_3410 Default value: 0x0000_0000 Bit 31 - 00 Field name HTABLE[31:00] Access RW The 64-bit multicast table is used for group address filtering. For hash filtering, the contents of the destination address in the incoming frame is passed through the CRC logic and the upper 6 bits of the CRC register are used to index the contents of the Hash table. The most significant bit determines the register to be used (Hi/Low), while the other five bits determine the bit with in the register. A value of '00000' selects the bit 0 of the selected register and a value of '11111' selects the bit 31 of the selected register. If the corresponding bit is '1', then the multicast frame is accepted else it is rejected. If the Pass All Multicast is set, then all multi-cast frames are accepted regardless of the multi-cast hash values. 57/194 6 Blocks description SPEAR-07-NC03 6.2.4.25 MII Address Register Mnemonic: MAC_ADDR Address: 0x3000_3414 Default value: 0x0000_0000 Bit 31 - 16 15 – 11 10 - 06 05 - 02 01 00 Field name Reserved PHY_ADD MII_REG Reserved MII_WR MII_BUSY Access RO RW RW RO RW RW The MII Address Register is used to control the Management cycles to the External PHY Controller chip. PHY_ADD: Phy Address. These bits tell which of the 32 possible PHY devices are being accessed MII_REG: MII Register. These bits select the desired MII register in the selected PHY device. MII_WR: MII Write. Setting this bit tells the PHY that this will be a write operation using the MII data register. If this bit is not set, this will be a read operation, placing the data in the MII data register. MII_BUSY: MII Busy. This bit should read a logic 0 before writing to the MII address and MII data registers. This bit must also be set to 0 during write to the MII address register. During a MII register access, this bit will be then set to signify that a read or write access is in progress. The MII data register should be kept valid until the MAC clears this bit during a PHY write operation. The MII data register is invalid until the MAC has cleared it during a PHY read operation. The MII address register should not be written to until this bit is cleared. 6.2.4.26 MII Data Register Mnemonic: MAC_DATA Address: 0x3000_3418 Default value: 0x0000_0000 Bit 31 - 16 15 – 00 Field name Reserved MII_DATA Access RO RW The MII Data Register contains the data to be written to the PHY register specified in the MII address register, or it contains the read data from the PHY register whose address is specified in the MII address register. MII_DATA: This contains the 16-bit value read from the PHY after a MII read operation or the 16-bit data value to be written to the PHY before a MII write operation. 58/194 SPEAR-07-NC03 6 Blocks description 6.2.4.27 Flow Control register Mnemonic: FCR Address: 0x3000_341C Default value: 0x0000_0000 Bit 31 - 16 15 - 03 02 01 00 Field name PTIME Reserved PCF FCE FCB Access RW RO RW RW RW This register is used to control the generation and reception of the Control (PAUSE Command) frames by the MAC's Flow control block. A write to register with busy bit set to '1' triggers the Flow Control block to generate a Control frame. The fields of the control frame are selected as specified in the 802.3x specification and PauseTime value from this register is used in the "Pause Time" field of the control frame. The Busy bit is set until the control frame is transferred onto the cable. The Host has to make sure that the Busy bit is cleared before writing the register. The Pass Control Frames bit indicates the MAC whether to pass the control frame to the Host or not and Flow Control Enable bit enables the receive portion of the Flow Control block. PTIME: Pause Time. This field tells the value that is to be used in the PAUSE TIME field in the control frame. PCF: Pass Control Frames. When set, the control frames are passed to the Host. The MAC110 core will decode the control frame (PAUSE), disables the transmitter for the specified amount of time. The Control Frame bit in the Receive Status (bit 25) is set and Transmitter Pause Mode signal indicates the current state of the MAC Transmitter. When reset, the MAC110 core will decode the control frames but will not pass the frames to the Host. The Control Frame bit in the Receive Status (bit 25) will be set and the Transmitter Pause Mode signal gives the current status of the Transmitter, but the Packet Filter bit in the Receive Status is reset indication the application to flush the frame. FCE: Flow Control Enable. When set, the MAC is enabled for operation and it will decode all the incoming frames for control frames. When the MAC receives a valid control frame (PAUSE command), it will disable the transmitter for the specified time. When reset, the operation in the MAC is disabled and the MAC does not decode the frames for control frames. Note: Flow Control is applicable when the MAC110 is set in Full Duplex Mode. In Half Duplex mode, this bit will enable using Backpressure to control flow of transmitted frames to the MAC110. FCB: Flow Control Busy. This bit should read a logic 0 before writing to the Flow Control register. To initiate a PAUSE control frame the host must set this bit to '1'. During a transfer of Control Frame, this bit will continue to be set to signify that a frame transmission is in progress. After the completion of the transmission of the PAUSE control frame, the MAC will reset to '0'. The Flow Control register should not be written to until this bit is cleared. 59/194 6 Blocks description SPEAR-07-NC03 6.2.4.28 VLAN1 Tag Register Mnemonic: VLAN1 Address: 0x3000_3420 Default value: 0x0000_FFFF Bit 31 - 16 15 - 00 Field name Reserved VLAN1_TAG Access RO RW This register contains the VLAN Tag field to identify the VLAN1 frames. The MAC compares the 13th and 14th bytes of the incoming frame field and if a match is found, it sets the VLAN1 bit in the Rx-Status (bit 22) register. The legal length of the frame is increased from 1518 bytes to 1522 bytes. VLAN1_TAG: This contains the VLAN Tag field to identify the VLAN1 frames. This field is compared with the 13th and 14th bytes of the incoming frames for VLAN1 frame detection. 6.2.4.29 VLAN2 Tag Register Mnemonic: VLAN2 Address: 0x3000_3424 Default value: 0xFFFF_FFFF Bit 31 - 16 15 - 00 Field name Reserved VLAN2_TAG Access RO RW This register contains the VLAN Tag field to identify the VLAN2 frames. The MAC compares the 13th and 14th bytes of the incoming frame field and if a match is found, it sets the VLAN2 bit in the Rx-Status register (bit 23). The legal length of the frame is increased from 1518 bytes to 1522 bytes. VLAN2_TAG: This contains the VLAN Tag field to identify the VLAN2 frames. This field is compared to the 13th and 14th bytes of the incoming frames for VLAN2 frame detection. 60/194 SPEAR-07-NC03 6 Blocks description 6.2.4.30 MMC Control Register Mnemonic: MMC_CTRL_REG Address: 0x3000_3500 Default value: 0x0000_2F72 Bit 31 – 14 13 – 03 02 01 00 Reserved MAX_FRM_SIZE RESET_ON_READ CNTR_ROLL_OVER CNTR_RESET Field name Access RO RW RW RW WO This register establishes the operating mode of the management counters. MAX_FRM_SIZE: These bits indicate the value of the Maximum Packet Size for the transmitted frames to be counted as long frames. RESET_ON_READ: When set the counter will be reset to 0 after read. CNTR_ROLL_OVER: When set, counters after reaching the maximum value start again from 0. CNTR_RESET: When set, all counters will be reset to 0. 6.2.4.31 MMC Interrupt High Register Mnemonic: MMC_INT_HI_REG Address: 0x3000_33504 Default value: 0x0000_0000 Bit 31 – 12 11 10 09 08 07 06 05 04 03 02 01 00 Field name Reserved TX_EXC_DEFER_FRMS TX_CRS_ERROR_FRMS TX_ABORTED_FRMS TX_LATE_COL_FRMS TX_DEFERRED_FRMS TX_MUL_COL_FRMS TX_SINGLE_COL_FRMS TX_BAD_FRMS TX_FIFO_UND_FRMS TX_BROADCAST_FRMS TX_MULTICAST_FRMS TX_UNICAST_FRMS Access RO RW RW RW RW RW RW RW RW RW RW RW RW 61/194 6 Blocks description SPEAR-07-NC03 The MMC interrupt register maintains the interrupt generated due to the counters reaching half of their maximum value. 6.2.4.32 MMC Interrupt Low Register Mnemonic: MMC_INT_LO_REG Address: 0x3000_3508 Default value: 0x0000_0000 Bit 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 09 08 07 06 05 04 03 Field name TX_1024_TO_MAX_FRMS TX_512_TO_1023_FRMS TX_256_TO_511_FRMS TX_128_TO_255_FRMS TX_65_TO_127_FRMS TX_64_BYTES_FRMS TX_GOOD_TRANSM_BYTES TX_TRANSM_BYTES TX_CNTRL_FRMS TX_TRANSM_FRMS RX_ETH_FRMS RX_LEN_ERR_FRMS RX_DRIBBLE_ERR_FRMS RX_CRC_ERR_FRMS RX_LONG_FRMS RX_RUNT_FRMS RX_FIFO_ERR_FRMS RX_BROADCAST_FRMS RX_MULTICAST_FRMS RX_UNICAST_FRMS RX_1024_TO_MAX_FRMS RX_512_TO_1023_FRMS RX_256_TO_511_FRMS RX_128_TO_255_FRMS RX_65_TO_127_FRMS RX_64_BYTES_FRMS RX_GOOD_NUM_BYTES RX_NUM_BYTES RX_UNSUP_CNTRL_FRMS Access RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW 62/194 SPEAR-07-NC03 6 Blocks description Bit 02 01 00 Field name RX_CNTRL_FRMS RX_GOOD_FRMS RX_NUM_FRMS Access RW RW RW The MMC interrupt register maintains the interrupt generated due to the counters reaching half of their maximum value. 6.2.4.33 MMC Interrupt Mask Registers Mnemonic: MMC_INT_MSK_HI_REG, MMC_INT_MSK_LO_REG Address: 0x3000_350C, 0x3000_3510 Default value: 0x0000_0000, 0x0000_0000 The MMC interrupt mask registers maintain the masks for the interrupt generated due to the counters reaching half of their maximum value. (MSB of the counter is set). 6.2.5 Programming the DMA MAC 6.2.5.1 The Ethernet Frame format Figure 4. Ethernet Frame Format Preamble 7 Bytes SFD 1 Byte Dst Addr 6 Bytes Src Addr 6 Bytes Length 2 Bytes Data 46 – 1500 Bytes FCS 4 Bytes Figure 5. IEEE802.3 Frame Format Preamble 7 Bytes SFD 1 Byte Dst Addr 6 Bytes Src Addr 6 Bytes Type 2 Bytes Data 46 – 1500 Bytes FCS 4 Bytes Automatically added by MAC layer Input to MAC layer The following is a description of what information the DMA MAC layer needs to be provided when sending frames on the LAN cable (See Figure 4 and Figure 5) – Destination Address (6 bytes): This field is the 48-bit standard format address of the device for whish this frame is intended. – Source Address (6 bytes): This field is the 48-bit standard format address of the device which is sending this frame. – Data (46-1500 Bytes): This field is the real content of the frame. It contains headers of the protocols above (like IEEE802.2 LLC/SNAP and TCP/IP) and data. Note that it must be at least 46 bytes long to have as a minimum of 64 bytes complete 63/194 6 Blocks description SPEAR-07-NC03 frames on the cable. This is done to guarantee the collision condition detected before the packet transmission ends, even with a cable as long as the maximum cable length allowed by the IEEE specification. However, since a zero-pad can be (depending on DIS_PADDING bit in TX_DMA_START register) automatically added by the DMA MAC when the minimum length constrain is not reached, the user doesn't needs to pay attention to it. The following fields are automatically added by the DMA MAC layer before sending the frame (see Figure 4 and Figure 5) – Preamble (7 Bytes): This field is used to synchronize the receiver with the frame timing. – Start Frame Delimiter (1 Byte): This field indicates the start of a frame. – Frame Check Sequence (4 Bytes): This field represents the CRC32 value of all the data provided by the DMA MAC user. It is used by the receiver to check if the frame has been corrupted during the transmission on the line. The FCS field can be provided by the SW, together with the data: in this case the MAC logic will be requested, via the ADD_CRC_DIS bit in the TX_DMA_Start register, to do not generate it again. On the other side, when the DMA MAC is receiving the frame from the LAN, it will download to the main memory the following field contents: – Destination address (6 Bytes) – Source Address (6 Bytes) – Type or Length (2 Bytes) – Data (46 - 1500 Bytes) – FCS (4 Bytes) 6.2.5.2 The DMA Descriptor Chain Figure 6. DMA Descriptor chain DMA_Cntrl DMA_Cntrl DMA_Addr DMA_Next Tx/Rx_Stat us Descr 1 (4 x 4 Bytes) DMA_Cntrl ... DMA_Addr DMA_Next Tx/Rx_Stat us Descr 2 (4 x 4 Bytes) DMA_Cntrl DMA_Addr DMA_Next Tx/Rx_Stat us Descr n (4 x 4 Bytes) Frame 0 Frame 1 Frame n The descriptor list is the mean the CPU and the DMA MAC use to communicate each other in order to transmit and receive frames on the cable. This list must be properly prepared before 64/194 SPEAR-07-NC03 6 Blocks description initiating any transfer activity to or from the cable (see Figure 6). The descriptor is produced by the CPU and consumed by the DMA MAC. A descriptor is a 16-bytes element which provides the DMA MAC with information about how to transmit or receive a single frame and how to report the transfer status back to the CPU. A Descriptor can be stored in any main memory location with a 32 bit aligned address. The first 3 words stored in a Descriptor are expected to be values of the 3 DMA MAC registers describing a DMA transfer (DMA_CNTL, DMA_ADDR and DMA_NEXT), while the fourth, related to the transmit/receive packet status, has the Descriptor Valid Bit as bit #16. When the DMA MAC fetches a Descriptor it loads this three values into its own corresponding registers and checks the VALID bit value. All the bits (except #16 - VALID bit) of the last word are to be used by the DMA MAC to report the transfer status. Its format should match the specification of the Transmit Packet Status and Receive Packet Status of the MAC110 core user manual with the minor changes reported in the following. The following is the Descriptor format in C language notation: { int int int int }; DMA_CNTL; DMA_ADDR; DMA_NEXT; TxRx_STATUS; //input-output //input //input //output 6.2.5.3 The Descriptor Control Bits The Descriptor keeps information about a single frame transfer and how to access to the next Descriptor. The following discussion is related to 3 bits of the Descriptor: The VALID bit, the NXT_EN bit and the NPOL_EN bit. The Descriptor can be accessed simultaneously by the CPU and the DMA MAC. This concurrent access is synchronized by the VALID bit in the Receive/Transmit status register. When the VALID bit is equal to 0 then the CPU is the owner of the Descriptor. Otherwise the owner is the DMA MAC. Since the Descriptor can be accessed in write mode by the owner at any time, race conditions are guaranteed to never happen. The NXT_EN bit enables the fetch of the Next Descriptor. When the DMA MAC finds this bit set to 0 then the activity is considered to be completed as soon as the current Descriptor DMA transfers have been completed. The NPOL_EN bit enables the DMA MAC to keep polling for a non valid Descriptor until its VALID bit become true (Set to 1). When the DMA MAC finds both the NPOL_EN bit and the VALD bit set to 0 then its activity is considered to be completed. 6.2.5.4 Transfer Status The transfer status returned by the DMA MAC is based on the Tx/Rx Packet Status defined by the MAC110 core. Nevertheless the bits definition has been a slightly changed: the 16th bit is now the VALID bit for both the status fields, and the Frame To Long bit has been moved from the 16th to the 13th position. 65/194 6 Blocks description SPEAR-07-NC03 Transfer Interrupts The DMA MAC can interrupt the CPU with three different levels of information about transfer completion. The CPU can choose which interrupt needs to be enabled. They do not exclude each other though; they can be all three enabled at the same time. The TX_CURR_DONE (RX_CURR_DONE) interrupt bit reports the CPU when a single Descriptor (i.e. one frame) has been completely treated by the DMA MAC and the CPU is again the owner (VALID bit is set to 0). The TX_NEXT (RX_NEXT) interrupt bit is set when next descriptor fetch is enabled (NXT_EN set to 1 in the current Descriptor) but the next Descriptor is not valid (Valid bit is set to 0). The TX_DONE (RX_DONE) interrupt bit is set when a whole DMA transfer is complete. This can happens either when the current is the last Descriptor in the chain (NXT_EN is set to 0) or when the next Descriptor is not valid yet (VALID bit set to 0) and the polling bit is disabled (NPOL_EN set to 0). 6.2.5.5 Frame Transmission (Tx) When the CPU wants to transmit a set of frames on the cable, it needs to provide the DMA MAC with a Descriptor list. The CPU is expected to allocate a Descriptor for each frame it wants to send, to fill it with the DMA control information and the pointer to the frame and to link the Descriptor in the chain (see Figure 6). The frames will be sent on the cable in the same order they are found on the chain. 6.2.5.6 Open list approach The simplest way to construct a Descriptor chain is the open list approach. Every Descriptor but the last one will have the DMA_NEXT field pointing to the next descriptor in the chain, the NXT_EN bit and the VALID bit on, the NPOL_EN bit on or off. The last Descriptor will e set in the same way except for the NXT_EN bit (off) and the DMA_NEXT field (NULL). The CPU starts the DMA activity loading the physical location of the first Descriptor into the DMA_NEXT Register of the DMA MAC and then set the DMA_START resister enable bit to on. The DMA MAC will then keep fetching the Descriptors one by one until it finds the NXT_EN bit set to off (last Descriptor in the chain). Every time it completes a descriptor (frame) it saves the transfer status into TxRx_STATUS, it turns the Descriptor VALID bit to off and rises the TX_CURR_DONE interrupt bit. When the NXT_EN bit is found to be off, that means the DMA MAC has fetched the last Descriptor in the chain. When it completes also this Descriptor (the end of the DMA transfer) it raises both the TX_CURR_DONE and the TX_DONE interrupt bits. Closed list approach The approach above is easy since it doesn't require the DMA MAC and the CPU to synchronize their access to the descriptor chain. The problem is that requires the CPU to build the list every time it needs a transfer. A faster way to operate is building a closed Descriptor list only the first time and using the VALID bit to mark the end of the transfer. Even more the polling facility could be used to save the CPU from the activity of programming the DMA_START register every time it needs to start the DMA Transfer. Instead, the DMA_START register will be activated only once and the DMA MAC will keep polling the invalid Descriptor, raising each time the TX_NEXT interrupt bit (if 66/194 SPEAR-07-NC03 6 Blocks description enabled), until the CPU finally sets its VALID bit to on. Since the DMA transfer practically never ends, note that in this case the TX_DONE interrupt bit is never raised. With this approach every Descriptor will have the DMA_NEXT field pointing to the next Descriptor in the chain (the last one will point the first one), the NXT_EN bit, the VALID bit and the NPOL_EN bit on. The DMA MAC will keep fetching the Descriptor one by one until it finds one with its VALID bit set to 0. Every time the DMA MAC completes a Descriptor (frame) it saves the Transfer Status into the TxRx_STATUS, ot turns its VALID bit to off and raises the TX_CURR_DONE interrupt bit. 6.2.5.7 Frame Reception (Rx) The frame reception process is something that needs to be activated at the beginning and kept always running. For this reason the closed Descriptor list (see above) is much more useful than the open list approach. Again, with this approach every Descriptor will have the DMA_NEXT field pointing to the next Descriptor in the chain (the last one will point to the first one), the NXT_EN bit, the VALID bit and the NPOL_EN bit on. The CPU starts the transfer activity loading the DMA Next register of the DMA MAC with the physical location of the first Descriptor and sets the DMA_START register enable bit to on. The DMA MAC will start fetching the Descriptors one by one, driven by the frame reception from the line. Every time the DMA MAC completes a Descriptor (frame) it saves the transfer status into the TxRx_STATUS, it turns its VALD bit to off and raises the RX_CURR_DONE interrupt bit. Eventually, if the DMA MAC will be faster then the CPU, it will wrap around the Descriptor chain finding a Descriptor still invalid. Then the DMA MAC keeps polling the invalid Descriptor, raising each time the RX_NEXT interrupt bit (if enabled), until some Descriptors gets available (note that in this case some frame could be lost). In the meantime the CPU should consume the frames received and set the VALID bit to on of all the Descriptor released. As soon as the DMA finds the Descriptor valid again, it will be able to complete the transfer and fetch the next Descriptor. 67/194 6 Blocks description SPEAR-07-NC03 6.3 Figure 7. Full-Speed USB Host Controller USB Host Controller Block Diagram OHCI Root USB HUB Regs. Control State Control Control AHB MASTER Wrapper HCI Slave Block Root Control Control HUB & TX OHCI Regs List Processor Block ED&TD Regs Control Host SIE RCV Root HUB Config Block USB APB SLAVE HCI Master Block Status 64x8 FIFO CNTL 64x8 FIFO 6.3.1 Overview The USB interface integrated into the SPEAr Net device is an Full-Speed USB controller and is compliant with the USB1.1 standard and OpenHCI (Open Host Controller Interface) Rev.1.0 compatible. SPEAr Net supports both, low and full speed USB devices. The Open Host Controller Interface (OpenHCI) Specification for the Universal Serial Bus is a register-level description of a Host Controller for the Universal Serial Bus (USB) which in turn is described by the Universal Serial Bus Specification. The purpose of OpenHCI is to accelerate the acceptance of USB in the marketplace by promoting the use of a common industry software/hardware interface. OpenHCI allows multiple Host Controller vendors to design and sell Host Controllers with a common software interface, freeing them from the burden of writing and distributing software drivers. 68/194 SPEAR-07-NC03 Figure 8. USB Focus Areas 6 Blocks description Figure 8 shows four main focus areas of a Universal Serial Bus (USB) system. These areas are the Client Software/USB Driver, Host Controller Driver (HCD), Host Controller (HC), and USB Device. The Client Software/USB Device and Host Controller Driver are implemented in software. The Host Controller and USB Device are implemented in hardware. OpenHCI specifies the interface between the Host Controller Driver and the Host Controller and the fundamental operation of each. The Host Controller Driver and Host Controller work in tandem to transfer data between client software and a USB device. Data is translated from shared-memory data structures at the clientsoftware end to USB signal protocols at the USB device end, and vice-versa. Figure 7 shows the Block Diagram of the protocols at the USB the SPEAr Net USB (HC) contains a set USB Host Controller. The integrated USB Host Controller (HC) contains a set of on-chip operational registers which are mapped into the noncacheable portion of the system addressable space. These registers are used by the Host Controller Driver (HCD). According to the function of these registers, they are divided into four partitions, specifically for Control and Status, Memory Pointer, Frame Counter and Root Hub. All of the registers should be read and written as Dwords. Reserved bits may be allocated in future releases of this specification. To ensure interoperability, the Host Controller Driver that does not use a reserved field should not assume that the reserved field contains 0. Furthermore, the Host Controller Driver should always preserve the value(s) of the reserved field. When a R/W register is modified, the Host Controller Driver should first read the register, modify the bits desired, then write the register with the reserved bits still containing the read value. Alternatively, the Host Controller Driver can maintain an in-memory copy of previously written values that can be modified and then written to the Host Controller register. When a write to set/clear register is written, bits written to reserved fields should be 0. 6.3.2 Host Controller Management The Host Controller (HC) is first managed through a set of Operational Registers. These registers exist in the Host Controller and are accessed using memory references via a noncached virtual pointer. All Host Controller Operational Registers start with the prefix Hc. 69/194 6 Blocks description SPEAR-07-NC03 The HcHCCA is filled in by software and points the Host Controller at the block of shared RAM called the Host Controller Communication Area (HCCA). All fields within the HCCA start with the prefix Hcca. 6.3.3 Initialization of the HCI There are a number of steps necessary for an OS to bring its Host Controller Driver to an operational state: ● Load Host Controller Driver and locate the HC ● Verify the HC and allocate system resources ● Take control of HC (support for an optional System Management Mode driver) ● Set up HC registers and HC Communications Area ● Begin sending SOF tokens on the USB Note: Due to some devices on the USB that may take a long time to reset, it is desirable that the Host Controller Driver start-up process not transition to the USBRESET state if at all possible. 6.3.4 Operational States The operational states of the Host Controller are defined by their effect on the USB: ● USBOPERATIONAL ● USBRESET ● USBRESUME ● USBSUSPEND 6.3.4.1 USBRESET When the Host Controller enters this state, most of the operational registers are ignored by the Host Controller and need not contain any meaningful values; however, the contents of the registers (except Root Hub registers) are preserved by the HC. The obvious exception is that the Host Controller uses the HcControl register which contains the HostControllerFunctionalState. While in this state, the Root Hub is being reset, which causes the Root Hub's downstream ports to be reset and possibly powered off. This state must be maintained for the minimum time specified in the USB Specification for the assertion of reset on the USB. Only the following interrupts are possible while the Host Controller is in the USBRESET state: OwnershipChange. 6.3.4.2 USBOPERATIONAL This is the normal state of the HC. In this state, the Host Controller is generating SOF tokens on the USB and processing the various lists that are enabled in the HcControl register. This allows the clients of the Host Controller Driver, USBD and above, to communicate with devices on the USB. The Host Controller generates the first SOF token within one ms of the time that the USBOPERATIONAL state is entered (if the Host Controller Driver wants to know when this occurs, it may enable the StartOfFrame interrupt). All interrupts are possible in the USBOPERATIONAL state, except ResumeDetected. 70/194 SPEAR-07-NC03 6 Blocks description 6.3.4.3 USBSUSPEND In this state, the Host Controller is not generating SOF tokens on the USB; nor is it processing any lists that may be enabled in the HcControl register. In fact, the Host Controller ignores most of the operational registers which need not contain any meaningful values; however, the Host Controller does preserve their values. While in this state, the Host Controller monitors the USB for resume signalling, and if detected, changes the state to USBRESUME. Because of this, there is a restriction on how the Host Controller Driver may modify the contents of HcControl while in the USBSUSPEND state: Host Controller Driver may only write to HcControl with the HostControllerFunctionalState field set to either USBRESET or USBRESUME (see exception). OpenHCI - Open Host Controller Interface Specification for USB After a certain length of time without SOF tokens, devices on the USB enter the suspend state. Normally, the Host Controller Driver must ensure that the Host Controller stays in this state for at least 5 ms and then exits this state to either the USBRESUME or the USBRESET state. An exception is when this state is entered due to a software reset and the previous state was not USBSUSPEND, in which case, if the Host Controller remains in the USBSUSPEND state for less than 1 ms, it may exit directly to USBOPERATIONAL (the timing of less than 1 ms ensures that no device on USB attempts to initiate resume signalling and thus the Host Controller does not attempt to modify HcControl). The only interrupts possible in the USBSUSPEND state are ResumeDetected (the Host Controller will have changed the HostControllerFunctionalState to the USBRESUME state) and OwnershipChange. 6.3.4.4 USBRESUME While the Host Controller is in the USBRESUME state, it is asserting resume signalling on the USB; as a result, no tokens are generated and the Host Controller does not process any lists that may be enabled in the HcControl register. In fact, most of the operational registers are ignored and need not contain any meaningful values; however, the Host Controller does preserve their values. This state must be maintained for the minimum time specified in the USB Specification for the assertion of resume on the USB. The only interrupt possible in the USBRESUME state is OwnershipChange. For more details please refer to the OpenHCI Interface Specification for USB in Chapter 8) Reference Documents 71/194 6 Blocks description SPEAR-07-NC03 6.3.5 Table 12. Operational Registers Mapping USB Host Controller Operational Register Map Register Name HcRevision HcControl Description Address 0x3000_2C00 0x3000_2C04 Revision field Read only USB Host Controller Operating mode Used by the Host Controller to receive commands issused by 0x3000_2C08 HcCommandStatus the Host Controller Driver Register provides status on various events that cause hardware 0x3000_2C0C HcInterruptStatus interrupts Register is used to control which events generate a hardware 0x3000_2C10 HcInterruptEnable interrupt 0x3000_2C14 HcInterruptDisable To clear the corresponding bit in the HcInterruptEnable register Register contains the physical address of the Host Controller 0x3000_2C18 HcHCCA Communication Area Register contains the physical address of the current 0x3000_2C1C HcPeriodCurrentED isochronous or Interrupt Endpoint Descriptor Register contains the physical address of the first Endpoint 0x3000_2C20 HcControlHeadED Descriptor of the Control list Register contains the physical address of the current Endpont 0x3000_2C24 HcControlCurrentED Descriptor of the control list Register contains the physical address of the first Endpoint 0x3000_2C28 HcBulkHeadED Descriptor of the Bulk list Register contains the physical address of the current endpoint of the Bulk list. As the bulk list will be served in a round-robin 0x3000_2C2C HcBulkCurrentED fashion, the endpoints will be ordered according to their insertion to the list. Contains the physical address of the last completed transfer 0x3000_2C30 HcDoneHead descriptor that was added to the Done queue. Register contains a 14-bit value which indicates the bit time 0x3000_2C34 HcFmInterval interval in a frame, and a 15-bit value indicating the full speed maximum packet size that the host controller may carry out. Register is a 14-bit down counter showing the bit time remaining 0x3000_2C38 HcFmRemaining in the current frame Register is a 16-bit counter providein a reference among events 0x3000_2C3C HcFmNumber happening in the host controller and the host controller driver Register has a 14-bit programmable value which determines 0x3000_2C40 HcPeriodicStart when is the earliest time HC should start processing the periodic list. Register contains an 11-bit value used by the host controller to 0x3000_2C44 HcLSThreshold determine whether to commit to the transfer of a maximum of 8byte LS packet before EOF. 0x3000_2C48 HcRhDescriptorA Register (first of 2) describes the characteristics of the root hub Register (second of 2) describes the characteristic of the root 0x3000_2C4C HcRhDescriptorB hub Register represents the Hub status field (lower word of Dword) 0x3000_2C50 HcRhStatus and the Hub Status Change field (upper word of Dword) Register [1:NDP] is used to control and report port events on a 0x3000_2C54 HcRhPortStatus[1: NDP] per-port basis. … “ 0x3000_2C54+4*NDP HcRhPortStatus[NDP] “ 72/194 SPEAR-07-NC03 6 Blocks description 6.3.6 Register description All the registers are 32 bit wide. 6.3.6.1 HcRevision Register Mnemonic: Address: 0x3000_2C00 Bit Field name Read/Write Reset HCD HC Revision This read-only field contains the BCD representation of the version of the HCI specification that is implemented by this HC. For example, a value of 11h corresponds to version 1.1. All of the HC implementations that are compliant with this specification will have a value of 10h. Description 31 - 08 REV 10 R R 07 - 00 reserved I 6.3.6.2 HcControl Register Address: 0x3000_2C04 Bit 31 - 11 Field name reserved RemoteWakeupEnable This bit is used by HCD to enable or disable the remote wakeup feature upon the detection of upstream resume signaling. When this bit is set and the ResumeDetected bit in HcInterruptStatus is set, a remote wakeup is signaled to the host system. Setting this bit has no impact on the generation of hardware interrupt. RemoteWakeupConnected This bit indicates whether HC supports remote wakeup signaling. If remote wakeup is supported and used by the system it is the responsibility of system firmware to set this bit during POST. HC clears the bit upon a hardware reset but does not alter it upon a software reset. Remote wakeup signaling of the host system is host-bus-specific and is not described in this specification. Root Hub Reset Read/Write Description HCD HC 10 RWE 0b RW R 09 RWC 0b RW RW 73/194 6 Blocks description SPEAR-07-NC03 Bit Field name Root Hub Reset Read/Write Description HCD HC InterruptRouting This bit determines the routing of interrupts generated by events registered in HcInterruptStatus. If clear, all interrupts are routed to the normal host bus interrupt mechanism. If set, interrupts are routed to the System Management Interrupt. HCD clears this bit upon a hardware reset, but it does not alter this bit upon a software reset. HCD uses this bit as a tag to indicate the ownership of HC. HostControllerFunctionalState for USB 00b: USBRESET 01b: USBRESUME 10b: USBOPERATIONAL 11b: USBSUSPEND A transition to USBOPERATIONAL from another state causes SOF generation to begin 1 ms later. HCD may determine whether HC has begun sending SOFs by reading the StartofFrame field of HcInterruptStatus. This field may be changed by HC only when in the USBSUSPEND state. HC may move from the USBSUSPEND state to the USBRESUME state after detecting the resume signaling from a downstream port. HC enters USBSUSPEND after a software reset, whereas it enters USBRESET after a hardware reset. The latter also resets the Root Hub and asserts subsequent reset signaling to downstream ports. BulkListEnable This bit is set to enable the processing of the Bulk list in the next Frame. If cleared by HCD, processing of the Bulk list does not occur after the next SOF. HC checks this bit whenever it determines to process the list. When disabled, HCD may modify the list. If HcBulkCurrentED is pointing to an ED to be removed, HCD must advance the pointer by updating HcBulkCurrentED before re-enabling processing of the list. 08 IR 0b RW R 07 - 06 HCFS 00b RW RW 05 BLE 0b RW R 74/194 SPEAR-07-NC03 6 Blocks description Bit Field name Root Hub Reset Read/Write Description HCD HC ControlListEnable This bit is set to enable the processing of the Control list in the next Frame. If cleared by HCD, processing of the Control list does not occur after the next SOF. HC must check this bit whenever it determines to process the list. When disabled, HCD may modify the list. If HcControlCurrentED is pointing to an ED to be removed, HCD must advance the pointer by updating HcControlCurrentED before re-enabling processing of the list. IsochronousEnable This bit is used by HCD to enable/disable processing of isochronous EDs. While processing the periodic list in a Frame, HC checks the status of this bit when it finds an Isochronous ED (F=1). If set (enabled), HC continues processing the EDs. If cleared (disabled), HC halts processing of the periodic list (which now contains only isochronous EDs) and begins processing the Bulk/Control lists. Setting this bit is guaranteed to take effect in the next Frame (not the current Frame). PeriodicListEnable This bit is set to enable the processing of the periodic list in the next Frame. If cleared by HCD, processing of the periodic list does not occur after the next SOF. HC must check this bit before it starts processing the list. ControlBulkServiceRatio This specifies the service ratio between Control and Bulk EDs. Before processing any of the nonperiodic lists, HC must compare the ratio specified with its internal count on how many nonempty Control EDs have been processed, in determining whether to continue serving another Control ED or switching to Bulk EDs. The internal count will be retained when crossing the frame boundary. In case of reset, HCD is responsible for restoring this value.. CBSR 0 1 2 3 No. of Control EDs Over Bulk EDs Served 1:1 2:1 3:1 4:1 04 CLE 0b RW R 03 IE 0b RW R 02 PLE 0b RW R 01 - 00 CBSR 00b RW R 75/194 6 Blocks description SPEAR-07-NC03 The HcControl register defines the opertating modes for the Host Controller. Most of the fields in this register are modified only by the Host Controller Driver, except HostControllerFunctionalState and RemoteWakeupConnected. 6.3.6.3 HcCommandStatus Register Address: 0x3000_2C08 Bit 31 - 18 Field name reserved SchedulingOverrunCount These bits are incremented on each scheduling overrun error. It is initialized to 00b and wraps around at 11b. This will be incremented when a scheduling overrun is detected even if SchedulingOverrun in HcInterruptStatus has already been set. This is used by HCD to monitor any persistent scheduling problems. Read/Write Reset HCD HC Description 17 - 16 SOC 00b R RW 15 - 04 reserved OwnershipChangeRequest This bit is set by an OS HCD to request a change of control of the HC. When set HC will set the OwnershipChange field in HcInterruptStatus. After the changeover, this bit is cleared and remains so until the next request from OS HCD. BulkListFilled This bit is used to indicate whether there are any TDs on the Bulk list. It is set by HCD whenever it adds a TD to an ED in the Bulk list. When HC begins to process the head of the Bulk list, it checks BF. As long as BulkListFilled is 0, HC will not start processing the Bulk list. If BulkListFilled is 1, HC will start processing the Bulk list and will set BF to 0. If HC finds a TD on the list, then HC will set BulkListFilled to 1 causing the Bulk list processing to continue. If no TD is found on the Bulk list, and if HCD does not set BulkListFilled, then BulkListFilled will still be 0 when HC completes processing the Bulk list and Bulk list processing will stop. 03 OCR 0b RW RW 02 BLF 0b RW RW 76/194 SPEAR-07-NC03 6 Blocks description Bit Field name Read/Write Reset HCD HC ControlListFilled This bit is used to indicate whether there are any TDs on the Control list. It is set by HCD whenever it adds a TD to an ED in the Control list. When HC begins to process the head of the Control list, it checks CLF. As long as ControlListFilled is 0, HC will not start processing the Control list. If CF is 1, HC will start processing the Control list and will set ControlListFilled to 0. If HC finds a TD on the list, then HC will set ControlListFilled to 1 causing the Control list processing to continue. If no TD is found on the Control list, and if the HCD does not set ControlListFilled, then ControlListFilled will still be 0 when HC completes processing the Control list and Control list processing will stop. HostControllerReset This bit is set by HCD to initiate a software reset of HC. Regardless of the functional state of HC, it moves to the USBSUSPEND state in which most of the operational registers are reset except those stated otherwise; e.g., the InterruptRouting field of HcControl, and no Host bus accesses are allowed. This bit is cleared by HC upon the completion of the reset operation. The reset operation must be completed within 10 s. This bit, when set, should not cause a reset to the Root Hub and no subsequent reset signaling should be asserted to its downstream ports. Description 01 CLF 0b RW RW 00 HCR 0b RW RW The HcCommandStatus register is used by the Host Controller to receive commands issued by the Host Controller Driver, as well as reflecting the current status of the Host Controller. To the Host Controller Driver, it appears to be a "write to set" register. The Host Controller must ensure that bits written as '1' become set in the register while bits written as '0' remain unchanged in the register. The Host Controller Driver may issue multiple distinct commands to the Host Controller without concern for corrupting previously issued commands. The Host Controller Driver has normal read access to all bits. The SchedulingOverrunCount field indicates the number of frames with which the Host Controller has detected the scheduling overrun error. This occurs when the Periodic list does not complete before EOF. When a scheduling overrun error is detected, the Host Controller increments the counter and sets the SchedulingOverrun field in the HcInterruptStatus register. 77/194 6 Blocks description SPEAR-07-NC03 6.3.6.4 HcInterruptStatus Register Address: 0x3000_2C0C Bit 31 Field name 0 OwnershipChange This bit is set by HC when HCD sets the OwnershipChangeRequest field in HcCommandStatus. This event, when unmasked, will always generate an System Management Interrupt (SMI) immediately. This bit is tied to 0b when the SMI pin is not implemented. Read/Write Reset HCD HC Description 30 OC 0b RW RW 29 - 07 reserved RootHubStatusChange This bit is set when the content of HcRhStatus or the content of any of HcRhPortStatus[NumberofDownstreamPort] has changed. FrameNumberOverflow This bit is set when the MSb of HcFmNumber (bit 15) changes value, from 0 to 1 or from 1 to 0, and after HccaFrameNumber has been updated. UnrecoverableError This bit is set when HC detects a system error not related to USB. HC should not proceed with any processing not signalling before the system error has been corrected. HCD clears this bit after HC has been reset. ResumeDetected This bit is set when HC detects that a device on the USB is asserting resume signalling. It is the transition from no resume signalling to resume signalling causing this bit to be set. This bit is not set when HCD sets the USBRESUME state. StartofFrame This bit is set by HC at each start of a frame and after the update of HccaFrameNumber. HC also generates a SOF token at the same time. 06 RHSC 0b RW RW 05 FNO 0b RW RW 04 UE 0b RW RW 03 RD 0b RW RW 02 SF 0b RW RW 78/194 SPEAR-07-NC03 6 Blocks description Bit Field name Read/Write Reset HCD HC WritebackDoneHead This bit is set immediately after HC has written HcDoneHead to HccaDoneHead. Further updates of the HccaDoneHead will not occur until this bit has been cleared. HCD should only clear this bit after it has saved the content of HccaDoneHead. SchedulingOverrun This bit is set when the USB schedule for the current Frame overruns and after the update of HccaFrameNumber. A scheduling overrun will also cause the SchedulingOverrunCount of HcCommandStatus to be incremented. Description 01 WDH 0b RW RW 00 SO 0b RW RW This register provides status on various events that cause hardware interrupts. When an event occurs, Host Controller sets the corresponding bit in this register. When a bit becomes set, a hardware interrupt is generated if the interrupt is enabled in the HcInterruptEnable register (see Chapter 6.3.6.5) and the MasterInterruptEnable bit is set. The Host Controller Driver may clear specific bits in this register by writing '1' to bit positions to be cleared. The Host Controller Driver may not set any of these bits. The Host Controller will never clear the bit. 6.3.6.5 HcInterruptEnable Register Address: 0x3000_2C10 Bit Field name Read/Write Reset HCD HC A ‘0’ written to this field is ignored by HC. A '1' written to this field enables interrupt generation due to events specified in the other bits of this register. This is used by HCD as a Master Interrupt Enable. 0 - Ignore 1 - Enable interrupt generation due to Ownership Change. Description 31 MIE 0b RW R 30 29 - 07 06 OC reserved RHSC 0b RW R 0b RW R 0 - Ignore 1 - Enable interrupt generation due to Root Hub Status Change. 0 - Ignore 1 - Enable interrupt generation due to Frame Number Overflow. 0 - Ignore 1 - Enable interrupt generation due to Unrecoverable Error. 05 FNO 0b RW R 04 UE 0b RW R 79/194 6 Blocks description SPEAR-07-NC03 Bit Field name Read/Write Reset HCD HC 0 - Ignore 1 - Enable interrupt generation due to Resume Detect. 0 - Ignore 1 - Enable interrupt generation due to Start of Frame. 0 - Ignore 1 - Enable interrupt generation due to HcDoneHead Writeback. 0 - Ignore 1 - Enable interrupt generation due to Scheduling Overrun. Description 03 RD 0b RW R 02 SF 0b RW R 01 WDH 0b RW R 00 SO 0b RW R Each enable bit in the HcInterruptEnable register corresponds to an associated interrupt bit in the HcInterruptStatus register. The HcInterruptEnable register is used to control which events generate a hardware interrupt. When a bit is set in the HcInterruptStatus register AND the corresponding bit in the HcInterruptEnable register is set AND the MasterInterruptEnable bit is set, then a hardware interrupt is requested on the host bus. Writing a '1' to a bit in this register sets the corresponding bit, whereas writing a '0' to a bit in this register leaves the corresponding bit unchanged. On read, the current value of this register is returned. 6.3.6.6 HcInterruptDisable Register Address: 0x3000_2C14 Bit Field name Read/Write Reset HCD HC A '0' written to this field is ignored by HC. A '1' written to this field disables interrupt generation due to events specified in the other bits of this register. This field is set after a hardware or software reset. 0 - Ignore 1 - Disable interrupt generation due to Ownership Change. Description 31 MIE 0b RW R 30 29 - 07 06 OC reserved RHSC 0b RW R 0b RW R 0 - Ignore 1 - Disable interrupt generation due to Root Hub Status Change. 0 - Ignore 1 - Disable interrupt generation due to Frame Number Overflow. 05 FNO 0b RW R 80/194 SPEAR-07-NC03 6 Blocks description Bit Field name Read/Write Reset HCD HC 0 - Ignore 1 - Disable interrupt generation due to Unrecoverable Error. 0 - Ignore 1 - Disable interrupt generation due to Resume Detect. 0 - Ignore 1 - Disable interrupt generation due to Start of Frame. 0 - Ignore 1 - Disable interrupt generation due to HcDoneHead Writeback. 0 - Ignore 1 - Disable interrupt generation due to Scheduling Overrun. Description 04 UE 0b RW R 03 RD 0b RW R 02 SF 0b RW R 01 WDH 0b RW R 00 SO 0b RW R Each disable bit in the HcInterruptDisable register corresponds to an associated interrupt bit in the HcInterruptStatus register. The HcInterruptDisable register is coupled with the HcInterruptEnable register. Thus, writing a '1' to a bit in this register clears the corresponding bit in the HcInterruptEnable register, whereas writing a '0' to a bit in this register leaves the corresponding bit in the HcInterruptEnable register unchanged. On read, the current value of the HcInterruptEnable register is returned. 6.3.6.7 HcHCCA Register Mnemonic: Address: 0x3000_2C18 Default value: Read/Write Bit 31 - 08 07 - 00 Field name HCD HCCA 0 R/W HC R Base Address of the Host Controller Communication Area Description The HcHCCA register contains the physical address of the Host Controller Communication Area. The Host Controller Driver determines the alignment restrictions by writing all 1s to HcHCCA and reading the content of HcHCCA. The alignment is evaluated by examining the number of zeroes in the lower order bits. The minimum alignment is 256 bytes; therefore, bits 0 through 7 must always return '0' when read. Detailed description can be found in Chapter 4. This area is used to hold the control structures and the Interrupt table that are accessed by both the Host Controller and the Host Controller Driver. 81/194 6 Blocks description SPEAR-07-NC03 6.3.6.8 HcPeriodCurrentED Register Mnemonic: Address: 0x3000_2C1C Default value: Read/Write Bit Field name HCD HC PeriodCurrentED This is used by HC to point to the head of one of the Periodic of lists which will be processed in the current Frame. The content of this register is updated by HC after a periodic ED has been processed. HCD may read the content in determining which ED is currently being processed at the time of reading. Description 31 – 04 PCED R RW 03 – 00 0 The HcPeriodCurrentED register contains the physical address of the current Isochronous or Interrupt Endpoint Descriptor. 6.3.6.9 HcControlHeadED Register Mnemonic: Address: 0x3000_2C20 Default value: Read/Write Bit Field name HCD HC ControlCurrentED This pointer is advanced to the next ED after serving the present one. HC will continue processing the list from where it left off in the last Frame. When it reaches the end of the Control list, HC checks the ControlListFilled of in HcCommandStatus. If set, it copies the content of HcControlHeadED to HcControlCurrentED and clears the bit. If not set, it does nothing. HCD is allowed to modify this register only when the ControlListEnable of HcControl is cleared. When set, HCD only reads the instantaneous value of this register. Initially, this is set to zero to indicate the end of the Control list. Description 31 – 04 CCED R RW 03 – 00 0 The HcControlCurrentED register contains the physical address of the current Endpoint Descriptor of the Control list. 82/194 SPEAR-07-NC03 6 Blocks description 6.3.6.10 HcBulkHeadED Register Mnemonic: Address: 0x3000_2C28 Default value: Read/Write Bit Field name Reset HCD HC BulkHeadED HC traverses the Bulk list starting with the HcBulkHeadED pointer. The content is loaded from HCCA during the initialization of HC. Description 31 – 04 BHED 0h R/W R 03 – 00 0 The HcBulkHeadtED register contains the physical address of the first Endpoint Descriptor of the Bulk list. 6.3.6.11 HcBulkCurrentED Register Address: 0x3000_2C2C Read/Write Bit Field name Reset HCD HC BulkCurrentED This is advanced to the next ED after the HC has served thepresent one. HC continues processing the list from where it left off in the last Frame. When it reaches the end of the Bulk list, HC checks the ControlListFilled of HcControl. If set, it copies the content of HcBulkHeadED to HcBulkCurrentED and clears the bit. If it is not set, it does nothing. HCD is only allowed to modify this register when the BulkListEnable of HcControl is cleared. When set, the HCD only reads the instantaneous value of this register. This is initially set to zero to indicate the end of the Bulk list. Description 31 – 04 BCED 0h R/W R/W 03 – 00 0 The HcBulkHeadtED register contains the physical address of the current endpoint of the Bulk list. As the Bulk list will be served in a round-robin fashion, the endpoints will be ordered according to their insertion of the list. 83/194 6 Blocks description SPEAR-07-NC03 6.3.6.12 HcDoneHead Register Address: 0x3000_2C30 Bit Field name Read/Write Reset HCD HC DoneHead When a TD is completed, HC writes the content of HcDoneHead to the NextTD field of the TD. HC then overwrites the content of HcDoneHead with the address of this TD. This is set to zero whenever HC writes the content of this register to HCCA. It also sets the WritebackDoneHead of HcInterruptStatus Description 31 – 04 DH 0h R R/W 03 – 00 0 The HcDoneHead register contains the physical address of the last completed Transfer Descriptor that was added to the Done queue. In normal operation, the Host Controller Driver should not need to read the register as its content is periodically written to the HCCA. 6.3.6.13 HcFmInterval Register Address: 0x3000_2C34 Bit Field name Read/Write Reset HCD HC Frame Interval Toggle HCD toggles this bit whenever it loads a new value to FrameInterval FSLargestDataPacket This field specifies a value which is loaded into the Largest Data Packet Counter at the beginning of each frame. The counter value represents the largest amount of data in bits which can be sent or received by the HC in a single transaction at any given time without causing scheduling overrun. The field value is calculated by the HCD. Description 31 FIT 0b RW R 30 - 16 FSMPS TBD RW R 15 – 14 Reserved FrameInterval This specifies the interval between two consecutive SOFs in bit times. The nominal value is set to be 11,999. HCD should store the current value of this field before resetting HC. By setting the HostControllerReset field of HcCommandStatus as this will cause the HC to reset this field to its nominal value. HCD may choose to restore the stored value upon the completion of the Reset sequence. 13 - 00 FI 2EDFh RW R 84/194 SPEAR-07-NC03 6 Blocks description The HcFmInterval register contains a 14-bit value which indicates the bit time interval in a Frame, (i.e., between two consecutive SOFs), and a 15-bit value indicating the Full Speed maximum packet size that the Host Controller may transmit or receive without causing scheduling overrun. The Host Controller Driver may carry out minor adjustment on the FrameInterval by writing a new value over the present one at each SOF. This provides the programmability necessary for the Host Controller to synchronize with an external clocking resource and to adjust any unknown local clock offset. 6.3.6.14 HcFmRemaining Register Address: 0x3000_2C38 Bit Field name Read/Write Reset HCD HC FrameRemainingToggle This bit is loaded from the FrameIntervalToggle field of HcFmInterval whenever FrameRemaining reaches 0. This bit is used by HCD for the synchronization between FrameInterval and FrameRemaining. . FrameRemaining This counter is decremented at each bit time. When it reaches zero, it is reset by loading the FrameInterval value specified in HcFmInterval at the next bit time boundary. When entering the USBOPERATIONAL state, HC re-loads the content with the FrameInterval of HcFmInterval and uses the updated value from the next SOF. Description 31 FRT 0b R RW 30 - 14 reserved FR 0h R RW The HcFmRemaining register is a 14-bit down counter showing the bit time remaining in the current Frame. 6.3.6.15 HcFmNumber Register Address: 0x3000_2C3C Bit Field name Read/Write Reset HCD HC Description 31 - 16 reserved FrameNumber This is incremented when HcFmRemaining is re-loaded. It will be rolled over to 0h after ffffh. When entering the USBOPERATIONAL state, this will be incremented automatically. The content will be written to HCCA after HC has incremented the FrameNumber at each frame boundary and sent a SOF but before HC reads the first ED in that Frame. After writing to HCCA, HC will set the StartofFrame in HcInterruptStatus. 15 - 00 FN 0h R RW 85/194 6 Blocks description SPEAR-07-NC03 The HcFmNumber register is a 16-bit counter. It provides a timing reference among events happening in the Host Controller and the Host Controller Driver. The Host Controller Driver may use the 16-bit value specified in this register and generate a 32-bit frame number without requiring frequent access to the register. 6.3.6.16 HcPeriodicStart Register Address: 0x3000_2C40 Bit 31 - 16 Field name reserved PeriodicStart After a hardware reset, this field is cleared. This is then set by HCD during the HC initialization. The value is calculated roughly as 10% off from HcFmInterval.. A typical value will be 3E67h. When HcFmRemaining reaches the value specified, processing of the periodic lists will have priority over Control/Bulk processing. HC will therefore start processing the Interrupt list after completing the current Control or Bulk transaction that is in progress. Read/Write Reset HCD HC Description 15 - 00 PS 0h RW R The HcPeriodicStart register has a 14-bit programmable value which determines when is the earliest time HC should start processing the periodic list. 6.3.6.17 HcLSThreshold Register Address: 0x3000_2C44 Bit Field name Read/Write Reset HCD HC Description 31 - 12 Reserved LSThreshold This field contains a value which is compared to the FrameRemaining field prior to initiating a Low Speed transaction. The transaction is started only if FrameRemaining ≥ this field. The value is calculated by HCD with the consideration of transmission and setup overhead. 11 - 00 LST 0628h RW R 86/194 SPEAR-07-NC03 6 Blocks description 6.3.6.18 HcRhDescriptorA Register Address: 0x3000_2C48 Bit Field name Power on Reset Read/Write Description HCD HC PowerOnToPowerGoodTime This byte specifies the duration HCD has to wait before accessing a powered-on port of the Root Hub. It is implementation-specific. The unit of time is 2 ms. The duration is calculated as POTPGT * 2 ms. 31 - 24 POTPGT IS RW R 23 - 13 Reserved NoOverCurrentProtection This bit describes how the overcurrent status for the Root Hub ports are reported. When this bit is cleared, the OverCurrentProtectionMode field specifies global or per-port reporting. 0: Over-current status is reported collectively for all downstream ports 1: No overcurrent protection supported OverCurrentProtectionMode This bit describes how the overcurrent status for the Root Hub ports are reported. At reset, this fields should reflect the same mode as PowerSwitchingMode. This field is valid only if the NoOverCurrentProtection field is cleared. 0: over-current status is reported collectively for all downstream ports 1: over-current status is reported on a per-port basis DeviceType This bit specifies that the Root Hub is not a compound device. The Root Hub is not permitted to be a compound device. This field should always read/write 0. NoPowerSwitching These bits are used to specify whether power switching is supported or port are always powered. It is implementationspecific. When this bit is cleared, the PowerSwitchingMode specifies global or per-port switching. 0: Ports are power switched 1: Ports are always powered on when the HC is powered on 12 NOCP IS RW R 11 OCPM IS RW R 10 DT 0b R R 09 NPS IS RW R 87/194 6 Blocks description SPEAR-07-NC03 Bit Field name Power on Reset Read/Write Description HCD HC PowerSwitchingMode This bit is used to specify how the power switching of the Root Hub ports is controlled. It is implementation-specific. This field is only valid if the NoPowerSwitching field is cleared. 0: all ports are powered at the same time. 1: each port is powered individually. This mode allows port power to be controlled by either the global switch or perport switching. If the PortPowerControlMask bit is set, the port responds only to port power commands (Set/ ClearPortPower). If the port mask is cleared, then the port is controlled only by the global power switch (Set/ClearGlobalPower). NumberDownstreamPorts These bits specify the number of downstream ports supported by the Root Hub. It is implementation-specific. The minimum number of ports is 1. The maximum number of ports supported by OpenHCI is 15. 08 PSM IS RW R 07 - 00 NDP IS R R The HcRhDescriptorA register is the first register of two describing the characteristics of the Root Hub. Reset values are implementation-specific. The descriptor length (11), descriptor type (TBD), and hub controller current (0) fields of the hub Class Descriptor are emulated by the HCD. All other fields are located in the HcRhDescriptorA and HcRhDescriptorB registers. 88/194 SPEAR-07-NC03 6 Blocks description 6.3.6.19 HcRhDescriptorB Register Address: 0x3000_2C4C Bit Field name Power on Reset Read/Write Description HCD HC PortPowerControlMask Each bit indicates if a port is affected by a global power control command when PowerSwitchingMode is set. When set, the port's power state is only affected by per-port power control (Set/ClearPortPower). When cleared, the port is controlled by the global power switch (Set/ ClearGlobalPower). If the device is configured to global switching mode (PowerSwitchingMode=0), this field is not valid. bit 0: Reserved bit 1: Ganged-power mask on Port #1 bit 2: Ganged-power mask on Port #2 ... bit15: Ganged-power mask on Port #15 DeviceRemovable Each bit is dedicated to a port of the Root Hub. When cleared, the attached device is removable. When set, the attached device is not removable. bit 0: Reserved bit 1: Device attached to Port #1 bit 2: Device attached to Port #2 ... bit15: Device attached to Port #15 31 - 16 PPCM IS RW R 15 - 00 DR IS RW R The HcRhDescriptorB register is the second register of two describing the characteristics of the Root Hub. These fields are written during initialization to correspond with the system implementation. Reset values are implementation-specific. 89/194 6 Blocks description SPEAR-07-NC03 6.3.6.20 HcRhStatus Register Address: 0x3000_2C50 Bit Field name Root Hub Reset Read/Write Description HCD HC ClearRemoteWakeupEnable Writing a '1' clears DeviceRemoveWakeupEnable. Writing a '0' has no effect. 31 CRWE - W R 30 - 18 Reserved OverCurrentIndicatorChange This bit is set by hardware when a change has occurred to the OCI field of this register. The HCD clears this bit by writing a ‘1’. Writing a ‘0’ has no effect. (read) LocalPowerStatusChange The Root Hub does not support the local power status feature; thus, this bit is always read as ‘0’. (write) SetGlobalPower In global power mode (PowerSwitchingMode=0), This bit is written to ‘1’ to turn on power to all ports (clear PortPowerStatus). In per-port power mode, it sets PortPowerStatus only on ports whose PortPowerControlMask bit is not set. Writing a ‘0’ has no effect. (read) DeviceRemoteWakeupEnable This bit enables a ConnectStatusChange bit as a resume event, causing a USBSUSPEND to USBRESUME state transition and setting the ResumeDetected interrupt. 0 = ConnectStatusChange is not a remote wakeup event. 1 = ConnectStatusChange is a remote wakeup event. (write) SetRemoteWakeupEnable Writing a '1' sets DeviceRemoveWakeupEnable. Writing a '0' has no effect. 17 OCIC 0b RW RW 16 LPSC 0b RW R 15 DRWE 0b RW R 14 - 02 reserved 90/194 SPEAR-07-NC03 6 Blocks description Bit Field name Root Hub Reset Read/Write Description HCD HC OverCurrentIndicator This bit reports overcurrent conditions when the global reporting is implemented. When set, an overcurrent condition exists. When cleared, all power operations are normal. If per-port overcurrent protection is implemented this bit is always ‘0’ (read) LocalPowerStatus The Root Hub does not support the local power status feature; thus, this bit is always read as ‘0’. (write) ClearGlobalPower In global power mode (PowerSwitchingMode=0), This bit is written to ‘1’ to turn off power to all ports (clear PortPowerStatus). In per-port power mode, it clears PortPowerStatus only on ports whose PortPowerControlMask bit is not set. Writing a ‘0’ has no effect. 01 OCI 0b R RW 00 LPS 0b RW R The HcRhStatus register is divided into two parts. The lower word of a Dword represents the Hub Status field and the upper word represents the Hub Status Change field. Reserved bits should always be written '0'. 6.3.6.21 HcRhPortStatus[1:NDP] Register Address: 0x3000_2C54 Bit 31 - 21 Field name Reserved PortResetStatusChange This bit is set at the end of the 10-ms port reset signal. The HCD writes a ‘1’ to clear this bit. Writing a ‘0’ has no effect. 0 = port reset is not complete 1 = port reset is complete PortOverCurrentIndicatorChange This bit is valid only if overcurrent conditions are reported on a per-port basis. This bit is set when Root Hub changes the PortOverCurrentIndicator bit. The HCD writes a ‘1’ to clear this bit. Writing a ‘0’ has no effect. 0 = no change in PortOverCurrentIndicator 1 = PortOverCurrentIndicator has changed Root Hub Reset Read/Write Description HCD HC 20 PRSC 0b RW RW 19 OCIC 0b RW RW 91/194 6 Blocks description SPEAR-07-NC03 Bit Field name Root Hub Reset Read/Write Description HCD HC PortSuspendStatusChange This bit is set when the full resume sequence has been completed. This sequence includes the 20-s resume pulse, LS EOP, and 3-ms resychronization delay. The HCD writes a ‘1’ to clear this bit. Writing a ‘0’ has no effect. This bit is also cleared when ResetStatusChange is set. 0 = resume is not completed 1 = resume completed PortEnableStatusChange This bit is set when hardware events cause the PortEnableStatus bit to be cleared. Changes from HCD writes do not set this bit. The HCD writes a ‘1’ to clear this bit. Writing a ‘0’ has no effect. 0 = no change in PortEnableStatus 1 = change in PortEnableStatus ConnectStatusChange This bit is set whenever a connect or disconnect event occurs. The HCD writes a ‘1’ to clear this bit. Writing a ‘0’ has no effect. If CurrentConnectStatus is cleared when a SetPortReset, SetPortEnable, or SetPortSuspend write occurs, this bit is set to force the driver to re-evaluate the connection status since these writes should not occur if the port is disconnected. 0 = no change in CurrentConnectStatus 1 = change in CurrentConnectStatus Note: If the DeviceRemovable[NDP] bit is set, this bit is set only after a Root Hub reset to inform the system that the device is attached. 18 PSSC 0b RW RW 17 PESC 0b RW RW 16 CSC 15 - 10 reserved (read) LowSpeedDeviceAttached This bit indicates the speed of the device attached to this port. When set, a Low Speed device is attached to this port. When clear, a Full Speed device is attached to this port. This field is valid only when the CurrentConnectStatus is set. 0 = full speed device attached 1 = low speed device attached (write) ClearPortPower The HCD clears the PortPowerStatus bit by writing a ‘1’ to this bit. Writing a ‘0’ has no effect. 09 LSDA Xb RW RW 92/194 SPEAR-07-NC03 6 Blocks description Bit Field name Root Hub Reset Read/Write Description HCD HC (read) PortPowerStatus This bit reflects the port’s power status, regardless of the type of power switching implemented. This bit is cleared if an overcurrent condition is detected. HCD sets this bit by writing SetPortPower or SetGlobalPower. HCD clears this bit by writing ClearPortPower or ClearGlobalPower. Which power control switches are enabled is determined by PowerSwitchingMode and PortPortControlMask[NDP]. In global switching mode (PowerSwitchingMode=0), only Set/ ClearGlobalPower controls this bit. In per-port power switching (PowerSwitchingMode=1), if the PortPowerControlMask[NDP] bit for the port is set, only Set/ClearPortPower commands are enabled. If the mask is not set, only Set/ ClearGlobalPower commands are enabled. When port power is disabled, CurrentConnectStatus, PortEnableStatus, PortSuspendStatus, and PortResetStatus should be reset. 0 = port power is off 1 = port power is on (write) SetPortPower The HCD writes a ‘1’ to set the PortPowerStatus bit. Writing a ‘0’ has no effect. Note: This bit is always reads ‘1b’ if power switching is not supported. 08 PPS 0b RW RW 07 - 05 reserved (read) PortResetStatus When this bit is set by a write to SetPortReset, port reset signaling is asserted. When reset is completed, this bit is cleared when PortResetStatusChange is set. This bit cannot be set if CurrentConnectStatus is cleared. 0 = port reset signal is not active 1 = port reset signal is active (write) SetPortReset The HCD sets the port reset signaling by writing a ‘1’ to this bit. Writing a ‘0’ has no effect. If CurrentConnectStatus is cleared, this write does not set PortResetStatus, but instead sets ConnectStatusChange. This informs the driver that it attempted to reset a disconnected port. 04 PRS 0b RW RW 93/194 6 Blocks description SPEAR-07-NC03 Bit Field name Root Hub Reset Read/Write Description HCD HC (read) PortOverCurrentIndicator This bit is only valid when the Root Hub is configured in such a way that overcurrent conditions are reported on a per-port basis. If perport overcurrent reporting is not supported, this bit is set to 0. If cleared, all power operations are normal for this port. If set, an overcurrent condition exists on this port. This bit always reflects the overcurrent input signal 0 = no overcurrent condition. 1 = overcurrent condition detected. (write) ClearSuspendStatus The HCD writes a ‘1’ to initiate a resume. Writing a ‘0’ has no effect. A resume is initiated only if PortSuspendStatus is set. (read) PortSuspendStatus This bit indicates the port is suspended or in the resume sequence. It is set by a SetSuspendState write and cleared when PortSuspendStatusChange is set at the end of the resume interval. This bit cannot be set if CurrentConnectStatus is cleared. This bit is also cleared when PortResetStatusChange is set at the end of the port reset or when the HC is placed in the USBRESUME state. If an upstream resume is in progress, it should propagate to the HC. 0 = port is not suspended 1 = port is suspended (write) SetPortSuspend The HCD sets the PortSuspendStatus bit by writing a ‘1’ to this bit. Writing a ‘0’ has no effect. If CurrentConnectStatus is cleared, this write does not set PortSuspendStatus; instead it sets ConnectStatusChange. This informs the driver that it attempted to suspend a disconnected port. 03 POCI 0b RW RW 02 PSS 0b RW RW 94/194 SPEAR-07-NC03 6 Blocks description Bit Field name Root Hub Reset Read/Write Description HCD HC (read) PortEnableStatus This bit indicates whether the port is enabled or disabled. The Root Hub may clear this bit when an overcurrent condition, disconnect event, switchedoff power, or operational bus error such as babble is detected. This change also causes PortEnabledStatusChange to be set. HCD sets this bit by writing SetPortEnable and clears it by writing ClearPortEnable. This bit cannot be set when CurrentConnectStatus is cleared. This bit is also set, if not already, at the completion of a port reset when ResetStatusChange is set or port suspend when SuspendStatusChange is set. 0 = port is disabled 1 = port is enabled (write) SetPortEnable The HCD sets PortEnableStatus by writing a ‘1’. Writing a ‘0’ has no effect. If CurrentConnectStatus is cleared, this write does not set PortEnableStatus, but instead sets ConnectStatusChange. This informs the driver that it attempted to enable a disconnected port. (read) CurrentConnectStatus This bit reflects the current state of the downstream port. 0 = no device connected 1 = device connected (write) ClearPortEnable The HCD writes a ‘1’ to this bit to clear the PortEnableStatus bit. Writing a ‘0’ has no effect. The CurrentConnectStatus is not affected by any write. Note: This bit is always read ‘1b’ when the attached device is nonremovable (DeviceRemoveable[NDP]). 01 PES 0b RW RW 00 CCS 0b RW RW The HcRhPortStatus[1:NDP] register is used to control and report port events on a per-port basis. NumberDownstreamPorts represents the number of HcRhPortStatus registers that are implemented in hardware. The lower word is used to reflect the port status, whereas the upper word reflects the status change bits. Some status bits are implemented with special write behavior (see below). If a transaction (token through handshake) is in progress when a write to change port status occurs, the resulting port status change must be postponed until the transaction completes. Reserved bits should always be written '0'. 95/194 6 Blocks description SPEAR-07-NC03 6.4 IEEE1284 Host Controller Figure 9. IEEE1284 Block Diagram Host Interface Configuration Registers IEE1284 Interface Peripheral Interface Protocol Compatibility Byte ECP EPP AMBA Bus Interface AMBA Wrapper & DMA Figure 10. IEEE1284 - DMA Block Diagram AHB Slave I/F AHB Master I/F Decode RX Reg TX Reg CFG Reg Arbiter Ack Request RX APB Bridge TX IO Port 6.4.1 Overview The IEEE1284 is a host-based multi-function parallel port that may be used to transfer data between a host PC and a peripheral such as a printer. It is designed to attach to the PC's ISA bus on one side and to the parallel port connector on the other. The parallel port interface comprises nine control/status lines and an 8-bit bi-directional data bus. It can be configured to operate in five modes, corresponding to the IEEE Standard 1284 parallel interface protocol standards. 96/194 SPEAR-07-NC03 6 Blocks description 6.4.2 Communication modes 6.4.2.1 COMPATIBILITY MODE Compatibility Mode provides an asynchronous, byte wide, forward channel (host-to-peripheral), with the data and status lines used according to original definitions, as per the original Centronics port. 6.4.2.2 NIBBLE MODE Nibble Mode provides an asynchronous, reverse channel (peripheral-to-host) under the control of the host. Data bytes are transmitted as two sequential, four-bit nibbles using four peripheralto-host status lines. When the host and/or peripheral do not support bi-directional use of the data lines, Nibble Mode may be used with Compatibility Mode to implement a bi-directional channel. Note: The two modes cannot be active simultaneously. 6.4.2.3 PS2 OR BYTE MODE Byte Mode provides an asynchronous, byte wide, reverse channel (peripheral-to-host) using the eight data lines of the interface for data and the control/status lines for handshaking. Byte Mode may be used to implement a bi-directional channel, with the transfer direction controlled by the host when both host and peripheral support bi-directional use of the data lines. 6.4.2.4 EPP MODE Enhanced Parallel Port (EPP) Mode provides an asynchronous, byte wide, bi-directional channel controlled by the host device. This mode provides separate address and data cycles over the eight data lines of the interface. 6.4.2.5 ECP MODE Extended Capabilities Port (ECP) Mode provides an asynchronous, byte wide, bi-directional channel. An interlocked handshake replaces the Compatibility Mode's minimum timing requirements. A control line is provided to distinguish between command and data transfers. 97/194 6 Blocks description SPEAR-07-NC03 6.4.3 Matrix of Protocol Signal Names Compatible Signal Names PD[7:0} Select nACK Busy Pe nFault nSelectIn nINIT nSTROBE nAutoFd Nibble Signal Names XFlag PtrClk PtrBusy AckDataReq nDataAvail 1284 Active HostClk HostBusy Byte Signal Names PD[7:0} XFlag PtrClk PtrBusy AckDataReq nDataAvail 1284 Active HostClk HostBusy EPP Signal Names PD[7:0} XFlag Intr nWait AckDataReq nDataAvail nAStrb nINIT nWrite nDStrb ECP Signal Names PD[7:0} XFlag nPeriphClk PeriphAck nAckReverse nPeriphRequest ECPMode nReverseRequest HostClk HostAck SPEAr Net Signal names PD[7:0} SLCT NACK BUSY PE NERR NSLCTIN NINIT NSTROBE NAUTOFD 6.4.4 Register MAP Table 13. IEEE1284 Register Map Register Name DMA_CTRL_STAT DMA_INT_EN DMA_INT_STAT DMA_RX_START DMA_RX_CTRL DMA_RX_ADDR DMA_RX_CADDR DMA_RX_CXFER DMA_RX_TO DMA_RX_FIFO_STS DMA_TX_START DMA_TX_CTRL DMA_TX_ADDR DMA_TX_CADDR DMA_TX_CXFER DMA_TX_TO DMA_TX_FIFO_STS Description DMA Status and control register DMA Interrupt source enable register DMA Interrupt status register DMA RX Start register DMA RX Control register DMA RX Address register DMA RX Current Address register DMA RX Current transfer count register DMA RX FIFO Time out register DMA RX FIFO Status register DMA TX Start register DMA TX Control register DMA TX Address register DMA TX Current Address register DMA TX Current transfer count register DMA TX FIFO Time out register DMA TX FIFO Status register In/Out Data register when used in compatibility and nibble mode In/Out Data register when used in EPP mode Address 0x2200_0000 0x2200_0004 0x2200_0008 0x2200_0010 0x2200_0014 0x2200_0018 0x2200_0020 0x2200_0024 0x2200_0028 0x2200_002c 0x2200_0030 0x2200_0034 0x2200_0038 0x2200_0040 0x2200_0044 0x2200_0048 0x2200_004c 0x2200_0678 (1) IEEE_CMP_DATA IEEE_EPP_DATA 98/194 SPEAR-07-NC03 Table 13. IEEE1284 Register Map Register Name IEEE_ECP_ADDR 0x2200_0679 (1) IEEE_CMP_STAT IEEE_EPP_STAT IEEE_ECP_STAT 0x2200_067A (1) IEEE_CMP_CTRL IEEE_EPP_CTRL IEEE_ECP_CTRL 0x2200_067B 0X2200_067C 0X2200_067D 0X2200_067E 0X2200_067F 0X2200_07F0 0x2200_07F1 IEEE_EPP_ADDRST B IEEE_EPP_DATASTB 1 IEEE_EPP_DATASTB 2 IEEE_EPP_DATASTB 3 IEEE_EPP_DATASTB 4 IEEE_CSR IEEE_CFG_CR1 IEEE_CFG_CR4 IEEE_CFG_CRA 0x2200_0800 (3) IEEE_ECP_FIFO IEEE_ECP_TEST IEEE_ECP_CFGA 0X2200_0801 0X2200_0802 IEEE_ECP_CFGB IEEE_ECP_ECR Address Strobe register in EPP mode Data 1 Strobe register in EPP mode Data 2 Strobe register in EPP mode Data 3 Strobe register in EPP mode Data 4 Strobe register in EPP mode Main Configuration register Configuration register CR1 Configuration register CR4 Configuration register CRA Data FIFO register in ECP mode Test register in ECP mode Configuration register A in ECP mode Configuration register B in ECP mode Extended Control register in ECP mode Control register in all modes Description 6 Blocks description Address Address register when used in ECP mode Status register in all modes 6.4.5 IEEE1284 Configuration The IEEE1284 is configured by a set of three programmable registers accessed through a Configuration Select Register (CSR). These registers will be in default state after power-up and are unaffected by RESET. 99/194 6 Blocks description SPEAR-07-NC03 6.4.5.1 Configuration Procedure The following sequence is required to program the configuration registers: Step Action Method This requires 55h to be written to port 0X2200_07F0 (CSR) twice in succession. Note: It is recommended that interrupts be disabled for the duration of the two writes. If a write to another address or port occurs between the two writes, the IEEE1284 will not enter Configuration Mode. The IEEE1284 contains three configuration registers CR1, CR4 and CRA. These registers are accessed by first writing the number of the desired register to port 0X2200_07F0 (CSR), then writing or reading the selected register through port 0X2200_07F1 Configuration Mode is exited by writing an AAh to port 0x2200_07F0 (CSR). 1 Enter Configuration Mode 2 Configure Registers 3 Exit Configuration Mode 6.4.5.2 Configuration Select Register This Write-Only register can only be accessed when the IEEE1284 is in Configuration Mode. The CSR is located at port 0x2200_07F0 and must be initialized upon entering Configuration Mode before the three configuration registers can be accessed, after which it can be used to select which of the configuration registers is to be accessed at port 0x2200_07F1. 6.4.5.3 Configuration Register CR1 This register can only be accessed when the M1284H is in the Configuration Mode and after CSR has been initialized to 01h. The default value of this register after power-up is 9Fh. The bit definitions are shown below: Bit 7 6 5 4 3 2 Function Parallel Port Mode Not used Not used Not used Not used If 1, sets the Parallel Port for Compatibility Mode (Default). If 0, enables the Extended Parallel Port Mode. (See CR4) Not used These bits are used to select the Parallel Port Address. Bit 1 0 1:0 Parallel Port Address 0 1 1 Bit 0 0 1 0 1 Description Disabled 0x2200_0778 0x2200_07BC 0x2200_0678 (Default) Description 100/194 SPEAR-07-NC03 6 Blocks description 6.4.5.4 Configuration Register CR4 This register can only be accessed when the IEEE1284 is in Configuration Mode and after CSR has been initialized to 04h. The default value of this register after power-up is 00h. The bit definitions are shown below: Bit 7 6 5 4 3 2 1:0 Bit 1 Bit 0 If CR1[3] = 0 then Standard Parallel Port (SPP) operation (Default) (Note 1) EPP Mode (also supports SPP operation) ECP Mode (Note 2) ECP & EPP Modes (Notes 2, 3) Function Reserved Description Must be always written with 0 Not used Not used Not used Not used Not used 0 0 0 1 1 1 0 1 If CR1 (3) = 1, the port is placed in Compatibility Mode. Note: 1 Standard Parallel Port operation denotes the use of the Peripheral data bus in either Compatibility Mode (and/or Nibble Mode) or PS/2 (Byte) Mode. 2 SPP operation may be selected through the ECR register of ECP as mode 000. 3 EPP Mode is selected through the ECR register of ECP as mode 100. 6.4.5.5 Configuration Register CRA This register can only be accessed when the IEEE1284 is in the Configuration Mode and after CSR has been initialized to 0Ah. The default value of this register after power-up is 00h. This register's byte defines the FIFO threshold for the ECP Mode parallel port. 101/194 6 Blocks description SPEAR-07-NC03 6.4.6 DMA Registers All The DMA registers are 32 bit wide. 6.4.6.1 DMA Status and Control Register Address 0x2200_0000 Default value 0x Bit 31 - 28 27 - 26 25 - 24 23 - 20 19 - 18 17 - 16 15 - 08 07 - 04 03 - 02 01 00 Field name TX_FIFO _SIZE TX_IO_DATA_WIDTH TX_CHAN_STATUS RX_FIFO_SIZE RX_IO_DATA_WIDTH RX_CHAN_STATUS REVISION Reserved Reserved LOOPB SRESET Access RO RO RO RO RO RO RO RO RO RW RW TX_FIFOSIZE: Size of transmitter data path FIFO. ● 0001: 2 * 32 BIT WORDS 00: 8-bit 01: Low End TX Channel (No DMA descriptor fetch) 0001: 2 * 32 BIT WORDS 00: 8-bit 01: Low End RX Channel (No DMA descriptor fetch) ???????? TX_IO_DATA_WIDTH: Width of the I/O bus transmit data path ● TX_CHAN_STATUS: provides information about the TX channel structure ● RX_FIFOSIZE: Size of receiver data path FIFO. ● RX_IO_DATA_WIDTH: Width of the I/O bus receive data path ● RX_CHAN_STATUS: provides information about the RX channel structure ● REVISION: Revision of the DMA ● LOOPB: Set to '1' to enable the loop-back mode. When set the RX DMA data are extracted by the TX FIFO and pushed in the RX one. SRESET: DMA soft reset, set to '1' to put the whole DMA logic in reset condition. This signal has no effect on the AHB interface so the whole DMA will be reset only when the last AHB transfer is finished. 102/194 SPEAR-07-NC03 6 Blocks description 6.4.6.2 DMA_INT_EN Address: 0x2200_0004 Default value: 0x0000_0000 Bit 31 30:29 28 27:26 25 24 23 22 21 20 19 18 17 16 15 14:13 12 11:10 09 08 07 06 05 04 03 02 01 00 Field Name Reserved Reserved TX_IO_INT_EN Reserved TX_MERR_INT_EN TX_SERR_INT_EN TX_DONE_EN Reserved TX_IOREQ_EN TX_RTY_EN TX_TO_EN TX_ENTRY_EN TX_FULL_EN TX_EMPTY_EN Reserved Reserved RX_IO_INT_EN Reserved RX_MERR_INT_EN RX_SERR_INT_EN RX_DONE_EN Reserved RX_IORQ_EN RX_RTY_EN RX_TO_EN RX_ENTRY_EN RX_FULL_EN RX_EMPTY_EN Access RO RO The DMA Interrupt enable register allows the various sources of interrupt to be individually enabled. All the enabled sources will then be OR-ed to generate the global DMA interrupt. Setting a bit in DMA_INT_EN register allows the corresponding interrupt described in DMA_INT_STAT to influence the global DMA interrupt. 103/194 6 Blocks description SPEAR-07-NC03 If any bit is set to '1' in both DMA_INT_STAT and DMA_INT_EN then the DMA interrupt will be asserted. Refer to the DMA_INT_STAT for a description of the interrupt sources. 6.4.6.3 DMA Interrupt Sources Status Register Mnemonic: DMA_INT_STAT Address: 0x2200_0008 Default value: 0x0000_0000 Bit 31 30:29 28 27:26 25 24 23 22 21 20 19 18 17 16 15:13 12 11:10 09 08 07 06 05 04 03 02 01 00 Field Name Reserved Reserved TX_IO_INT Reserved TX_MERR_INT TX_SERR_INT TX_DONE Reserved TX_IOREQ TX_RTY TX_TO TX_ENTRY TX_FULL TX_EMPTY Reserved RX_IO_INT Reserved RX_MERR_INT RX_SERR_INT RX_DONE Reserved RX_IOREQ RX_RTY RX_TO RX_ENTRY RX_FULL RX_EMPTY Access RO RO RW RO RW RW RW RO RW RW RW RW RW RW RO RW RO RW RW RW RO RW RW RW RW RW RW 104/194 SPEAR-07-NC03 6 Blocks description Client interrupt status register reports the interrupt status of interrupts from the following sources: DMA_RX, DMA_TX and IO_IP. All the significant register bits are read/Clear (RC): they can be read, a write with '0' has no effect while writing '1' reset the bit value to '0'. Each bit can bi cleared writing '1' (writing '0' will have no effect) TX_IO_INT: Set when the external IO device (IEEE1284 block), connected to the TX DMA port, sets an interrupt request. TX_MERR_INT: Set when AHB master receives an error response from the selected slave and the internal arbiter is granting the TX FIFO. TX_SERR_INT: Set when the AHB slave drives an error on the AHB BUS as response to an TX_FIOFO_PUSH request. This condition is achieved when on of the following conditions is true: i. ii. iii. iv. TX_DMA.START_SERR_EN is true and retry counter expires. Slave access with size > 32 bit. Slave access with a read request. Slave access when the TX_DMA_START.DMA_EN is true (DMA Master Mode) TX_DONE: Set when the TX master DMA completes. TX_IOREQ: Set when the DMA TX is active (master or slave mode) and the IO interface request cannot be served because: i. ii. FIFO is empty Current DMA cycle is finished and the next one is not yet started. TX_RTY: Set when the AHB slave retry counter expires (even if the TX_DMA_START.SERR_EN is false), that means that an AHB TX FIFO write has been attempt, with a wrong byte size attributes, more than allowed by the retry counter. TX_TO: Set when some data are stalled inside the TX FIFO for too long time. TX_ENTRY: Set when the TX DMA is triggered by a number of empty TX FIFO entries bigger than the value set in the DMA_CNTL register. TX_FULL: Set when the TX FIFO becomes full (< 4 byte entries available). TX_EMPTY: Set when the TX FIFO becomes empty. RX_IO_INT: Set when the external IO device (IEEE1284 block), connected to the RX DMA port, sets an interrupt request. RX_MERR_INT: Set when AHB master receives an error response from the selected slave and the internal arbiter is granting the RX FIFO. RX_SERR_INT: Set when the AHB slave drives an error on the AHB BUS as response to a RX_FIFO_POP request. This condition is achieved when on of the following conditions is true: v. RX_DMA.START_SERR_EN is true and retry counter expires. vi. Slave access with size > 32 bit. 105/194 6 Blocks description SPEAR-07-NC03 vii. Slave access with a write request. viii. Slave access when the RX_DMA_START.DMA_EN is true (DMA Master Mode) RX_DONE: Set when the RX master DMA completes. RX_IOREQ: Set when the DMA RX is active (master or slave mode) and the IO interface request cannot be served because: i. ii. iii. FIFO is full Current DMA cycle is finished and the next one is not yet started. There is a Time-out condition (acknowledge is de-asserted for one clock cycle) RX_RTY: Set when the AHB slave retry counter expires (even if the RX_DMA_START.SERR_EN is false), that means that an AHB RX FIFO read has been attempt, with a wrong byte size attributes, more than allowed by the retry counter. RX_ENTRY: Set when the RX DMA is triggered by a number of valid RX FIFO entries bigger than the value set in the DMA_CNTL register. RX_FULL: Set when the RX FIFO becomes full and no more data can be accepted. RX_EMPTY: Set when the RX FIFO becomes empty. 6.4.6.4 RX DMA Start Register Mnemonic: RX_DMA_START Address: 0x2200_0010 Default value: 0x0000_0000 Bit 31:24 23:08 07:04 03 02 01 00 Field Name Reserved Reserved Reserved SERR_EN Reserved IO_EN DMA_EN Access RO RO RO RW RO RW RW SERR_EN: Set to '1' to enable the RX DMA slave logic to respond with an error, instead of retry, when the retry count expires. IO_EN: Set to '1' enable the RX DMA interface, in slave mode (DMA_EN must be '0'), to get data from the IO IP (IEEE1284) and write it into the RX FIFO. DMA_EN: Writing '1' starts the RX DMA master SM running. When all the DMA sequences complete, this bit is reset by the DMA logic. Note: The DMA_EN 0->1 transition or IO_EN 0->1(with DMA_EN = 0) transition resets the FIFO content and the RX interrupts (DMA_INT_STAT(15:0)). 106/194 SPEAR-07-NC03 6 Blocks description Even if DMA_EN has an higher priority with respect IO_EN (when DMA_EN=1, the IO_EN bit is don't care), it's suggested to avoid the set of the two bit at the same time. When the processor wants to start a new master DMA, first it has to fill the descriptor registers (DMA_CNTL, DMA_ADDR and, if required, DMA_NXT) and then it has to enable the DMA (write a '1' in DMA_EN). When all the DMA sequences complete, the DMA SM resets to '0' the DMA_EN bit and waits for this field being enabled again. If the DMA descriptor fetch logic has been enabled, more than one DMA can complete before the DMA_EN bit is reset; in this case it will be set to '0' only after the last DMA ends. 6.4.6.5 RX DMA CNTL Register Mnemonic: RX_DMA_CNTL Address: 0x200_0014 Default value: 0x0000_0000 Bit 31:22 21:17 16 15 14 13 12 11:00 Field Name ADDR_WRAP ENTRY_TRIG Reserved DLY_EN Reserved Reserved CONT_EN DMA_XFERCOUNT Access RW RW RO RW RO RO RW RW ADDR_WRAP: Determines where the DMA address counter wraps by forcing the DMA address counter to retain the data originally written by the host in DMA_ADDR. As soon as the DMA has written the memory location prior to the value specified in ADD_WRAP the wrapping condition occurs. This can be used to restrict the address counter within an address window (e.g. circular buffer). The wrapping point MUST be 32 bit aligned, so the 10 bits of ADDR_WRAP are used to compare DMA address bits 11 to 2; if ADD_WRAP=DMA_ADDR (11:2) then a 4Kbyte buffer is defined. ADDRWRAP is ignored unless WRAP_EN is set. ENTRY_TRIG: Determines the amount of valid entries (in 32 BIT words) required in the receive FIFO before the DMA is re-triggered. If the value is set to 0, as soon as one valid entry is present, the DMA logic starts the data transfer. DLY_EN: This bit enables (when '1') the DMA trigger delay feature: if a FIFO valid data resides in the FIFO more than a programmed period (DMA_TO), a time-out condition occurs that requires the DMA SM to empty the FIFO even if the number of valid words doesn't exceed the threshold value. 107/194 6 Blocks description SPEAR-07-NC03 CONT_EN: Continuous Mode Enable, enables continuous DMA run. If set the DMA runs indefinitely ignoring DMA_ XFERCOUNT. Note: "continuous mode" supersedes "next descriptor mode". DMA_XFERCOUNT: Block size (in bytes) of DMA, maximum 4 Kbytes. Note: The DMA_XFERCOUNT field MUST have a value multiple of the IO DMA bus size, i.e. ● ● ● IO DMA DATA bus 8 bit -> all DMA_XFERCOUNT values are allowed IO DMA DATA bus 16 bit -> DMA_XFERCOUNT(0) MUST be 0 IO DMA DATA bus 32 bit -> DMA_XFERCOUNT(1:0) MUST be 00 If DMA_XFERCOUNT is set to '0', the DMA will transfer 4 Kbyte data. 6.4.6.6 RX DMA ADDR Register Mnemonic: RX_DMA_ADDR Address: 0x2200_0018 Default value: xxxx_xxxx Bit 31:02 01 00 Field Name DMA_ADDR FIX_ADDR WRAP_EN Access RW RW RW DMA_ADDR: Start address, 32 bits WORD ALIGNED, for master DMA transfer. DMA SM will read this register only before starting the DMA operation, so further updates of this register will have no effect on the running DMA. FIX_ADDR: Disables incrementing of DMA_ADDR: this means that all the DMA data transfer operation will be performed at the same AHB address, i.e. the DMA base address. WRAP_EN: Enables wrap of the DMA transfer address to DMA_ADDR when the memory location, specified in ADDR_WRAP, is reached. 6.4.6.7 RX DMA Current Address Register Mnemonic: RX_DMA_CADDR Address: 0x2200_0020 Default: xxxx_xxxx Bit 31:00 Field Name DMA_CADDR Access RW DMA_CADDR: Current DMA address value, byte aligned. The value of this register will change while the DMA is running, reflecting the value driven by the core on the AHB bus. 108/194 SPEAR-07-NC03 6 Blocks description 6.4.6.8 RX DMA Current Transfer Count Register Mnemonic: RX_DMA_CXFER Address: 0x2200_0024 Default value: xxxx_xxxx Bit 31:12 11:00 Field Name Reserved DMA_CXFER Access RO RW DMA_CXFER: Current DMA address value, byte aligned. The value of this register will change while the DMA is running, reflecting the value driven by the core on the AHB bus. 6.4.6.9 RX DMA FIFO Time Out Register Mnemonic: RX_DMA_TO Address: 0x2200_0028 Default value: 0x0000_0000 Bit 31:16 15:00 Field Name Reserved TIME_OUT Access RO RW TIME_OUT: This value is used as initial value for the FIFO entry time out counter in master mode and as initial value for the RETRY counter in slave mode. Register value must be not zero if the feature that use it are activated. The time-out counter starts as soon as one valid entry is present in the FIFO and is reset every time a FIFO data is pop out of the FIFO. The counter expires (FIFO time out condition) if no FIFO data are pop for a period longer than the TIME_OUT register value; when this happens, depending on the control registers settings, an interrupt can be set or the FIFO can be flushed. Retry counter is incremented after each AHB slave RETRY response and is cleared after OKAY or ERROR response. 109/194 6 Blocks description SPEAR-07-NC03 6.4.6.10 RX DMA FIFO Status Register Mnemonic: RX_DMA_FIFO Address: 0x2200_002C Default value: 0x????_???? Bit 31:30 29:24 23:21 20:16 15:13 12:08 07:04 03 02 01 00 Field Name Reserved ENTRIES Reserved DMA_POINTER Reserved IO_POINTER Reserved DELAY_T ENTRY_T FULL EMPTY Access RO RO RO RO RO RO RO RO RO RO RO ENTRIES: Full entries (in 32 bits words) in FIFO. DMA_POINTER: FIFO DMA SM side pointer value. IO_POINTER: FIFO IO side pointer value. DELAY_T: Set to '1' when DMA FIFO delay time out is expired. ENTRY_T: Set to '1' when the DMA FIFO entry trigger threshold has been reached. FULL: Set to '1' when the DMA FIFO is full. EMPTY: Set to '1' when the DMA FIFO is empty 6.4.6.11 DMA Start register Mnemonic: TX_DMA_START Address: 0x2200_0030 Default value: 0x0000_0000 Bit 31:04 03 02 01 00 Field Name Reserved SERR_EN Reserved IO_EN DMA_EN Access RO RW RO RW RW SERR_EN: Set to '1' to enable the TX DMA slave logic to respond with an error instead of retry when the retry counter is expired. 110/194 SPEAR-07-NC03 6 Blocks description IO_EN: Set to '1' to enable the TX DMA interface, in slave mode (DMA_EN must be set to '0'), to get data from the TX FIFO, as soon as they are valid, and pass them to the IO IP (IEEE1284) block, on its request. DMA_EN: The TX DMA master SM starts when this bit is set to '1'. When all the DMA sequences are completed, this bit is reset to '0' by the DMA logic itself. Note: The DMA_EN 0->1 transition or IO_EN 0->1(with DMA_EN = 0) transition resets the FIFO content and the TX interrupts (DMA_INT_STAT(15:0)). Even if DMA_EN has an higher priority with respect IO_EN (when DMA_EN=1, the IO_EN bit is don't care), it's suggested to avoid the set of the two bit at the same time. When the processor wants to start a new master DMA, first it has to fill the descriptor registers (DMA_CNTL, DMA_ADDR and, if required, DMA_NXT) and then it has to enable the DMA (write a '1' in DMA_EN). When all the DMA sequences complete, the DMA SM resets to '0' the DMA_EN bit and waits for this field being enabled again. f the DMA descriptor fetch logic has been enabled, more than one DMA can complete before the DMA_EN bit is reset; in this case it will be set to '0' only after the last DMA ends. 6.4.6.12 TX DMA Control Register Mnemonic: TX_DMA_CNTL Address: 0x2200_0034 Default value: 0x0000_0000 Bit 31:22 21:17 16 15 14:13 12 11:00 Field Name ADDR_WRAP ENTRY_TRIG Reserved DLY_EN Reserved CONT_EN DMA_XFERCOUNT Access RW RW RO RW RO RW RW ADDR_WRAP: Determines where the DMA address counter wraps by forcing the DMA address counter to retain the data originally written by the host in DMA_ADDR. As soon as the DMA has read the memory location prior to the value specified in ADD_WRAP the wrapping condition occurs. This can be used to restrict the address counter within an address window (e.g. circular buffer). The wrapping point MUST be 32 bit aligned, so the 10 bits of ADDR_WRAP are used to compare DMA address bits 11 to 2; if ADD_WRAP=DMA_ADDR(11:2) then a 4Kbyte buffer is defined. ADDRWRAP is ignored unless WRAP_EN is set. ENTRY_TRIG: Determines the amount of empty entries (in 32 BIT words) required in the TX FIFO before the DMA is re-triggered. 111/194 6 Blocks description SPEAR-07-NC03 If the value is set to 0, as soon as one empty entry is present, the DMA logic starts the data request. DLY_EN: This bit enables (when '1') the DMA trigger delay feature: if a FIFO valid data resides in the FIFO more than a programmed period (DMA_TO), a time-out condition occurs and the related (TX_TO) interrupt will be set. CONT_EN: Continuous Mode Enable, enables continuous DMA run. If set the DMA runs indefinitely ignoring DMA_ XFERCOUNT. Note: "continuous mode" supersedes "next descriptor mode". DMA_XFERCOUNT: Block size (in bytes) of DMA, maximum 4 Kbytes. Note: The DMA_XFERCOUNT field MUST have a value multiple of the IO DMA bus size, i.e. ● ● ● IO DMA DATA bus 8 bit -> all DMA_XFERCOUNT values are allowed IO DMA DATA bus 16 bit -> DMA_XFERCOUNT(0) MUST be 0 IO DMA DATA bus 32 bit -> DMA_XFERCOUNT(1:0) MUST be 00 If DMA_XFERCOUNT is set to '0', the DMA will transfer 4 Kbytes data. 6.4.6.13 TX DMA Address Register Mnemonic: TX_DMA_ADDR Address: 0x2200_0038 Default value: xxxx_xxxx Bit 31:02 01 00 Field Name DMA_ADDR FIX_ADDR WRAP_EN Access RW RW RW DMA_ADDR: Start address, 32 bit WORD ALIGNED, for master DMA transfer. The DMA SM reads this register only before starting the DMA operation, so further updates of this register will have no effect on the running DMA. While the DMA is in progress, a read operation to this register will return the DMA current address value. FIX_ADDR: Disables incrementing of DMA_ADDR: this means that all the DMA data transfer operation will be performed at the same AHB address, i.e. the DMA base address. WRAP_EN: Enables wrap of the DMA transfer address to DMA_ADDR when the memory location, specified in ADDR_WRAP, is reached. 112/194 SPEAR-07-NC03 6 Blocks description 6.4.6.14 TX DMA Current Address Register Mnemonic: TX_DMA_CADDR Address: 0x2200_0040 Default value: xxxx_xxxx Bit 31:00 Field Name DMA_CADDR Access RO DMA_CADDR: Current DMA address value, byte aligned. The value of this register will change while the DMA is running, reflecting the value driven by the core on the AHB bus. 6.4.6.15 TX DMA Current Transfer Register Mnemonic: TX_DMA_CXFER Address: 0x2200_0044 Default value: xxxx_xxxx Bit 31:12 11:00 Field Name Reserved DMA_CXFER Access RO RO DMA_CXFER: Current DMA transfer counter value. It's updated while the DMA is running. 6.4.6.16 TX DMA FIFO Time Out Register Mnemonic: TX_DMA_TO Address: 0x2200_0048 Default value: 0x0000_0000 Bit 31:16 15:00 Field Name Reserved TIME_OUT Access RO RW TIME_OUT: This value is used as initial value for the FIFO entry time out counter in master mode and as initial value for the RETRY counter in slave mode. Register value must be not zero if the features that use it are activated. This counter starts as soon as one valid entry is present in the FIFO and is reset every time a FIFO data is pop out of the FIFO. The counter expires (FIFO time out condition) if no FIFO data are pop for a period longer than the TIME_OUT register value; when this happens, depending on the control registers settings, an interrupt can be set. Retry counter is incremented after each AHB slave RETRY response and is cleared after OKAY or ERROR response. 113/194 6 Blocks description SPEAR-07-NC03 6.4.6.17 TX DMA FIFO Status Register Mnemonic: TX_DMA_FIFO Address: 0x2200_004C Default value: 0x????_???? Bit 31:30 29:24 23:21 20:16 15:13 12:08 07:04 03 02 01 00 Field Name Reserved ENTRIES Reserved DMA_POINTER Reserved IO_POINTER Reserved DELAY_T ENTRY_T FULL EMPTY Access RO RO RO RO RO RO RO RO RO RO RO ENTRIES: Free entries (in 32 bits word) in FIFO. DMA_POINTER: FIFO DMA SM side pointer value. IO_POINTER: FIFO IO side pointer value. DELAY_T: Set to '1' when the DMA FIFO delay time out is expired. ENTRY_T: Set to '1' when the DMA FIFO entry trigger threshold has been reached. FULL: Set to '1' when DMA FIFO is full. EMPTY: Set to '1' when the DMA FIFO is empty. 6.4.7 Parallel Port register This section is split into three sub-sections: Compatibility and Byte Modes; EPP Mode; and ECP mode. Each register set description gives the I/O address assignments and a description of the relevant registers and its bits. It is worth noting that the STAT and CTRL registers (described under Compatibility and Byte Modes) are common to all modes. The base address for the parallel port is determined at power-up. This can be changed by software as described in Section All registers are accessed as byte quantities. Some of the registers described contain reserved bits. These will have a hard value associated with them, defined in the register description: this value will not change even if these bits are written to. A read from a register that contains reserved bits will return the hard values associated with those bits. 114/194 SPEAR-07-NC03 6 Blocks description 6.4.7.1 Compatibility and Byte modes The port consists of three registers and can be programmed to operate at three different base addresses - 0x2200_0678, 0x2200_0378 and 0x2200_03BC. The write locations are: i. Write data to output port (DATA) - Base Address + 0h ii. Write command to output port (CTRL)- Base Address + 2h The read locations are: iii. Read peripheral data (DATA) - Base Address + 0h iv. Read peripheral status data (STAT) - Base Address + 1h v. Read back control register (CTRL) - Base Address + 2h STAT Register (RO) This Read-Only register has a port address of Base Address + 01h. The bit definitions are shown below: Bit D7 D6 D5 D4 D3 D2 D1 D0 Name NBUSY NACK PE SLCT NERR Comment If asserted, indicates that the peripheral is busy. If asserted, indicates that the peripheral has received a data byte and is ready for another. If asserted, indicates that the peripheral is out of paper. If asserted, indicates that the peripheral is selected. If asserted, indicates that the peripheral has a fault. Reserved Always returns 0. Reserved Always returns 0. TIMEOUT Asserted high when timeout occurs (only in EPP mode). Note: Note: You may only read from the STAT register: writes to it have no effect. CTRL Register (RW) This Read/Write register has a port address of Base Address + 02h. The bit definitions are shown below: Bit D7 D6 D5 D4 D3 D2 D1 D0 Name Reserved Always returns 0. Reserved Always returns 0. PDIR INTEN SLCTIN NINIT AUTOFD Direction bit. (Read/Write only in EPP and ECP Modes.) If asserted, allows the peripheral to interrupt the CPU. If asserted, it means the host has selected the peripheral. If asserted, the peripheral is initialized. This tells the printer to advance the paper by one line each time a carriage return is received. Comment STROBE If asserted, this instructs the peripheral to accept the data on the data bus 115/194 6 Blocks description SPEAR-07-NC03 Note: SLCTIN, AUTOFD and STROBE are inverted when read back from the CTRL register. In PS/2 (Byte) Mode, bit 5 is used to control the direction of the data transfer on the parallel port data bus. Also in Byte Mode, when PDIR = 0 (forward direction), PDOUT[7:0] is enabled; when PDIR = 1 (reverse direction), PDIN[7:0] is enabled. At reset, CTRL is set to 00h. 6.4.7.2 EPP Mode The following table shows the I/O assignments for the registers used in EPP Mode: Parallel Port Register Address Base Address + 0h 1h 2h 3h 4h – 7h DATA STAT CTRL ADDSTR DATASTR Data Register Status Register Control Register Address Strobe Register Data Strobe Registers RW RO RW RW RW Abbreviation Register Name Access The DATA, STAT and CTRL registers are as described above for the Compatibility and Byte Modes. The ADDSTR register provides a peripheral address to the peripheral via PDOUT[7:0] during a host write, and to the host via PDIN[7:0] during a host address read operation. An automatic address strobe is generated on the parallel port interface when data is read or written to this register. The DATASTR registers provide data from the host to the peripheral via PDOUT[7:0] during a write operation, and data from the peripheral to the host during a read operation. An automatic data strobe is generated on the parallel port interface when data is read or written to these registers. If no EPP Read, Write or Address cycle is currently being executed, the Peripheral data bus may be used in either Compatibility Mode (and/or Nibble Mode) or PS/2 (Byte) Mode. In this condition, all output signals (NSTROBE, NAUTOFD and NINIT) are set by the CTRL register and direction is controlled by the PDIR bit of the CTRL register. Before an EPP cycle is executed, the control register PDIR bit must be set to 0 (by writing 04h or 05h to the CTRL register). If PDIR is left set to 1, the IEEE1284 will not be able to perform a write and will appear instead to perform an EPP read on the parallel bus without any error being indicated. If an EPP bus cycle does not terminate within 10ms, the EPP timeout flag will be set and all following EPP bus cycles will be aborted until this flag is cleared writing to the STAT register. 116/194 SPEAR-07-NC03 6 Blocks description 6.4.7.3 ECP Mode This section describes the registers used in ECP Mode. It is worth noting that the Extended Control Register ECR (which can only be entered from ECP Mode) allows various modes of operation. In particular, ECR[7:5] = 000 selects Compatibility Mode and ECR[7:5] = 001 selects Byte Mode. These have been discussed above. The I/O assignments in ECP mode are shown below: Port Address Abbreviation Base Address + 0h 1h 2h 400h 400h 400h 400h 401h 402h ECPAFIFO STAT CTRL SDFIFO ECPDFIFO TFIFO CFGA CFGB ECR ECP Address Register Status Register Control Register Standard Parallel Port Data FIFO ECP Data FIFO Test FIFO ECP Configuration A Register ECP Configuration B Register Extended Control Register 011 All All 010 011 110 111 111 All RW R RW RW RW RW RW RW RW Register Name ECR[7:5] Access The functions of the above registers are detailed in the 'Extended Capabilities Port Protocol and ISA Interface Standard Rev 1.12', which is available from Microsoft. The bit map of the Extended Parallel Port Registers is shown below: D7 Data ECPAFIFO STAT CTRL SDFIFO ECPDFIFO TFIFO CFGA CFGB ECR 0 0 0 PINTR1 MODE 0 0 1 0 INTERR PD7 1 NBUSY 0 NACK 0 PE PDIR SLCT INTEN D6 PD6 D5 PD5 D4 PD4 D3 PD3 Address NERR SLCTIN 0 NINT 0 FD 0 STROBE D2 PD2 D1 PD1 D0 PD0 Note 1 2 1 1 2 2 2 0 0 DMAEN 0 0 SERVINT 0 0 FIFOF 0 0 FIFOE Parallel Port Data FIFO ECP Data FIFO Test FIFO Note: 1 These Registers are available in all modes. 2 All FIFOs use one common 16 byte FIFO. 117/194 6 Blocks description SPEAR-07-NC03 ECP Address FIFO Register (ECPAFIFO) The ECPAFIFO register provides a channel address to the peripheral depending on the state of bit 7. This I/O address location is only used in ECP Mode (ECR bits [7:5]=011). In this mode, bytes written to this register are placed in the parallel port FIFO and transmitted via PDOUT[7:0] using the ECP protocol. Bit 7 should always be set to 1. Bits [7:0] ECP Address The register contents is passed to the peripheral by PDOUT[7:0]. The peripheral should interpret bits [6:0] as a channel address. Note: that the SPEAr Net asserts NAUTOFD to indicate that information on the PD[7:0] is an ECP address. The SPEAr Net negates NAUTOFD when PD[7:0] is transferring data. Status Register (STAT) Already discussed in Section 5.4.5.1.1. Control register (CTRL) Already discussed in Section 5.4.5.1.2. Standard Parallel Port Data FIFO Register (SDFIFO) SDFIFO is used to transfer data from the host to the peripheral when the ECR register is set for compatible FIFO mode (Bits [7:5] = 010). Data bytes written or DMAed from the system to this FIFO are transmitted by a hardware handshake to the peripheral using the standard Compatibility protocol. For this register, bytes are placed in the parallel port FIFO using DATAIN[7:0] and transmitted via PDOUT[7:0]. Note: that bit 5 in the CTRL register must be set to 0 for forward transfer. ECP Data FIFO Register (ECPDFIFO) ECPDFIFO is used to transfer data from the host to the peripheral when the ECR register is set for ECP mode (Bits [7:5] = 011). Data bytes written or DMAed from the system to this FIFO are transmitted by a hardware handshake to the peripheral using the ECP protocol. Note: that bit 5 in the CTRL register must be set to 0 for forward transfer or to 1 for a reverse transfer. Test FIFO Register (TFIFO) The Test FIFO provides a test mechanism for the ECP Mode FIFO by allowing data to be read, written or DMAed in either direction between the system and this FIFO. This Test Mode is selected by setting ECR[7:5] = 110. The data is transferred purely through the microprocessor interface and is therefore transferred at the maximum ISA rate. It may appear on the parallel port data lines, but without any hardware handshake. The Test FIFO does not stall when overwritten or under-run. Data is simply ignored or re-read. The full and empty bits of the ECR register (bits 1 and 0) can however be used to ascertain the correct state of the FIFO. ECP Configuration Register A (CFGA) The CFGA register provides information about the ECP Mode implementation. It is a Read Only register. Access to this register is enabled by programming the ECR register (ECR[7:5] = 111). The bit definitions in this register are shown below: 118/194 SPEAR-07-NC03 0b00010000 6 Blocks description At reset CFGA is set to 10h. 10h indicates an 8-bit implementation. ECP Configuration Register B (CFGB) The CFGB register checks the PINTR1 line to determine possible conflicts. It is a Read Only register. The bit definitions are shown below: Bit D7 D6 D5 D4 D3 D2 D1 D0 Name PINTR1 Always return 0 Returns the value of the PINTR1 line Always return 0 Always return 0 Always return 0 Always return 0 Always return 0 Always return 0 Description Extended Control Register (ECR) This Read/Write register selects ECP mode, enables service and error interrupts and provides interrupt status. The ECR also enables and disables DMA operations and provides FIFO empty and FIFO full status. The bit definitions are shown below: Bit D7 D6 D5 D4 D3 D2 D1 D0 Name MODE3 MODE2 MODE1 INTERR DMAEN SERVINT FIFOF FIFOE Mode bit. Mode bit. Mode bit. Error interrupt enable. DMA enable. Service interrupt. This bit is set when the FIFO is full. This bit is set when the FIFO is empty. Description Bits [7:5] - ECP Mode Select This field selects one of the following modes: Mode 000 This puts the parallel port into Compatibility Mode and resets the pointers to the FIFO (but not its contents). Setting the direction bit in the CTRL register does not affect the parallel port interface in this mode. For register descriptions in this mode, refer to Section 4.1 ‘Functional Pin Groups’ on page 13. This puts the parallel port into Byte Mode and resets the pointers to the FIFO (but not its contents). The outcome is similar to above except that the direction bit selects forward or reverse transfers. Mode 001 119/194 6 Blocks description SPEAR-07-NC03 This puts the parallel port into ISA Compatible FIFO mode, which is the same as mode 000 except that PWords are written or DMAed to the FIFO. FIFO data is automatically transmitted using the standard parallel port protocol. Note, this mode should only be used when PDIR = 0. This puts the port into ECP Mode. In the forward direction, bytes written to the ECPDFIFO and ECPAFIFO locations are placed in the ECP FIFO and transmitted automatically to the peripheral using ECP protocol. In the reverse direction, bytes are transferred from PDIN [7:0] to the ECP FIFO. Reserved. Reserved. This selects an ECP Test Mode in which the FIFO is read and written purely through the microprocessor interface. This is places the interface into Configuration Mode. In this mode, the CFGA and CFGB registers are accessible at base address + 400h and at base address + 401h, respectively. Mode 010 Mode 011 Mode 100 Mode 101 Mode 110 Mode 111 Bit [4] - INTERR When 0, this bit enables error interrupts to the host when a high to low transition occurs on the NERR signal. Bit [3] - DMAEN DMA is enabled when DMAEN = 1, and disabled when DMAEN =0. Bit [2] - Service Interrupt (SERVINT) If SERVINT = '1', DMA is disabled and all service interrupts are disabled. SERVINT = '0' enables one of three interrupts: i. ii. If DMAEN = '1' during DMA, the SERVINT bit will be set to a 1 when terminal count is reached. If DMAEN = '0' and PDIR = 0, the SERVINT bit will be set to '1' whenever there are 'WriteIntrThreshold' or more bytes free in the FIFO (see Section 4.3.6.1). iii. If DMAEN = '0' and PDIR = 1, the SERVINT bit will be set to '1' whenever there are 'ReadIntrThreshold' or more valid bytes to be read from the FIFO (see Section 4.3.6.2). Bit [1] - FIFO Full Status (FIFOF) This bit indicates when the FIFO is full. Bit [0] - FIFO Empty Status (FIFOE) This bit indicates when the FIFO is empty. 120/194 SPEAR-07-NC03 6 Blocks description 6.5 UART Controller Figure 11. UART Block Diagram AMBA AHB APB Interface REGISTER ARRAY BAUD RATE GENERATOR RXCLK Receiver Shift Register TXCLK LOCAL FIFO Transmitter Shift Register 6.5.1 Overview The UART provides a standard serial data communication with transmit and receive channels that can operate concurrently to handle a full-duplex operation. Two internal FIFO for transmitted and received data, deep 16 and wide 8 bits, are present; these FIFO can be enabled or disabled through a register. Interrupts are provided to control reception and transmission of serial data. The clock for both transmit and receive channels is provided by an internal baud rate generator that divides the AHB System clock by any divisor value from 1 to 255. The output clock frequency of baud generator is sixteen times the baud rate value. The maximum speed achieved is 115.000 baud. 121/194 6 Blocks description SPEAR-07-NC03 6.5.2 Registers Map Address 0x3000_1800 0x3000_1804 0x3000_1808 0x3000_180C 0x3000_1810 0x3000_1814 0x3000_1818 0x3000_181C 0x3000_1820 0x3000_1824 Register Name UART_BAUD_RATE UART_TX_BUFFER UART_RX_BUFFER UART_CONTROL UART_INT_ENABLE UART_STATUS UART_GUARD_TIME UART_TIME_OUT UART_TX_RESET UART_RX_RESET Access RW WO RO RW RW RO RW RW WO WO 6.5.3 Register description All the UART registers are 16 bit wide. 6.5.3.1 Baud Rate Generator Register Mnemonic: UART_BAUD_RATE Address: 0x3000_1800 Default value: 0x0001 Bit 15:00 Field Name BAUD_RATE Access RW BAUDE_RATE - This register select the UART baud rate according to the following formula: HCLK Frequency (48MHZ) / (UART_BAUD_RATE * 16) Baud 110 150 300 600 1200 2400 4800 9600 19200 38400 115200 Reg. value 0x6A88 0x4E20 0x2710 0x1388 0x09C4 0x04E2 0x01A0 0x0138 0x009C 0x004e 0x001A Error 0.003% 0 0 0 0 0 0 0.16% 0.16% 0.16% 0.16% UART TX Buffer Register 122/194 SPEAR-07-NC03 6 Blocks description 6.5.3.2 Mnemonic: UART_TX_BUFFER Address: 0x3000_1804 Default value: 0x0000 Bit 15:09 08:00 Field Name Reserved TX_DATA Access RO WO TX_DATA - Values written to this register will fill the 16 word tx FIFO. When the FIFO is disabled values written to this register will directly fill the transmitter shift register. 6.5.3.3 UART RX Buffer Register Mnemonic: UART_RX_BUFFER Address: 0x3000_1808 Default value: 0x0000 Bit 15:10 09:00 Field Name Reserved RX_DATA Access RO RO RX_DATA - Values read to this register will un-fill the 16 word RX FIFO. When the FIFO is disabled value read to this register will directly empty the RX shift register. 6.5.3.4 UART Control Register Mnemonic: UART_CONTROL Address: 0x3000_180C Default value: 0x0000 Bit 15:11 10 09 08 07 06 05 04:03 02:00 Field Name Reserved FIFO_EN Reserved RX_EN RUN LOOP_EN PARITY STOP_BIT MODE Access RO RW RW RW RW RW RW RW RW FIFO_EN - When set to '1' enable the FIFO. Reserved - This bit should be always set to '0'. RX_EN - When set enable the RX channel. 123/194 6 Blocks description SPEAR-07-NC03 RUN - When set to '1' enable the Bud Rate Generator. Note: If this bit is reset both TX and RX channels are inactive. LOOP_EN - When set to '1' enable the internal loop and the external TX and RX lines become inactive. PARITY - Parity selection bit. '1' means "odd" parity (parity bit set on even number of '1's in data) STOP_BIT - Select the number of stop bit added. b4 0 0 1 1 b3 0 1 0 1 0.5 Stop Bit 1 Stop Bit 1.5 Stop Bit 2 Stop Bit Stop Bit MODE - Mode Control Field b2 0 0 0 0 1 1 1 1 b1 0 0 1 1 0 0 1 1 b0 0 1 0 1 0 1 0 1 Reserved 8 bit Data Reserved 7 bit Data + parity 9 bit Data 8 bit Data + Wake Up Reserved 8 Bit Data + parity Mode 6.5.3.5 UART Interrupt Enable Register Mnemonic: UART_INT_EN Address: 0x3000_1810 Default value: 0x0000 Bit 15:09 08 07 06 05 04 03 02 01 00 Field Name Reserved RX_HALF_FULL TIME_OUT_IDLE TIME_OUT_NOT_EMPTY OVERRUN_ERROR FRAME_ERROR PARITY_ERROR TX_HALT_EMPTY TX_BUFFER_EMPTY RX_BUFFER_FULL Access RO RW RW RW RW RW RW RW RW RW 124/194 SPEAR-07-NC03 6 Blocks description Each bit, when set to '1' will enable the corresponding interrupt while, when reset to '0' will mask it. 6.5.3.6 UART Status Register Mnemonic: UART_STATUS Address: 0x3000_1814 Default value: 0x0006 Bit 15:10 09 08 07 06 05 04 03 02 01 00 Field Name Reserved TX_FULL RX_HALF_FULL TIME_OUT_IDLE TIME_OUT_NOT_EMPTY OVERRUN_ERROR FRAME_ERROR PARITY_ERROR TX_HALT_EMPTY TX_BUFFER_EMPTY RX_BUFFER_FULL Access RO RO RO RO RO RO RO RO RO RO RO 6.5.3.7 UART Guard Time Register Mnemonic: UART_GUARD_TIME Address: 0x3000_1818 Default value: 0x0000 Bit 15:08 07:00 Field Name Reserved GUARD_TIME Access RO RW GUARD_TIME - This register define the delay, in term of bit time from the last character transmitted and the assertion of TX_BUFFER_EMPTY. 6.5.3.8 UART Time Out Register Mnemonic: UART_TIME_OUT Address: 0x3000_181C Default value: 0x0000 Bit 15:08 07:00 Field Name Reserved TIME_OUT Access RO RW 125/194 6 Blocks description SPEAR-07-NC03 TIME_OUT - This register set the time out value in term of bit time between two consecutive characters received. 6.5.3.9 UART TX Reset Register Mnemonic: UART_TX_RESET Address: 0x3000_1820 Default value: NA Any value written to this address will reset the TX FIFO. This register is WO. 6.5.3.10 UART RX Reset Register Mnemonic: UART_TX_RESET Address: 0x3000_1824 Default value: NA Any value written to this address will reset the RX FIFO. This register is WO. 6.6 I2C Controller Figure 12. I2C Controller Block Diagram SCL Control I2C BUS APB BUS APB Interface Register Array SDA Control 6.6.1 Overview The controller serves as an interface between the ARM720 and the serial I2C bus. It provides multi-master functions, and controls all I2C bus-specific sequencing, protocol, arbitration and timing. It supports fast I2C mode (400 KHz). Main Features: ● ● ● ● ● ● ● Parallel-bus/I2C protocol converter Multi-master capability 7-bit Addressing Transmitter/Receiver flag End-of-byte transmission flag Transfer problem detection Clock generation 126/194 SPEAR-07-NC03 ● ● ● ● ● ● 6 Blocks description I2C bus busy flag Arbitration Lost Flag End of byte transmission flag Transmitter/Receiver Flag Start bit detection flag Start and Stop generation In addition to receiving and transmitting data, this interface converts it from serial to parallel format and vice versa, using either an interrupt or polled handshake. The interrupts can be enabled or disabled by software. The interface is connected to the I2C bus by a data pin (SDAI) and by a clock pin (SCLI). It can be connected both with a standard I2C bus and a Fast I2C bus. This selection is made by software. Mode Selection The interface can operate in the four following modes: – Slave transmitter/receiver – Master transmitter/receiver By default, it operates in slave mode. The interface automatically switches from slave to master after it generates a START condition and from master to slave in case of arbitration loss or a STOP generation, this allows MultiMaster capability. Communication Flow In Master mode, it initiates a data transfer and generates the clock signal. A serial data transfer always begins with a start condition and ends with a stop condition. Both start and stop conditions are generated in master mode by software. The first byte following the start condition is the address byte; it is always transmitted in Master mode. A 9th clock pulse follows the 8 clock cycles of a byte transfer, during which the receiver must send an acknowledge bit to the transmitter. Figure 13. I2C Bus Protocol Acknowledge may be enabled and disabled by software. The I2C interface address and/or general call address can be selected by software. The speed of the I2C interface may be selected between Standard (0 - 100 KHz) and Fast I2C (100 - 400 KHz). 127/194 6 Blocks description SPEAR-07-NC03 SDA/SCL Line Control Transmitter mode: the interface holds the clock line low before transmission to wait for the microcontroller to write the byte in the Data Register. Receiver mode: the interface holds the clock line low after reception to wait for the microcontroller to read the byte in the Data Register. The SCL frequency (FSCL) is controlled by a programmable clock divider which depends on the I2C bus mode. When the I2C cell is enabled, the SDA and SCL ports must be configured as floating open-drain output or floating input. In this case, the value of the external pull-up resistance used depends on the application. 6.6.2 Register Map Address 0x3000_1560 0x3000_1564 0x3000_1568 0x3000_156C 0x3000_1570 0x3000_1574 0x3000_1578 CR SR1 SR2 CCR OAR Reserved DR Register Name Access RW RW RW RW RW RO RW 6.6.3 Register Description All the registers are 8 bit wide and aligned at 32 bit. 6.6.3.1 Control Register Mnemonic: CR Address: 0x3000_1560 Default value: 0x00 Bit 07:06 05 04 03 02 01 00 Field Name Reserved PE ENGC START ACK STOP ITE Access RO RW RW RW RW RW RW PE: Peripheral enable. This bit is set and cleared by software. 128/194 SPEAR-07-NC03 0: Peripheral disabled 1: Master/Slave capability Notes: 6 Blocks description – – – When PE=0, all the bits of the CR register and the SR register except the Stop bit are reset. All outputs are released while PE=0 When PE=1, the corresponding I/O pins are selected by hardware as alternate functions. To enable the I2C interface, write the CR register TWICE with PE=1 as the first write only activates the interface (only PE is set). ENGC: Enable general call. This bit is set and cleared by software. It is also cleared by hardware when the interface is disabled (PE=0). The 00h General Call address is acknowledged (01h ignored). 0: General Call disabled 1: General Call enabled START: Generation of a Start condition. This bit is set and cleared by software. It is also cleared by hardware when the interface is disabled (PE=0) or when the Start condition is sent (with interrupt generation if ITE=1). – In master mode: 0: No start generation – 1: Repeated start generation In slave mode: 0: No start generation 1: Start generation when the bus is free ACK: Acknowledge enable. This bit is set and cleared by software. It is also cleared by hardware when the interface is disabled (PE=0). 0: No acknowledge returned. 1: Acknowledge returned after an address byte or a data byte is received. STOP: Generation of a stop condition. This bit is set and cleared by software. It is also cleared by hardware in master mode. Note: This bit is not cleared when the interface is disabled (PE=0). – In master mode: 0: No stop generation. 1: Stop generation after the current byte transfer or after the current Start condition is sent. The STOP bit is cleared by hardware when the Stop condition is sent. In slave mode: 0: No stop generation. 1: Release the SCL and SDA lines after the current byte transfer (BTF=1). In this mode the STOP bit has to be cleared by software. – 129/194 6 Blocks description SPEAR-07-NC03 ITE: Interrupt enable. This bit is set and cleared by software and cleared by hardware when the interface is disabled (PE=0). 0: Interrupts disabled 1: Interrupts enabled 6.6.3.2 Status Register 1 Mnemonic: SR1 Address: 0x3000_1564 Default value: 0x00 Bit 07 06 05 04 03 02 01 00 Field Name EVF Reserved TRA BUSY BTF ADSL M/SL SB Access RO RO RO RO RO RO RO RO EVF: Event flag. This bit is set by hardware as soon as an event occurs. It is cleared by software reading SR2 register in case of error event. It is also cleared by hardware when the interface is disabled (PE=0). 0: No event 1: One of the following events has occurred: – BTF=1 (Byte received or transmitted) – ADSL=1 (Address matched in Slave mode while ACK=1) – SB=1 (Start condition generated in Master mode) – AF=1 (No acknowledge received after byte transmission) – STOPF=1 (Stop condition detected in Slave mode) – ARLO=1 (Arbitration lost in Master mode) – BERR=1 (Bus error, misplaced Start or Stop condition detected) – Address byte successfully transmitted in master mode. TRA: Transmitter / Receiver When BTF is set, TRA=1 if a data byte has been transmitted. It is cleared automatically when BTF is cleared. It is also cleared by hardware after detection of Stop condition (STOPF=1), loss of bus arbitration (ARLO=1) or when the interface is disabled (PE=0). 130/194 SPEAR-07-NC03 0: Data byte received (if BTF=1) 1: Data byte transmitted BUSY: Bus busy. 6 Blocks description This bit is set by hardware on detection of a Start condition and cleared by hardware on detection of a Stop condition. It indicates a communication in progress on the bus. This information is still updated when the interface is disabled (PE=0). 0: No communication on the bus 1: Communication ongoing on the bus BTF: Byte transfer finished. This bit is set by hardware as soon as a byte is correctly received or transmitted with interrupt generation if ITE=1. It is cleared by software reading SR1 register followed by a read or write of DR register. It is also cleared by hardware when the interface is disabled (PE=0). – Following a byte transmission, this bit is set after reception of the acknowledge clock pulse. In case an address byte is sent, this bit is set only after the EV6 event. BTF is cleared by reading SR1 register followed by writing the next byte in DR register. – Following a byte reception, this bit is set after transmission of the acknowledge clock pulse if ACK=1. BTF is cleared by reading SR1 register followed by reading the byte from DR register. The SCL line is held low while BTF=1. 0: Byte transfer not done 1: Byte transfer succeeded ADSL: Address matched (Slave mode) This bit is set by hardware as soon as the received slave address matched with the OAR register content or a general call is recognized. An interrupt is generated if ITE=1. It is cleared by software reading SR1 register or by hardware when the interface is disabled (PE=0). The SCL line is held low while ADSL=1. 0: Address mismatched or not received 1: Received address matched M/SL: Master/Slave. This bit is set by hardware as soon as the interface is in Master mode (writing START=1). It is cleared by hardware after detecting a Stop condition on the bus or a loss of arbitration (ARLO=1). It is also cleared when the interface is disabled (PE=0). 0: Slave mode 1: Master mode SB: Start bit (Master mode). This bit is set by hardware as soon as the Start condition is generated (following a write START=1). An interrupt is generated if ITE=1. It is cleared by software reading SR1 register followed by writing the address byte in DR register. It is also cleared by hardware when the interface is disabled (PE=0). 0: No Start condition 1: Start condition generated 131/194 6 Blocks description SPEAR-07-NC03 6.6.3.3 Status Register 2 Mnemonic: SR2 Address: 0x3000_1568 Default value: 0x00 Bit 07:05 04 03 02 01 00 Field Name Reserved AF STOPF ARLO BERR GCAL Access RO RO RO RO RO RO AF: Acknowledge failure. This bit is set by hardware when no acknowledge is returned. An interrupt is generated if ITE=1. It is cleared by software reading SR2 register or by hardware when the interface is disabled (PE=0). The SCL line is not held low while AF=1. 0: No acknowledge failure 1: Acknowledge failure STOPF: Stop detection (slave mode). This bit is set by hardware when a Stop condition is detected on the bus after an acknowledge (if ACK=1). An interrupt is generated if ITE=1. It is cleared by software reading SR2 register or by hardware when the interface is disabled (PE=0). The SCL line is not held low while STOPF=1. 0: No Stop condition detected 1: Stop condition detected ARLO: Arbitration lost. This bit is set by hardware when the interface loses the arbitration of the bus to another master. An interrupt is generated if ITE=1. It is cleared by software reading SR2 register or by hardware when the interface is disabled (PE=0). After an ARLO event the interface switches back automatically to Slave mode (M/SL=0). The SCL line is not held low while ARLO=1. 0: No arbitration lost detected 1: Arbitration lost detected BERR: Bus error. This bit is set by hardware when the interface detects a misplaced Start or Stop condition. An interrupt is generated if ITE=1. It is cleared by software reading SR2 register or by hardware when the interface is disabled (PE=0). The SCL line is not held low while BERR=1. 0: No misplaced Start or Stop condition 1: Misplaced Start or Stop condition 132/194 SPEAR-07-NC03 GCAL: General Call (Slave mode). 6 Blocks description This bit is set by hardware when a general call address is detected on the bus while ENGC=1. It is cleared by hardware detecting a Stop condition (STOPF=1) or when the interface is disabled (PE=0). 0: No general call address detected on bus 1: general call address detected on bus 6.6.3.4 Clock Control Register Mnemonic: CCR Address: 0x3000_156C Default value: 0x00 Bit 07 06:00 Field Name SM/FM CC Access RW RW SM/FM: Fast/Standard I2C mode. This bit is set and cleared by software. It is not cleared when the interface is disabled (PE=0). 0: Standard I2C mode 1: Fast I2C mode CC(6:0): 7-bit clock divider. These bits select the speed of the bus (FSCL) depending on the I2C mode. They are not cleared when the interface is disabled (PE=0). Standard mode (FM/SM=0): FSCL 100kHz FSCL = fCPU/(3x([CC6..CC0]+2)) Note: The programmed FSCL assumes no load on SCL and SDA lines. 133/194 6 Blocks description SPEAR-07-NC03 6.6.3.5 Own Address Register Mnemonic: OAR Address: 0x3000_1570 Default value: 0x00 Bit 07:01 00 Field Name ADD DIR Access RW RW ADD(7:1): Interface address. These bits define the I2C bus address of the interface. They are not cleared when the interface is disabled (PE=0). DIR: Address direction bit. This bit is don't care, the interface acknowledges either 0 or 1. It is not cleared when the interface is disabled (PE=0). Note: Address 01h is always ignored. 6.6.3.6 Data Register. Mnemonic: DR Address: 0x3000_1578 Default value: 0x00 Bit 07:00 Field Name D Access RW D(7:0): 8 bit data register. These bits contain the byte received or to be transmitted on the bus. Transmitter mode: Byte transmission start automatically when the software writes in the DR register. Receiver mode: the first data byte is received automatically in the DR register using the least significant bit of the address. Then, the next data bytes are received one by one after reading the DR register. 6.6.4 I2C Functional description By default the I2C interface operates in Slave mode (M/SL bit is cleared) except when it initiates a transmit or receive sequence. 6.6.4.1 Slave Mode As soon as a start condition is detected, the address is received from the SDA line and sent to the shift register; then it is compared with the address of the interface or the General Call address (if selected by software). Address not matched: the interface ignores it and waits for another Start condition. 134/194 SPEAR-07-NC03 Address matched: the interface generates in sequence: – Acknowledge pulse if the ACK bit is set. – EVF and ADSL bits are set with an interrupt if the ITE bit is set. 6 Blocks description Then the interface waits for a read of the SR1 register, holding the SCL line low (see Figure 8 Transfer sequencing EV1). Next, read the DR register to determine from the least significant bit if the slave must enter Receiver or Transmitter mode. Slave Receiver Following the address reception and after SR1 register has been read, the slave receives bytes from the SDA line into the DR register via the internal shift register. After each byte the interface generates in sequence: – Acknowledge pulse if the ACK bit is set – EVF and BTF bits are set with an interrupt if the ITE bit is set. Then the interface waits for a read of the SR1 register followed by a read of the DR register, holding the SCL line low (see Figure 8) Transfer sequencing EV2). Slave Transmitter Following the address reception and after SR1 register has been read, the slave sends bytes from the DR register to the SDA line via the internal shift register. The slave waits for a read of the SR1 register followed by a write in the DR register, holding the SCL line low (see Figure 8 Transfer sequencing EV3). When the acknowledge pulse is received: – The EVF and BTF bits are set by hardware with an interrupt if the ITE bit is set. Closing slave communication After the last data byte is transferred a Stop Condition is generated by the master. The interface detects this condition and sets: – EVF and STOPF bits with an interrupt if the ITE bit is set. Then the interface waits for a read of the SR2 register (see Figure 3 Transfer sequencing EV4). Error Cases – BERR: Detection of a Stop or a Start condition during a byte transfer. In this case, the EVF and the BERR bits are set with an interrupt if the ITE bit is set. If it is a Stop then the interface discards the data, released the lines and waits for another Start condition. If it is a Start then the interface discards the data and waits for the next slave address on the bus. – AF: Detection of a non-acknowledge bit. In this case, the EVF and AF bits are set with an interrupt if the ITE bit is set. Note: In both cases, SCL line is not held low; however, SDA line can remain low due to possible "0" bits transmitted last. It is then necessary to release both lines by software. How to release the SDA / SCL lines Set and subsequently clear the STOP bit while BTF is set. The SDA/SCL lines are released after the transfer of the current byte. 135/194 6 Blocks description SPEAR-07-NC03 6.6.4.2 Master Mode To switch from default Slave mode to Master mode a Start condition generation is needed. Start condition and Transmit Slave address Setting the START bit while the BUSY bit is cleared causes the interface to switch to Master mode (M/SL bit set) and generates a Start condition. Once the Start condition is sent: – The EVF and SB bits are set by hardware with an interrupt if the ITE bit is set. Then the master waits for a read of the SR1 register followed by a write in the DR register with the Slave address byte, holding the SCL line low (see Figure 8 Transfer sequencing EV5). Then the slave address byte is sent to the SDA line via the internal shift register. After completion of this transfers (and acknowledge from the slave if the ACK bit is set): – The EVF bit is set by hardware with interrupt generation if the ITE bit is set. Then the master waits for a read of the SR1 register followed by a write in the CR register (for example set PE bit), holding the SCL line low (see Figure 8 Transfer sequencing EV6). Next the master must enter Receiver or Transmitter mode. Master Receiver Following the address transmission and after SR1 and CR registers have been accessed, the master receives bytes from the SDA line into the DR register via the internal shift register. After each byte the interface generates in sequence: – Acknowledge pulse if if the ACK bit is set – EVF and BTF bits are set by hardware with an interrupt if the ITE bit is set. Then the interface waits for a read of the SR1 register followed by a read of the DR register, holding the SCL line low (see Figure 8 Transfer sequencing EV7). To close the communication: before reading the last byte from the DR register, set the STOP bit to generate the Stop condition. The interface goes automatically back to slave mode (M/SL bit cleared). Note: In order to generate the non-acknowledge pulse after the last received data byte, the ACK bit must be cleared just before reading the second last data byte. Master Transmitter Following the address transmission and after SR1 register has been read, the master sends bytes from the DR register to the SDA line via the internal shift register. The master waits for a read of the SR1 register followed by a write in the DR register, holding the SCL line low (see Figure 8 Transfer sequencing EV8). When the acknowledge bit is received, the interface sets: – EVF and BTF bits with an interrupt if the ITE bit is set. To close the communication: after writing the last byte to the DR register, set the STOP bit to generate the Stop condition. The interface goes automatically back to slave mode (M/SL bit cleared). 136/194 SPEAR-07-NC03 Error Cases 6 Blocks description – – – BERR: Detection of a Stop or a Start condition during a byte transfer. In this case, the EVF and BERR bits are set by hardware with an interrupt if ITE is set. AF: Detection of a non-acknowledge bit. In this case, the EVF and AF bits are set by hardware with an interrupt if the ITE bit is set. To resume, set the START or STOP bit. ARLO: Detection of an arbitration lost condition. In this case the ARLO bit is set by hardware (with an interrupt if the ITE bit is set and the interface goes automatically back to slave mode (the M/SL bit is cleared). Note: In all these cases, the SCL line is not held low; however, the SDA line can remain low due to possible "0" bits transmitted last. It is then necessary to release both lines by software. Figure 14. Transfer sequencing Legend: S=Start, P=Stop, A=Acknowledge, NA=Non-acknowledge EVx=Event (with interrupt if ITE=1) EV1: EVF=1, ADSL=1, cleared by reading SR1 register. EV2: EVF=1, BTF=1, cleared by reading SR1 register followed by reading DR register. EV3: EVF=1, BTF=1, cleared by reading SR1 register followed by writing DR register. EV3-1: EVF=1, AF=1, BTF=1; AF is cleared by reading SR1 register. BTF is cleared by releasing the ines (STOP=1, STOP=0) or by writing DR register (DR=FFh). Note: If lines are released by STOP=1, STOP=0, the subsequent EV4 is not seen. EV4: EVF=1, STOPF=1, cleared by reading SR2 register. EV5: EVF=1, SB=1, cleared by reading SR1 register followed by writing DR register. EV6: EVF=1, cleared by reading SR1 register followed by writing CR register (for example PE=1). EV7: EVF=1, BTF=1, cleared by reading SR1 register followed by reading DR register. EV8: EVF=1, BTF=1, cleared by reading SR1 register followed by writing DR register. 137/194 6 Blocks description SPEAR-07-NC03 6.7 Dynamic Memory Controller Figure 15. SDRAM Controller Block Diagram APB bus APB Slave Interface and Registers Refresh Timer Memory Driver Control AHB bus Static Memory Controller AHB Slave Interface Data Multiplexer Address External Bus Interface Data 6.7.1 Overview The DRAM Controller block is an AHB slave used to provide an interface between the system bus and external memory device. The controller supports four external banks, containing either SDRAM or EDO memories. Memory components with 32, 16 and 8 bit data buses are supported. 6.7.2 Memory Access The DRAM Controller supports single and burst accesses for both memory types. A single state machine and shared control signals are used for a memory access. 6.7.2.1 SDRAM Access SDRAM accesses are performed with the pre-charge command at the end of each access, i.e. banks are not kept open, as shown in Figure 16. Figure 16. SDRAM Access Example CLK RAS CAS WE CS ADDR DATA State Idle Setup Wait Access Access Access Pre Pre Idle Row Col0 Col1 Col15 138/194 SPEAR-07-NC03 6 Blocks description Initially the row address is output and the MISA (RAS) and MICS outputs are asserted. During the Access state the column address is output on the address bus and the MIAA (CAS) output is asserted. When the memory access has completed the MIAA and MIWE outputs are asserted to pre-charge the accessed SDRAM bank. The SDRAM data accesses are not performed as a single burst. In each access cycle a new read/write command is issued to the SDRAM device, causing the column address to reload. To support this mode of operation, the SDRAM device must be configured to have a burst length of one. Using a number of individual accesses allows the same location to be accessed in a number of consecutive access cycles e.g. during a byte burst access to a word wide memory bank. A SDRAM access is not permitted to cross a 512 byte boundary (the minimum supported SDRAM row size) without passing through the SETUP cycle to update the SDRAM row address. After the last access cycle of every transfer, the pre-charge command must be issued to the SDRAM. A feature of SDRAM read accesses is that there is some latency between the read access being initiated and the data being returned by the device. The data latency from the read command to the first valid data must be configured by the user. The memory interface is compatible with the Intel "PC SDRAM Specification" and only uses commands defined in that specification. 6.7.2.2 EDO Access An EDO access is shown in Figure 17. Figure 17. EDO Access Example CLK RAS CAS WE/OE ADDR DATA State Idle Address setup Setup Wait Wait Access Access wait Access Access wait Idle Row Col0 Col1 Col15 To support EDO accesses an ADDRESS SETUP cycle has been added to provide a cycle of setup between the Row address output becoming valid and the RAS signal being activated. Also added is an ACCESS WAIT cycle, after each ACCESS cycle. The MICS output is used as the EDO RAS signal. The DRAM Controller must capture read data on the clock following the read access. The user must configure the single cycle data latency. 139/194 6 Blocks description SPEAR-07-NC03 6.7.3 Table 14. Memory Data Width Address Mapping Table DRAM Address Bus Address Column Address Width Column Memory Interface Output Address Bits 13 12 11 10 ba ba ba 9 Row 10 Column 8 X 22 21 20 19 18 17 16 15 14 13 12 11 10 0 10 9 8 7 6 5 4 3 2 1 9 AHB bus address ba ba ba 0 9 9 8 8 7 7 6 6 5 5 4 4 3 3 2 2 1 1 0 0 9 8 bits 22 21 20 19 18 17 16 15 14 13 12 11 10 22 21 20 19 18 17 16 15 14 13 12 11 10 X x 16 bits Row 9 10 Column 8 32 bits Row 9 10 x x x x 22 21 20 19 18 17 16 15 14 13 12 11 x 22 21 20 19 18 17 16 15 14 13 12 22 21 20 19 18 17 16 15 14 13 12 11 10 x 22 21 20 19 18 17 16 15 14 13 12 11 0 11 10 9 8 7 6 5 4 3 2 ba ba ba x 22 21 20 19 18 17 16 15 14 13 12 11 10 6.7.4 External Bus Interface The External Bus Interface is used to share the address and data pads (pins) between the DRAM Controller and the Static Memory Controller. The handshaking between the EBI and the memory controller consists of a two-wire interface, BusReq and BusGnt, both signals are active high. BusReq is asserted by the memory controller indicating that it requires access to the bus to perform a transfer. When the EBI sees a BusReq it responds with a BusGnt active when the bus is available and can be granted to the memory controller. The EBI will wait for the currently granted memory controller to finish the access (i.e. to deassert BusReq) before it grants the next memory controller. Therefore the memory controller must keep the BusReq signal asserted as long as it requires the memory bus. The arbitration uses a fixed priority scheme. 140/194 SPEAR-07-NC03 6 Blocks description 6.7.5 Register MAP Address 0x3000_2800 0x3000_2804 0x3000_2808 0x3000_280C 0x3000_2810 0x3000_2814 0x3000_2818 0x3000_281C 0x3000_2820 0x3000_2824 0x3000_2828 0x3000_282C 0x3000_2830 0x3000_2834 0x3000_2838 0x3000_283C 0x3000_2840 Register Name MB1Config MB2Config MB3Config MB4Config SDRAM1ConfigLo SDRAM1ConfigHi SDRAM2ConfigLo SDRAM2ConfigHi SDRAM3ConfigLo SDRAM3ConfigHi SDRAM4ConfigLo SDRAM4ConfigHi MemConfig Bank 1 Size Bank 2 Size Bank 3 Size Bank 4 Size Access R/W R/W R/W R/W RO RO RO RO RO RO RO RO R/W R/W R/W R/W R/W 6.7.6 Register Description All the registers are 16 bit wide. 6.7.6.1 Memory Bank Configuration Register Mnemonic: MB1Config, MB2Config, MB3Config, MB4Config Address: 0x3000_2800, 0x3000_2804, 0x3000_2808, 0x3000_280C Default value: 0x0000 Bit 15:12 11:10 09:08 07:05 04:02 01:00 Field Name Reserved DEV_WID DATA_LAT SETUP_TIME IDLE_TIME SDRAM_COL Access RO RW RW RW RW RW DEV_WID - Define the data width of the external memory device: 00 01 10 11 Byte (8 bit) Half Word (16 bit) Word (32 bit) Reserved 141/194 6 Blocks description SPEAR-07-NC03 DATA_LAT - Defines the number of memory clock cycles between the start of a memory read access and the first valid data. The DATALAT value is valid between 0 and 3. SETUP_TIME - Defines the number of memory clock cycles the memory drivers spends in the DECODE state before accessing the external memory. The SETUPTIME value is valid between 0 and 7. IDLE_TIME - Defines the minimum time the memory driver must spend in the IDLE state following memory accesses. The value defines the number of Memory Clock cycles. The IDLETIME value is valid between 0 and 7. SDRAM_COL - Specifies the width of the SDRAM column address: 00 01 10 11 8 bits 9 bits 10 bits Reserved 6.7.6.2 SDRAM Configuration Registers These registers are write only. A write access to the high registers will start the SDRAM configuration cycle, during which the value written to the register will be asserted on the memory bus for a one clock period. After the power-up the CPU must configure each SDRAM device, i.e. perform prechargerefresh-mode register set procedure as specified in the SDRAM device data sheet. Mnemonic: SDRAM1ConfigLo, SDRAM2ConfigLo, SDRAM3ConfigLo, SDRAM4ConfigLo, Address: 0x3000_2810, 0x3000_2818, 0x3000_2820, 0x3000_2828 Default value: 0x0000 Bit 15:14 13:00 Field Name Reserved MIAB Access RO WO Mnemonic: SDRAM1ConfigHi, SDRAM2ConfigHi, SDRAM3ConfigHi, SDRAM4ConfigHi Address: 0x3000_2814, 0x3000_281C, 0x3000_2824, 0x3000_282C Default value: 0x0000 Bit 15:03 02 01 02 Field Name Reserved MIWE MIAA MISA Access RO WO WO WO 142/194 SPEAR-07-NC03 MIAB - Memory Interface Address Bus MIWE - Memory Interface Write Enable MIAA - Memory Interface Access Active (nCAS) MISA - Memory Interface Setup Active (nRAS) 6 Blocks description 6.7.6.3 Memory Configuration Register Mnemonic: MEM_CONFIG Address: 0x3000_2830 Default value: 0x0000 Bit 15:14 13 12 11 10 09 08 07:00 Field Name Reserved PWR_SAVE TYPE B3EN B2EN B1EN B0EN REFR Access RO RW RW RW RW RW RW RW PWR_SAVE - When set to '1', the following refresh cycle will put the memory in "Self Refresh" mode. The memory will exit the Self-refresh mode when this bit is reset to '0'. Type - Define the memory type connected. 1 - SDRAM 0 - EDO Note: The four banks must be populated with the same type of memory. BxEN - The bank enable bits are used to enable each bank separately. If an AHB transfer is accessing a disabled bank, the DRAM Controller will return the error response to the AHB master. 1 - Enable 0 - Disable REFR - This value is used to determine the refresh period. The period can be set in the 1 us steps. REFR 00000000 00000001 00000010 … 11111111 Refresh period is 255us Refresh Period Refresh is disabled Refresh period is 1us Refresh period is 2us 143/194 6 Blocks description SPEAR-07-NC03 6.7.6.4 Bank Size Registers Mnemonic: Bank Size 0, Bank Size 1, Bank Size 2, Bank Size 3 Address: 0x3000_2834, 0x3000_2838, ox3000_283C, 0x3000_2840 Default value: 0x0000 There are four registers of 16 bits each that specify, for each bank, its size. The size is defined parametrically as 2 STEP_SIZE in our case 64Kbytes steps, but it could be larger by increasing STEP_SIZE in the Dram Package, also smaller step size are possible however STEP_SIZE can not be smaller than 10. For 64Kbytes size the Bank[3:0]Size registers have the organization below: Table 15. 15 Unused Memory Bank Size Register 98 Size 0 Where (Size+1) represents the size of the bank in 64Kbytes steps, that is: Table 16. Bank size field and its corresponding actual size Size field (binary) 0_0000_0000 0_0000_0001 0_0000_0010 ... 0_0000_1111 ... 0_0001_1111 ... 0_0011_1111 ... 0_0111_1111 ... 0_1111_1111 ... 1_1111_1111 Bank actual size 1 x 64Kbytes = 64Kbytes 2 x 64Kbytes = 128Kbytes 3 x 64Kbytes = 192Kbytes ... 16 x 64Kbytes = 1Mbytes ... 32 x 64Kbytes = 2Mbytes ... 64 x 64Kbytes = 4Mbytes ... 128 x 64Kbytes = 8Mbytes ... 256 x 64Kbytes = 16Mbytes ... 512 x 64Kbytes = 32Mbytes 144/194 SPEAR-07-NC03 6 Blocks description 6.8 6.8.1 Static Memory Controller SRAMC description The block is designed to control the data flow from the internal AMBA (Advanced Microcontroller Bus Architecture) AHB (Advanced High-Performance Bus) bus to any static memory components (ROM, SRAM and FLASH). Length, setup and hold timings required to properly transfer data to external memory components are controllable by programming of internal registers, dedicated to each external memory space as is the external bus width. Each internal register also contains a flag bit which informs the controller if a particular memory space is accessible or not. SRAMC receives the HSEL from The AHB decoder. The block contains 4 registers which are used to control 4 external regions: ● 2 (Region 0 and 1) with programmable contiguous size for static memory ● 2 (Region 2 and 3) for External I/O with fixed size 6.8.2 Registers Map and description Address 0x3000_2400 0x3000_2404 0x3000_2408 0x3000_240C Register Name REG0 REG1 REG2 REG3 Access R/W R/W R/W R/W All the registers are 16 bit wide. 6.8.2.1 Region 0 Control Register Mnemonic: REG0 Address: 0x3000_2400 Default value: 0b000_0000_0011_11xx Bit 15:08 07:06 05 04:02 01:00 Field Name SIZE Reserved ENABLE LENGTH SIZE Access RW RO RW RW R0 SIZE - Define the region size in steps of 64 Kb: 0x00 = 64 Kb 0x01 = 128 Kb ----0FF = 16 Mb 145/194 6 Blocks description SPEAR-07-NC03 ENABLE - This bit, when set to '1' and the CPU access this region, an external cycle is performed with the proper length as defined in the next field. If the CPU access the region when the ENABLE bit is reset the external cycle is not performed and an Error is sent to the CPU. LENGTH - This field define the strobe pulse width in term of clock cycle. SIZE - This field define the data bus size to be used for this region. 00 = 8 bit 01 = 16 bit 10 = 32 bit 11 = Reserved This field latch its contents during the rising edge of nRESET through two external address line (See configuration register for more detail). 6.8.2.2 Region 1 Control Register Mnemonic: REG1 Address: 0x3000_2404 Default value: 0x001D The fields are exactly the same of the previous register. The unique difference is that in this register also the SIZE field is programmable by CPU. Note: when B_SIZE differs from "00" then the external address bus shift right by1 bit: eadd[31:0]