Cypress EZ-USB FX3 SDK User manual

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 1
Cypress EZ-USB® FX3™ SDK
Quick Start Guide
Version 1.3.1
Cypress Semiconductor
198 Champion Court
San Jose, CA 95134-1709
Phone (USA): 800.858.1810
Phone (Intl): 408.943.2600
http://www.cypress.com

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 2
Copyrights
Copyright © 2013 Cypress Semiconductor Corporation. All rights reserved.
EZ-USB, FX3, FX3S and GPIF are trademarks of Cypress Semiconductor. All other trademarks or registered trademarks
referenced herein are the property of their respective owners.
The information in this document is subject to change without notice and should not be construed as a commitment by
Cypress. While reasonable precautions have been taken, Cypress assumes no responsibility for any errors that may
appear in this document. No part of this document may be copied or reproduced in any form or by any means without the
prior written consent of Cypress. Made in the U.S.A.
Disclaimer
CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATERIAL,
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 systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies
Cypress against all charges.
License Agreement
Please read the license agreement during installation.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 3
Contents
1FX3 SDK....................................................................................................................................... 5
1.1 Device Overview.................................................................................................................. 5
1.2 FX3 SDK Overview.............................................................................................................. 6
1.3 FX3 DVK Board Overview................................................................................................... 7
2SDK Installation........................................................................................................................... 9
2.1 Components of the FX3 SDK .............................................................................................. 9
2.2 Installed Directory Structure .............................................................................................. 10
3Working with the SDK............................................................................................................... 12
3.1 Programming the FX3 device............................................................................................ 12
3.2 Building the firmware......................................................................................................... 12
3.3 Setting up the FX3 DVK Board.......................................................................................... 13
3.4 Host driver binding............................................................................................................. 13
3.5 Firmware Download........................................................................................................... 14
3.6 Testing the application....................................................................................................... 14
4Firmware Example Overview ................................................................................................... 15
4.1 USB Bulk data loopback examples ................................................................................... 15
4.2 USB Isochronous data loopback examples....................................................................... 16
4.3 USB debug example.......................................................................................................... 16
4.4 FX3S Storage Examples ................................................................................................... 16
4.5 USB Video Class example................................................................................................. 17
4.6 Slave FIFO Application examples...................................................................................... 17
4.7 Serial Interface examples.................................................................................................. 18
4.8 USB Bulk/Isochronous data source sink examples........................................................... 19
4.9 USB Bulk Streams example .............................................................................................. 19
4.10 USB enumeration example.............................................................................................. 20
4.11 Flash Programmer example............................................................................................. 20
4.12 Mass Storage Class example.......................................................................................... 20
4.13 USB Audio Class Example .............................................................................................. 20
4.14 Two Stage Booter Example ............................................................................................. 20
4.15USB host and OTG examples......................................................................................... 21
4.16 CX3 Examples................................................................................................................. 21
5FX3 Programming Guidelines.................................................................................................. 22
5.1 Device Initialization............................................................................................................ 22
5.2 Embedded Operating System ........................................................................................... 24
5.3 Memory Usage .................................................................................................................. 26
5.4 USB Device Handling........................................................................................................ 27
5.5 Support for different FX3 parts .......................................................................................... 30
5.6 Porting Applications from SDK 1.2 to SDK 1.2.1............................................................... 31

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 4
5.7 Porting Applications from SDK 1.2.1 to SDK 1.2.2............................................................ 31
5.8 Porting Applications from SDK 1.2.2 to SDK 1.2.3............................................................ 33
5.9 Porting Applications from SDK 1.2.3 to SDK 1.3............................................................... 33
5.10 Porting Applications from SDK 1.3 to SDK 1.3.1............................................................. 34
6FX3 Application Example ......................................................................................................... 35
6.1 Creating the Project........................................................................................................... 35
6.2 Application Description...................................................................................................... 38
7CX3 MIPI CSI-2 Interface .......................................................................................................... 44
7.1 Introduction to the CX3 device .......................................................................................... 44
7.2 CX3 MIPI CSI-2 interface .................................................................................................. 45
7.3 Configuring the CX3 MIPI CSI-2 Interface......................................................................... 49
7.4 Fixed function GPIF-2 interface on the CX3...................................................................... 55

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 5
1 FX3 SDK
1.1 Device Overview
Cypress EZ-USB FX3 is the next generation USB3.0 peripheral controller which is
highly integrated, flexible and enables system designers to add USB 3.0 capability
to any system.
The EZ-USB FX3S device is an extension to the FX3 device, which adds the
capability to control SD, eMMC and SDIO peripherals to the list of features
supported.
The EZ-USB CX3 controller is an extension to the EZ-USB FX3 device which adds
the ability to interface with and perform uncompressed video transfers from Image
Sensors implementing the MIPI CSI-2 interface.
Figure 1-1: EZ USB FX3 System Diagram
The FX3 and FX3S devices have a fully configurable, parallel, General
Programmable Interface called GPIF II, which can connect to any processor, ASIC,
DSP, or FPGA.
The General Programmable Interface GPIF II is an enhanced version of the GPIF
in FX2LP, Cypress‟s flagship USB2.0 product. The GPIF II Controller drives the
behavior and timing of the GPIF II Interface based on one or more user

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 6
configurable state machines. It provides an easy and glueless interface to popular
interfaces such as asynchronous SRAM, synchronous SRAM, Address Data
Multiplexed interface, parallel ATA, and can be programmed to implement most
other parallel communication protocols.
The CX3 device makes use of a fixed GPIF II configuration to interface the USB
portion of the controller with the MIPI CSI-2 interface. Therefore, the GPIF II
interface is not available for other purposes in the CX3 device.
All of these devices have an integrated USB Phy and controller along with a 32-bit
microcontroller (ARM926EJ-S) for powerful data processing and for building
custom applications. The device has 512 KB (256 KB in some cases) of on-chip
RAM that can be used for code and data storage. It has an inter-port DMA
architecture which enables data transfers at speeds greater than 400 MBps.
These devices are fully compliant to the USB 3.0 v1.0 and USB 2.0 specifications.
An integrated USB 2.0 OTG controller enables applications that need dual role
usage scenarios. The device is also compliant with the USB Battery Charging
Specification v1.1.
There are also serial peripherals such as UART, SPI, I2C, and I2S for
communicating to on board peripherals (for example the I2C interface is typically
connected to an EEPROM).
1.2 FX3 SDK Overview
Cypress delivers the complete software and firmware stack for FX3/FX3S/CX3 in
order to easily integrate all USB applications in the embedded system environment.
The software development kit comes with application examples which help
accelerate application development.
The components of the FX3 software development kit are shown in Figure 1-2.
Figure 1-3: FX3/FX3S Software Solution (SDK)

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 7
On the device side, there is the FX3 firmware stack that consists of a full fledged
API library and a comprehensive firmware framework. A well documented library of
APIs enable users to access the hardware functions of the device. The SDK also
includes application implementation examples in source form demonstrating
different usage models. Users can also develop their own application using this
firmware framework and modifying it as applicable. There is complete flexibility for
users to develop custom applications using the firmware framework. An RTOS
library is integrated with the firmware stack, allowing users to implement complex
applications requiring multiple threads of firmware execution.
A set of development tools is provided with the SDK, which includes the GPIF II
Designer and third party compiler tool-chain and IDE.
The firmware development environment will help the customer develop, build and
debug firmware applications for FX3. The third party ARM® software development
tool provides an integrated development environment with compiler, linker,
assembler and JTAG debugger. A recent build of the free GNU tool-chain for ARM
processors and an Eclipse based IDE is provided by Cypress.
The USB host side (Microsoft Windows) stack for the FX3 contains:
Cypress generic USB 3.0 driver (WDF) on Windows 7 (32/64 bit) and
Windows Vista (32/64 bit) and Windows XP (32 bit)
Convenience APIs that expose generic USB driver APIs through C++ and
C# interfaces
USB control center, a Windows utility that provides interfaces to interact with
the device at low levels such as configuring end points, data transfers etc
Bulkloop application, a user application to perform data loopback on the
Bulk endpoints.
Streamer application, a user application to perform data streaming over
Isochronous or Bulk endpoints.
1.3 FX3 DVK Board Overview
Cypress provides a FX3 DVK board that can be used for firmware and system
development using the FX3 device. The DVK board provides the means to connect
an external processor or device to the GPIF interface and to connect slave devices
to the I2C, SPI and I2S interfaces.
The FX3 DVK Board can be used to execute the firmware examples in the SDK
and also for firmware development based on the SDK. The hardware connection
and programming sections below assume the use of the FX3 DVK board.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 8
Please refer to the FX3 DVK User Guide for additional information regarding the
DVK board.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 9
2 SDK Installation
2.1 Components of the FX3 SDK
The FX3 SDK installation includes multiple components:
1. FX3 Firmware –This contains the FX3 Firmware libraries, Header files,
Example code and firmware conversion utility
2. ARM GCC –This contains the GNU Toolchain for ARM processors
3. Eclipse –The eclipse IDE with the required plug-ins
4. USB Suite –The windows host driver, C++ & C# API libraries, and the
Control center, Bulkloop & Streamer applications.
5. GPIF II Designer –Windows based tool for configuring the GPIF II port of
the FX3 device.
The FX3 SDK installer installs all of these components when the “Typical” or
“Complete” install options are chosen. They can also be selectively installed by
using the “Custom” option on the installer.
The default installation path for the FX3 SDK is:
C:\Program Files\Cypress\EZ-USB FX3 SDK\<version>, where 1.3 is the version
for this release of the SDK.
Note: On 64-bit Windows installations, the default installation path for the SDK is:
C:\Program Files (x86)\Cypress\EZ-USB FX3 SDK\<version>
The FX3 SDK also includes the following documentation:
1. FX3 Release Notes
2. FX3 Programmer‟s Manual
3. FX3 API guide
4. FX3 SDK Trouble Shooting guide
After installation, these documents can be found in the <Installation folder>\doc\
folder.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 10
2.2 Installed Directory Structure
The following figure shows the FX3 firmware related files in the FX3 SDK
installation.
Figure 2-1: FX3 SDK Installed Directory Structure

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 11
The following figure shows the USBSuite related files in the FX3 SDK installation.
C# Sample Applications
C++ Sample Applications
CyUsb3.sys driver
C# API library
C++ API library
Figure 2-2: USBSuite Installed Directory Structure

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 12
3 Working with the SDK
3.1 Programming the FX3 device
The FX3 examples can be built and run on the FX3 DVK. The following steps
describe the setup and boot process:
1. Install the components of the SDK (Firmware, Toolchain, IDE and Host
drivers) on the host machine.
2. Connect the FX3 board to the host machine and power the board up.
3. Bind the driver for the FX3 device.
4. Launch the IDE, import the example projects and build them
5. Launch the CyControl Center utility (available from USB Suite software)
6. Download the boot image to the FX3 device using the Control Center
“Download Firmware” feature.
7. The FX3 device will reboot using this new firmware.
These steps are explained in more detail in the following sections.
The UsbBulkLoopAuto example is used here to explain the steps. This example
implements a vendor specific USB 3.0 peripheral with two bulk endpoints. The
firmware application loops back any data that is sent on the OUT endpoint on the
IN endpoint.
Section 8 of the FX3 Programmers Manual describes the overall application
structure.
It is assumed that the FX3 DVK board is used to run the firmware.
Note: The CyControl utility is a Windows based utility, and the above steps assume
that a Windows Host is being used. Please refer to the CyUSB for Linux
documentation for a description of how to perform these steps on a Linux host.
3.2 Building the firmware
Each of the firmware examples in the FX3 SDK has an Eclipse project associated
with it, which can be used for building and debugging the application. The
instructions for building and running the Firmware examples using the Eclipse IDE
and GNU tool-chain are provided in detail in Section 11.2.2 of the FX3

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 13
Programmers Manual. The section details how to import the projects, configure
settings for the projects, debug and run the example using GNU debugger.
Import all of the firmware examples in the SDK into the Eclipse IDE. The example
applications are automatically built when they are imported, and generate ELF
binaries. These binaries are converted by the Eclipse projects to binary image
format using the elf2img utility. This binary image format can be programmed onto
the FX3 part. The elf2img binary conversion utility is part of the FX3 SDK
(<Installation folder>\util\elf2img). The eclipse project post build step uses the
following command for performing the conversion.
elf2img.exe –i BulkLoopAuto.elf –o BulkLoopAuto.img
Refer to the readme.txt under (<Installation folder>\util\elf2img) for more
information on the conversion tool and the command line options. Also refer to the
application note AN76405 - EZ-USB FX3 Boot Options for information about the
boot procedure and options.
3.2.1 Serial Peripheral Drivers and APIs
The drivers and APIs for the FX3 serial peripheral interfaces (I2C, I2S, SPI, UART
and GPIO) are provided with the FX3 SDK in source form. Full register
documentation for these blocks is part of the FX3 Programmer‟s Manual.
The drivers and APIs for the serial peripherals are built into a separate ARM EABI
library (cyu3lpp.a). The source code as well as the Eclipse IDE projects for building
this library can be found in the SDK under the <Installation
Folder>\firmware\lpp_source folder.
All of the FX3 application examples link with this library in addition to the FX3 API
library consisting of the drivers and APIs for the device, USB and GPIF blocks
(cyfxapi.a).
3.3 Setting up the FX3 DVK Board
The FX3 device can be configured to boot from a USB host by enumerating as a
custom device. The boot mode for the device is specified through a set of three
PMODE pins that can be controlled through some jumpers and switches on the
FX3 DVK board.
Please refer to the FX3 DVK User Guide for the jumper settings to control the
PMODE pins.
3.4 Host driver binding
The steps for installation and binding of the host drivers for different Windows
platforms are described in section 3 of the host driver help file, CyUSB.pdf,
installed as part of the USB Suite.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 14
Once the board has been connected to the host PC, the device will be seen
enumerating and asking for driver selection. For booting, the FX3 enumerates as a
USB 2.0 device with VID=0x04B4 and PID=0x00F3.
Select the “Install from a specific location” and point to the <Installation
Root>/driver/bin/<os>/<arch>/cyusb3.inf file to bind the device with the Cypress
CyUsb3.sys driver.
To bind with a new device or application with a different VID/PID pair; the
corresponding VID/PID entries must be made in the cyusb3.inf file.
3.5 Firmware Download
The CyControl center utility, which can be used to communicate with the FX3
device, is described in CyControlCenter.pdf, installed as part of the USB Suite.
Once the driver binding has been completed, open the CyControl Center (Start-
>Programs->Cypress->Cypress USBSuite->Control Center). The Cypress FX3
Device should be visible through the tool and you can look through the USB
descriptors reported by the device.
Use the Program->FX3 option on the tool to program the previously generated
BulkLoopAuto.img binary file onto the device. This download is performed directly
onto the RAM on the FX3 device.
3.6 Testing the application
Once the download is complete, a new USB device can be seen enumerating and
asking for driver selection. Repeat the driver selection process performed during
initial boot and associate the same CyUsb3.sys driver with the new device as well.
The data transfer feature of the CyControl Center can be used to verify the data
loop-back functionality.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 15
4 Firmware Example Overview
The firmware examples included in the FX3 SDK are listed below. These examples
are provided as separate Eclipse projects.
4.1 USB Bulk data loopback examples
These examples illustrate a loopback mechanism between two/three USB Bulk
Endpoints. The example comprises of Vendor Class USB enumeration descriptors
with 2/3 Bulk Endpoints. The DMA multichannel examples use 3 endpoints for the
loopback.
Following are the different types of Bulk data loopbacks provided. These examples
are provided as Eclipse projects.
1. cyfxbulklpauto: This example makes use of the DMA AUTO Channel for the
loopback between the endpoints.
2. cyfxbulklpautosig: This example makes use of the DMA AUTO Channel with
Signaling for the loopback between the endpoints.
3. cyfxbulklpmanual: This example makes use of the DMA MANUAL Channel for
the loopback between the endpoints.
4. cyfxbulklpmaninout: This example makes use of the DMA MANUAL IN + DMA
MANUAL OUT Channel for the loopback between the endpoints.
5. cyfxbulklpautomanytoone: This example makes use of the Multichannel DMA
AUTO MANY TO ONE for the loopback between endpoints.
6. cyfxbulklpautoonetomany: This example makes use of the Multichannel DMA
AUTO ONE TO MANY for the loopback between endpoints.
7. cyfxbulklpmanonetomany: This example makes use of the Multichannel DMA
MANUAL ONE TO MANY for the loopback between endpoints.
8. cyfxbulklpmanmanytoone: This example makes use of the Multichannel DMA
MANUAL MANY TO ONE for the loopback between endpoints.
9. cyfxbulklpmulticast: This example makes use of the Multichannel DMA
MULTICAST for the loopback between endpoints.
10.cyfxbulklpman_removal: This example demonstrates the use of DMA MANUAL
channels where a header and footer get removed from the data before sending

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 16
out. The data received from EP1 OUT is looped back to EP1 IN after removing
the header and footer. The removal of header and footer does not require the
copy of data.
11.cyfxbulklplowlevel: The DMAchannel is a helpful construct that allows for
simple data transfer. The low level DMAdescriptor and DMA socket APIs allow
for finer constructs. This example uses these APIs to implement a simple
bulkloop back example where a buffer of data received from EP1 OUT is looped
back to EP1 IN.
12.cyfxbulklpmandcache: FX3 device has the data cache disabled by default. The
data cache is useful when there is large amount of data modifications done by
the CPU. But enabling D-cache adds additional constraints for managing the
data cache. This example demonstrates how DMA transfers can be done with
the data cache enabled.
All the above examples are implemented to work at USB 2.0 and USB 3.0 speeds.
4.2 USB Isochronous data loopback examples
These examples illustrate a loopback mechanism between two USB Isochronous
Endpoints. The example comprises of Vendor Class USB enumeration descriptors
with 2 Isochronous Endpoints.
Following are the different types of Isochronous data loopbacks provided. These
examples are provided as Eclipse projects.
1. cyfxisolpauto: This example makes use of the DMA AUTO Channel for the
loopback between the endpoints.
2. cyfxisolpmaninout: This example makes use of the DMA MANUAL IN + DMA
MANUAL OUT Channel for the loopback between the endpoints.
The above examples are implemented to work at USB 2.0 and USB 3.0 speeds.
4.3 USB debug example
cyfxusbdebug: This example demonstrates the use of USB interrupt endpoint to log
the debug data from the FX3 device. The default debug logging in all other
examples are done through the UART. This example shows how any consumer
socket can be used to log FX3 debug data.
4.4 FX3S Storage Examples
1. FX3SMassStorage: Implementation of a USB mass storage class device using
the FX3S APIs backed with SD/eMMC storage devices. This example
demonstrates the high data rates that are achievable on the USB -> Storage
data path through the FX3S device.
2. GpifToStorage: Example that shows how to access SD/eMMC storage devices
from an external processor that connects to the FX3S device through the GPIF
port.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 17
3. FX3SFileSystem: Example that demonstrates the use of the FX3S storage API
to integrate a file system into the firmware application. The FatFs file system by
Elm Chan is used here to manage FAT volumes stored on the cards connected
to FX3S.
4. FX3SSdioUart: This example implements a USB Virtual COM port that uses a
Arasan SDIO –UART bridge chip for the UART functionality. This example
shows how the SDIO APIs can be used to transfer data between the USB host
and a SDIO peripheral.
5. FX3SRaid0: This example implements a RAID-0 disk using a pair of SD cards
or eMMC devices for storage. Access to the RAID-0 disk is provided through a
USB mass storage class (MSC) interface. This implementation provided nearly
twice the throughput of a MSC function using a single SD card or eMMC device.
4.5 USB Video Class example
1. cyfxuvcinmem: This example implements a USB Video Class Driver with the
help of the appropriate USB enumeration descriptors. With these descriptors
the FX3 device enumerates as a USB Video Class device on the USB host. The
video streaming is accomplished with the help of a DMA Manual Out channel.
Video frames are stored in contiguous memory locations as a constant array.
The streaming of these frames continuously from the device results in a video
like appearance on the USB host.
2. cyfxuvcinmem_bulk: This example demonstrates the USB video class device
stack implementation for FX3. The example is similar to the UVC example, but
uses Bulk endpoints instead of isochronous endpoints.
These examples are implemented to work at USB 2.0 and USB 3.0 speeds.
4.6 Slave FIFO Application examples
The Slave FIFO application example demonstrates data loopback between the
USB Host and the PCI host. The example comprises of two data pipes between the
USB Host and the PCI host. Data is looped back at the PCI host. The loopback is
observed on the USB host. GPIF™ - II interface is configured to implement the
Slave FIFO protocol for Sync and Async modes (16 and 32 bit configurations).
1. cyfxslaveasync: Asynchronous mode Slave FIFO example using 2 bit FIFO
address.
2. cyfxslavesync: Synchronous mode Slave FIFO example using 2 bit FIFO
address.
3. cyfxslaveasync5bit: Asynchronous mode Slave FIFO example using 5 bit FIFO
address.
4. cyfxslavesync5bit: Synchronous mode Slave FIFO example using 5 bit FIFO
address.
The above examples are implemented to work at USB 2.0 and USB 3.0 speeds.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 18
4.7 Serial Interface examples
The serial interface examples demonstrate data accesses to the Serial IOs, I2C,
SPI and UART.
4.7.1 UART examples
In the UART examples, the data is looped from the PC host back to the PC host
through the FX3 device. The loopback can be observed on the PC host. The
examples are provided for both DMA mode and Register mode of data transfers for
the UART.
1. cyfxuartlpdmamode: This example makes use of the DMA MANUAL Channel
for the loopback to the PC host over UART. The DMA buffer is 32 bytes.
2. cyfxuartlpregmode: This example loops back data one byte at a time.
3. cyfxusbuart: This example implements a CDC-ACM compliant USB to UART
bridge device using the UART port on the FX3 device.
4.7.2 I2C examples
In the I2C examples, a USB I2C data loopback is achieved over 2 USB
Isochronous endpoints through an I2C slave device. A DMA MANUAL IN and a
DMA MANUAL OUT channels are used for the Isochronous endpoints. The data is
looped back one I2C page at a time which is 64 bytes. The examples are
implemented for USB 2.0 speeds.
1. cyfxusbi2cdmamode: This example makes use of the DMA MANUAL IN and a
DMA MANUAL OUT channel for the I2C DMA access.
2. cyfxusbi2cregmode: This example reads/writes one page to the I2C device
using the register mode accesses.
4.7.3 SPI examples
In the SPI examples, a USB SPI data loopback is achieved over 2 USB
Isochronous endpoints through a SPI slave device. A DMA MANUAL IN and a DMA
MANUAL OUT channels are used for the Isochronous endpoints. The data is
looped back one page at a time which is 16 bytes. The examples are implemented
for USB 2.0 speeds.
1. cyfxusbspidmamode: This example makes use of the DMA MANUAL IN and a
DMA MANUAL OUT channel for the SPI DMA access.
2. cyfxusbspiregmode: This example reads/writes one page to the SPI device
using the register mode accesses.
3. cyfxusbspigpiomode: This example demonstrates the use of GPIO to build an
SPI master. The example read / writes data to an SPI Flash attached to the FX3
device using FX3 GPIOs.

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 19
4.7.4 I2S example
cyfxusbi2sdmamode: This example demonstrates the use of I2S APIs. The
example sends the data received on EP1 OUT to the left channel and EP2 OUT to
the right channel.
4.7.5 GPIO examples
This is a simple GPIO application example illustrating the usage of GPIO
operations with the help of an Input and an Output GPIO.
4. cyfxgpioapp: This example implements simple Set operation on the Output
GPIO and Get operation on the Input GPIO. It also implements GPIO interrupt
for the Input GPIO.
5. cyfxgpiocomplexapp: This example implements the following features:
a) A PWM output.
b) Input line which measures low time of the input signal.
c) A counter which increments on the negative edge of input signal.
4.8 USB Bulk/Isochronous data source sink examples
These examples illustrate data source and data sink mechanism with two USB
Bulk/Isochronous Endpoints. The example comprises of Vendor Class USB
enumeration descriptors with 2 Bulk/Isochrounous Endpoints. The examples are
implemented to work for USB 2.0 and USB 3.0 speeds.
1. cyfxbulksrcsink: This example makes use of the DMA MANUAL IN channel for
sinking the data received from the Bulk OUT endpoint and DMAMANUAL OUT
Channel for the sourcing the data to the Bulk IN endpoint.
2. cyfxisosrcsink: This example makes use of the DMA MANUAL IN channel for
sinking the data received from the Isochronous OUT endpoint and DMA
MANUAL OUT Channel for the sourcing the data to the Isochronous IN
endpoint.
3. cyfxisosrc: This example makes use of a DMA MANUAL OUT channel to
implement a single Isochronous IN endpoint. Multiple bandwidth settings and
vendor specific control transfers are also supported in this example.
4. cyfxgpiftousb: This example makes use of a DMA AUTO channel to
continuously stream data to a BULK IN endpoint. The data is sourced by
continuously latching data from the GPIF II data bus. As no control signals are
used, there is no need for any actual device connectivity on the GPIF II
interface when using this example. This helps identify the maximum USB
throughput through the FX3 device, when there are no firmware bottlenecks
involved.
4.9 USB Bulk Streams example
This example illustrates data source and data sink mechanism with two USB Bulk
Endpoints using the Bulk Streams. A set of Bulk Streams are defined for each of the

Cypress EZ-USB® FX3™ SDK Quick Start Guide, Version 1.3.1 20
endpoints (OUT and IN). Data source and data sink happen through these streams.
Streams are applicable to USB 3.0 speeds only. The example works similar to Bulk
source sink example (cyfxbulksrcsink) when connected to USB 2.0.
1. cyfxbulkstreams: This example makes use of the DMA MANUAL IN channel for
sinking the data received from the streams of the Bulk OUT endpoint and DMA
MANUAL OUT Channel for the sourcing the data to the streams of the Bulk IN
endpoint.
4.10 USB enumeration example
The enumeration example is an implementation of a USB bulk loop with normal
mode enumeration in FX3.
1. cyfxbulklpautoenum: The example illustrates the normal mode enumeration
mechanism provided for FX3 where all setup requests are handled by the
application. The example implements a simple bulk loop.
4.11 Flash Programmer example
This example (cyfxflashprog) illustrates the programming of I2C EEPROMS and
SPI flash devices from USB. The read / write operations are done using pre-
defined vendor commands. The utility can be used to flash the boot images to
these devices.
4.12 Mass Storage Class example
This example (cyfxmscdemo) illustrates the implementation of a USB mass storage
class (Bulk Only Transport) device using a small section of the FX3 device RAM as
the storage device. The example shows how mass storage commands can be
parsed and handled in the FX3 firmware.
4.13 USB Audio Class Example
This example creates a USB Audio Class compliant microphone device, which
streams PCM audio data stored on the SPI flash memory to the USB host. Since
the audio class does not require high bandwidth, this example works only at USB
2.0 speeds.
4.14 Two Stage Booter Example
A simple set of APIs have been provided as a separate library to implement two
stage booting. This example demonstrates the use of these APIs. Configuration
files that can be used for Real View Tool chain are also provided.