Cypress EZ-USB FX3 CYUSB3KIT-001 Manual de usuario

CYUSB3KIT-001

EZ-USB®FX3™ Development Kit Guide

Doc. #: 001-70237 Rev. *C

Cypress Semiconductor

198 Champion Court

San Jose, CA 95134-1709

Phone (USA): +1.800.858.1810

Phone (Intnl): +1.408.943.2600

http://www.cypress.com

Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 2

Copyrights

Cypress Semiconductor Corporation assumes no responsibility for the use of any circuitry other than circuitry embodied in a

Cypress product. Nor does it convey or imply any license under patent or other rights. Cypress products are not warranted

nor intended to be used for medical, life support, life saving, critical control or safety applications, unless pursuant to an

express written agreement with Cypress. Furthermore, Cypress does not authorize its products for use as critical components

in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user.

The inclusion of Cypress products in life-support systems application implies that the manufacturer assumes all risk of such

use and in doing so indemnifies Cypress against all charges.

Any Source Code (software and/or firmware) is owned by Cypress Semiconductor Corporation (Cypress) and is protected by

and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty

provisions. Cypress hereby grants to licensee a personal, non-exclusive, non-transferable license to copy, use, modify, create

derivative works of, and compile the Cypress Source Code and derivative works for the sole purpose of creating custom soft-

ware and or firmware in support of licensee product to be used only in conjunction with a Cypress integrated circuit as speci-

fied in the applicable agreement. Any reproduction, modification, translation, compilation, or representation of this Source

Code except as specified above is prohibited without the express written permission of Cypress.

Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATE-

RIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

PARTICULAR PURPOSE. Cypress reserves the right to make changes without further notice to the materials described

herein. Cypress does not assume any liability arising out of the application or use of any product or circuit described herein.

Cypress does not authorize its products for use as critical components in life-support systems where a malfunction or failure

may reasonably be expected to result in significant injury to the user. The inclusion of Cypress’ product in a life-support sys-

tems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all

charges.

Use may be limited by and subject to the applicable Cypress software license agreement.

EZ-USB®is a registered trademark and EZ-USB FX3 is a trademark of Cypress Semiconductor Corp. All other 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 Data Sheets. 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.

Downloaded from Arrow.com.Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 3

Contents

1. Introduction 5

1.1 Kit Contents.................................................................................................................5

1.1.1 FX3 Software ...................................................................................................5

1.1.2 Tools Not Included............................................................................................5

1.1.3 Other Suggested Tools.....................................................................................6

1.2 Additional Learning Resources....................................................................................6

1.3 Document History ........................................................................................................6

1.4 Documentation Conventions........................................................................................6

1.5 Abbreviations...............................................................................................................7

2. Getting Started 8

2.1 FX3 DVK Software Installation ....................................................................................8

2.2 FX3 SDK Installation..................................................................................................12

2.3 Rolling Back to a Previous Version of FX3 SDK........................................................13

2.4 FX3 SDK Installation on Linux OS.............................................................................13

2.5 Eclipse IDE Quick Tour..............................................................................................14

2.5.1 Start Eclipse...................................................................................................14

2.5.2 Import a Project..............................................................................................15

2.5.3 Tweak Eclipse IDE Settings ...........................................................................17

2.6 Example 1: Blinking LED and push button ................................................................18

2.6.1 FX3 Firmware Download and Debug Methods..............................................20

2.6.2 Code Structure...............................................................................................33

2.7 Importing All of the Cypress Examples......................................................................34

3. Kit Operation 35

3.1 Default Jumper Settings on DVK Board ....................................................................35

3.2 Bus-Power Mode.......................................................................................................36

3.3 Self-Power Mode.......................................................................................................36

3.4 First Time USB Enumeration.....................................................................................38

3.4.1 Manual Installation of Cypress Driver ............................................................39

3.5 Boot Options..............................................................................................................41

3.6 USB Boot...................................................................................................................43

3.6.1 Download Firmware Image to FX3 RAM........................................................43

3.7 I2C Boot.....................................................................................................................45

3.7.1 Download Firmware Image to I2C EEPROM.................................................45

3.7.2 Booting from I2C EEPROM............................................................................48

3.7.3 Choosing the Correct I2C EEPROM Configuration........................................48

3.8 SPI Boot.....................................................................................................................50

3.8.1 Download Firmware Image to SPI Flash........................................................50

3.8.2 Booting from SPI Flash..................................................................................53

3.9 ADMUX Boot .............................................................................................................54

3.10 USB 3.0 Enumeration................................................................................................54

Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 4

Contents

3.11 Example 2: Loopback of Data over Bulk Endpoints...................................................55

3.12 Modify the Bulkloop Firmware Example ....................................................................57

3.13 Example 3: Measurement of Throughput Using USB 3.0 Bulk Transfers..................62

4. Hardware 65

4.1 Power Supply.............................................................................................................65

4.2 USB Receptacle ........................................................................................................66

4.3 Clocking Mechanism for FX3.....................................................................................67

4.4 GPIF II Connector......................................................................................................69

4.4.1 Interconnecting to the GPIF II Connector.......................................................73

4.4.2 FX3 DVK Interconnect Boards.......................................................................76

4.5 Reset Circuit ..............................................................................................................76

4.6 Serial Interfaces.........................................................................................................77

4.6.1 I2C Interface...................................................................................................77

4.6.2 I2S..................................................................................................................77

4.6.3 SPI and UART................................................................................................77

4.6.4 JTAG ..............................................................................................................80

A. Appendix - Troubleshooting 81

A.1 Self-Power Mode.......................................................................................................81

A.2 Bus-Power Mode.......................................................................................................81

A.3 USB 2.0 Enumeration................................................................................................82

A.4 USB Driver Installation...............................................................................................82

A.5 USB Boot...................................................................................................................83

A.6 I2C Boot.....................................................................................................................84

A.7 SPI Boot.....................................................................................................................84

A.8 USB3.0 Enumeration.................................................................................................85

B. Appendix - PCB Layout 86

B.1 Assembly Top............................................................................................................86

B.2 Assembly Bottom.......................................................................................................87

Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 5

1. Introduction

The Cypress EZ-USB®FX3™ Development Kit (DVK) is a combination of hardware, software, and

documentation that enables customers to evaluate the FX3 device. This document describes how to

install the software related to the FX3 DVK and operate the DVK board. A simple project to blink an

LED helps verify correct installation and operation of the integrated development environment (IDE).

The guide introduces different types of firmware download and debug methods with detailed

instructions on how to use them. Two more example projects (USBBulkLoopAuto on page 55 and

USBBulkSourceSink on page 62) serve to explain the use of software host applications provided for

FX3. This document also briefly explains different hardware interfaces available on the DVK board.

In addition, Appendix A provides a troubleshooting guide, which helps to isolate the root cause of

errors while operating the DVK board along with a corresponding solution.

1.1 Kit Contents

The Cypress EZ-USB FX3 DVK includes the following:

■Development kit board

■USB 3.0 A to Micro B cable

■Quick Start Guide

■5-V AC-DC adapter

Visit http://www.cypress.com/shop 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 FX3 Software

■FX3 Development Kit (DVK) Installer: It installs documentation, such as user guide and release

notes, and DVK hardware files, such as schematic, PCB Layout, and Gerber.

■FX3 Software Development Kit (SDK) Installer: It installs the Eclipse IDE and GCC tool chain, a

firmware library with code samples, and a Cypress USB suite including a Windows driver and

sample Visual Studio applications. After installation, a Cypress Update Manager insures that all

modules are up to date.

1.1.2 Tools Not Included

■Microsoft Visual C++ and C# software required for editing and building USB PC application

source code. Free Visual Studio Express editions are available on the Microsoft web site.

■USB 3.0 capable PC host: The FX3 DVK firmware examples can work in either USB 2.0 or USB

3.0 speeds.To achieve maximum performance with FX3 hardware, use a PC with USB 3.0 host

controller ports.

Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 6

Introduction

1.1.3 Other Suggested Tools

You can use the following USB protocol analyzers to analyze the traffic between the PC host and the

FX3 device.

■Hardware analyzers

❐Ellisys USB Explorer 280

❐Lecroy USB Voyager M3i

❐Beagle USB 5000 SuperSpeed Protocol Analyzer

■Software protocol analyzers

❐SourceQuest SourceUSB

❐SysNucleus USBTrace

1.2 Additional Learning Resources

Visit http://www.cypress.com/fx3 for additional learning resources in the form of datasheets, a

technical reference manual, and application notes.

1.3 Document History

1.4 Documentation Conventions

Revision PDF Creation

Date Origin of

Change Description of Change

** 06/23/2011 MRKA Initial version of kit guide

*A 08/11/2011 MRKA Updated figures and table in section 2.1.4; added section 2.1.4.1.

Updated Table 2-3 and Figure 2-11. Added Figure 2-12.

*B 12/22/2012 NMMA Updated Getting Started chapter.

Added the Hardware chapter.

Added the Appendix chapter.

*C 03/30/2014 RSKV Explained three firmware example projects.

Added information on debugging using UART and JTAG.

Added information on the GPIF II interconnect boards.

Table 1-1. Document Conventions for Guides

Convention Usage

Courier New Displays file locations, user entered text, and source code:

C:\ ...cd\icc\

Italics Displays file names and reference documentation:

Read about the sourcefile.hex file in the PSoC Designer User Guide.

[Bracketed, Bold]Displays keyboard commands in procedures:

[Enter] or [Ctrl] [C]

File > Open Represents menu paths: File > Open > New Project

Bold Displays commands, menu paths, and icon names in procedures:

Click the File icon and then click Open.

Times New Roman Displays an equation: 2 + 2 = 4

Text in gray boxes Describes cautions or unique functionality of the product.

Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 7

Introduction

1.5 Abbreviations

Table 1-2. List of Abbreviations

Abbreviation Meaning

AC Alternating Current

ADMUX Address Data Multiplexing

ASIC Application-Specific Integrated Circuit

COM port Communication Port

CTS UART Clear To Send

DC Direct Current

DSP Digital Signal Processor

DVK Development Kit

EEPROM Electrically Erasable Programmable Read-only memory

EP Endpoint

ESD Electrostatic discharge

FMC FPGA Mezzanine Card

FPGA Field-Programmable Gate Array

GCC GNU Compiler Collection

GDB GNU Debugger

GPIF General Programmable Interface

GPIO General Purpose Input/Output

HSMC High Speed Mezzanine Card

I2C Inter-integrated circuit

I2SInter-IC Sound

IDE Integrated Development Environment

KB Kilobyte

LED Light-emitting diode

MB Mega Byte

OS Operating System

OTG USB On-The-Go

PC Personal computer

PHY Physical layer

PID Product ID

RTS UART Ready To Send

SCL I2C Serial Clock

SDA I2C Data

SDK Software Development Kit

SPI Serial Peripheral Interface

USB Universal Serial Bus

USB-IF Universal Serial Bus Implementers Forum

VID Vendor ID

Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 8

2. Getting Started

This chapter guides you through the installation of the Windows versions of the FX3 DVK and FX3

Software Development Kit (SDK). After installing the Eclipse-based tools, a simple example confirms

that the installation is correct and introduces the Eclipse system.

2.1 FX3 DVK Software Installation

To install the kit software, follow these steps:

1. Download the latest FX3 DVK software from EZ-USB FX3 Development Kit page, which contains

the kit hardware files, Kit documents, FX3 manuals, guides and SDK for Windows and Linux. If

your browser does not ask to run the downloaded file, locate the FX3DVKSetup.exe file in your

download folder and double-click it to start the Installer (Figure 2-1).

Figure 2-1. FX3 DVK Installer Screen

Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.Downloaded from Arrow.com.

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 9

Getting Started

2. Select the required Installation Type and click the Next button to start the Installation Wizard

(Figure 2-2). For the first time installation it is recommended to Installation Type as Typical.

Figure 2-2. Installation Wizard

CYUSB3KIT-001 EZ-USB FX3 Development Kit Guide, Doc. #: 001-70237 Rev. *C 10

Getting Started

3. Accept the license agreements for the various software components and click Next and wait till

the installation is complete.

Figure 2-3. Installation Progress Showing Individual Modules

Tabla de contenidos

Otros manuales de Microcontrolador de Cypress

Cypress

Cypress CY8CKIT-030 Manual de usuario

Cypress

Cypress FM4 Series Manual de usuario

Cypress

Cypress CY4607 HX2VL Manual de usuario

Cypress

Cypress enCoRe III CY3664-EXT Manual de instrucciones

Cypress

Cypress S6E1C1 Series Manual del propietario

Cypress

Cypress FM4-U120-9B560 Manual de usuario

Cypress

Cypress CY3643 Manual de usuario

Cypress

Cypress MB96640 Series Manual de usuario

Cypress

Cypress PSoC 3 Manual de usuario

Cypress

Cypress CY3280-CPM1 Manual de usuario

Cypress

Cypress CY14NVSRAMKIT-001 Manual de usuario

Cypress

Cypress WirelessUSB CY3635 N:1 Manual de usuario

Cypress

Cypress MB95580H Series Manual de usuario

Cypress

Cypress PSOC 3 FIRSTTOUCH STARTER KIT Manual de usuario

Cypress

Cypress MB9BF564K Manual de usuario

Cypress

Cypress CY8CKIT-042 Manual de usuario

Cypress

Cypress CY8CKIT-042-BLE-A Manual de usuario

Cypress

Cypress CY8CKIT-046 Manual de usuario

Cypress

Cypress CapSense CY8CMBR2010 Guía

Cypress

Cypress CY8CPROTO-062S3-4343W Manual de usuario

Cypress

Cypress MB2146-301A-E Manual de usuario

Cypress

Cypress CY8CKIT-042-BLE Manual de usuario

Cypress

Cypress FR81S CY91F52 Series Instrucciones de funcionamiento

Cypress

Cypress Traveo S6J3310 Series Manual de usuario

Manuales populares de Microcontrolador de otras marcas

AMS

AMS AS7261 Demo Kit Manual de usuario

Novatek

Novatek NT6861 Manual de usuario

Espressif Systems

Espressif Systems ESP8266 SDK Guía de configuración

Nuvoton

Nuvoton ISD61S00 ChipCorder Guía

STMicrolectronics

STMicrolectronics ST7 Assembler Linker Manual de usuario

Texas Instruments

Texas Instruments Chipcon CC2420DK Manual de usuario

Lantronix

Lantronix Intrinsyc Open-Q 865XR SOM Manual de usuario

NEC

NEC 78GK0S/K 1+ Series Instrucciones de instalación y funcionamiento

Mikroe

Mikroe SEMITECH N-PLC Click Instrucciones de instalación y funcionamiento

Intel

Intel Agilex Manual de usuario

DIGITAL-LOGIC

DIGITAL-LOGIC MICROSPACE Manual de usuario

Texas Instruments

Texas Instruments TMS320F2837 D Series Manual de usuario

CYPRES

CYPRES CY14NVSRAMKIT-001 Manual de usuario

Texas Instruments

Texas Instruments INA-DUAL-2AMP-EVM Manual de usuario

Espressif Systems

Espressif Systems ESP8266EX Instrucciones de funcionamiento

Abov

Abov AC33M8128L Manual de usuario

Laird

Laird BL654PA Manual de usuario

Silicon Laboratories

Silicon Laboratories C8051F800 Manual de usuario