FX3 Programmers Manual Doc. # 001-64707 Rev. *C Cypress Semiconductor 198 Champion Court San Jose, CA 95134-1709 Phone (USA): 800.858.1810 Phone (Intnl): 408.943.2600 http://www.cypress.com Copyrights Copyrights © Cypress Semiconductor Corporation, 2011-2012. The information contained herein is subject to change without notice. Cypress Semiconductor Corporation assumes no responsibility for the use of any circuitry other than circuitry embodied in a Cypress product. Nor does it convey or imply any license under patent or other rights. Cypress products are not warranted nor intended to be used for medical, life support, life saving, critical control or safety applications, unless pursuant to an express written agreement with Cypress. Furthermore, Cypress does not authorize its products for use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress products in life-support systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges. Any Source Code (software and/or firmware) is owned by Cypress Semiconductor Corporation (Cypress) and is protected by and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty provisions. Cypress hereby grants to licensee a personal, non-exclusive, non-transferable license to copy, use, modify, create derivative works of, and compile the Cypress Source Code and derivative works for the sole purpose of creating custom soft- ware and or firmware in support of licensee product to be used only in conjunction with a Cypress integrated circuit as speci- fied in the applicable agreement. Any reproduction, modification, translation, compilation, or representation of this Source Code except as specified above is prohibited without the express written permission of Cypress. Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATE- RIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes without further notice to the materials described herein. Cypress does not assume any liability arising out of the application or use of any product or circuit described herein. Cypress does not authorize its products for use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress’ product in a life-support sys- tems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges. Use may be limited by and subject to the applicable Cypress software license agreement. All trademarks or registered trademarks referenced herein are property of the respective corporations. 2 FX3 Programmers Manual, Doc. # 001-64707 Rev. *C Contents 1. Introduction 9 1.1 Chapter Overview ......................................................................................................10 1.2 Document Revision History ......................................................................................10 1.3 Documentation Conventions .....................................................................................11 2. Introduction to USB 13 2.1 USB 2.0 System Basics.............................................................................................13 2.1.1 Host, Devices, and Hubs................................................................................13 2.1.2 Signaling Rates ..............................................................................................13 2.1.3 Layers of Communication Flow......................................................................13 2.1.4 Device Detection and Enumeration................................................................17 2.1.5 Power Distribution and Management .............................................................18 2.1.6 Device Classes ..............................................................................................18 2.2 USB 3.0: Differences and Enhancements over USB 2.0...........................................18 2.2.1 USB 3.0 Motivation ........................................................................................18 2.2.2 Protocol Layer ................................................................................................19 2.2.3 Link Layer.......................................................................................................21 2.2.4 Physical Layer................................................................................................21 2.2.5 Power Management .......................................................................................22 2.3 Reference Documents ...............................................................................................22 3. FX3 Overview 23 3.1 CPU ...........................................................................................................................23 3.2 Interconnect Fabric ....................................................................................................24 3.3 Memory......................................................................................................................25 3.4 Interrupts....................................................................................................................26 3.5 JTAG Debugger Interface..........................................................................................27 3.6 Peripherals.................................................................................................................28 3.6.1 I2S..................................................................................................................28 3.6.2 I2C..................................................................................................................30 3.6.3 UART .............................................................................................................31 3.6.4 SPI .................................................................................................................32 3.6.5 GPIO/Pins ......................................................................................................33 3.6.6 GPIF...............................................................................................................38 3.7 DMA Mechanism .......................................................................................................39 3.8 Memory Map and Registers.......................................................................................42 3.9 Reset, Booting, and Renum.......................................................................................43 3.10 Clocking .....................................................................................................................44 3.11 Power.........................................................................................................................46 3.11.1 Power Domains..............................................................................................46 3.11.2 Power Management .......................................................................................46 FX3 Programmers Manual, Doc. # 001-64707 Rev. *C 3 Contents 4. FX3 Software 49 4.1 System Overview.......................................................................................................49 4.2 FX3 Software Development Kit (SDK).......................................................................50 4.3 FX3 Firmware Stack ..................................................................................................50 4.3.1 Firmware Framework.....................................................................................50 4.3.2 Firmware API Library .....................................................................................50 4.3.3 FX3 Firmware Examples................................................................................51 4.4 FX3 Host Software ....................................................................................................51 4.4.1 Cypress Generic USB 3.0 Driver ...................................................................51 4.4.2 Convenience APIs .........................................................................................51 4.4.3 USB Control Center .......................................................................................51 4.4.4 Bulkloop .........................................................................................................51 4.4.5 Streamer ........................................................................................................51 4.5 FX3 Development Tools ............................................................................................52 4.5.1 Firmware Development Environment.............................................................52 4.5.2 GPIF II Designer ............................................................................................52 5. FX3 Firmware 53 5.1 Initialization................................................................................................................53 5.1.1 Device Boot ...................................................................................................55 5.1.2 FX3 Memory Organization.............................................................................55