Microchip Technology Protouch2 User manual

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 1
Protouch2 Command Line
Interface User Manual

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 2
Microchip Technology, Inc.
Microchip Technology, Incorporated
2355 W. Chandler Boulevard
Chandler, Arizona 85224
480/792-7416
REV
DATE
ORIGINATOR
DESCRIPTION OF CHANGE
0.2
9/2/2014
Vishnu P
Initial version
0.4
10/14/2014
Vishnu P
Changes from version 0.2
0.9
12/23/2014
Vishnu P
Changes from version 0.3 to 0.9
1.1
9/3/2015
Vishnu P
Changes from version 0.9 to 1.1
1.2
21/4/2015
Riyas K
Changes from version 1.1 to 1.2
1.4
12/05/2015
Riyas K
Changes from version 1.2 to 1.4
1.5
04/08/2015
Vishnu P
Changes from version 1.4 to 1.5
1.51
09/04/2015
Vishnu P
Changes from version 1.5 to 1.51
1.54
09/25/2015
PrasannaV
Changes from version 1.51 to 1.54
1.55
10/01/2015
Karpagam A
Changes from version 1.54 to 1.55
1.6
3/30/2016
Prasanna V
Changes from version 1.55 to 1.6
1.7
5/30/2016
Prasanna V
Changes from version 1.6 to 1.7 BETA
1.7
8/29/2016
Karpagam A
Changes from version 1.7 BETA to 1.7 RC2

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 3
Table of Contents
1Introduction............................................................................................................6
1.1 Abbreviations................................................................................................. 6
2Legal Information ..................................................................................................6
3INI File Description...............................................................................................7
3.1 HUB_VID_LIST section (Hub Vendor ID) .................................................... 7
3.2 HUB_RESET_DELAY Section: ................................................................... 7
3.2.1 RESTART_DELAY............................................................................... 7
3.3 HCE_DEV_INFO Section (Hub Controller Information) ............................. 7
4Logging..................................................................................................................9
5Version...................................................................................................................9
6Help........................................................................................................................9
7Known Limitations ................................................................................................9
8Programming time .................................................................................................9
8.1 USB Devices................................................................................................ 10
8.2 LAN78xx Devices........................................................................................ 10
9USB Devices........................................................................................................11
9.1 Programming SPI Flash firmware................................................................ 11
9.1.1 Programming SPI Flash firmware ........................................................ 11
9.1.2 Programming SPI Flash firmware and configuration file..................... 12
9.1.2.1 Generic method.............................................................................. 12
9.1.2.2 Production line............................................................................... 14
9.1.3 Erasing SPI Flash.................................................................................. 15
9.2 Single Device OTP Programming................................................................ 16
9.2.1 OTP Programming................................................................................ 16
9.2.2 Program OTP and Lock OTP –USB57x4 Family................................ 16
9.3 Program OTP and USB serial string............................................................ 17
9.4 Program OTP and Verify Programmed Configuration Item........................ 17
9.5 Batch Programming (Automated Execution)............................................... 19
9.5.1 Mass OTP Programming (Single device is connected) ........................ 19
9.5.2 Mass OTP Programming (Multiple devices are connected)................. 20
9.5.3 Mass program OTP and USB serial string............................................ 21
9.5.4 Mass program OTP and Verify Programmed Configuration Item ....... 23
9.6 Verification of Hub Configuration Items..................................................... 24
9.6.1 Supported Parameters ........................................................................... 24
9.6.2 vid ......................................................................................................... 24
9.6.3 pid ......................................................................................................... 24
9.6.4 did ......................................................................................................... 24
9.6.5 usbvcd................................................................................................... 24
9.6.6 languageid............................................................................................. 24
9.6.7 manufacturer......................................................................................... 25
9.6.8 product .................................................................................................. 25
9.6.9 serial...................................................................................................... 25
9.6.10 usb3vid.................................................................................................. 25

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 4
9.6.11 usb3pid.................................................................................................. 25
9.6.12 usb3did.................................................................................................. 25
9.6.13 usb3vcd................................................................................................. 25
9.6.14 usb3languageid ..................................................................................... 25
9.6.15 usb3manufacturer.................................................................................. 25
9.6.16 usb3product........................................................................................... 25
9.6.17 usb3serial .............................................................................................. 25
9.6.18 Get value of parameter before and after programming......................... 25
9.6.19 Get value of parameter.......................................................................... 26
9.6.20 Compare value of a parameter with known value ................................ 26
9.7 Dump Memory............................................................................................. 27
9.7.1 OTP Memory........................................................................................ 27
9.7.2 SPI Memory.......................................................................................... 27
9.8 Changing Vendor ID/Product ID of the Hub ............................................... 28
9.9 Changing Vendor ID/Product ID of the Hub Controller.............................. 28
10 LAN78XX Devices..............................................................................................28
10.1 Single Device EEPROM Programming ................................................... 28
10.1.1 EEPROM Programming ....................................................................... 28
10.1.2 Program EEPROM and USB Serial/MAC address .............................. 29
10.1.3 Program EEPROM and Verify Programmed Configuration Item........ 30
10.2 Single Device OTP Programming............................................................ 31
10.2.1 OTP Programming................................................................................ 31
10.2.2 Program OTP and USB Serial/MAC address....................................... 31
10.2.3 Program OTP and Verify Programmed Configuration Item................. 32
10.3 Batch Programming (Automated Execution)........................................... 33
10.3.1 Mass EEPROM/OTP Programming (Single device is connected)....... 33
10.3.2 Mass program EEPROM/OTP and USB serial string .......................... 33
10.3.3 Mass program EEPROM/OTP and Mac Address................................. 34
10.3.4 Mass program EEPROM/OTP with Mac Address and serial number.. 35
10.3.5 Mass program OTP and Verify Programmed Configuration Item ....... 36
10.4 Verification of Hub Configuration Items ................................................. 37
10.4.1 Get value of parameter before and after programming......................... 42
10.4.2 Get value of parameter.......................................................................... 42
10.4.3 Compare value of a parameter with known value ................................ 42
10.5 Dump Memory ......................................................................................... 43
10.5.1 OTP Memory........................................................................................ 43
10.5.2 EEPROM Memory................................................................................ 43
10.6 Changing Vendor ID/Product ID of the LAN78xx .................................. 43
11 Appendix I ...........................................................................................................44
11.1 Serial Number Suppression...................................................................... 44
11.1.1 Why is it required?................................................................................ 44
11.1.2 When is it needed?................................................................................ 44
11.1.3 How to execute SerialNumSuppression.bat file?.................................. 44
12 Appendix II..........................................................................................................45
12.1 Changing filename extension ................................................................... 45
12.2 To show or hide file name extensions...................................................... 45

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 5
13 Appendix III –Find Hub Index or path...............................................................47
13.1 Index Method............................................................................................ 47
13.1.1 Usage of index in “/id” command......................................................... 47
13.1.2 To List the hubs or to find the index of a hub....................................... 48
13.2 Port Chain Method.................................................................................... 49
13.2.1 Usage of port chain in “/devpath” command........................................ 49
13.2.2 To find the port chain of a hub.............................................................. 51
14 Appendix IV.........................................................................................................52
14.1 Troubleshooting........................................................................................ 52
14.2 Error codes................................................................................................ 52
15 Appendix V..........................................................................................................54
15.1 Internal HFC device enabled by Default.................................................. 54
15.1.1 SKUS .................................................................................................... 54
15.1.2 HFC Driver Installation ........................................................................ 55
15.1.2.1 Automatic HFC Driver installation ............................................... 55
15.1.2.2 Manual HFC Driver installation.................................................... 56
15.1.3 HFC Driver Uninstallation.................................................................... 56
15.2 Internal HFC device disabled by Default................................................. 57
15.2.1 SKUS .................................................................................................... 57
15.2.2 Hub class filter driver............................................................................ 57
15.2.2.1 Hub class filter driver installation ................................................. 57
15.2.2.2 Hub class filter driver uninstallation ............................................. 58
15.2.2.3 Advantage...................................................................................... 58
15.2.2.4 Disadvantage ................................................................................. 58
15.2.3 Hub device specific filter driver ........................................................... 59
15.2.3.1 Advantage...................................................................................... 59
15.2.3.2 Disadvantage ................................................................................. 59
16 Appendix VI.........................................................................................................59
16.1 LAN78xx Driver Installation.................................................................... 59
17 Appendix VII.......................................................................................................59
17.1 Usage of index /id for LAN commands.................................................... 59
17.2 To List the LAN78xx devices or to find the index of LAN78xx............. 60

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 6
1 Introduction
Protouch2 CLI application is programming tool for USB253x/USB4604, USB57x4
LAN78xx and other families of Microchip USB hub products.
1.1 Abbreviations
HFC –Hub Feature controller (Internal USB Device) –USB device that appears on
the (n+1th) (5th) port of the Hub where n is the no of downstream physical ports in the
hub
PT2 –Protouch2 application
2 Legal Information
Software License Agreement
(c) 2004 - 2016 Microchip Technology Inc.
Microchip licenses this software to you solely for use with Microchip products. The software is
owned by Microchip and its
licensors, and is protected under applicable copyright laws. All rights reserved.
SOFTWARE IS PROVIDED "AS IS" MICROCHIP EXPRESSLY DISCLAIMS ANY
WARRANTY OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL MICROCHIP
BE LIABLE FOR ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES, LOST PROFITS OR LOST DATA, HARM TO YOUR EQUIPMENT, COST OF
PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR SERVICES,
ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE
THEREOF), ANY CLAIMS FOR INDEMNITY OR CONTRIBUTION, OR OTHER SIMILAR
COSTS.
To the fullest extent allowed by law, Microchip and its licensors liability shall not exceed the
amount of fees, if any, that you have paid directly to Microchip to use this software.
MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR
ACCEPTANCE OF THESE TERMS.
Trademark Information
The Microchip name and logo, the Microchip logo, MPLAB, and PIC are registered
trademarks of Microchip Technology
Incorporated in the U.S.A. and other countries.
PICDEM and PICtail are trademarks of Microchip Technology Incorporated in the U.S.A. and
other countries.
Microsoft, Windows, Windows Vista, and Authenticode are either registered trademarks or
trademarks of Microsoft Corporation in the United States and/or other countries.
SD is a trademark of the SD Association in the U.S.A and other countries

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 7
3 INI File Description
This section can be ignored for LAN78xx products and only applicable to USB hub
products.
3.1 HUB_VID_LIST section (Hub Vendor ID)
The application will populate list of hubs connected to the computer with
unique index numbers. By default, microchip hubs will be moved to lower index‟s
based on the Vendor ID (VID) during the initial process of application. To move
other hubs to lower index position when listing the hubs, Vendor ID needs to be
specified in HUB_VID_LIST section of INI file.
INI File Name: Protouch2.ini
Example:
[HUB_VID_LIST]
; Microchip VID
HUB_VID1=0x0424
; Other VID's Section
; Add as HUB_VID'n+1' = VID in "0x" format
; "HUB_VID2=0x8085"
; Maximum five VID's can be added here.
; So the maximum is HUB_VID5= 0xXXXX;
3.2 HUB_RESET_DELAY Section:
3.2.1 RESTART_DELAY
RESTART_DELAY is the time delay for the device enumeration once the device is
restarted. Device will be restarted in the application with RESTART_DELAY
timeout for specific commands. Application will wait for the device enumeration up
to value specified in the RESTART_DELAY variable.
Example:
RESTART_DELAY = 10000; In Milliseconds
3.3 HCE_DEV_INFO Section (Hub Controller Information)
HCE is nothing but the internal HFC device.The internal HFC device is
basically a winusb class USB device. By default, the tool will support with microchip
default Vendor ID and Product ID of the HFC device (Not the Vendor ID and Product
ID of HUB).
If the Vendor ID and Product ID (PID) of HFC Device need to be changed,
then add HFC Product ID to the HCE_DEV_INFO section in the INI file.

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 8
To get the winusb handle from the HFC, PID needs to be added to the following
list. Vendor ID of the HFC will be taken from "HUB_VID_LIST" section (Refer
section 3.1).Following listed Product ID's are default one and if any of the HFC
device has different PID's except below listed values , those need to be added into the
list.
Example:
[HCE_DEV_INFO]
HCE_PID1 = 0x2530;
HCE_PID2 = 0x2740;
HCE_PID3 = 0x274E;
HCE_PID4 = 0x274F;
; VID of the HFC will be taken from "HUB_VID_LIST" section
Maximum entry is 10. (Max is HFC_PID10 = 0x1234 and HFC_PID11 = 0x1234 is
not valid one)

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 9
4 Logging
A detailed log file named “PT2.log” is automatically created in the same path as
where the application is running.
Logging levels can be selected using following commands,
/s0 (or) /s –Suppress the command window and no log messages will be updated in
PT2.log file for that operation
/s1 –Suppress the command window and short description for operation performed
will be updated in log file
/s2 –Suppress the command window and detailed description for operation
performed will be updated in log file
By default, detailed description will be logged if any one of these options was not
given.
5 Version
The version number of the tool can be found using the following command;
>pt2main.exe /version
6 Help
Help regarding the command line arguments can be obtained by using the following
command;
For USB and LAN help
>pt2main.exe /help or >pt2main.exe /?
For USB help
>pt2main.exe /hu
For LAN help
>pt2main.exe /hl
7 Known Limitations
Please refer to the release notes for more information on supported operating systems,
SKUs supported, USB controllers supported and known limitations.
8 Programming time

Protouch2 CLI User Manual
2016 Microchip Technology Inc
Page 10
8.1 USB Devices
If the internal HFC device is enabled by default, depending on the OS (Win 7 or 8.1)
and architecture (32 or 64 bit), it takes about 0.5 to 2 seconds for programming
configuration file and 4 to 8 seconds for programming firmware file.
If the internal HFC device is disabled by default, depending on the OS (Win 7 or 8.1)
and architecture (32 or 64 bit), it takes about 5 to 15 seconds for programming
configuration file and 8 to 18 seconds for programming firmware file.
8.2 LAN78xx Devices
To program 256 bytes in LAN78xx devices EEPROM, it takes about to 2 to 3
seconds with EHCI controller and takes about 7 to 8 seconds with xHCI controller.
To program 256 bytes in LAN78xx devices OTP, it takes about to 2 to 3 seconds with
EHCI controller and takes about 7 to 8 seconds with xHCI controller.