Application Note AN_101. Submitting Modified FTDI Drivers for Windows Hardware Certification

Transcription

1 AN_101 Submitting Modified FTDI Drivers for Windows Hardware Certification Issue Date: Device drivers are signed and certified by Microsoft to provide the end user a smooth experience when installing new hardware. This applications note provides information to help an OEM obtain certification under their company name. 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) Fax: + 44 (0) Web Site:

2 Table of Contents 1 Introduction Windows Hardware Certification for FTDI Drivers How does driver certification work? OEM participation in the Microsoft Logo Program Creating a DUA submission FTDI-specific details Windows Hardware Certification Kit (HCK) FTDI-specific details Additional Information Alternative Solution Self-Signed Driver Contact Information... 8 Appendix A References... 9 Website References... 9 Acronyms and Abbreviations... 9 Appendix B List of Figures List of Figures Appendix C Revision History

3 1 Introduction FTDI provide device drivers for use with its USB Bridge ICs. These drivers are available for a number of operating systems. In particular, Microsoft instituted a device driver certification process for its Windows desktop and server operating systems to ensure the drivers are functional with their products. Many FTDI customers are interested in changing the FTDI drivers to reflect their corporate identity through custom USB Vendor IDs (VID), Product IDs (PID), product names, company names and performance options. OEM customers can do this by editing one or both of the driver INF files (FTDIPORT & FTDIBUS). Technical Note TN_100 describes the various scenarios and when customized device drivers are required. INF (or Information) files are scripts which tell the Windows Operating System how to install and configure peripheral hardware drivers (.SYS,.DLL and related files). When adding custom VIDs or PIDs, FTDI require the default FTDI VID (0x0403) and PID (0x6001, 0x6010, 0x6011, 0x6014 and 0x6015) values are deleted before submitting the driver DUA package to Microsoft. Once an INF file has been edited, its original digital signature is no longer valid. Any attempt to load a driver package that includes a modified INF file as a clean install will result in a warning window to appear, as shown for Windows 7 in Figure 1.1. Figure 1.1 Logo Test Warning Pop-Up Window This warning is not fatal to the install, but many FTDI customers desire a more professional look and feel to the products that they are distributing to their customers. The Windows Hardware Certification process provides new CAT signature files for the modified device driver and prevents the warning window from appearing. With the release of Windows Vista 64-bit, Windows 7 64-bit and Windows 8 64-bit editions, Microsoft require signed device drivers. Unsigned drivers cannot be loaded through the typical user environment. This requirement will carry forward to new future operating system releases as well. A Windows Hardware Certified driver becomes eligible for automatic distribution through the Microsoft Windows Update service, allowing plug and play driver installation. Note: The current FTDI driver package CDM , consists of the following files that implement and control the VCP and D2XX drivers. INF files These files tell Windows how to install the driver ftdibus.inf for D2XX driver, ftdiport.inf for VCP driver SYS files driver core files ftdibus.sys for D2XX driver, ftser2k.sys for VCP driver CAT files Windows catalogue files contain digital signatures DLL files Windows dynamic link library support driver operation LIB files Contain API commands used by driver application programs 2

4 2 Windows Hardware Certification for FTDI Drivers An OEM will participate in the Windows Logo Program to obtain Hardware Certification for their modified version of the FTDI drivers. 2.1 How does driver certification work? Formal driver testing and Windows Hardware Certification are performed by FTDI for each release of the FTDI device drivers. With this formal certification, any customer hardware design that uses FTDI ICs also carries this formal driver certification. OEM designs which use the default FTDI VID and PIDs carry this full certification since no modifications are made to the device driver. OEM designs that use a unique PID (assigned by FTDI), or their own VID (assigned by the USB-IF at require edits to the INF files and must obtain a new driver certification. After an OEM submits a driver package with modified INF files for certification, a new digitally signed driver package, including new CAT signature files, will be available by Microsoft for download upon successful completion. This new driver package will install without warning messages on the Windows OS versions selected during the submission process. As noted in Technical Note TN_100, the OEM must remove the default FTDI VID/PID combinations and indicate the OEM company name within the modified INF files. FTDI has a utility called FT_INF which can help in creating the modified INF files. FT_INF can be downloaded from the FTDI Website. In order to eliminate conflicts, it is necessary for FTDI to review customer edited INF files prior to authorizing Reseller requests to a customer. See Section 2.3 for details on requesting Reseller rights. There are two submissions that must be made Reseller acceptance and Driver Update Acceptable (DUA) submission. Note: The Reseller / DUA submission is the correct type. Complete hardware tests have already been performed by FTDI and not required of the OEM. Note: FTDI will only authorize reseller rights on the currently released version of the device drivers. 2.2 OEM participation in the Microsoft Logo Program A FAQ published by Microsoft contains the latest information on OEM participation in the Windows Logo Program: This FAQ contains links on how to establish the accounts and signing certificates required for a successful submission. In particular, take note of the Driver Update Acceptable section. All logo certification is based upon participation of the OEM and Microsoft, including certain legal agreements. FTDI only facilitates the OEM submission to Microsoft by issuing Reseller Rights for our latest device drivers. This is the only involvement that FTDI has in the process. Additional details can be found at this link. When reviewing the linked document, remember that FTDI has gone through full testing of the device driver. Be sure to check the following topics along with the entire document: Submission requirements Submissions types that don't require complete testing Fee structure 3

5 2.3 Creating a DUA submission FTDI-specific details As noted above, the only FTDI involvement in the Windows Hardware Certification process is to issue Reseller Rights to an OEM. 1. Send a request for Reseller Rights to the FTDI UK Support support1@ftdichip.com. Include the following information in this request: Reseller Rights Request and the OEM Company Name in the subject line. The body of the must contain the following information: o o o o o Company name as it is registered with the Winqual account. Company contact person and contact details, including mailing address, telephone number and address. Product name(s). The intended VID and range of PIDs that will be assigned to this DUA submission The intended FTDI part number(s) associated with the DUA submission Attach copies of the edited INF files. Be sure to rename the files to end in.txt rather than.inf. The FTDI mail servers will remove files ending in.inf. 2. Upon receipt of this data, FTDI UK will review the request and submitted INF files. Valid requests will be granted through the Windows Dev Center account and the company contact will be notified by a response to the request . The response will include the Reseller Submission ID. Note: FTDI are not responsible for the contents or suitability of the INF files. FTDI expects the OEM to test all modifications prior to submission. Note: FTDI will only grant reseller rights based on the most recent certified device driver release. 3. Reseller Rights appear under the Manage submissions link of the Hardware certification section of the dashboard. FTDI drivers will fall under the HCK kit type. 4. Submission instructions can be found here: Follow the HCK instructions. 5. When accessing the approved reseller package, download both the Signed files CAB file and Dua shell package The Dua shell package is used with the HCK Studio to create the new submission. The Microsoft procedures for submitting driver certification requests have changed significantly due to the release of Windows 8. Be sure to check the Microsoft links throughout this document and the Microsoft websites. 2.4 Windows Hardware Certification Kit (HCK) FTDIspecific details The resold submission will be submitted through the Windows HCK Studio tool. This tool is available at the Microsoft Windows Dev Center. When installing the tool, select the Studio Only installation option. Ensure the VeriSign Microsoft Code Signing key is installed on the same computer on which the HCK studio will be installed. The code signing key is used to create the DUA submission files. When going through the HCK steps, be sure to take note of the following: 4

6 1. Open the HCKX package and select Driver Update at the bottom of the file dialog: Figure 2.1 HCK Driver Update Package Selection 2. Select the Package tab. Figure 2.2 HCK Package Tab 5

7 a. Right-click the single entry under Drivers Folder, then select Replace Driver. b. Browse to the directory containing the driver with the edited INF files (Remember to remove the original FTDI files if different INF file names are being used). 3. Select Create Package. a. When prompted to select a Signing Option, select Use the certificate Store. Figure 2.3 HCK Driver Signing Options b. Select the appropriate key. c. Select the location to save the resulting HCKX file. 4. Continue with the instructions provided by Microsoft to complete the DUA submission. 2.5 Additional Information 1. Maintenance, distribution and support of any new driver are the responsibility of the OEM. Please check our website ( on a regular basis for driver updates. 2. All end-user support requests received by FTDI for an OEM product will be referred to the OEM. 3. The Microsoft Windows Logo and Hardware Certification programs are continually changing. Be sure to consult the various help pages and FAQs available through your Windows Dev Center account. 4. The Windows Update program is available for automatic driver distribution, especially under Windows Vista and later. FTDI encourages OEMs to leverage this service to provide a positive end-user experience. 5. Binary files and filenames cannot be changed in any way in order to qualify for a DUA submission. Any edits to the binary files require a full re-test of the driver and is outside the scope of this application note and FTDI Customer Engineering Support activities. 6. The INF filenames may be modified. FTDI suggests retaining bus and port in the filenames to differentiate between the two types of interfaces, D2XX and VCP, respectively (e.g. ABCbus.inf and ABCport.inf). The CAT file references within the INF files may also be changed. FTDI suggests matching the name to those chosen for the INF files (e.g. ABCbus.cat and ABCport.CAT). 7. Additional files, such as a README file or the Windows Logo Report generated by the DUA process, may be included in an OEM driver distribution. 8. FTDI do not charge a fee for granting reseller rights; however, there is an associated fee charged by Microsoft for each Windows Driver Certification application. Consult Microsoft and Symantec/VeriSign for the latest fees and special offers. 9. Windows RT is not supported. From the Microsoft Windows Certification site: Windows RT uses class drivers and in-box drivers exclusively, departing from a common driver added scenario on the x64 or x86 architectures. Connected devices on Windows RT are tested and certified using only the in-box or class driver. 6

8 2.6 Alternative Solution Self-Signed Driver As noted above, 32-bit versions Microsoft Windows Vista, 7 and 8 allow driver installation of an unsigned driver even though a warning is displayed. At the time of publication of this application note, a self-signed driver may be installed on all 32- bit and 64-bit Windows versions. When a self-signed driver is installed, Windows will display a warning indicating that the source of the signature is unknown and give the option to continue. It is important to note that although the drivers are not submitted to Microsoft, a current VeriSign Code Signing Certificate is necessary. In addition, self-signed drivers are not eligible for distribution through Windows Update which may lead to a non-ideal end-user experience. FTDI employ this technique for the release of beta versions of the device drivers. See Technical Note TN_129 for details on self-signing driver releases. 7

9 3 Contact Information Head Office Glasgow, UK Future Technology Devices International Limited Unit 1, 2 Seaward Place, Centurion Business Park Glasgow G41 1HH United Kingdom Tel: +44 (0) Fax: +44 (0) (Sales) (Support) (General Enquiries) sales1@ftdichip.com support1@ftdichip.com admin1@ftdichip.com Branch Office Tigard, Oregon, USA Future Technology Devices International Limited (USA) 7130 SW Fir Loop Tigard, OR USA Tel: +1 (503) Fax: +1 (503) (Sales) (Support) (General Enquiries) us.sales@ftdichip.com us.support@ftdichip.com us.admin@ftdichip.com Branch Office Taipei, Taiwan Future Technology Devices International Limited (Taiwan) 2F, No. 516, Sec. 1, NeiHu Road Taipei 114 Taiwan, R.O.C. Tel: +886 (0) Fax: +886 (0) Branch Office Shanghai, China Future Technology Devices International Limited (China) Room 1103, No. 666 West Huaihai Road, Shanghai, China Tel: Fax: (Sales) (Support) (General Enquiries) tw.sales1@ftdichip.com tw.support1@ftdichip.com tw.admin1@ftdichip.com (Sales) (Support) (General Enquiries) cn.sales@ftdichip.com cn.support@ftdichip.com cn.admin@ftdichip.com Web Site 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: SC

10 Appendix A References Website References Microsoft Windows Dev Center: Microsoft Windows Hardware Logo Program FAQ: FTDI FT_INF Utility FTDI TN_129 Driver Release Signing Acronyms and Abbreviations Terms DLL DUA HCK INF PID/VID SYS USB USB-IF WHQL Clean Install Reseller Rights Description Windows Dynamic Link Library Driver Update Acceptable Hardware Certification Kit Windows Information File Product ID/Vendor ID Windows peripheral hardware driver file Universal Serial Bus USB Implementers Forum Windows Hardware Quality Labs A first time driver install on a PC, or a re-install of the driver after it has been deleted from the system Conformation sent by FTDI UK to the customer giving permission to continue with the driver certification process 9

11 Appendix B List of Figures List of Figures Figure 1.1 Logo Test Warning Pop-Up Window... 2 Figure 2.2 HCK Package Tab... 5 Figure 2.3 HCK Driver Signing Options

12 Appendix C Revision History Document Title: Document Reference No.: FT_ Clearance No.: FTDI# 47 Product Page: Document Feedback: Send Feedback Revision Changes Date 1.0 Initial Release More information added and contact information updated Corrected references to VeriSign certificate types Added reference to WHQL process checking for a valid VID, formatted table of contents Added instruction to sign the CAB file produced by the WST tool (step 7), corrected small type, added full VeriSign price for 1 year Formatted with sub-headings, updated figures with screen shots from Windows 7, added text indicating FTDI now reviews INF files prior to authorizing reseller rights, minor edits Updated section 2.2 to clarify instructions, updated code signing link Added note regarding 64-bit signtool.exe in section 2.2 Added section 2.3, added feedback links, edited Microsoft web address Updated formatting to new application note template, updated procedures to reflect new Microsoft certification naming schemes and procedures Updated for Windows 8 HCK-style submission Updated US Office address