0% found this document useful (0 votes)
55 views

An 370 FT60X Configuration Programmer User Guide

Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
55 views

An 370 FT60X Configuration Programmer User Guide

Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 15

Application Notes

AN_370

FT60X Configuration Programmer


User Guide

Version 1.5

Issue Date: 2017-12-08

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 the 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
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#460

Table of Contents
1 Introduction .............................................................. 3
1.1 Overview .............................................................................3
1.2 Prerequisite .........................................................................3

2 User Interface ........................................................... 4


3 Chip Configuration Configurable ................................ 5
4 Chip Configuration Initialization Status ..................... 9
5 Contact Information ................................................ 12
Appendix A – References ............................................. 13
Document References ............................................................... 13
Acronyms and Abbreviations..................................................... 13

Appendix B – List of Tables & Figures .......................... 14


List of Tables.............................................................................14
List of Figures ...........................................................................14

Appendix C – Revision History ..................................... 15

2
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#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 default 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
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#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

Clicking this button will erase the custom configuration in the device.
After erasing, the chip will automatically reset using its default
Erase Configuration
configuration and the application template values will also change to
reflect the configuration from the chip.

Clicking this button will set the custom configuration that the user has
Write Configuration
selected. The chip will automatically reset using the new configuration.

Clicking this button will show the current settings that the device is
Read Configuration
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
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#460

3 Chip Configuration Configurable

Controls Default Value Description

Vendor identification as specified in the idVendor field of the


USB Device Descriptor
This should match the VID in the Windows installation file
(INF).
Vendor ID 0x0403
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.

Name of Manufacturer as specified in the USB Device


Manufacturer FTDI
Descriptor

Product FTDI SuperSpeed-


Product name as specified in the USB Device Descriptor
Description FIFO Bridge

Serial Number as specified in the USB Device Descriptor

The Serial Number field may be customised to uniquely


identify a device and does not require the INF file to be
Serial Number 000000000001 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.

Bus- Bus-powered or self-powered capability as specified in Bit 6


powered/Self- Self-powered of the bmAttributes field of the USB Configuration
powered Descriptor

Remote Remote wakeup capability as specified in the bmAttributes


Enabled
Wakeup field of the USB Configuration Descriptor

Maximum power consumption derived from the bMaxPower


field of the USB Configuration Descriptor. This value is
Max Power 96 (mA)
equivalent to bMaxPower/8 if USB 3 and bMaxPower/2 if
USB 2.

5
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#460

Controls Default Value Description

FIFO Clock 100 MHz Clock speed of the FIFO in MHz

Mode of the FIFO (245 mode or 600 mode)

Note that FIFO mode selected should match the protocol


FIFO Mode 600 Mode 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 channel, 1 OUT pipe only, 1 IN pipe only)
4 Channels
Configuration
Note that maximum performance decreases as the number
of pipes increases. To achieve maximum performance, use
as few pipes or channels as possible.

Battery Enables/disables detection of the power source type. E.g.


Charging Disabled Standard Downstream Port (SDP) , Charging Downstream
Enabled Port (CDP) or Dedicated Charging Port (DCP)

DCP (11)

Battery CDP (10)


GPIO Pin Configuration used to indicate the type of power
Charging
source detected by the Battery Charging module of the chip.
Settings SDP (01)

Default (00)

Controls the chip behavior when the chip receives less data
than expected from the FIFO Master.

There are two subcategories which are mutually exclusive.


o On Multiple of MaxPacketSize bytes
o On Multiple of FIFO bus-width bytes
“On Multiple of FIFO bus-width bytes “option is available
only from RevB.

Ignore Session These sub-options are disabled by default and are enabled
Not set when ‘Ignore Session Underrun’ option is checked. A read
Underrun
session is said to underrun, when the FIFO master stops or
pauses writing before the length of data requested in a
corresponding FT_ReadPipe is reached. i.e. If the host
issues FT_ReadPipe (X bytes) and the master pauses or
stops before X bytes are written, the session is said to have
underrun. The FT_ReadPipe will return with the length of
data written by the FIFO master up to the point where it
stopped/paused.
A session underrun may be ignored so that the session
remains open until the requested length of data is reached.
This allows FIFO masters to write as when data is available

6
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#460

Controls Default Value Description

in its buffers. However, the bursts of data written into the


FT60x device have to comply with certain simple rules.
When ‘On Multiple of MaxPacketSize bytes’ is selected, the
FIFO master may write in bursts of multiples of
MaxPacketSize bytes. When a burst is not a multiple of
MaxPacketSize bytes or when the requested length is
reached, the session is closed.
When ‘On Multiple of Bus-width bytes’ is selected, the FIFO
master may write in multiples of bus-width size. When a
burst is not a multiple of bus-width size, or the requested
length is reached, the session is closed.
When ‘On Multiple of MaxPacketSize bytes’ is selected, the
device transmits data over the USB in maxPacketSize
packets, in parallel, with the FIFO master writes. When ‘On
Multiple of Bus-width bytes’ is selected, the device waits for
its internal FIFO buffer to be filled completely before
initiating a write transfer on the USB.

Disabled for all IN Enables/disables sending of a notification message for


pipes 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
Notification data available for the pipe.
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 2-
channel 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.

Configuration to control the drive strengths of the FIFO pins

Output drive strength setting for the FIFO data bus


FIFO DATA: 50
50 ohm (default)
Ohm
35 ohm
25 ohm
Pin Drive
Strength 18 ohm
Control
Output drive strength setting for the FIFO clock
50 ohm (default)
35 ohm
FIFO Clock: 50
25 ohm
Ohm

7
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#460

Controls Default Value Description

18 ohm

Configuration to control the drive strengths of the GPIO pins

GPIO0: 50 Ohm Output drive strength setting for gpio0


50 ohm (default)
35 ohm
25 ohm
18 ohm
Output drive strength setting for gpio1
50 ohm (default)
35 ohm
25 ohm

GPIO1: 50 Ohm 18 ohm

9 Notification Callback and GPIO pin state reads are over the
interrupt endpoint and hence have a minimum latency of
(Available from
2**(bInterval-1) USB frames.
RevB)
Default value of 9, will give a latency of 2**(9-1) USB
Interrupt frames. That is 256 frames. As 1 frame is 125us, this gives
Latency a latency of 32ms.
(bInterval)

bInterval can be modified to reduce or increase this latency.


Minimum value is 1 and the max is 16.

Table 3.1 Description of User Configurable

FTDI provides a set of APIs to query and set the chip’s configuration. Please refer to the D3XX
Programmer's Guide.

Note: When calculating the maximum string length of a string descriptor the following rules must
be applied:
Each string descriptor requires a 2 byte header therefore of the maximum 128 bytes there is 128-6=122
bytes available.
As the data is sent in Unicode, this then divides down to 122/2=61 bytes.

Additional restrictions are also applied:


Max size for SerialNumber is 16 characters
Max size for Description is 32 characters
Max size for Manufacturer is 61-32-16=13 characters when Description and SerialNumber are
maxed out.

8
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#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

Indicates whether the configuration data read is valid or


Custom Configuration Invalid or
not. If custom configuration is invalid, the chip will use the
Validity Valid
default configuration.

Indicates whether the configuration data is corrupted or not


Custom Configuration Invalid or by validating the checksum. If the custom configuration
Checksum Valid checksum is invalid, the chip will use the default
configuration.

Indicates whether the GPIOs are used as configuration


input.

Note that the GPIOs will only be used as a configuration


input when the device is running a default configuration.
Used or
GPIO Input Below is the pin setting corresponding to mode and channel
Ignored
configuration.

GPIO1 0 – GPIO0 0 – 245 mode – 1 channel


GPIO1 0 – GPIO0 1 – 600 mode – 1 channel
GPIO1 1 – GPIO0 0 – 600 mode – 2 channels
GPIO1 1 – GPIO0 1 – 600 mode – 4 channels
High or
GPIO 0 Indicates whether GPIO 0 is set to high or low.
Low

High or
GPIO 1 Indicates whether GPIO 1 is set to high or low.
Low

Default or Indicates whether the chip was initialized using some


Configuration Used
Custom custom chip configuration or the default chip configuration.

Table 4.1 Status Information of Chip Configuration Initialization

9
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#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 the 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.

10
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#460

Figure 4.2 Chip Configuration Status - Custom Chip Configuration

11
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#460

5 Contact Information
Head Office – Glasgow, UK Branch Office – Tigard, Oregon, USA

Future Technology Devices International Limited Future Technology Devices International Limited
Unit 1, 2 Seaward Place, Centurion Business Park (USA)
Glasgow G41 1HH 7130 SW Fir Loop
United Kingdom Tigard, OR 97223-8160
Tel: +44 (0) 141 429 2777 USA
Fax: +44 (0) 141 429 2758 Tel: +1 (503) 547 0988
Fax: +1 (503) 547 0987
E-mail (Sales) [email protected]
E-mail (Support) [email protected] E-Mail (Sales) [email protected]
E-mail (General Enquiries) [email protected] E-Mail (Support) [email protected]
E-Mail (General Enquiries) [email protected]

Branch Office – Taipei, Taiwan Branch Office – Shanghai, China

Future Technology Devices International Limited Future Technology Devices International Limited
(Taiwan) (China)
2F, No. 516, Sec. 1, NeiHu Road Room 1103, No. 666 West Huaihai Road,
Taipei 114 Shanghai, 200052
Taiwan , R.O.C. China
Tel: +886 (0) 2 8797 1330 Tel: +86 21 62351596
Fax: +886 (0) 2 8751 9737 Fax: +86 21 62351595

E-mail (Sales) [email protected] E-mail (Sales) [email protected]


E-mail (Support) [email protected] E-mail (Support) [email protected]
E-mail (General Enquiries) [email protected] E-mail (General Enquiries) [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 responsible to ensure that their systems, and any Future Technology
Devices International Ltd (FTDI) devices incorporated in their systems, meet all applicable safety, regulatory and system-level
performance requirements. All application-related information in this document (including application descriptions, suggested
FTDI devices and other materials) is provided for reference only. While FTDI has taken care to assure it is accurate, this
information is subject to customer confirmation, and FTDI disclaims all liability for system designs and for any applications
assistance provided by FTDI. Use of FTDI devices in life support and/or safety applications is entirely at the user’s risk, and the
user agrees to defend, indemnify and hold harmless FTDI from any and all damages, claims, suits or expense resulting from
such use. This document is subject to change without notice. No freedom to use patents or other intellectual property rights is
implied by the publication of this document. Neither the whole nor any part of the information contained in, or the product
described in this document, may be adapted or reproduced in any material or electronic form without the prior written consent
of the copyright holder. Future Technology Devices International Ltd, Unit 1, 2 Seaward Place, Centurion Business Park,
Glasgow G41 1HH, United Kingdom. Scotland Registered Company Number: SC136640

12
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#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

13
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#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 Configurable ............................................................................. 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........................................... 11

14
Product Page
Document Feedback Copyright © Future Technology Devices International Limited
AN_370 FT60X Configuration Programmer User Guide
Version 1.5

Document Reference No.: FT_001164 Clearance No.: FTDI#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

In Section 3.Chip Configuration Configurable table,


1.1 updated the following parameters - Controls -> FIFO 2015-12-21
Clock; Default Value->100 MHZ;

2016-04-05
1.2 Updated Section 1.2 Prerequisites

Updated section 3, to remove the references to


1.3 2016-07-07
GPIO2.

Figure 2.1/4.1/4.2 have been updated to reflect the


1.4 GUI changes 2016-08-24
Updated Table 3.1

The following configuration options has been


removed:
1. FIFO Clock on in Suspend.
1.5 2017-12-08
2. Disable Chip Power down.
GUI screen shots have been updated to reflect the
new change.

15
Product Page
Document Feedback Copyright © Future Technology Devices International Limited

You might also like