Home

CYUSB3KIT-003 SUPERSPEED EXPLORER KIT USER GUIDE

1. S CYPRESS PERFORM A 7 seng ce m eg Se a ee S So N A CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A Cypress Semiconductor 198 Champion Court San Jose CA 95134 1709 Phone USA 800 858 1810 Phone Intnl 1 408 943 2600 http www cypress com e 7i CYPRESS Copyrights Cypress Semiconductor Corporation 2014 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 fo
2. 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 Flash Code Protection Cypress products meet the specifications contained in their particular Cypress PSoC Datasheets Cypress believes that its family of PSoC products is one of the most secure families of its kind on the market today regardless of how they are used There may be methods unknown to Cypress that can breach the code protection features Any of these methods to our knowledge would be dishonest and possibly illegal Neither Cypress nor any other semiconductor manufacturer can guaran tee the security of their code Code protection does not mean that we are guaranteeing the product as unbreakable Cypress is willing to work with the customer who is concerned about the integrity of their code Code protection is constantly evolving We at Cypress are committed to continuously improving the code protection features of our products CYUSBS3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 2 Safety Information Regulatory Compliance ccceccceceseeeeeeeseeeeeseeeeeeeeees General Safety Instructions seeuussss ESD brotechon AE Handling Boards ccccseeceeceseeeeeeseeeeeeeeeeeeeeeas 1 Introduction Tel FU COMME E LiT SOWANG RET 1 1 2 Tools Not Iocuded 1 1 3
3. CYPRESS PERFORM Kit Operation The firmware launch status is shown in the bottom right corner of the EZ USB Suite debug per spective After the firmware is launched completely a second window opens with the message No source available for as shown in Figure 3 27 Figure 3 27 Launching Debug Session Complete l cyfibulksresink c t 23 Ho source available for View Disassembly 2 Console 3 Tasks LC Problems LA Executables D Memory USBBulkScurceSinkLED Debug Zylin Embedded debug Native C AProgram Files xt Transfer rate 7 KB sec 478 bytes write Warning the current language does not match this fraen Warning the current language does not match this frame 187 done edb 168 stack list argusents B 8B las8 done stack argss framez levels a argss gdb 109 stack list locals 6 1605 done localss edb 6 Ignore this message and click Resume The debug point stops at main as shown in Figure 3 28 Figure 3 28 Debugger SE at Main Lor T m 0 a Bu 4 7 E yr erg T3 35 Debug Debug i ED e Variables 2 Da Breakpeunts MI Regecbers B Modules Ste Fe ke Oe 7 oo A C Preqram Files t ypres E USB Fx3 uet fm arm nagre eabi gdp eze 02 061 DRESS A Name Value DTI 4 a D USBSerial CpencCD Program kn DN Chaer RER Li vi C frparanm Files II Cypres CYUSAIRTT O0 8 upse Dam OC Kune etum bin stakes 4 Ze USBBEulk amp nurreSankl ED Debug Zim Embedded debug
4. This firmware supports reading and writing to the onboard SRAM The LED blinking activity is maintained in this firmware as well You can find the firmware source SRAM FX3 in the Firmware folder of the SuperSpeed Explorer Kit installation Be sure to import this project into the EZ USB Suite and build the firmware image if not already done The firmware will be copied to the EZ USB Suite Workspace folder and a newly built firmware image will be available in the same path To test the functionality of this firmware follow these steps 1 Disconnect the development board from the computer if it is already connected 2 Insert the J5 jumper to enable SRAM CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 30 SES cypress PERFORM Kit Operation 3 Make sure that the J2 jumper is inserted so that 3 3 V is provided to the SRAM interface The SRAM works only at 3 3 V 4 Insert the J4 jumper to boot from USB 5 Connect the development board to your computer using the USB 3 0 cable 6 Open the USB Control Center application and load the newly built firmware image SRAM_FX3 img from the project folder in the workspace to FX3 RAM as described in Section 3 5 2 on page 26 7 FX3 re enumerates as Cypress FX3 Example device 1 Wait for the drivers to be installed automatically If the drivers are not installed automatically follow the steps listed in Section A 1 1 on page 52 to install the drivers manually 8
5. Cypress Product FX3 SeralNumber Configurations 1 MaxPacketSize 512 VendorlD 04 B4 Product D 0 F1 Qlass 00h SubClass 00h Protacol 00h NumberOf DeviceCapability 2h Descriptor Type 15 DescriptorLength 5 TotalLength 22 lt USB20 Device Extension Descriptorl ength 7 Descriptor l ypez 16 DeviceCapability Type 2 bmAttribute D n z USB20 Device Extension SUPERSPEED USB DescriptorLength 10 Descriptor Type 16 DeviceCapability Type 3 Functionality Supporte 3 bm Attribute 00h U1 Device Exit Latency 10 U2Device Exit Latencyz 7FFh SUPERSPEED USB Programming Succeeded Another USB Control Center option is to conduct USB transfers to and from the FX3 board The example firmware booted from the EEPROM contains code to respond to a custom USB request type called a vendor request To exercise this option select the Control endpoint 0x00 item in the device tree and click the Data Transfers tab as shown in Figure 3 6 Then select Vendor from the Req type USB request type drop down list The example firmware responds to a vendor request code of OxAA which you enter in the Req code box Your panel values should look similar to those in Figure 3 6 Enter a number between 0 and 9 in the Data to send Hex box and click the CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 25 SESJ Cypress PERFORM Kit Operation Transfer Data but
6. Default Cp1252 9 Default Team Other Cp1252 Other Usage Data Collector Open referenced projects when a project is opened Always Never Prompt Canc 2 6 4 Building the Project To build an FX3 project select the project in the Project Explorer window and click the Build icon hammer in the EZ USB Suite You can choose to build a Debug version or a Release version of the firmware Figure 2 13 The generated image file in the Release version is smaller than in the Debug version See Section 3 5 2 on page 26 and Section 3 5 3 on page 28 to learn how to download the compiled code image into the SuperSpeed Explorer Kit development board Figure 2 13 Build Firmware Icon MICC Cypress EZ JSB Suite File Edit Source Refactor Navigate Search Run Project CYTools Window Help D iy i vie i ey Gy Fi 97 7 Br Hr 0 Al Fal 1 Debug e e 3 Release a LS USBBulkSourceSinkLED d Binaries gt iii Includes gt Ga Debug gt Ga Release p 8 cyfx gcc startup S p E eyfxbulkdscr c t L eyfxbulksrcsink c p h eyfxbulksrcsink h p e cyfxtx c La makefile readme tet Note You can go to www cypress com go GettingStartedwithEzUsbSuite for a video course on get ting started with the Eclipse IDE for FX3 CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 19 3 1 Kit Operation SSF Cypress PERFORM The SuperSpeed Explorer Kit includes the develo
7. In the USB Control Center application expand the Cypress FX3 Example device 1 in the left panel and select the Bulk out endpoint and in the Data Transfers tab in the right panel click Transfer File OUT as shown in Figure 3 12 Figure 3 12 Sending Data Through Control Center to Write to SRAM URB Stat AbortPipe ResetPipe X G4 E Cypress FS Example device 1 Data Transfers Device Class Selection zal Transfer parameters Text to send Data to send Hex Er Pitemate Setting 0 Bytes to transfer S Bulk out endpoint O01 1024 PktMode Bulk in endpoint x81 Transfer Data OUT Transfer File OUT ah Programming Succeeded A dialog box opens prompting you to select a file A sample 1 KB file 1024 Count hex is provided in the File Transfer folder of the SuperSpeed Explorer Kit installation Browse to the path Install Directory gt Cypress SuperSpeed Explorer Kit 1 0 File Transfer to select the file This writes the 1 KB data available in the file to the SRAM starting from the address 0x00 CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 31 CYPRESS Keen PERFORM Note For Windows 7 and above the default install directory is C Program Files x86 For Windows XP the default install directory is C Program Files 9 Send a vendor command with the Req code OxBB to the control endpoint as shown in Figure 3 13 This step is necessary to switch the GPIF state ma
8. Ze 57 CTLOY e mp 57 5 CS wag pears ge pppaz amp T sk Sg e es aK em 5 POLK spar 57 5 GPIOS7 I25MCLX VO SW oan e mp 57 5 Ps CIKK oars 57 cc s 3 e 2c FX3 E GC SOA FAS amp e yyc SCL FX3 6 RECTANGULAR HEADERS FOR EXPANSION CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 48 SES Cypress PERFFORM Hardware 4 4 1 SuperSpeed Explorer Kit Interconnect Boards Two popular applications of FX3 are the following m Use FX3 as a USB controller for an image sensor to stream uncompressed data m Implement the synchronous slave FIFO configuration of FX3 to interface to an FPGA The application note AN75779 How to Implement an Image Sensor Interface with EZ USB FX3 in a USB Video Class UVC Framework www cypress com go AN75779 explains how to implement an image sensor interface with FX3 in a USB video class UVC framework The project provided with this application note interfaces FX3 with an Aptina MI9M114 Image Sensor www aptina com products soc mt9m114 The application note AN65974 Designing with the EZ USB amp FX3 Slave FIFO Interface www cypress com go AN65974 explains how to use FX3 in a slave FIFO configuration to interface to both Xilinx and Altera FPGAs This application note uses the Xilinx Spartan 6 SP601 Evaluation Kit www xilinx com products boards and kits EK S6 SP601 G htm and the Altera Cyclone III Starter Board www altera com products devkits altera kit cyc3 starter html to
9. 8 Figure 4 7 shows the SuperSpeed Explorer Kit EEPROM circuit To avoid contention with the EEPROM anything you connect to the I2C bus should avoid DC addresses that start with 1010 or 1011 Figure 4 7 EEPROM and Circuit I2C GPIO58 SCL e 12C GPIO59_ SDA 2C GPIO60 CHARGER DETECT For more details on EC EEPROM boot including EC boot image format refer to the application note AN76405 EZ USB FX3 Boot Options www cypress com go AN76405 KR FX3 includes an I S port to support external audio codec devices FX3 functions as an ES master transmitter only The IS interface comprises four signals clock I2S_CLK serial data 26 SD word select I28 WS and master system clock I28 MCLK FX3 can generate the system clock as an output on the 12S MCLK line or accept an external system clock input on the same line All four IS lines come out on the rectangular connector J7 SPI and UART FX3 supports an SPI master interface on the serial peripheral port The SPI I O lines are shared with the UART I O lines on the FX3 device The FX3 SPI UART lines are brought out to the pins of a rectangular connector The same lines are also connected to the USB Serial IC Figure 4 8 on the SuperSpeed Explorer Kit The USB Serial IC enumerates with one interface as a virtual COM port CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 50 Cypress PERFORM Hardware Figure 4 8 USB Serial IC USB TO SERIAL JT
10. C for code development The executable firmware launches and the debug perspective view opens as shown in Figure 3 26 Figure 3 26 Launching Debug Session Debug Source nat found Cypress EZ USE Sus File Edit Navigate Search Bun Project CY Tools Window Help ri amp b o ER de Ze e O r Qs Um uw di sel e iF Ep F Debug H W vt oe Sf a H PPT Co 00 Variables 2 go Breakpoints MI Registers mi Modules G th B Ze USBEulkSnurceSankL ED Debug Zjlin Embedded debug Mative Mame Value df Embedded GOA 02 06 14 1007 AM Suspended aP Thread 1 Suspended 2 symbol is mot availablez he Oe ae mm a m cyfebullseesinke E i5 Ne source available for DI SG Outline X An outline is net available m F Debug PX HERE A CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A x 45 Tasks Problems QD Executables J Memory Sg Progress m x x bb BLS m Oe rie Pn Landing section vertors size ixl1f5 lma wlan Loading section vectors sire Gviften Ima Ole P85 edennloaad sectione veeters section siree Sa16 total siree 3011010 785 eden load sections vectors section sente S816 section sizes fAs total sente Aale tetal sires 2811018 Landing section rest size QubSec lma awiobaimponNn Loading section test sire Gvkb cr Ima madida ZB5edewnload sectlane tevt srctlon sirzrees 46548 total sires 28118160 41
11. Configurations pj CAProgram Files x86 Cypress E i A 2 06 14 10 53 AM a L USBSerial OpenOCD Program DI p C Program Files x86 Cypress CYUSBSKIT 003M D USBSerialOpenOCD openOCD exe 4 SC USBBulkSourceSinkLED Debug Zylin Embedded debug Native i terminated Embedded GDB 02 06 14 11 27 AM Exited Exit code 0 gi terminated exit value 0 C Program Files x86 Cypress EZ USB FX3 SDK 1 3 bin arm none eabi gdb exe 0 11 To completely stop the debug session drop the GDB connection and terminate the OpenOCD tool running in the background click the Drop GDB Session icon twice instead of clicking the CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 44 SESJ Cypress PERFORM Kit Operation Terminate icon as explained in the previous step Clicking the Drop GDP Session icon the first time stops the GDB session and then clicking it again terminates the OpenOCD application Note It is recommended that you drop the GDB session and terminate the OpenOCD application before unplugging the USB cable of the integrated debugger because the OpenOCD tool keeps polling for the availability of the integrated debugger If the integrated debugger is unplugged without dropping the GDB session continuous CyJTAGRead failed and CyJTAGWrite failed messages will be flashed in the Console window of the EZ USB Suite Terminating the OpenOCD application will stop this activity If the GDB sess
12. E Altemate Setting 0 eme Bulk out endpoint x01 Data to send Hex PktMode Transfer Data IN Transter Pie AN 2 33 3 A3 4 2 74 A3 Bil HZ C2 Di De El EZ Fl Fe 3 7 Integrated Debugger 53 54 5 2 n3 83 EE B3 c3 DS E3 transfer Kit Operation ac 4c 5c ec TC Bc D AB AC HB BC DC EC FC P an 4D 5n oD Hu BD DD AD BD CH DD ED FD 3E AE 5E 5F GE TE 7 BE SE BE CE CF DE EE FE The CY7C65215 USB Serial IC www cypress com go CY7C65215 is a full soeed USB Serial bridge controller that offers two configurable serial communications blocks SCBs The development board uses the first serial channel of the CY7C65215 as a UART and the second serial channel as a JIAG interface Figure 3 15 shows the block diagram Figure 3 15 Block Diagram of CY7C65215 EZ USB FX3 USB 3 0 Connector USB Serial IC CY7C65215 CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A Micro B USB 2 0 Connecto r J8 33 SES Cypress Kit Operation 3 7 1 PERFFORM UART To use the UART functionality on the SuperSpeed Explorer Kit follow these instructions 1 Use J1 to connect the development board to your computer This powers the board and provides the USB 3 0 conduit to FX3 Then use a micro USB 2 0 cable to connect J8 to your computer This connection makes the integrated debugger enumerate with three in
13. Guide Doc 001 93186 Rev A 42 F CYPRESS Keen PERFORM 7 Apply breakpoints wherever necessary and click Resume For example apply breakpoints in the function BulkSrcSinkAppThread_Entry as shown in Figure 3 29 To apply a breakpoint double click on the blue bar to the left of the line This part of the firmware toggles the GPIO to which the blue LED LED2 is connected Note Do not add breakpoints in the sections of code where USB requests are handled CyFx BulkSrcSinkApplnUSBSetupCB CyFxBulkSrcSinkApplnUSBEventCB functions in the USBBulk SourceSinkLED firmware project because they affect the USB enumeration process or any other control request handling Similarly avoid placing breakpoints in the GPIF callback or DMA callback sections of the firmware project as these functions are called inside the FX3 SDK librar ies Applying a breakpoint inside these functions may affect how the firmware works in applica tions where FX3 is receiving continuous data over GPIF II and is streaming that data to the host Figure 3 29 Applying Breakpoints in the Firmware Entry function for the BulkSrcSinkAppThread 2 yold BulkSrcSinkAppThread Entry uint32 t input c cyfxbulksresinke 3 gt c d CyU3PReturnStatus t stat uint32 t eventMask CYFX USB CTRL TASK CYFX USB HO uint32 t eventStat uintl6 t prevUsbLogIndex 6 tmpl tmp2 CyU3PUsbLinkPowerMode curState ac Initialize the debug module CyFxB
14. Monitor monitor monitor Mww Mww Mww Mww arm gdb 0x40000000 0O0xE3A00015 0x40000004 OxEEO090r31 0x40000008 0xE240024F 0x4000000C OxEEO90F11 t Set the PC to 0x40000000 monitor reg pc 0x40000000 Si Si Si Si In the Run commands section enter load The Initialize and Run commands are the GDB commands to initialize and run the JTAG target device in this case FX3 CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 40 E y CYPRESS PERF OR M Figure 3 25 Commands Tab of Debug Configurations Window in EZ USB Suite manage and run configurations amp x oi type filter text c C C Application c C C Attach to Application c C C Postmortem Debugger fe C C Remote Application Launch Group SC Zylin Embedded debug Cygwin SC Zylin Embedded debug Native SC USBBulkSourceSinkLED Debug Name USBBulkSourceSinkLED Debug B Main 5 Debugger I Commands 5 Source P Environment E Common Help tips on how to setup GDB init script Initialize commands monitor reg pc 0x40000000 si si si si Run commands load Filter matched 8 of 8 items Kit Operation 5 Click Debug Accept the option to switch to the Debug Perspective An Eclipse perspective is a screen layout optimized for various activities In the upper right corner of the Eclipse screen you can select Debug for debugging or C
15. available on the Microsoft website m USB 3 0 capable PC host The SuperSpeed Explorer Kit firmware examples can operate at either USB 2 0 or USB 3 0 speeds To achieve maximum performance with the FX3 hardware use a PC with a USB 3 0 host controller m Java Runtime Environment JRE Other Suggested Tools The following USB protocol analyzers can be used to analyze the traffic between the PC host and the FX3 device m Hardware analyzers 3 Ellisys USB Explorer 280 a Lecroy USB Voyager M 3 Beagle USB 5000 SuperSpeed Protocol Analyzer m Software protocol analyzers a SourceQuest SourceUSB 3 SysNucleus USBTrace a USBlyzer Additional Learning Resources Visit the EZ USB FX3 web page www cypress com fx3 for additional learning resources in the form of a datasheet a technical reference manual application notes knowledge base articles and training videos CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 8 Introduction a P EJ CYPRESS 1 3 Documentation Conventions Table 1 1 Document Conventions for Guides Convention fae S in file locations user entered text and source code pto Italics me file names and reference documentation For example CYUSBS232UART cyusb Displays keyboard commands in procedures Bracketed Bold Enter or Ctrl C Courier New Represents menu paths File gt Open gt New Project Bold Displays commands menu paths and icon names in proced
16. explain the application FPGA codes and an FX3 firmware project are available with the application note Table 4 2 shows the interconnect boards that are available for the SuperSpeed Explorer Kit to interface with Aptina image sensors and Xilinx and Altera FPGA boards Table 4 2 Interconnect Boards Available for SuperSpeed Explorer Kit PartNo Name Interface for CYUSBSACC 004 Aptina Interconnect Aptina image sensor www cypress com go CYUSB3ACC 004 CYUSB3ACC 005 FMC Interconnect Xilinx FPGA board www cypress com go C YUSB3ACC 005 CYUSBSACC 006 HSMC Interconnect Altera FPGA board www cypress com go CYUSB3ACC 006 For more information on the interconnect boards visit the web pages provided in the table 4 5 Reset Circuit You can reset the FX3 device from an onboard push button SW1 The reset circuit used for FX3 on the SuperSpeed Explorer Kit is shown in Figure 4 6 Figure 4 6 Reset Circuit V3P3 R1 100K c RESET IN 3 be 434 123 050 816 C2 GND 1uF 25V C0402 Manufacturer Wurth Electronics Inc CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 49 CYPRESS Hardware 4 6 4 6 1 4 6 2 4 6 3 PER FQOHR M Serial Interfaces I C The EC interface lines on the FX3 device are available on the rectangular connector J6 for probing and expansion These lines also connect to the onboard EEPROM device and USB Serial IC as shown in Figure 4 7 and Figure 4
17. folder in the path Install Direc tory NCypress note that for Windows 7 and above the default install directory is C Pro gram Files x86 and for Windows XP the default install directory is C Program Files This folder contains documentation drivers hardware files example firmware and an OpenOCD executable for using the USB Serial IC www cypress com go CY7C65215 as a USB JTAG debugger 2 6 EZ USB Suite Eclipse IDE 2 6 1 Starting the EZ USB Suite Note The EZ USB Suite is dependent on the Java Runtime Environment JRE As the JRE is not packaged with the FX3 SDK 1 3 1 you need to download and install it separately You can get the current version of Java from the Java website http java com en download index jsp if it is not already installed on the system Navigate to the Windows Start menu and select All Programs click the Cypress folder to expand it Figure 2 7 Click the Eclipse entry to expand it and double click the EZ USB Suite entry CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 15 ai CYPRESS Software Installation 2 6 2 PERFORM Figure 2 7 Launch the EZ USB Suite iFFiFETE i F 1 TESS ARM GCC USB Serial A Cypress USBSuite CYUSBS236 DVK A Eclipse iid EZ USB Suite Files EZ USB Suite h l Release Notes EZ USB FX3 SDK GPIF I Designer This launches a first time startup screen that sets up a Workspace folder for all your Cyp
18. the GDB debugger Leave the GDB command file field blank Figure 3 24 Debugger Tab of Debug Configurations Window in EZ USB Suite Create manage and run configurations amp x iui type filter text c C C Application B Launch Group c C C Attach to Application c C C Postmortem Debugger c C C Remote Application SC Zylin Embedded debug Cygwin 4 SC Zylin Embedded debug Native zc USBBulkSourceSink Debug Filter matched 8 of 13 items Name USBBulkSourceSink Debug r B Commands 7 Source P Environment i Common Debugger Embedded GDB V Stop on startup at main Debugger Options DB debugger C Program Files x86 Cypress EZ USB FX3 SDK 1 3 bin arm none eabi gdb exe DB command file Warning Some commands in this file may interfere with the startup operation of the debugger for example run GDB command set Protocol mi Z verbose console mode Use full file path to set breakpoints 4 In the Commands tab Figure 3 25 copy and paste the following text into the Initialize commands section Ser prompt This connects to a target via netsiliconLibRemote listening for commands on this PC s tcp port 3333 target remote localhost 3333 monitor reset halt Set the processor to SVC mode monitor reg cpsr O0xd3 Disable all interrupts monitor mww OXFFFFFO14 OxFFFFFFFF Enable the TCMs monitor
19. AC CONVERTER 4 6 4 JTAG FX3 debug is available using the FX3 JTAG port and the Cypress USB Serial IC as a dedicated JTAG master The USB Serial IC implements a JTAG TAP controller so no additional hardware is required for JTAG operation The Eclipse development software includes an OpenOCD driver for this JTAG port Figure 4 8 shows the circuit for the JTAG interface using the USB Serial IC 4 6 5 User Push Button SW2 As shown in Figure 4 9 a push button is connected to GPIO45 of the FX3 which can be used by the user application Figure 4 9 User Push Button SW2 Red 100K Swe Al oz Bi o o C40 424 123 050 816 0 1uf 26V NC C0402 4 6 6 User LED LED2 As shown in Figure 4 10 the blue LED LED2 is connected to GPIO54 SPI SSN of FX3 The LED glows when GPIO is driven low Figure 4 10 User LED LED2 d zb T V3P3 WSPLSSN UART CT CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 51 A Appendix 7 CYPRESS PERFORM A 1 Troubleshooting A 1 1 Manual Installation of a Cypress Driver Ze In Windows invoke Start right click Computer and choose Properties gt Select Device Man ager Note In Windows XP invoke Start right click My Computer and choose Properties gt Hard ware tab gt Select Device Manager Locate the FX3 or USB Serial device entry with a yellow symbol in the Other devices list Note FX3 enumerates as WestBridge
20. AM cydsn 5 cyfx gcc startup S h cyfxgpif2config working h gt e cyfxsram c h cyfxsram h e cyfxsramusbdscr c IW cyfxgpif2config h i makefile readme txt 4 E USBBulkSourceSinkLED gt i Binaries GU Includes gt zz Debug gt CG Release 5 cyfx gcc startup S gt e cyfxbulkdscr c e cyfxbulksrcsink c h cyfxbulksrcsink h makefile readme txt 2 6 3 Automatically Saving Your Edits It is recommended that you change one of the Eclipse default settings To automatically save your edits before building the project navigate to Windows gt Preferences gt General gt Workspace and select Save automatically before build Figure 2 12 Click OK CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 18 5 CYPRESS Software Installation PERFORM Figure 2 12 Automatically Saving Edits type filter text a vcn See Startup and Shutdown for workspace startup and shutdown preferences Appearance Compare Patch A Content Types Build automatically Editors Refresh using native hooks or polling Keys Refresh on access Network Connections 3 Perspectives Search Security Startup and Shutdown Workspace save interval in minutes 5 Always close unrelated projects without prompt Web Browser Workspace name shown in window title Workspace C C Cypress Help Install Update Mylyn Text file encoding New text file line delimiter Run Debug
21. B3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 12 J CYPRESS TNT Software Installation The installation procedure involves extracting these archives and setting environment variables Refer to the FX8 SDK Linux Support pdf file available in the following extracted folder of the FX3 SDK for Linux installation x3 sdk v1 3 linuxNFX3 FirmwareNcyfx3sdkNdoc 2 4 SuperSpeed Explorer Kit Installation To install the SuperSpeed Explorer Kit software follow these steps 1 Download the latest kit installer from www cypress com go SuperSpeedExplorerkit Locate the SuperSpeedExplorerkitSetup exe file in the Downloads folder and double click it to run the Installer Figure 2 3 Figure 2 3 SuperSpeed Explorer Kit Installer Screen Welcome to the InstallShield Wizard for Superspeed Explorer Kit Click next to start the upgrade process Cancel 2 Click Next and select the required Installation Type When installing for the first time it is best to select the Typical installation type Figure 2 4 CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 13 E CYPRESS PERFORM Software Installation Product Installation Overview Choose the install type that best suits your needs Choose the type of installation Product SuperSpeed Explorer Kit Installation Type Typical Installs the most common features of Superspeed Explorer Kit 3 Click Next to start the Instal
22. EN EE 36 4 Hardware 46 MN POW SR SUI E He 46 4 2 USB 3 0 Receptacle Connechor 47 Ao EE Ee ee ec o 47 4 4 X GPIF Il Connector eee 48 4 4 1 SuperSpeed Explorer Kit Interconnect Boards cccccsseeeeeseeeeeeeeeeeeeeeeas 49 4 5 Reset Circuit ccccceecccccseeeccccesseecceeueceecseeueeecsauseeesseaeseessauseeesseaeeessanseeessanseesssaaees 49 4 6 rie 50 SC WR E 50 VS 50 AG OP WANG BULUM 50 LX D MEI en ee ne ea OE eR TP 51 4 6 5 User Push Button GW 51 AGO Ue CTED LED e 51 Appendix 52 TOUDISSMOOWIGL E T 52 Manual Installation of a Cypress Driver cccceccccecceeseeeeeeeeeeseeeeseeeeeaeeeessaeeeeeeaseeees 52 If You Have Too Many COM Ports ssseessseeseeeeennnnnnnnnen nnne nnn nnns 54 CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 4 Safety Information I E s gt CYPRESS PERFORM Regulatory Compliance The CYUSB3KIT 003 SuperSpeed Explorer kit is intended for use as a development platform for hardware or software in a laboratory environment The board is an open system design which does not include a shielded enclosure This kit may cause interference to other electrical or electronic devices in close proximity In a domestic environment this product may cau
23. EZ USB FX3 SDK 1 3 Installation Page Please wait while setup installs confiqures EZ USB FX3 SDK on your computer Caching ag FX3 SDK B126 m ARM GCC B126 Eclipse B126 CySuiteUSB3 B584 cygpitZdesigner B1174 Installing FX3 SDK Eclipse CySuitteUSBS CyGPIF2Designer 1 0 Rolling Back to a Previous Version of FX3 SDK Some features or application programming interfaces APIs of the SDK may not be supported in the latest version of the FX3 SDK To use those features you can roll back to any previous version of the FX3 SDK using the Cypress Update Manager Follow the steps given in the knowledge base article How to Roll Back to a Previous Version of FX3 SDK KBA89637 www cypress com go KBA89637 to install any previous version FX3 SDK Installation on Linux OS FX3 SDK version 1 2 and later revisions support firmware development with the EZ USB Suite on the Linux platform The EZ USB FX3 SDK www cypress com go FX3SDK for Linux is released in the form of a gzipped tar archive called FX3 SDK tar gz On extraction this tar archive contains the following gzipped tar archives FXS3 Firmware tar gz FX3 firmware library and examples ARM GOCOC tgz Sourcery ARM GNU toolchain to compile firmware examples eclipse x86 tgz EZ USB Suite for 32 bit Linux OS eclipse x64 tgz EZ USB Suite for 64 bit Linux OS cyusb linux Build no tar gz The CyUSB Suite provides QT based USB applications to com municate with the FX3 device CYUS
24. Le cyfxbulksrcsink c Toggle Breakpoint Ctrl Shift B LR cyfxbulksresink h Toggle Line Breakpoint L i uf Toggle Method Breakpoint L makefile Toggle Watchpoint readme bet Skip All Breakpoints Remove All Breakpoints Breakpoint Types U L External Tools 2 Double click Zylin Embedded debug Native A new debug configuration opens with the firmware name as the Project name Confirm that EZ USB Suite has filled in the fields as shown in Figure 3 23 If the C C Application field is empty click Search Project and select the Debug or Release build of the e f file which was built previously Figure 3 23 Debug Configuration in EZ USB Suite a Debug Configurations re gx wl make Li BEI x ms Mame USBBulkSourceSinkLED Debug type nier te E Main b s Debugger Ell Commands lj Source M Environment E Common E Cyr e nppticinon ee Project optional c C C Attach to Application E C C Pastmortem Debugger USBBulkSourceSinkLED t C C Remote Application C C Application Launch Group a FEO ce cc Tr 1f n Fin Embedded deine Cue Debug USBBulkSourceSinkL ED elf Search Project Application console Double click Apply Revert Filter matched 8 of 8 items CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 39 X E CYPRESS PERFORM Kit Operation 3 In the Debugger tab browse to the path shown in Figure 3 24 for
25. Mative Step Into 03 elackCanfig Li 4 Ef Embedded GDR 02 06 14 11 27 AM Suspended il a Thread 1 uspended Breakpoant hil zlmani cylsbulksrcunk cl128 OxS0004 418 d CMPregram Files iG y pren EZ ADR FX3 SUE d urarme none e abi gdbewe 027065714 11227 AM m L nyfehulksresimk e 3X e p S Outline Dissssernhhy Ez ZI main waded n CyU3PTaMatriwConfig t ia cfp H H Enter Io atson here 2 th ARKI Cy sPReturmstatus t status CY USP SUCCESS e r3 P3 Initialize the device P Ss LE mov rj B Cyl3P amp ysClackConfig t clarktanfig ADM BC ztr TA rii 2 6 clockConfig setsysClkaga CyTrue 1142 clecktonfig setsysclkage ClockConfig cputlktdy 2 DURAS ZO mov rJ 1 rlockCanfig dmat lkt lw 2 ADOOAR24 str r3 ril s 64 xr clockConfig medoctkoiv di m 7147 Lael ake cn d bk mue S 4 m t m El Console i2 45 Tasks H Problems 3 Executables Memory Sg Progress x 34x bl j EE mE n 5 VSEBulkscurcesinkLED Debug E i Ernibecdided debug Malrzos CAF rogram Files 3Bb vCypressEZ USE FX3 SDEXL dibirarm nene eabe gadb ee 02 06 14 11 7 AM Drop GDB Session va cr ee Om AE Lon war leis ies RN Exprez amp ion var le44 done namea varJ numchilda 65 values types CyUJPSysClockConfig t threanad ida 1 has morea B gdb lgas done values g gdb lO46 var evaluate expression varJ le45 done valuea gdb d m Writable 5mart Insert 1138 1 CYUSB3KIT 003 SuperSpeed Explorer Kit User
26. Other Suggested Tools 1 2 Additional Learning Resources usse 1 3 Documentation Conventons 14 ACIONYINS TPERCEU TUM 1 5 Document History eeeeeeeeeeeseseeeeenreeenre 2 Software Installation 2 31 FXS SDK Installation on Windows OS 2 2 Rolling Back to a Previous Version of FX3 SDK 2 3 FX3 SDK Installation on Linux OS 2 4 SuperSpeed Explorer Kit Installation 2 5 Cypress Update Manager 2 6 EZ USB Suite Eclipse IDE 2 6 1 Starting the EZ USB Sulte 2 6 2 Importing a broiect 2 6 3 Automatically Saving Your Edits 2 6 4 Building the Project essssesussss 3 Kit Operation 9 1 USBOOnmECiO eege een 32 let 33 Emwelt 3 4 USB Control Center 30 ele e el 3 5 1 Boot From Onboard Il2C EERDROM 3 5 2 Boot as a USB Loader nnnnnnnnnnennnnnennneneennenne 3 5 8 Program the EEDROM sess 3 6 Firmware Examples ccccccsccccsscecceeecseeseeceeeeseeees 3 6 1 USBBulkSourceSink with LED Blink 3 6 2 SRAM Exvample esee 3 Integrated Debugger CSO WEE A RE CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A J cypress PERFORM A Cypress PERFORM Contents E
27. PRESS Haase PERFORM Figure 4 3 Crystal Circuit XTALIM XTALOUT PART NUMBER Nx25205A 15 200000MHZ NBGI1 Manufacturer NDK Figure 4 4 FSLC 0 2 Lines Pulled to Ground FSLCU FSLC1 R76 FSLC2 10K 4 4 GPIF Il Connector The General Programmable Interface Gen 2 GPIF Il enables functionality similar to but more advanced than that of the FX2LP GPIF It is a programmable state machine that enables a flexible interface functioning either as a master or a slave using industry standard or proprietary interfaces You can implement both parallel and serial interfaces with GPIF II The development board provides two rectangular connectors to interface with external processors ASICs DSPs or FPGAs as Figure 4 5 shows If the GPIF Il is not used as the FX3 firmware these pins become the FX3 GPIO pins Figure 4 5 GPIF Il Lines on Rectangular Connectors V3P3 va D vo USES VBUS e USB3 VBUS 5 INT N CTLI5 lt Ox o 6 250031 s CTLI2 e Dots 57 5 PMOOE 2 nose K aus 57 CTL e yyDat4 57 s TRLN 5 PMCOE 14 oars 57 cro e pppars 57 5 PMOOE 0 nas o SE 57 CTL9 e spatz 57 lt Grits 3 57 CTL e ppan s7 pba 57 CT pate s7 Se die er Rice 2 4 57 CTEK sp 57 5 8 SPLMOSI UART RX lt 0025 S 57 CTS amp 2 me amp 7 58 SP MISO UART TX oan pne 27 24 iM 5 SPESEN_UART CTS X gt poazs 25 5 CTL e spe 57 DQ22 2500 57 CL zs 57 5 SPLSCX UART RTS GC 0021 57 e 57 cnt e Spa 57 DQ20
28. SB BootLoader Device as shown in Figure A 3 Note After driver installation the USB Serial interfaces can be identified as a USB Serial Port COM Acts as a UART interface a USB Serial Dual Channel Vendor MFG Used to configure the USB Serial IC a USB Serial Dual Channel Vendor 1 Acts as a JTAG interface Figure A 3 FX3 Entry in Device Manager After Driver Binding DEE ee Ele Action View Help el sall HH e ees a Sound video and game controllers gt li System devices A y Unrversal Serial Bus controllers Mg Cypress FX3 USB BootLoader Device g Generic USB Hub BR Generic USB Hub 8 Generic USB Hub g Intel R 7 Series C216 Chipset Family USB Enhanced j Intel R USB 3 0 eXtensible Host Controller M Intel R USB 3 0 Root Hub USB Composite Device USB Root Hub 1 8 USB Root Hub g USB Virtualization y y Y ce BR Intel R 7 Series C216 Chipset Family USB Enhanced y y Di CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 53 E 7j CYPRESS A 2 If You Have Too Many COM Ports Some terminal programs do not allow high COM port numbers for example COM17 The reason Windows assigns such high numbers is that many applications that create COM ports do not remove the port when the application is no longer running To clear these unused COM ports follow these Steps 1 Select Start All Programs Accessories and right click Command Prompt to start a Co
29. SBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 37 E a ES cypress Kit Operation PERFORM When you click Run OpenOCD is invoked and the messages shown in Figure 3 21 appear in the EZ USB Suite Console window indicating that OpenOCD has accepted the integrated debugger as a JTAG adapter has recognized FX3 as a target device and is now running in the background as a debug server Note You need to create the external tool configuration only once for each JTAG debugger per Workspace The configuration you just entered is saved in the EZ USB Suite Figure 3 21 Console Window in EZ USB Suite C C Cypress Z USB Suite EE OON NN C C aM File Edit Source Refactor Navigate Search Run Project CY Tools Window Help r3 v ax Ea e GI Y Ay En G Ld Ke Ke pos Yv Q Yv Q v e ge Sy v Ki e v ES es C C SS t3 Project Explorer 23 mr Alog ET ES USBBulkSourceSinkLED An outline is not available Problems Tasks E Console XC Ei Properties ij En i8 E89 rt E r Oo USBSerial OpenOCD Program C Program Files x86 Cypress SuperSpeed Explorer Kit 1 0 USBSerialOpenOCD openOCD exe Open On Chip Debugger 9 7 80 2013 11 98 13 13 Licensed under GNU GPL v2 For bug reports read http openocd sourceforge net doc doxygen bugs html Warn Adapter driver openjtag did not declare which transports it allows assuming legacy JTAG only Info only one transport option autoselect jtag adapter nsr
30. User Guide Doc 001 93186 Rev A 34 SSF Cypress Kerai PERF QOHR M Figure 3 17 Selecting USB Serial COM Port in Tera Term 3 ma Pees U a Pe pep m era lerm ars WC F ile Edit Seti Tera Term New connection O TCPHIP myhost example com History Telnet SSH SSH2 eg UNSPEC Cancel Help In the Tera Term application choose Setup Serial Port to change the COM port settings as shown in Figure 3 18 and click OK Note In all the SDK firmware projects and the firmware projects provided with the SuperSpeed Explorer Kit the UART block of the FX3 device is initialized to work at 115200 baud rate There fore in the Tera Term application you should select the 115200 baud rate while setting up the COM port unless you have changed the baud rate setting for the UART block in the FX3 firm ware project Figure 3 18 Setting Up the COM Port in Tera Term CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A Baud rate Data Cancel Parity Stop Help Flow control Transmit delay 0 msec char 0 msecjline Note Though the UART hardware flow control is supported by the FX3 SDK it is not supported by the SuperSpeed Explorer Kit Therefore the Flow Control field should be set to none in the UART communication terminal When the UART interface is used while debugging through JTAG the UART baud rate should not be mo
31. age is available in the EEPROM otherwise FX3 falls back to USB boot When the J4 jumper is inserted FX3 allows firmware download through USB This section discusses how to execute three FX3 boot options m Boot from the onboard IC EEPROM and run its code m Boot as a USB loader to load and run code from the PC m Program the onboard EEPROM with your own code and boot from it after a reset Boot From Onboard IC EEPROM Confirm that the J4 jumper is not inserted This enables FX3 to boot from the onboard PC EEPROM which is loaded in the factory with the USBBulkSourceSinkLED example code 1 Connect the development board to your computer using the USB 3 0 cable provided with the kit as shown in Figure 3 3 Figure 3 3 USB Connection CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 23 SES cypress PERFORM Kit Operation 2 After connecting the development board to the host wait for the Windows drivers to install If the drivers do not install automatically follow the steps in the Appendix on page 52 to manually install the drivers 3 After the driver installation is complete observe the blue LED LED2 If the development board is connected to a USB 3 0 port the blue LED LED2 blinks If the development board is connected to a USB 2 0 port the blue LED LED2 stays ON If the development board is connected to a USB 1 1 port the blue LED LED2 stays OFF Note This is a useful way to speed
32. chine from the SRAM Write cycle to SRAM read cycle Figure 3 13 Sending Vendor Request to Read From SRAM Ccosocwoce a RN ENSE Program Hep eR 5 Ej o s 3 Dl URE Stat Abort Pipe ResetPipe X amp E Cypress FX3 Example device 1 Data Transfers Transfer parameters Text to send Data to send Hex Bytes to transfer T 1 nees Direction Reg type Target Device e Reg code DD wValue 0000 windex 0000 6D 7D O360 i 62 63 0370 7 72 73 74 75 7 0380 Bz B3 o350 1 92 93 5340 AZ AS Ad AS OoO3B0 Bz B3 gaca i Cz C3 gang Dz D3 O3SE0 EZ E3 3F0 FO Fl Fz F3 F4 F5 F BULK OUT transfer completed da dna nnanad CONTROL OUT transfer Zero length data transfer completed File selected C Program Files x86 Cypress SuperSpeed Explorer Kit 1 0 File Transfer 1024 Count hex 10 Select the Bulk in endpoint 0x81 in the left panel In the Data Transfers tab in the right panel enter 1024 in the Bytes to transfer field and click Transfer Data IN to read the 1024 bytes written to SRAM in the previous step See Figure 3 14 CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 32 a SES cypress PERFFORM Figure 3 14 Reading 1024 Bytes From SRAM E URE Stat Abort Pipe ResetPipe X amp El Cypress FX3 Example device 1 BOS Transfer parameters El Configuration 1 Lin Control endpoint 0x00 Text to send Interface 0
33. d new code builds during development without disconnecting the USB cable This time select IC EEPROM as the target device instead of RAM in the USB Control Center application Figure 3 6 This causes FX3 to invoke a secondary loader called Cypress FX3 USB BootProgrammer Device Figure 3 6 as opposed to the BootLoader device used to program the FX3 RAM in the previous section Note The BootProgrammer has different VID PID values than the BootLoader which may trigger driver installation the first time it is used If the driver does not install automatically follow the steps in Section A 1 1 on page 52 to manually install the driver Figure 3 9 TC EEPROM Download Option USB Control Center Control endpoir Essen H Interface D Figure 3 10 FX3 Re Enumerates as a Cypress FX3 USB BootProgrammer Device r USB Center File Program Help ER c GN Ir mE Cypress USB BaotProgrammer 2 After selecting I C EEPROM as the programming target navigate to the mg file to be loaded and click Open After the BootProgrammer code erases and reprograms the EEPROM a success message appears in the lower left corner of the USB Control Center Note that erasing and programming EEPROM takes much longer than programming internal RAM on the order of 20 30 seconds CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 28 an 7 CYPR ESS 3 6 3 6 1 Kit Operation 3 Disconnect the USB cable r
34. d or High Speed rates The USB 2 0 Micro B receptacle connects to an onboard Cypress CY7C65215 USB Serial Dual Channel UART I2C SPI Bridge www cypress com go CY7C65215 which is configured as an integrated debugger operating at the USB Full Speed rate This chip provides a bridge between the FX3 debug interface and a PC s USB port enabling two debug methods serial terminal messages and JTAG debug These debug methods are explained in Section 3 7 on page 33 Jumpers The SuperSpeed Explorer Kit development board contains four jumpers labeled J2 J5 The jumper settings are as follows Jumper J2 This jumper sets the voltage levels of the FX3 power domains VIO1 VIO2 and VIO3 Inserting the jumper selects 3 3 V while removing the jumper selects 1 8 V These domains set the operating voltage of the FX3 interface pins The default is to have the J2 jumper in place selecting the 3 3 V interface This makes the interface compatible with the 3 3 V SRAM connected to the GPIF II interface Jumper J3 This jumper is connected in series with the VBUS signal of the USB 3 0 connector This jumper must be inserted to power the development board The J3 jumper is provided to measure the development board s power consumption by removing the J3 jumper and connecting an ammeter between the J3 pin headers Jumper J4 This jumper selects the FX3 boot method Similar to all Cypress EZ USB parts the code is loaded booted into high speed internal RAM f
35. e I O in each power domain Figure 4 1 shows the circuit used to switch the voltage level using the J2 jumper CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 46 F CYPRESS Haare PERFORM Figure 4 1 Circuit to Switch Voltage Level for FX3 VIO Domain VIO 1 8V When J2 is Open USB3 VBUS VIO VIO 3 3V When J2 is Shorted d IP4 NCP1117DTARKG 3 UIN VOUT 2 R21 0 Ohm TAB m R79 805 GB Za LDO 1 6K C69 10 uFd 25v R16 J2 E 180 Ohm 1 OH 2 5 QN A30 R2 C74 961102 6404 AR 609 002 115 121 3 3V 1 8V 8 1 5A REGULATOR FOR VIO 4 2 USB 3 0 Receptacle Connector A standard B type USB 3 0 connector is on the development board Figure 4 2 shows the USB 3 0 pins SS TX M SS TX P SS RX P and SS RX M and USB 2 0 pins D and D that are available on the J1 USB connector The USB 3 0 and USB 2 0 lines go through an ESD protection device This connector accepts either the newer USB 3 0 plug or an older USB 1 1 2 0 plug Figure 4 2 USB 3 0 Type B Connector and ESD Device USES VBUS a B d H w 4 3 FX3 Clock On the development board the clock for the FX3 is provided by an onboard 19 2 MHz crystal connected to the FX3 XTALIN and XTALOUT pins as shown in Figure 4 3 The FSLC 0 2 lines of FX3 are tied to ground to select the 19 2 MHz crystal for clocking as shown in Figure 4 4 CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 47 F CY
36. educes the USB overhead and achieves higher data throughput m Xfers to Queue This setting initiates multiple transfers and adds them to a task queue which reduces the latency between successive transfers on the host application side Therefore queu ing more transfers results in a higher data rate CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 29 SES Cypress Kit Operation 3 6 2 PERFFORM Figure 3 11 Streamer exe BULK IN 16384 Bytes 15 MaxBurst Packets per Xfer 256 Successes 576 Xfers to Queue 64 Failures H Timeout Per Xfer ms 1500 Transfer Rate KB s TT aE 443500 CPU Utilization HBG The SuperSpeed bulk throughput depends on the burst size buffer size and the number of buffers This firmware is already optimized to achieve maximum throughput Refer to AN86947 Optimizing USB 3 0 Throughput with EZ USB FX3 www cypress com go AN86947 for more details about the parameters that affect the throughput in the bulk source sink firmware AN86947 www cypress com go AN86947 lists the USB 3 0 throughput numbers using internally provided FX3 data The USB 3 0 throughput numbers will be slightly lower when the data originates from an external device into FX3 through GPIF Il Refer to AN65974 Designing with the EZ USB FX3 Slave FIFO Interface www cypress com go AN65974 for the throughput numbers when an FPGA supplies data to FX3 via the GPIF Il interface SRAM Example
37. embly 7 DH LED toggling function start Erbe locaton bere 3 th fee ifion time l a fl Cyt sPGpilaSetValue LED GPTO CyFalse Turm LED QN 4 amp Atan gbe mov ra 54 x36 Cyl3PThreadsleep nn time OH time ptp mov ri S UBAgca bl BageldsSes zcyusPGpiosetwui DI Cyl Threadsleepicr if off time apgeagcU ldr r3 pe 2068 Us UBAgcc ldrh r5 r3 CyuiPGplasetValues LED GPIO CyTrur f Turm eg ADOOAdd sov r r3 Cyli3PThreadsleep aff time ZUR bl Bxapegss c tx thread sli 816 if off time la d LED toggling function end ADOOAddli ldr r3 pe 2076 Ge abaan ideh ei ferl 5d a m EJ Console ii Tasks CA Problems 3 Executables Memory Go Progress E u EE Caf St pm Erf D Ubbiulkoeurceainklil Debug L5yhn Embedded debug Matroe CP rogram Files Bb cypresskEZ USB FX3 SDEXL Snan nanea bregi bee DZ L4 10 54 ANT Zap done names vara numchilda 8 wvalues 7 typea CyU3SPReturnStatus t thresd ida 1 has morea g pdb 578 wvar evaluate ewpresslon vari 5726 daonr value a pdb 571 var evaluate ewprezslon varg 521 donr valura 7 pdb 4 m b Wrtable Smat Insert Blz 79 9 Click the Step Over icon until you reach the second breakpoint Note that if the development board is connected to the SuperSpeed host the debugger will reach the second breakpoint If the development board is connected to the high speed host the debugger will not
38. emove the J4 jumper reattach the cable and the FX3 boots with the code from EEPROM Firmware Examples Two firmware examples are provided with the SuperSpeed Explorer Kit installation in addition to those provided with the SDK The SDK examples are available in the Firmware folder of the FX3 SDK To import an SDK example refer to the steps in Section 2 6 2 on page 16 For Windows 7 and above the default location of the firmware folder is C Program Files x86 Cypress EZ USB FX3 SDK 1 3 firmware For Windows XP the default install directory is C Program Files Cypress EZ USB FX3 SDK 1 3 firmware Note The SuperSpeed Explorer Kit development board does not support FX3 USB HS OTG functionality Therefore the OTG host based example firmware projects provided with the FX3 SDK do not apply to this kit In addition SDK example firmware projects that are meant for FX3S and CX3 are not applicable to this development board USBBulkSourceSink with LED Blink This is the default firmware stored in the kit s onboard EEPROM As described in the previous section this firmware supports the following features m It implements endless data sources and sinks over a pair of USB bulk endpoints m The blue LED LED2 blinks at connection depending on the USB host controller capability If the development board is connected to a USB 3 0 port the blue LED LED2 blinks and if it is con nected to a USB 2 0 port the blue LED LED2 stays ON If the develop
39. hich is packaged with the FX3 Software Development Kit SDK The SuperSpeed Explorer Kit combines hardware software and documentation that enable customers to evaluate the FX3 device This user guide describes the steps to install the software required by the SuperSpeed Explorer Kit and to operate the development board provided with the kit The guide also documents different types of firmware download and debug methods with detailed instructions Two example projects USBBulkSourceSinkLED and SRAM FX3 explain the use of various features provided on the SuperSpeed Explorer Kit development board and the host applications provided with the FX3 SDK This document also explains the hardware interfaces available on the development board Interconnect boards are available to interface the SuperSpeed Explorer Kit development board with Aptina image sensor boards Xilinx FPGA boards and Altera FPGA boards See Section 4 4 1 on page 49 for more information on the interconnect boards 1 1 Kit Contents The SuperSpeed Explorer Kit contains the following m FA development board m USB 3 0 Ato B cable m Quick start guide m Jumpers Visit the kit web page www cypress com go SuperSpeedExplorerKit for more information Inspect the contents of the kit If any parts are missing contact your nearest Cypress sales office for further assistance 1 1 1 Software FX3 Software Development Kit FX3 SDK The FX3 software development platform is based on
40. his step was followed the FX3 SDK and SuperSpeed Explorer Kit Setup are already installed on your machine You can jump to Section 2 5 on page 15 for steps to launch Cypress Update Manager Cypress Update Manager helps ensure you have the latest FX3 SDK and the SuperSpeed Explorer Kit Setup installed on your machine 2 1 FX3 SDK Installation on Windows OS To install the latest version of the FX3 SDK follow these steps 1 Download the latest FX3 SDK from the EZ USB FX3 Software Development Kit page www cypress com go FX3SDK which includes Windows and Linux downloads If your browser does not ask to run the downloaded file locate the FX3SDKSetup exe file in the Downloads folder and double click it to start the installer Figure 2 1 Figure 2 1 FX3 SDK Installer Screen JSE FX3 SDK 1 3 Product Installation Overview Choose the install type that best suits your needs Product EZ USB FX3 SDK 1 3 1 Installation Type Typical z Installs the most common features of EZ USB FX3 SDK 1 3 1 CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 11 Riga SES CYPRESS Software Installation 2 2 2 3 PERFORM 2 Click Next to start the Installation Wizard 3 Accept the license agreements for the various software components and click Next The installer indicates the completion progress Figure 2 2 Figure 2 2 Installation Progress Showing Individual Modules e Cyinstaller for
41. hown in Figure 3 33 Figure 3 33 Icon to Switch to C C Perspective Sao ls E E D i C C N i Other CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 45 F CYPRESS PERFORM This chapter describes the hardware interfaces and circuits available on the SuperSpeed Explorer Kit development board It covers the following topics Power supply USB 3 0 receptacle connector FX3 clocking mechanism using onboard crystal User push button User LED GPIF II connector Reset circuit Serial interfaces I S IC SPI UART and JTAG 4 1 Power Supply The SuperSpeed Explorer Kit development board is powered from the USB 3 0 connector J1 This development board does not support self powered mode although the FX3 device does support it Select voltage levels for FX3 I O power domains through the J2 jumper as shown in Table 4 1 Table 4 1 Power Supply Domain Power Domains Jumper Poston Voltage Level ior vioz vios Shor defaui J2 VIOT VIO2 VIOS FX3 I O voltage domains VIO4 and VIO5 are fixed to 3 3 V If you are using the onboard SRAM you must select the 3 3 V option The FX3 device has additional power domains USTXVDDQ US3RXVDDQ AVDD and VDD which are fixed at 1 2 V on the development board Refer to the Pin Description section of the EZ USB FX3 SuperSpeed USB Controller datasheet www cypress com go CYUSB301X for details on configuring th
42. in Jumper J5 This jumper is connected in series with the CTLO pin of the FX3 The CTLO pin is used as a chip select signal for the onboard SRAM external to FX3 J5 must be inserted for applications that use the SRAM It is recommended that you deselect the SRAM by removing J5 when the SRAM is not used Note that the SRAM operates at 3 3 V and does not support 1 8 V signaling Therefore the SRAM must be deselected if the 1 8 V interface is selected if J2 is removed then J5 should also be removed Table 3 1 summarizes the default jumper settings Table 3 1 Default Jumper Settings Jumper Jumper Ste Fuer O CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 21 Cypress IIIS Kit Operation Table 3 1 Default Jumper Settings J2 Short Power domain VIO1 VIO2 and VOIS voltages set to 3 3 V to support external 3 3 V interfaces and the onboard SRAM J3 Short Development board is powered from USB 3 0 VBUS This jumper must be in place for normal operation Boot from PC EEPROM on the development board if a valid firmware image is J4 Open present in EEPROM otherwise fall back to USB boot Note By default USBBulkSourceSink with LED Blink firmware is stored by EEPROM Deselect external SRAM 3 3 Power Mode The development board operates only in USB bus powered mode Note that an FX3 design can also be self powered but this feature is not supported in this kit 3 4 USB Control Center To explore vari
43. ing an antistatic wrist strap attached to the chassis ground any unpainted metal surface on the board when handling parts Handling Boards CYUSB3KIT 003 boards are sensitive to ESD Hold the board only by its edges After removing the board from its box place it on a grounded static free surface Use a conductive foam pad if available Do not slide the board over any surface CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 6 1 Introduction vy me CYPRESS PERFORM k 4 Cypress EZ USB FX3 FX3 is an ARM based controller designed to implement USB 3 0 peripherals USB 3 0 offers the SuperSpeed signaling rate of 5 gigabits per second which is 10 times greater than the high speed signaling rate of 480 megabits per second Because FX3 is USB 3 0 compliant in addition to operating at the new SuperSpeed data rate it can also operate at the High Speed and Full Speed USB data rates FX3 has a fully configurable General Programmable Interface GPIF Il that can interface with any processor ASIC image sensor or field programmable gate array FPGA It provides easy and glueless connectivity to popular industry interfaces such as synchronous slave FIFO asynchronous SRAM asynchronous and synchronous address data multiplexed interfaces image sensor interfaces and CompactFlash Additionally users can define proprietary interfaces using Cypress s GPIF II Designer tool w
44. ion is dropped and the OpenOCD application is terminated then you should run the external tool configuration before starting the debug session again Figure 3 32 shows the icon for External Tools Configurations The drop down list associated with this icon identifies all the external tools configurations saved with the EZ USB Suite When the external tool configu ration is run you can launch the debug session to debug the firmware Figure 3 32 External Tools Configurations Icon Debug USBBulkSourceSinkLED cyfxbulksrcsink c Cypress EZ USB aire File Edit Source Refactor Navigate Search Run Project CY Tools Window Help D arem Oo ueos e EI gn i Ex z Ge r Debug 53 Kl USBSerial OpenOcD Eo GE c USBBulkSourceSinkLED Debug Zylin Embedded de Run As of Embedded 02 06 14 10 53 AM Suspende Diena Took Configuration vi C Program Files x86 Cypress EZ USB FX3 SDH j i 5 AM Q USBSerial OpenOCD Program Ue Form pj C Program Files x86 CypressvCYUSB3KIT 003 1 0 USBSerialOpenOCDopenOCD exe SC terminated USBBulkSourceSinkLED Debug Zylin Embedded debug Native terminated Embedded GDB 02 06 14 11 27 AM Exited Exit code 0 gi terminated exit value 0 C Program Files x86 Cypress EZ USB FX3 SDE 1 3 bin arm none eabi gdb exe 0 The Debug perspective view is the best one to use for debug sessions To return to the code development perspective click the Open Perspective icon and select C C as s
45. lation Wizard 4 Accept the license agreements for the various software components and click Next Wait until the installation is complete Figure 2 5 Figure 2 5 Installation Progress Showing Individual Modules Cyinstaller for SuperSpeed Explorer K Please wait while setup installs confiqures SuperSpeed Explorer Kit on your computer Caching ag SuperSpeed Explorer Kit Installing SuperSpeed Explorer Kit Rev CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 14 p Cypress lt r ee Software Installation 2 5 Cypress Update Manager 1 When the installation is complete you have the option to run the Cypress Update Manager Figure 2 6 to ensure you have the latest Explorer Kit revision installed The Update Manager can be launched in Windows from the Start menu by choosing All Programs gt Cypress gt Cypress Update Manager Click the Check for updates button at the bottom of the Cypress Update Manager window If No Updates appear next to the FX3 SDK or SuperSpeed Explorer Kit click the Exit button If there are updates click the Update button to download and install the latest software Figure 2 6 Cypress Update Manager Cypress Update Manager detected the following installed software ge EZ USB FX3 SDK 1 3 1 Release Notes No Updates el SuperSpeed Explorer Kit Rev Release Notes No Updates No Updates Available 2 The installation creates the SuperSpeed Explorer Kit
46. m mand Prompt window 2 Choose Run As Administrator 3 In the DOS window type without quotes set devmgr show nonpresent devices 1 4 In the DOS window type without quotes start devmgmt msc This brings up the Device Man ager window 5 Inthe View menu select Show hidden devices Notice that the Ports COM amp LPT entry may have many old COM ports those that are not actually present are greyed out To eliminate the ports you are no longer using right click it and select Unin stall This will give Windows a chance to select lower COM numbers for the application CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 54 Mouser Electronics Authorized Distributor Click to View Pricing Inventory Delivery amp Lifecycle Information Cypress Semiconductor CYUSB3KIT 003
47. ment board is connected to a USB 1 1 port the blue LED LED2 stays OFF m The LED blink rate can be modified through a vendor command The firmware source USBBulkSourceSinkLED is located in the Firmware folder of the SuperSpeed Explorer Kit installation To study and modify this example import this project into the EZ USB Suite and build the firmware image see Section 2 6 on page 15 The firmware will be copied to the EZ USB Suite Workspace folder and a newly built firmware image will be available in the same path after building the project In Section 3 5 1 on page 23 the Cypress USB Control Center was used to exercise the LED functionality of this example A second Windows application streamer exe can be used to exercise the data source and sink capabilities This application is available at Install Directory NCypressNEZ USB FX3SDK 1 3 application cpp streamer x86 Release Note For Windows 7 and above the default install directory is C Program Files x86 For Windows XP the default install directory is C Program Files Before running streamer exe make sure the Cypress FX3 USB StreamerExample Device is loaded into FX3 as detailed in Section 3 5 1 on page 23 As Figure 3 11 shows select 256 as Packets per Xfer and 64 as Xfers to Queue from the drop down list available in the Streamer application m Packets per Xfer A transfer is a collection of packets for one data set A greater number of pack ets for each transfer r
48. or execution The SuperSpeed Explorer Kit supports USB boot and EC boot FX3 contains an internal ROM where the boot code resides and an internal RAM where application firmware and data are stored At power on depending on this jumper setting FX3 boots from the internal ROM and then does one of the following m f J4 is removed then FX3 copies the application firmware from the onboard 2 Mbit EC EEPROM to FX3 s internal RAM and then enumerates with the functionality defined in the application firm ware If there is no valid firmware in EEPROM or if the EEPROM is disabled or not present then FX3 enumerates as a bootloader device and enables firmware download to internal RAM through USB This method of booting is referred to as IC boot with fallback to USB The USBBulk oourceSinkLED firmware is stored in the onboard EEPROM when the SuperSpeed Explorer Kit development board leaves the Cypress factory The steps to store new firmware in EEPROM and then boot from it are explained in Section 3 5 3 on page 28 m fJ4is inserted then FX3 enumerates as a bootloader device and allows the application firmware to be loaded to internal RAM through USB This boot method is referred to as USB boot In this boot method you can download the application firmware to FX3 s RAM using a host application The steps to load firmware to FX3 s RAM using this boot method are explained in a later section The J4 jumper is labeled PMODE to correspond to the FX3 PMODEO p
49. ot directory and browse to the Firmware folder of the SuperSpeed Explorer Kit installation as shown in Figure 2 10 The default path to the firmware folder is lt Install Directory gt Cypress SuperSpeed Explorer Kit 1 0 Firmware for Windows 7 and above the default install directory is C Program Files x86 and for Windows XP the default install directory is C Program Files Select the Copy projects into workspace option so that the project folder will be copied to your Workspace folder Select the firmware application in the Projects box and click Finish Figure 2 10 Browse to Project Folder Import Projects Select a directory to search for existing Eclipse projects Select root directory Cypress SuperSpeed Explorer Kil OXFirmware O Select archive file Projects SRAM FX3 C Program Files x86 Cypress Superspeed Explorer E Select All SBBulkSourceSinkLED C Program Files x86 Cypress Superspe Deselect All Working sets Add project to working sets CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 17 SESJ Cypress PERFORM Software Installation 3 The added projects now appear in the EZ USB Suite Project Explorer Double click a project name to see the underlying components Figure 2 11 Figure 2 11 USBBulkSourceSinkLED and SRAM FX3 Projects Added to Project Explorer L Project Explorer 23 S i Die s P Binaries GU Includes gt zz Debug gt zz Release gt LG SR
50. ous FX3 boot options open Cypress s USB Control Center application by choosing Start menu All Programs gt Cypress gt Cypress USBSuite gt Control Center see Figure 3 2 Figure 3 2 USB Control Center Opening Screen r USB Control Center File Program Help m i p o 5 B URB Stat AbortPipe ResetPipe X amp B F Desertor fe CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 22 SES CYPRESS PERFORM 3 5 3 5 1 Kit Operation Alternatively the USB Control Center application can be launched by clicking the icon shown in the following figure in the EZ USB Suite application File Edit Source Refactor Navigate Search Run Project CY Tools Window Help A BeS a iz reeju amp ig G amp amp SC e Project Explorer 5 i S pen Control Center Ctrl 6 Note If you see various non Cypress devices in the left panel of the USB Control Center application select the Device Class Selection tab and deselect all check boxes except the one that says Devices served by the CyUSB3 sys driver or a derivative The following sections demonstrate how to use the USB Control Center to identify connected USB devices download FX3 code and test firmware by conducting USB transfers Boot Options As described in Section 3 2 on page 21 the SuperSpeed Explorer Kit development board supports the USB and EC boot options When the J4 jumper is removed FX3 boots from the onboard PC EEPROM if a valid firmware im
51. pment board shown in Figure 3 1 Figure 3 1 SuperSpeed Explorer Kit Development Board DEBUGGE J2 INTEGRATED The development board provides convenient access to FX3 interfaces such as GPIF Il IC SPI UART and ES The two 40 pin headers on the reverse PCB side in Figure 3 1 provide FX3 signals to connect to external boards using the GPIF Il interface Note that for convenience the headers have long pins that extend above the top side of the PCB for use as test points or attachment to mating connectors All GPIF Il signals which include a 32 bit data bus 13 control lines and a 100 MHz clock are available to connect to external devices such as FPGAs CPLDs image sensors or microcontrollers The FX3 SDK examples help you program and evaluate these interfaces The GPIF II interface supports 32 24 16 and 8 bit data modes unused GPIF II pins can alternatively serve as GPIO pins if the GPIF Il interface is not required USB Connectors The SuperSpeed Explorer Kit development board provides two USB connectors The USB 3 0 Type B receptacle brings out the FX3 USB signals This receptacle accepts either a USB 3 0 or USB 2 0 cable the other end of the cable connects to a USB host PC A USB 3 0 cable is included in the kit CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 20 Ji CYPRESS 3 2 Kit Operation Use this port to test FX3 applications that communicate with a host PC at SuperSpee
52. r USB operation CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 24 SES cypress PERFFORM Kit Operation In Figure 3 4 the development board is connected to a USB 2 0 receptacle One way to determine this is to look at the BcdUSB entry 02 10 which indicates the USB specification version under which the device enumerated USB 2 1 With this connection the blue LED LED2 on the board stays ON to indicate the USB 2 0 High Speed connection Compare Figure 3 4 with Figure 3 5 where the same development board was unplugged from the front panel USB 2 0 receptacle and plugged into a rear panel USB 3 0 receptacle on the same PC The blue LED now blinks and the BcdUSB Descriptor Info entry now reads 03 00 indicating a USB 3 0 device SuperSpeed devices also uniquely contain Binary Device Object Store BOS descriptors as shown in Figure 3 5 The same development board is now operating with SuperSpeed capability This demonstrates an important USB 3 0 FX3 feature Firmware can be written to automatically detect and support SuperSpeed or legacy USB attachments The example Cypress code shows how this can be done Figure 3 5 Same Device Different Port Now Operating as a USB 3 0 Device r USB Control Center URE Stat AbortPipe ResetPipe X amp P F LL SS eS eee est Descriptor info Data Transfers Device Class Selection DEVICE Friendly Mame Cypress FX3 USB StreamerExample Device Manufacturerz
53. r Windows 7 and above the default install directory is C Program Files x86 For Windows XP the default install directory is C Program Files CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 27 F Cypress Keen 3 9 9 PERFORM Notice that after loading the firmware from the PC the FX3 automatically disconnects from USB and immediately reappears in the USB Control Center as the device created by the code it loaded namely the Cypress FX3 USB StreamerExample Device as described previously You can confirm operation of the code using the same steps as those used to change the blink rate The only difference is that this code is loaded into the FX3 RAM from the PC instead of the EEPROM This method can be used to download and test any code you develop using the FX3 SDK Because loading into RAM is extremely fast the load and test cycles can be very short Program the EEPROM You may want to have the FX3 boot from the onboard EEPROM using the code you put into it 1 To program your own code into the EEPROM and boot directly to it at power on start the FX3 bootloader by inserting the J4 jumper and then connecting the development board to the PC Note that pressing the RESET button has the same effect as disconnecting then reconnecting to the USB As long as the J4 jumper is in place pressing the RESET button always brings the SuperSpeed Explorer Kit development board back as a code loader This allows you to loa
54. re than 115200 The debug prints in Figure 3 19 can be observed when running the USBBulkSourceSinkLED firmware on the FX3 device To obtain the debug prints available in the USBBulkSourceSinkLED project over UART follow the steps mentioned above and then perform one of the following actions a The USBBulkSourceSinkLED firmware is stored in the onboard EEPROM by default If the EEPROM still has the same firmware then remove the J4 jumper and press the FX3 reset button so the USBBulkSourceSinkLED firmware from EEPROM is loaded to the FX3 RAM b Insert the J4 jumper and follow the steps in Section 3 5 2 on page 26 to load the USBBulk SourceSinkLED firmware to the FX3 RAM using the USB boot option 35 Cypr ESS 3 2 Kit Operation Figure 3 19 UART Debug Prints When Running USBBulkSourceSinkLED Firmware Project COM9 115200baud Tera Term VT File Edit Setup Control Window Help UART debug initialized About to connect to USE host CY_U3SP_USB_EVENT_COMNECT detected 41 CuFxBulk amp Src amp 5inkfipplniInit complete Connected to Super Speed host Blinking LED2 Blue LED with OM time of 6 8065 seconds Blinking LED2 ON time changed to 8 5 seconds Value entered greater than 9 etting ON time to 4 5 seconds Blinking LED2 ON time changed to 4 5 seconds Value entered is H LED2 will remain OFF Blinking LED2 ON time changed to 4 3 seconds JTAG The JTAG interface provided by the integrated debugger suppor
55. reach the second breakpoint because the initial state of the blue LED LED2 is that it will stay on This part of the code is in an infinite loop and clicking Resume will make the debugger stop at the first and second breakpoints one after the other Use the Step Into or Step Over icons when required Note All FX3 SDK APIs should be stepped over Stepping into FX3 SDK APIs APIs are the function calls that start with CyU3P in the firmware will result in a warning message of source not available at If you encounter this message click the Step Return icon 10 To stop the debug session click the Terminate icon see Figure 3 28 When the debug session is terminated it can be launched again with the Debug Configurations icon shown in Figure 3 31 Be sure to reset FX3 before loading the debug configuration again Clicking the drop down arrow of the Debug Configurations icon will display all the debug configurations available You can select the desired debug configuration from the drop down list Figure 3 31 Debug Configurations Icon 8 Debug USBBulkSourceSinkLED cyfx ink c Cypress EZ USB File Edit Source Refactor Navigate Search Run Project CY Tools Window Help St HEET e do amp Bos4 i4eihH 9 9c St a E Debug m Sas l USBBulkSourceSinkLED Debug L Ze 4 SC USBBulkSourceSinkLED Debug Zylin Debug As Embedded GDB 02 06 14 10 53 4 Debug
56. reign 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
57. ress Eclipse projects Accept the default path of C NUsersN username Cypress Workspace You may want to select Use this as the default and do not ask again to skip this message every time you start the EZ USB Suite You can create more workspaces by choosing File Switch Workspace Other In this way you can define different workspaces for different projects An empty EZ USB Suite Workbench appears as shown in Figure 2 8 Figure 2 8 Empty EZ USB Suite Workbench File Edit Souree Refactor Mavigate Search Bum Project CY Took Windes Help me r r XA v 0 Q we rer m Gee Water Espiar Zi D EL TEE A JE Problems 5X 2 xm Tacks DI Console 71 Prapenties p oo T items Desceriptien a Resource Path Lncatinn Type Importing a Project To import an Eclipse project from any path follow these steps 1 Inthe EZ USB Suite choose File gt Import gt General gt Existing Projects into Workspace Figure 2 9 Click Next CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 16 I e Zeg CYPRESS Software Installation PERFORM Figure 2 9 Import an Eclipse Project Select Create new projects from an archive file or director Select an import source type filter text A General Ii Archive File ES Existing Projects into Workspace L 1 File System El Preferences gt Em C C gt gt CVS gt Ge Git 2 Click the Browse button to Select ro
58. se radio interference In such cases take adequate preventive measures Also do not use this board near any medical equipment or RF devices Attaching additional wiring to this product or modifying the product operation from the factory default may affect its performance and cause interference with other apparatus in the immediate vicinity If such interference is detected suitable mitigating measures must be taken The CYUSBSKIT 003 SuperSpeed Explorer contains electrostatic discharge ESD sensitive devices Electrostatic charges readily accumulate on the human body and any equipment and can discharge without detection Permanent damage may occur on devices subjected to high energy discharges Cypress recommends proper ESD precautions to avoid performance degradation or loss of functionality Store unused CYUSBSKIT 003 SuperSpeed Explorer boards in the protective shipping package End of Life Product Recycling This kit has an end of life cycle five years from the year of manufacturing mentioned on the back of the box Contact your nearest recycler to discard the kit CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 5 A Cypress PERF OR M Safety Information General Safety Instructions ESD Protection ESD can damage boards and associated components Cypress recommends that you perform procedures only at an ESD workstation If an ESD workstation is not available use appropriate ESD protection by wear
59. see Figure A 1 when the J4 jumper is inserted before connecting the board to the computer The FX3 device belongs to the WestBridge family of Cypress s USB 3 0 controllers Therefore when there are no drivers installed and there is no valid firmware running the FX3 device displays the entry WestBridge in the Device Manager When the J4 jumper is not inserted that is when FX3 boots from PC and there is a valid firm ware running in FX3 s RAM FX3 enumerates with the string descriptors provided in the firmware In the USBBulkSourceSinkLED firmware which is provided in the EEPROM by default FX3 enu merates with the string descriptor FX3 when no drivers are installed The USB Serial device enumerates with the entry USB Serial Dual Channel Figure A 1 FX3 Device Entry in Windows Device Manager File Action View Help e m E El E NG b Monitors A EF Network adapters E tp Cisco Systems VPN Adapter for 64 bit Windows amp Intel R 825 9LM Gigabit Network Connection amp Intel R Centrino R Advanced M 6205 EK Microsoft Virtual WiFi Miniport Adapter li Microsoft Virtual WiFi Miniport Adapter 2 5 amp VirtualBox Host Only Ethernet Adapter T Us Other devices o fg WestBridge b fi Processors b DP Security Devices b JE SM Driver b amp Sound video and game controllers p lll System devices O akl l c a m He n CYUSBS3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 52 SES cypre
60. ss PERFORM 3 Right click on the FX3 or USB Serial device entry to verify the VID PID of the device Choose Properties gt Details Select Hardware Ids and observe if the VID PID for the WestBridge entry is OX04B4 0x00F3 as shown in Figure A 2 Figure A 2 Default FX3 Bootloader VID PID Property Value USBYVID 04B4 amp PID 00F3 amp REV 0100 USBIVID 04B4 amp PID 00F3 4 Right click on the FX3 or USB Serial device entry and select Browse my computer for driver software Provide the location of drivers in the field Search for driver software in the location Note The drivers are located in the path lt Install Directory gt Cypress SuperSpeed Explorer Kit 1 0 Driver bin Provide the complete path depending on the version of Windows OS For Windows 7 and above the default install directory is C Program Files x86 For Windows XP the default install directory is C Program Files For example ona 64 bit Windows 7 machine the default location of driver is C Program Files x86 Cypress SuperSpeed Explorer Kit 1 0 Driver bin Win7 x64 5 The Device Manager window should remove the device entry and identify the same entry with the friendly name provided in the inffile for the particular VID PID combination For example when the J4 jumper is inserted the SuperSpeed Explorer Kit development board enumerates with the string WestBridge and VID PID 0x04B4 0x00F3 and after driver installation this entry appears as Cypress FX3 U
61. st delay 200 jtag ntrst delay 200 adapter speed 1000 kHz trst and srst srst_pulls_trst srst gates jtag trst push pull srst open drain connect deassert srst RCLK adaptive adapter speed 1800 kHz Info clock speed 1000 kHz info JTAG tap fx3 cpu tap device found 0x07926069 mfg 0x034 part 0x7926 ver 0x0 Info Embedded ICE version 6 Info fx3 cpu hardware has 2 breakpoint watchpoint units Follow these steps to create a debug configuration for the project Because individual projects require individual debug configurations this procedure must be done once for every project To create a debug configuration for a project make sure to import the firmware project into the workspace and build the project if not already done Then follow these steps 1 Select the desired project in the Project Explorer then go to Run Debug Configurations as shown in Figure 3 22 CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 38 CYPRESS KU ODE PERFORM Figure 3 22 Generating Debug Configuration in EZ USB Suite C C Cypress EZ USB Suite File Edit Source Refactor Navigate Search Run Project CY Tools Window Help D dm e gg Run T ES Project Explorer 2 x m j zs B Run History i USBBulkSourceSinkLED Hs ug Binaries Run Configurations Includes E Debug Debug History Release Debug As S cyfx gcc startup S Debug Configurations s Le cyfxbulkdscr c
62. terface Manufacturer Cypress Product West Bridge SerialNumber 000000004BE Configurations 1 MaxPacket Size 64 VendorlD 04 B4 Product D 00 F3 Class 00h SubClass 00h Protocel 00h BedDevice 01 00 BedUSB 02 00 zCONFIGURATION L jon 0 Configuration Value 1 Interfaces 1 Descriptor Type 2 DescriptorLength 9 TotalLength 18 MaxPower 100 lt INTERFACE gt Interface 0 Interface Number 0 AltSetting 0 Class FFh Endpoints 0 Descriptor Type 4 DescriptorLength 9 a INTERFACE Note The FX3 bootloader operates at high speed USB 2 0 even if connected to a USB 3 0 port Therefore it appears as a USB 2 0 device seen by BcdSUB 02 00 and no BOS SuperSpeed descriptor 2 When the FX3 enumerates as a bootloader device it can be used to download code into internal RAM or to program the onboard EEPROM with custom code To download and execute code from the FX3 internal RAM choose Program gt FX3 gt RAM as shown in Figure 3 8 Figure 3 8 Programming FX3 RAM ies o DC EEPROM i trol endpoi EXE GL Interface D SPI FLASH 3 A pop up window asks for a file to download Navigate to the same example firmware application available in the path this is the same firmware stored in the EEPROM when the SuperSpeed Explorer Kit development board leaves the Cypress factory at Install Directory gt Cypress SuperSpeed Explorer Kit 1 0 Firmware USBBulk SourceSinkLED Debug Note Fo
63. terfaces One of the interfaces will be COM port You can verify the entry in the Device Manager Figure 3 16 Figure 3 16 USB Serial IC Enumerating as COM Port y Device Manager II enin Hle Action View Help JA Mice and other pointing devices Ka Monitors gt Sr Network adapters a Y Ports COM amp LPT l ff USB Serial Port COM D Processors DO Security Devices You can use any standard UART communication terminal such as Tera Term to display the mes sages transmitted over the UART Note Some PC terminal applications put an upper limit on COM port choices for example offer ing support only up to COM If your USB serial port has a COM number that is too high for your PC terminal app see Section A 2 on page 54 for a method to remove inactive COM port assign ments to free up the lower numbered COM ports 2 When the COM port entry is verified in the Windows Device Manager open Tera Term or any other standard UART communication terminal select the USB Serial Port COM and click OK as shown in Figure 3 18 Note The Tera Term application is known to have problems of data loss at very low baud rates 1200 and below with the integrated debugger when larger blocks of data are received or trans mitted over UART You can use other standard COM port terminals such as HyperTerminal or TestView if you encounter such data loss issue with the Tera Term application CYUSBSKIT 003 SuperSpeed Explorer Kit
64. test USB ports on a PC where the USB operating speed is not always obvious For example some desktop PCs have the telltale blue plastic inserts which are supposed to indicate USB 3 0 in both front and rear USB receptacles Nevertheless the front panel receptacles often operate only at a USB 2 0 rate 480 Mbps 4 Take a look at the USB Control Center It should appear as shown in Figure 3 4 The USB Control Center detects the development board which is named Cypress FX3 USB StreamerExample Device This appears as the heading in a device tree in the left panel Figure 3 4 FX3 Board Connected to a USB 2 0 Port Friendly Mame Cypress FX3 USB StreamerExample Device Manufacturerz Cypress Altemate Setting D Product FX3 Bulk out endpoint O01 SerialNumber Configurations 1 MaxPacketSize 64 VendorlD 04 B4 ProductID W F1 Qass 00h SubClass 00h Protocol 00h Bed Device 00 QU EI INTERFACE Interface 0 Interface Number 0 AltSetting 0 Class FFh lt ENDPOINT Programming Succeeded With the Descriptor Info tab selected expand the device tree nodes and click on the various components Device Configuration Interface and so on Notice that the descriptor information changes according to what is highlighted in the device tree This illustrates the context sensitive nature of the USB Control Center you should select an item in the device tree before conducting a particula
65. the Eclipse integrated development environ ment IDE A prerequisite for using the SuperSpeed Explorer Kit is to download and install the FX3 Software Development Kit www cypress com go FX3SDk This package installs the EZ USB Suite CYUSB3KIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 7 e A CYPRESS PERF OR M 1 2 Introduction and ARM GCC toolchain a firmware library with example projects and the Cypress USB Suite including a Windows driver and sample Microsoft Visual Studio applications After installation the Cypress Update Manager ensures that all modules are up to date SuperSpeed Explorer Kit Installer The SuperSpeed Explorer Kit www cypress com go SuperSpeedExplorerKit installer package installs documentation such as user guide quick start guide and release notes hardware files such as schematic PCB layout and gerber and firmware examples USBBulkSourceSinkLED and SHAM FX3 The SuperSpeed Explorer Kit installer also includes Windows drivers for FX3 and soft ware for JTAG debugging including an OpenOCD executable and configuration file to use the CY7C65215 USB Serial Dual Channel Bridge with CapSense and BCD www cypress com go CY7C65215 on the SuperSpeed Explorer Kit development board as an integrated debugger for FX3 Tools Not Included m Microsoft Visual C or C software required for editing and building the USB PC application source code Free Visual Studio Express editions are
66. ton The LED blinks with a 1 second period and the ON time corresponding to the data you enter times 100 milliseconds Entries greater than nine LED ON for 900 ms blink at a fixed 500 ms ON time Note Make sure there are no spaces before the number you type into the Data to send Hex text box Figure 3 6 Using the USB Control Center to Set the FX3 LED Blink Rate Data to send Hex PktMode wValue 0000 windex 0000 CONTROL OUT transfer gt goog O CONTROL OUT transfer completed Programming Succeeded 3 5 2 Boot as a USB Loader To demonstrate the FX3 operation as a USB bootloader follow these instructions 1 Unplug the development board insert the J4 jumper and reattach the development board to the PC In USB boot mode FX3 enumerates as a high speed bootloader using Vendor ID VID 04B4 and Product ID PIDZOxOOF3 FX3 identifies itself in the USB Control Center as the Cypress FX3 Bootloader Device as shown in Figure 3 7 It may take several seconds for this device entry to appear CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 26 SES cypress PERFORM Kit Operation Figure 3 7 FX3 as a USB Bootloader USB Control Center File Program Help e IL Lo z dal URB Stat AbortPipe ResetPipe X amp B IE Cypress FX3 USB BootLoader Device Descriptor Info El Configuration 1 prc DEVICE E UNUM FiendlyName Cypress FX3 USB BootLoader Device D In
67. ts the OpenJTAG protocol and uses the OpenOCD demon tool on the host to conduct a debugging session All the required files for JTAG debugging are provided with the SuperSpeed Explorer Kit installation and are available in the following default path after installation lt Install Directory gt Cypress SuperSpeed Explorer KitN1 0NUSBSerialOpenOCD Note For Windows 7 and above the default install directory is C Program Files x86 For Windows XP the default install directory is C Program Files The OpenOCD demon tool is tailored to work with the integrated debugger The OpenOCD executable provided with the SuperSpeed Explorer Kit setup is generated by patching OpenOCD 0 7 0 http openocd sourceforge net and then compiling to make it work with the integrated debugger provided on the development board The configuration file arm926ejs FX3 cfg is also provided as required by OpenOCD to identify the USB Serial IC as a JTAG debugger and FX3 as a target Follow these steps to debug the FX3 firmware using the onboard USB Serial IC as a JTAG debugger Hardware Setup 1 Insert the J4 jumper and connect the development board USB 3 0 connector J1 to your computer using the USB 3 0 cable 2 Connect the development board to your computer using a micro USB cable through the USB 2 0 microconnector J8 Here the USB Serial IC CY7C65215 acts as a USB JTAG device 3 Wait for the USB Serial IC to enumerate and install the Cypress driver automaticall
68. ulkSrcSinkApplnDebugInit CyU3PDebugPrint 1 UART debug initialized r n Initialize the application CyFxBulkSrcSinkApplnInit for eh LED toggling function start if on time 8 CyU3PGpiosetValue LED GPIO CyFalse i oos CyU3PThreadSleep on time if off time 6 CyU3PGpioSetValue LED GPIO CyTrue CyU3PThreadSleep off time LED toggling function end 8 After the debugger stops at main click Resume The debugger stops at the first breakpoint as shown in Figure 3 30 This line of the firmware switches the blue LED LED2 ON The second breakpoint is applied at the line of firmware that switches the blue LED LED2 OFF CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 43 a SES cypress ee Kit Operation Figure 3 30 Debugger Stops at First Breakpoint File Edit Source Refactor Navigate Search Bun Project CY Took Window Help ri iiim me i 0 mo e Ae Fehler Se eero m FE Debug e E Debug H pto L gt ES am bb te Vanables zi e Bo Breskpoinis MI Regesten B Modules LB EI Er Dip 2 aP Thread 1 Suspended Breabkoeant hit Name Value 3Bulk amp reSinkAppThread Entry cyfebullezrzsink c B12 elDO040he t input 2 dx thread shell entre tv thread shell entre ce 21 elie 1 symbhel i mot available oe po ChPregram Files sBEJCypress ET USB XS SORI TUhimarm nane eabi gdh eve 02 06 14 10654 AM D Se Outline E Disass
69. ures Click the File icon and then click Open Times New Roman Displays an equation 24224 Text in gray boxes Describes cautions or unique functionality of the product 1 4 Acronyms File Open The following table lists the acronyms used in this kit guide Bron E feet rain race eom DomwnWonpai Gm tere pg edema gp Wiasgnipmeso DW DeeomenKi pp E e tgp E Eug e R8 ero emi CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 9 Sa P EJ CYPRESS 1 5 Introduction Acronym Weaning om E e pg e e e e py ie pp Pedo SOK SofwaedeeopmHNRE Sg ehpephraiefae Us 0 mms 000000000 Document History PDF Creation Origin of p 07 10 2014 NIKL Initial version of kit user Initial version of kit user guide A 08 01 2014 NIKL Updated links Minor content edits throughout the document CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 10 2 Software Installation WW SES cypress PERFORM This chapter guides you through the installation of the FX3 SDK for the Windows and Linux environ ments and the SuperSpeed Explorer Kit setup for the Windows environment Note The SuperSpeed Explorer Kit Quick Start Guide packaged with the kit box specifies to down load and install the SuperSpeed Explorer Kit Setup as the first step If t
70. y If the driver does not install automatically follow the steps in Section A 1 1 on page 52 to manually install the driver After driver installation the USB Serial interfaces can be identified as m USB Serial Port COMx This interface acts as an UART interface m USB Serial Dual Channel Vendor MFG This interface is used to configure the USB Serial IC m USB Serial Dual Channel Vendor 1 This interface acts as a JTAG interface Software Setup 1 Open the EZ USB Sulite and highlight the USBBulkSourceSinkLED project you loaded and compiled in Section 3 6 1 on page 29 2 Create an external tool configuration for the debugger In the EZ USB Suite choose Run External Tools External Tools Configurations Double click Program A new run configuration opens Give the configuration a name and fill in the fields as follows and as shown in Figure 3 20 CYUSBSKIT 003 SuperSpeed Explorer Kit User Guide Doc 001 93186 Rev A 36 SES cypress PERFORM Kit Operation Figure 3 20 External Tool Configuration in EZ USB Suite Create manage and run configurations Run a program x Dy cus o c 7 Es Fl ze Name USBSerial_OpenOcD type filter text UE Main Vm Refresh el Build PS Environment i Common Program Location Q New configuration C Program Files x86 Cypress SuperSpeed Explorer Kit 1 0 USBSerialOpenOCD openOCD exe Browse Workspace Browse File System Working Directory C Program Files x86 C
71. ypress SuperSpeed Explorer Kit 1 O USBSerialOpenOCD Browse Workspace Browse File System Arguments Tam bes FX3 cfq Variables Filter matched 2 of 2 items V Location This field specifies the location for the OpenOCD executable openOCD exe available in the USBSerialOpenOCD folder of the SuperSpeed Explorer Kit installation For a SuperSpeed Explorer Kit installation using the default installation path copy and paste the following path in this field C Program Files x86 Cypress SuperSpeed Explorer Kit 1 0 USBSerialOpenOCD openOCD exe Working Directory This field specifies the OpenOCD working directory Use the same directory that contains the executable For a SuperSpeed Explorer Kit installation using the default installation path copy and paste the following path in this field C Program Files x86 Cypress SuperSpeed Explorer Kit 1 0 USBSerialOpenoOCD Arguments This field specifies the arguments supplied to the OpenOCD executable The file arm926ejs_FX3 cfg provided in the USBSerialOpenOCD folder of the SuperSpeed Explorer Kit installation contains the JTAG debugger and the target FX3 details as required by OpenOCD Copy and paste the following argument f arm926ejs_FX3 cfg Note When you click Run the EZ USB Suite will build the entire workspace before launching the External Tool configuration To eliminate this step you can uncheck the Build before launch option in the Build tab CYU

CYUSB3KIT-003 SUPERSPEED EXPLORER KIT USER GUIDE

Contents

Download Pdf Manuals

Related Search

Related Contents