Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Issue Date: 2013-01-07 This application note explains how to program FT311D vendor string using a free FTDI utility, FT311 Configuration. The application communicates with the FT311D over USB via the FTDI USB to USB Null Modem cable 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 © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 Table of Contents 1 2 Introduction .................................................................................................................................... 2 1.1 Overview ................................................................................................................................. 2 1.2 Hardware Requirements ......................................................................................................... 2 1.3 Software Requirements .......................................................................................................... 3 Test Setup ....................................................................................................................................... 4 2.1 Preparing the test PC .............................................................................................................. 4 2.2 Preparing the hardware .......................................................................................................... 4 3 Using the FT311 Configuration Utility ............................................................................................. 5 4 Contact Information........................................................................................................................ 7 Appendix A – References ........................................................................................................................ 8 Document References......................................................................................................................... 8 Acronyms and Abbreviations .............................................................................................................. 8 Appendix B – List of Tables & Figures ..................................................................................................... 9 List of Tables ....................................................................................................................................... 9 No table of figures entries found. ....................................................................................................... 9 List of Figures ...................................................................................................................................... 9 Appendix C – Revision History .............................................................................................................. 10 Product Page Document Feedback 1 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 1 Introduction Android Open Accessory hardware is paired with applications running on the Android platform via the descriptor strings the device sends to the Android. The FT311D allows for these strings to be modified such that the device may be used with multiple applications. This application note describes the test setup and usage of the FT311 Configuration Utility for making these modifications. The utility is intended for use in FT311D manufacturing environment to configure the vendor strings. This utility is needed only if the default vendor strings have to be changed. FT311 Configuration application is downloadable from the FTDI website at http://www.ftdichip.com/Support/SoftwareExamples/Android/FT311Configuration_V010100.zip 1.1 Overview The figure 1.1 below shows the block diagram of the FT311 Configuration setup. USB Host Windows FTDI USB to USB Null Modem Cable USB Host FT311D Development Module Figure 1.1 : Block diagram of FT311 Configuration setup 1.2 Hardware Requirements FTDI FT311D (may be mounted on the UMFT311EV or the customers own design). FTDI USB to USB Null Modem Cable. 5V power supply. Product Page Document Feedback 2 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 Note: Customers developing custom design should refer to Appendix A: document reference for FT311D Development Module. 1.3 Software Requirements Operating system: Windows XP or later. USB Serial Converter driver: Install the latest FTDI D2XX driver from www.ftdichip.com http://www.ftdichip.com/Drivers/D2XX.htm Framework: Microsoft .NET Framework 4 needs to be installed to run the test software Application: FT311Configuration.exe and supporting files Product Page Document Feedback 3 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 2 Test Setup 2.1 Preparing the test PC 1. Download & install Microsoft .NET Framework 4 from the following website http://www.microsoft.com/download/en/details.aspx?id=17851 2. FT311 Configuration is downloadable from the FTDI website at http://www.ftdichip.com/Support/SoftwareExamples/Android/FT311Configuration_V01010 0.zip 3. Copy the test software (FT311Configuration_V010100.zip) folder to a local hard drive. 4. Unzip them if the folders are compressed. For maximum compatibility, make sure that there are no non-English character in the path leading to the folders. 2.2 Preparing the hardware The test setup is done with the following steps 1. Connect the FTDI USB Null Modem cable to the PC and install the driver. This will happen automatically if connected to the internet. 2. Power up the FT311D from a 5V supply. 3. Connect the free end of USB to USB Null Modem Cable to the FT311D Hardware via the USB Host port. 4. The FT311D will now enumerate the Null Modem cable to complete the data link back to the PC. WINDOWS PC .NET4 FRAMEWORK FTDI D2xx DRIVERS FT311D CONFIGURATION UTILITY FT311D USB NULL MODEM CABLE 5V PSU Figure 2.1 : Completed FT311D Test Setup The completed test setup is shown in the Figure 2.1. The FT311D is powered from 5V. In this case, the 5V supply is provided through the FT311 GPIO board (UMFT311GP) to a FT311D break-out board (note this break-out board is not offered for sales). One end of USB to USB Null Modem cable is connected to FT311D Development Module USB host port. NOTE: The mode select pins on the FT311D should be set before the device is powered to ensure the Configuration utility programs the correct descriptors to match the mode of operation. Product Page Document Feedback 4 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 3 Using the FT311 Configuration Utility Figure 3.1 : FT311 Configuration Utility Run FT311Configuration.exe, and the software will start, opening a screen similar to the one shown in figure 3.1. the buttons may then be used to perform the following tasks: Read File Read File will load the configuration file into the template window, filling in the values for the strings. A default configuration.xml is installed when you install the executable. This may be updated with the Write File button. Erase Flash Any updates that the user programs to the FT311D may be erased with the Erase Flash button. A device that is erased will still function with the default strings stored in the device. The utility also checks the setup and pops up a message if the setup is wrong e.g. wrong device selected. The result is PASS if the configuration is successful. The result is FAIL if the configuration failed Note: Device type is determined by the setting of the CNFGx pins on the FT311D. Refer to the FT311D datasheet for the mode selection of the FT311D based on the CNFGx pins. Choose the device type using the Select device combo box to match with the device type selected using the CNFGx pins. Write Flash Write Flash will upload the strings displayed in the GUI to the FT311D. The utility also checks the setup and pops up a message if the setup is wrong e.g. wrong device selected. The result is PASS if the configuration is successful. The result is FAIL if the configuration failed Product Page Document Feedback 5 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 Note: Device type is determined by the setting of the CNFGx pins on the FT311D. Refer to the FT311D datasheet for the mode selection of the FT311D based on the CNFGx pins. Choose the device type using the Select device combo box to match with the device type selected using the CNFGx pins. Read Flash Read Flash will read the values previously written to the FT311D and display them in the GUI. A device that has not been flashed or has been erased will return blank values in the GUI. Write File Write File will store the values displayed in the GUI to the configuration.xml file. Clear Screen Clear screen will reset the display to blank boxes. EXIT The application may be closed by selecting EXIT Note: The Read File, Write File, Clear Screen and EXIT button in the utility is functional with the FT311D connected or not. The Erase Flash, Write Flash and Read Flash button in the utility is functional only when the FT311D is connected. Product Page Document Feedback 6 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 4 FTDI Chip Contact Information E-mail (General Enquiries) Head Office – Glasgow, UK [email protected] Branch Office – Hillsboro, Oregon, USA 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 E-mail (Sales) E-mail (Support) E-mail (General Enquiries) 7130 SW Fir Loop Tigard, OR 97223 USA Tel: +1 (503) 547 0988 Fax: +1 (503) 547 0987 [email protected] [email protected] [email protected] E-Mail (Sales) E-Mail (Support) E-Mail (General Enquiries) Branch Office – Taipei, Taiwan Branch Office – Shanghai, China Room 1103, No. 666 West Huaihai Road, Shanghai, 200052 China Tel: +86 21 62351596 Fax: +86 21 62351595 2F, No. 516, Sec. 1, NeiHu Road Taipei 114 Taiwan , R.O.C. Tel: +886 (0) 2 8791 3570 Fax: +886 (0) 2 8791 3576 E-mail (Sales) E-mail (Support) [email protected] [email protected] [email protected] [email protected] [email protected] E-mail (Sales) E-mail (Support) E-mail (General Enquiries) [email protected] [email protected] [email protected] Web Site http://ftdichip.com 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 Product Page Document Feedback 7 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 Appendix A – References Document References FT311D Development Module datasheet FT311 GPIO Board datasheet Acronyms and Abbreviations Terms Description FT311D FTDI USB Android Accessory PC Personal Computer RXD Receive TXD Transmit Asynchronous Data output UART USB USB-IF Product Page Document Feedback Universal asynchronous receiver/transmitter Universal Serial Bus USB Implementers Forum 8 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 Appendix B – List of Tables & Figures List of Tables No table of figures entries found. List of Figures Figure 1.1 : Block diagram of FT311 Configuration setup ......................................................... 2 Figure 2.1 : Completed FT311D Test Setup ............................................................................ 4 Figure 3.1 : FT311 Configuration Utility ................................................................................. 5 Product Page Document Feedback 9 Copyright © 2013 Future Technology Devices International Limited Application Note AN_212 User Guide for FT311 Configuration Utility Version 1.0 Document Reference No.: FT_000694 Clearance No.: FTDI# 323 Appendix C – Revision History Document Title: AN_212 User Guide for FT311 Configuration Utility Document Reference No.: FT_000694 Clearance No.: FTDI# 323 Product Page: http://www.ftdichip.com/FTProducts.htm Document Feedback: Send Feedback Revision 1.0 Product Page Document Feedback Changes Initial Release Date 2013-07-01 10 Copyright © 2013 Future Technology Devices International Limited