Application Notes AN_370 FT60X Configuration Programmer User Guide Version 1.2 Issue Date: 2016-04-05 This document provides a guide on how to use the FT60X Chip Configuration Programmer application for customizing the chip configuration. Use of FTDI devices in life support and/or safety applications is entirely at t he user’s risk, and the user agrees to defend, indemnify and hold FTDI harmless from any and all damages, claims, suits or expense resulting from such use. Future Technology Devices International Limited (FTDI) Unit 1, 2 Seaward Place, Glasgow G41 1HH, United Kingdom Tel.: +44 (0) 141 429 2777 Fax: + 44 (0) 141 429 2758 Web Site: http://ftdichip.com Copyright © Future Technology Devices International Limited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 Table of Contents 1 Introduction ............................................................ 3 1.1 Overview.......................................................................... 3 1.2 Prerequisite ..................................................................... 3 2 User Interface ......................................................... 4 3 Chip Configuration Configurables ............................. 5 4 Chip Configuration Initialization Status .................... 9 5 Contact Information .............................................. 11 Appendix A – References ........................................... 12 Document References ............................................................ 12 Acronyms and Abbreviations .................................................. 12 Appendix B – List of Tables & Figures ......................... 13 List of Tables ......................................................................... 13 List of Figures ........................................................................ 13 Appendix C – Revision History .................................... 14 2 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 1 Introduction This document explains how to use the FT60X Series Chip Configuration Programmer, a utility application for customizing the chip configuration. 1.1 Overview The FT600 and FT601 are the first USB devices in a brand new SuperSpeed series from FTDI Chip. The devices provide a USB 3.0 SuperSpeed to FIFO Bridge, with up to 5Gbps of bandwidth. Delivering the option of 16 bit (FT600) and 32 bit (FT601) wide parallel FIFO interfaces; the FT60X series enables connectivity for numerous applications including high resolution cameras, displays, multifunction printers and much more. During initialization, the FT60X devices read configuration data and initialize the system using these values. If the chip configuration data read is empty or invalid, the de fault chip configuration data will be used. The Chip Configuration Programmer application allows the user to get, set or update this chip configuration data. 1.2 Prerequisite A PC running Windows 7 Operating System or greater is required. The PC should also be installed with D3XX Direct Drivers. FT60X uses D3XX (FTDI’s latest USB driver targeted for USB 3.0 SuperSpeed devices). They can be obtained here: http://www.ftdichip.com/Drivers/D3XX.htm The PC should also be installed with the Microsoft Visual C++ 2013 Redistributable (x86) package. Please us the following steps to install it:- 1. Go to https://www.microsoft.com/en-us/download/details.aspx?id=40784 2. Click ‘Download’ button 3. Check the ‘vcredist_x86.exe’ and click ‘Next’. 4. After download completes, run ‘vcredist_x86.exe’ to install the package 3 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 2 User Interface Below is a screenshot of the FT60X Chip Configuration Programmer application. Figure 2.1 Application Screenshot The application allows the user to reset/clear, write and read the device configuration. Main Buttons Description Erase Configuration Clicking this button will erase the custom configuration in the device. After erasing, the chip will automatically reset using its default configuration and the application template values will also change to reflect the configuration from the chip. Write Configuration Clicking this button will set the custom configuration that the user has selected. The chip will automatically reset using the new configuration. Read Configuration Clicking this button will show the current settings that the device is configured with. Table 2.1 Description of Main UI Controls Note: when changing FIFO Clock, or any of the drop-down menus, you must scroll to the selected item and click on it. Make sure the selection is highlighted in blue before writing the configuration. If the selection is not highlighted, the chip configuration will not change. 4 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 3 Chip Configuration Configurables Controls Default Value Description Vendor identification as specified in the idVendor field of the USB Device Descriptor Vendor ID 0x0403 This should match the VID in the Windows installation file (INF). If this parameter is changed, then the corresponding change is required in the INF installation file. NOTE: changes to the INF file will invalidate any driver certification. Product identification as specified in the idProduct field of the USB Device Descriptor This should match the PID in the Windows installation file (INF). Product ID 0x60IF If this parameter is changed, then the corresponding change is required in the INF installation file. NOTE: changes to the INF file will invalidate any driver certification. Manufacturer FTDI Name of Manufacturer as specified in the USB Device Descriptor Product Description FTDI SuperSpeedFIFO Bridge Product name as specified in the USB Device Descriptor Serial Number as specified in the USB Device Descriptor Serial Number 000000000001 The Serial Number field may be customised to uniquely identify a device and does not require the INF file to be updated. The total number of bytes for this field is 128 bytes, which is shared across the string descriptors for Manufacturer, Product Description and Serial Number. Buspowered/Selfpowered Self-powered Bus-powered or self-powered capability as specified in Bit 6 of the bmAttributes field of the USB Configuration Descriptor Remote Wakeup Enabled Remote wakeup capability as specified in the bmAttributes field of the USB Configuration Descriptor Max Power 96 (mA) Maximum power consumption derived from the bMaxPower field of the USB Configuration Descriptor. This value is equivalent to bMaxPower/8 if USB 3 and bMaxPower/2 if USB 2. FIFO Clock 100 MHz Clock speed of the FIFO in MHz 5 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 Controls Default Value C learance N o.: FT DI#460 Description Mode of the FIFO (245 mode or 600 mode) FIFO Mode 600 Mode Note that FIFO mode selected should match the protocol used by the external FIFO master. Data transfer will not work if the FIFO protocol used does not match. Number of channels or pipes. A channel is equivalent to 2 pipes – 1 for OUT and 1 for IN. (4 channels, 2 channels, 1 channel, 1 OUT pipe only, 1 IN pipe only) Channel Configuration Battery Charging Enabled 4 Channels Disabled Note that maximum performance decreases as the number of pipes increases. To achieve maximum performance, use as few pipes or channels as possible. Enables/disables detection of the power source type. E.g. Standard Downstream Port (SDP) , Charging Downstream Port (CDP) or Dedicated Charging Port (DCP) DCP (11) Battery Charging Settings CDP (10) SDP (01) GPIO Pin Configuration used to indicate the type of power source detected by the Battery Charging module of the chip. Default (00) Enable/disable the ability to cancel sessions when the chip receives an underrun from the FIFO master. When this is set, the chip will not cancel or invalidate IN requests from the host application when it receives an underrun condition from the FIFO master and if the packet size received from the FIFO master is a multiple of the USB max packet size (USB3:1024, USB2:512). Cancel Session On Underrun Disabled Not set By default, the chip always cancels or invalidates IN requests from the host application when it receives an underrun condition from the FIFO master. Underrun conditions happen when the FIFO master provides data less than the FIFOSe gmentSize. The FIFOSegmentSize is as follows: 6 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 Controls Default Value C learance N o.: FT DI#460 Description CHANNEL_CONFIG_4: 1KB CHANNEL_CONFIG_2: 2KB CHANNEL_CONFIG_1: 4KB CHANNEL_CONFIG_1_OUTPIPE: 8KB CHANNEL_CONFIG_1_INPIPE: 8KB Disabled for all IN pipes Enables/disables sending of a notification message for unexpected IN data where there is no existing read requests. When this is set on a pipe, the host application should not actively read on this pipe, instead it will register a callback function. The callback function will be called when there is data available for the pipe. Notification Message Enabled This feature is intended for unexpected short packets (maximum of 4kb), such as error status information from the FIFO master to the host application. For example, for a camera device, the user can select 2channel configuration because it needs 2 IN pipes – 1 for camera data, 1 for control/error status information. Notification messages should be used for the control/error status information pipe but not for the camera data pipe. 0x00010800 Configuration to control the drive strengths of the FIFO pins Bit 1-0: Output driving strength setting for FIFO data bus 2’b00: 50 ohm (default) 2’b01: 35 ohm 2’b10: 25 ohm MSIO Control 2’b11:18 ohm Bit 5-4: Output driving strength setting for FIFO clock 2’b00: 50 ohm (default) 2’b01: 35 ohm 2’b10: 25 ohm 2’b11:18 ohm 0x00000000 Configuration to control the drive strengths of the GPIO pins Bit 9-8: Output driving strength setting for gpio0 GPIO Control 2’b00: 50 ohm (default) 2’b01: 35 ohm 2’b10: 25 ohm 2’b11:18 ohm 7 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 Controls Default Value C learance N o.: FT DI#460 Description Bit 11-10: Output driving strength setting for gpio1 2’b00: 50 ohm (default) 2’b01: 35 ohm 2’b10: 25 ohm 2’b11:18 ohm Bit 13-12: Output driving strength setting for gpio2 2’b00: 50 ohm (default) 2’b01: 35 ohm 2’b10: 25 ohm 2’b11:18 ohm Table 3.1 Description of User Configurables FTDI provides a set of APIs to query and set the chip’s configuration. Please refer to the D3XX Programmers Guide. 8 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 4 Chip Configuration Initialization Status When the user clicks on the Read Configuration button, the current configuration values used during initialization will be displayed, including the status information. The status reflects the FT60X actual configuration result when the chip has completed the startup process. Below is a table showing the description of the status information of the chip configuration initialization. Status Information Values Description Custom Configuration Validity Invalid or Valid Indicates whether the configuration data read is valid or not. If custom configuration is invalid, chip will use the default configuration. Custom Configuration Checksum Invalid or Valid Indicates whether the configuration data is corrupted or not by validating the checksum. If the custom configuration checksum is invalid, the chip will use the default configuration. Indicates whether the GPIOs are used as configuration input. Used or Ignored GPIO Input Note that the GPIOs will only be used as a configuration input when the device is running a default configuration. Below is the pin setting corresponding to mode and channel configuration. GPIO1 0 GPIO1 0 GPIO1 1 GPIO1 1 – – – – GPIO0 0 – GPIO0 1 – GPIO0 0 – GPIO0 1 – 245 mode 600 mode 600 mode 600 mode – – – – 1 1 2 4 channel channel channels channels GPIO 0 High or Low Indicates whether GPIO is set to high or low. GPIO 1 High or Low Indicates whether GPIO is set to high or low. Configuration Used Default or Custom Indicates whether chip was initialized using some custom chip configuration or the default chip configuration. Table 4.1 Status Information of Chip Configuration Initialization 9 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 Below is a sample illustration where the device is detected to be running using the default chip configuration. Figure 4.1 Chip Configuration Status - Default Chip Configuration Below is a sample illustration where the device is detected to be running using some custom chip configuration. If user wants to go back to the default chip configuration, the user can click on the Erase Configuration button. This will erase the custom setting in the chip. Figure 4.2 Chip Configuration Status - Custom Chip Configuration 10 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 5 Contact Information Head Office – Glasgow, UK Branch Office – Tigard, Oregon, USA Future Technology Devices International Limited Unit 1, 2 Seaward Place, Centurion Business Park Glasgow G41 1HH United Kingdom Tel: +44 (0) 141 429 2777 Fax: +44 (0) 141 429 2758 Future Technology Devices International Limited (USA) 7130 SW Fir Loop Tigard, OR 97223-8160 USA Tel: +1 (503) 547 0988 Fax: +1 (503) 547 0987 E-mail (Sales) E-mail (Support) E-mail (General Enquiries) [email protected] [email protected] [email protected] E-Mail (Sales) E-Mail (Support) E-Mail (General Enquiries) [email protected] [email protected] [email protected] Branch Office – Taipei, Taiwan Branch Office – Shanghai, China Future Technology Devices International Limited (Taiwan) 2F, No. 516, Sec. 1, NeiHu Road Taipei 114 Taiwan , R.O.C. Tel: +886 (0) 2 8797 1330 Fax: +886 (0) 2 8751 9737 Future Technology Devices International Limited (C hina) Room 1103, No. 666 West Huaihai Road, Shanghai, 200052 C hina Tel: +86 21 62351596 Fax: +86 21 62351595 E-mail (Sales) E-mail (Support) E-mail (General Enquiries) E-mail (Sales) E-mail (Support) E-mail (General Enquiries) [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] Web Site http://ftdichip.com Distributor and Sales Representatives Please visit the Sales Network page of the FTDI Web site for the contact details of our distributor(s) and sales representative(s) in your country. System and equipment manufacturers and designers are res ponsible to ens ure that their s ystems , and any Future Tec hnology D evices I nternational L td (FTDI ) devic es incorporated in their sys tems , meet all applicable safety, regulatory and s ystem- level performance requirements . A ll applic ation- related information in this document (including application descriptions , s ugges ted FTDI devices and other materials ) is provided for reference only. While FTDI has taken c are to ass ure it is acc urate, this information is s ubjec t to c us tomer confirmation, and FTDI disclaims all liability for s ys tem des igns and for any applications ass istance provided by FTDI . Use of FTDI devices in life s upport and/or safety applications is entirely at the us er’s risk, a nd the user agrees to defend, indemnify and hold harmless FTDI from any and all damages , c laims , s uits or expense resulting from s uc h use. T his document is s ubject to c hange without notic e. N o freedom to us e patents or other intellec tual property rights is implied by the publication of this doc ument. Neither the whole nor any part of the information c ontained in, or the product desc ribed in this doc ument, may be adapted or reproduc ed in any material or electronic form without the prior written cons ent of the c opyright holder. Future T echnology D evices I nternational L td, U nit 1 , 2 Seaward Place, Centurion Business Park, G las gow G 4 1 1 HH, U nited Kingdom. Sc otland Registered C ompany N umber: SC136640 11 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 Appendix A – References Document References FT600Q-FT601Q SuperSpeed USB3.0 IC Datasheet DS_UMFT60xx module datasheet D3XX Programmer’s Guide Acronyms and Abbreviations Terms Description CDP Charging Downstream Port DCP Dedicated Charging Port FIFO First In First Out GPIO General Purpose Input / Output ID Identification INF Windows driver installation file SDP Standard Downstream Port UI User Interface USB Universal Serial Bus VID Vendor Identification 12 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 Appendix B – List of Tables & Figures List of Tables Table 2.1 Description of Main UI Controls ..................................................................................... 4 Table 3.1 Description of User Configurables .................................................................................. 8 Table 4.1 Status Information of Chip Configuration Initialization ................................................... 9 List of Figures Figure 2.1 Application Screenshot ................................................................................................. 4 Figure 4.1 Chip Configuration Status - Default Chip Configuration ............................................... 10 Figure 4.2 Chip Configuration Status - Custom Chip Configuration .............................................. 10 13 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited AN_370 FT60X Configuration Programmer User Guide V ers ion 1 .2 D oc ument Reference N o.: FT _001164 C learance N o.: FT DI#460 Appendix C – Revision History Document Title: AN_370 FT60X Configuration Programmer User Guide Document Reference No.: FT_001164 Clearance No.: FTDI#460 Product Page: http://www.ftdichip.com/FTProducts.htm Document Feedback: Send Feedback Revision Changes Date 1.0 Initial Release 2015-09-03 1.1 In Section 3.Chip Configuration Configurable table, updated the following parameters - Controls -> FIFO Clock; Default Value->100 MHZ; 2015-12-21 1.2 Updated Section 1.2 Prerequisites 2016-04-05 14 P roduc t Page D oc ument Feedback C opyright © Future T echnology D evices I nternational L imited