EZ-USB® FX3™ HD 720p Camera Kit Quick Start Guide Version 2.0 Cypress Semiconductor 198 Champion Court San Jose, CA 95134-1709 Phone (USA): 800.858.1810 Phone (Intnl): 408.943.2600 http://www.cypress.com Copyrights Copyrights © Cypress Semiconductor Corporation, 2011. 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 lifesupport 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 software and or firmware in support of licensee product to be used only in conjunction with a Cypress integrated circuit as specified 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 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. Use may be limited by and subject to the applicable Cypress software license agreement. EZ-USB® is a registered 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 guarantee 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. 2 EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 Contents 1. Introduction 1.1 1.2 1.3 1.4 1.5 1.6 Kit Contents .................................................................................................................5 Software.......................................................................................................................6 Minimum System Requirement....................................................................................6 Additional Learning Resources....................................................................................6 Document History ........................................................................................................7 Documentation Conventions .......................................................................................7 2. Getting Started 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 5 9 EZ-USB FX3 HD 720p Camera Kit ..............................................................................9 2.1.1 Overview ..........................................................................................................9 Configure Jumper Settings on FX3 DVK ...................................................................10 Camera Kit Assembly ................................................................................................11 Install FX3 Software Development Kit (SDK) ............................................................12 Connect Camera Kit to PC ........................................................................................13 Program the Camera Kit ............................................................................................16 Run Video Capturing Software to View Live HD 720p Video from Camera Kit .........17 Connecting the Camera Kit to USB 2.0 Port..............................................................18 EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 3 Contents 4 EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 1. Introduction The Cypress EZ-USB FX3 HD 720p Camera Kit is a combination of hardware, software, and documentation that demonstrates FX3 design for high-definition (HD) cameras. You can use this kit as an example to build your own USB 3.0 camera. The FX3 HD 720p Camera Kit consists of three boards: EZ-USB FX3 Development Board (DVK), Aptina MT9M114 Image Sensor Headboard, and Aptina Interconnect Board. This kit allows you to: 1.1 Stream uncompressed High-definition 720p (1280x720) resolution video at 30 frames per second (fps) over USB 3.0 Stream uncompressed Standard-definition VGA (640x480) resolution video at 15 frames per second (fps) over USB 2.0 Kit Contents In order to use the EZ-USB FX3 HD 720p Camera Kit, please procure the following boards and firmware example code: EZ-USB FX3 Development Board (CYUSB3KIT-001) Aptina MT9M114 Image Sensor Headboard (MT9M114EBLSTCZH ES) Sign NDA with Aptina (send request to [email protected] for expedited process) Buy from Aptina Distributors (http://www.aptina.com/how_to_buy/distributors.jsp) Aptina Interconnect Board Buy from Cypress Website (http://www.cypress.com/?rID=58321) Please contact [email protected] FX3 Image Sensor USB Video Class (UVC) Firmware Example Code The binary image is available for download from Camera Kit Web Page (http://www.cypress.com/?rID=72599) The source code is available upon request EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 5 Introduction Figure 1-1. EZ-USB FX3 HD 720p Camera Kit Boards 1.2 Software The following software is required to run the demonstration: Latest EZ-USB FX3 Software Development Kit (SDK) Debut Video Capture Software v1.69 1.3 1.4 Download from http://www.cypress.com/?rID=57990 Download from http://www.nchsoftware.com/capture/index.html Minimum System Requirement Windows 7, Vista, XP PC with USB 2.0 host or USB 3.0 host (In the absence of a USB 3.0 host, an USB 3.0 ExpressCard adapter may be used) Additional Learning Resources Visit www.cypress.com for additional learning resources in the form of data sheets, technical reference manual and application notes. 6 EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 Introduction 1.5 Document History 1.0 PDF Creation Date 12/28/2012 Origin of Change STVC 2.0 05/21/2013 STVC Revision 1.6 Description of Change Initial version of kit guide Changed document title to EZ-USB FX3 HD 720p Camera Kit Quick Start Guide, Rev. 2.0 Updated Section 1.1 Kit Contents, Aptina interconnection board is now procured by contacting [email protected]. Documentation Conventions Table 1-1. Document Conventions for Guides Convention Courier New Italics File > Open Bold Usage Displays file locations, user entered text, and source code: C:\ ...cd\icc\ Displays file names and reference documentation: Read about the sourcefile.hex file in the PSoC Designer User Guide. Represents menu paths: File > Open > New Project Displays commands, menu paths, and icon names in procedures: Click the File icon and then click Open. EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 7 Introduction 8 EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 2. 2.1 Getting Started EZ-USB FX3 HD 720p Camera Kit Figure 2-1. System Block Diagram 2.1.1 Overview In this application, FX3 interfaces to a parallel image sensor over the General Programmable Interface (GPIF II). The FX3 firmware supports the USB Video Class (UVC) and communicates with a USB 3.0 or USB 2.0 host. An application such as Debut Video Capture is used for viewing video on the PC. This application communicates directly with the UVC driver on the PC. The control commands to the image sensor are communicated by FX3 over the I2C interface. The details of the GPIFII descriptor and the firmware implementation can be found in the application note “AN75779 - Interfacing an Image Sensor to EZ-USB® FX3™ in a USB video class (UVC) Framework” EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 9 Getting Started 2.2 Configure Jumper Settings on FX3 DVK The jumper settings on the FX3 development board must be set properly to run the camera demo. Please follow the instructions below: 1. Unplug all jumpers from the FX3 DVK 2. Place the jumpers as illustrated in Figure 2-2 Figure 2-2. FX3 DVK Jumper Configuration for HD 720p Camera Kit EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 10 Getting Started 2.3 Camera Kit Assembly 1. Connect the interconnect board to the FX3 DVK via the GPIF II Samtec connector 2. Connect the Aptina image sensor headboard to the interconnect board via the 26-pin connector. The male connector is located on the back of the Aptina image sensor headboard and the female connector is on the front of the interconnect board Note: See demo video for kit assembly on http://www.cypress.com/?rID=72422. Figure 2-3. EZ-USB FX3 HD 720p Camera Kit Assembly EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 11 Getting Started 2.4 Install FX3 Software Development Kit (SDK) 1. Download the latest FX3 SDK from http://www.cypress.com/?rID=57990 2. Using the “Typical” Installation Type, complete the install wizard Figure 2-4. FX3 SDK Installation Note: The 32-bit and 64-bit drivers are located at C:\Program Files (x86)\Cypress\EZ-USB FX3 SDK\1.2\driver\bin. Figure 2-5. Default Location of the 32-bit and 64-bit Drivers EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 12 Getting Started 2.5 Connect Camera Kit to PC 1. Connect the Camera Kit to a USB 3.0 port on the PC via a USB 3.0 cable 2. Toggle the switch (SW9) on the FX3 DVK to turn it on (LEDs will light up) Figure 2-6. Toggle the Switch (SW9) to Turn on the FX3 DVK 3. New hardware will be detected and device driver software should be installed automatically. Figure 2-7. Automatic Detection and Installation of FX3 Device Driver Software EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 13 Getting Started 4. If the system is unable to locate the driver, please install the driver manually: a. Launch Device Manager, under Other devices, right click on “WestBridge” and select Update Driver Software... Figure 2-8. Manual Installation of FX3 Driver Software - Step 1 b. Choose Browse my computer for driver software Figure 2-9. Manual Installation of FX3 Driver Software - Step 2 EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 14 Getting Started c. Click Browse, locate the driver at "C:\Program Files (x86)\Cypress\EZ-USB FX3 SDK\1.2\driver\bin", then click Next Figure 2-10. Manual Installation of FX3 Driver Software - Step 3 d. Complete the installation process. Camera Kit will show up as "Cypress USB BootLoader" in Device Manager. The FX3 driver software is now installed Figure 2-11. Manual Installation of FX3 Driver Software - Step 4 EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 15 Getting Started 2.6 Program the Camera Kit 1. Download the image sensor firmware example code (cyfxuvc.img) from Camera Kit Web Page (http://www.cypress.com/?rID=72599), save it in a folder of your choice 2. Launch USB Control Center from Start Menu > All Programs > Cypress > Cypress USBSuite > Control Center 3. In USB Control Center, go to Program > FX3 > RAM, choose the FX3 image sensor firmware example code (cyfxuvc.img) from where it was saved to program the Camera Kit Figure 2-12. Program Camera Kit with Image Sensor Firmware Example Code 4. Once the programming is completed, the message "Programming Succeeded" will appear at the bottom-left corner of the USB Control Center window. In Device Manager, the Camera Kit will appear as an Imaging Device called “FX3”. Figure 2-13. Successful Programming of Camera Kit with Image Sensor Firmware Example Code EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 16 Getting Started 2.7 Run Video Capturing Software to View Live HD 720p Video from Camera Kit 1. Download and install the unlicensed trial version of Debut Video Capture software from http://www.nchsoftware.com/capture/index.html Note: During installation, deselect all related Programs and Extras, as they are not required for this camera demonstration Figure 2-14. Debut Video Capture Official Web Page 2. Launch Debut Video Capture software from desktop 3. Click on Device to view live video streaming 4. Click on Options, select "FX3" as the Capture Device Figure 2-15. Debut Video Capture Software and Option Settings EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 17 Getting Started 2.8 Connecting the Camera Kit to USB 2.0 Port EZ-USB FX3 HD 720p Camera Kit is compatible with USB 2.0. When connected to a USB 2.0 host PC, the Camera Kit operates at a reduced resolution (VGA 640x480) and frame rate (15 frames per second). EZ-USB FX3 HD 720p Camera Kit - Quick Start Guide, Rev. 2.0 18