Microchip Technology Protouch2 User Manual
  1. Manuals
  2. Brands
  3. Microchip Technology Manuals
  4. Recording Equipment
  5. Protouch2
  6. User manual
Microchip Technology Protouch2 User Manual

Microchip Technology Protouch2 User Manual

Command line interface
Hide thumbs Also See for Protouch2:
Table of Contents

Advertisement

Quick Links

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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Protouch2 and is the answer not in the manual?

Questions and answers

Related Manuals for Microchip Technology Protouch2

Summary of Contents for Microchip Technology Protouch2

  • Page 1 Protouch2 CLI User Manual Protouch2 Command Line Interface User Manual  2016 Microchip Technology Inc Page 1...
  • Page 2 Protouch2 CLI User Manual Microchip Technology, Incorporated 2355 W. Chandler Boulevard Chandler, Arizona 85224 480/792-7416 Microchip Technology, Inc. DATE ORIGINATOR DESCRIPTION OF CHANGE 9/2/2014 Vishnu P Initial version 10/14/2014 Vishnu P Changes from version 0.2 12/23/2014 Vishnu P Changes from version 0.3 to 0.9...

  • Page 3: Table Of Contents

    Protouch2 CLI User Manual Table of Contents Introduction ......................6 Abbreviations ....................6 Legal Information ....................6 INI File Description ....................7 HUB_VID_LIST section (Hub Vendor ID) ............ 7 HUB_RESET_DELAY Section: ..............7 3.2.1 RESTART_DELAY ................7 HCE_DEV_INFO Section (Hub Controller Information) ......7 Logging ........................
  • Page 4 Protouch2 CLI User Manual 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 ................
  • Page 5 Protouch2 CLI User Manual 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...

  • Page 6: Introduction

    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.

  • Page 7: Ini File Description

    Protouch2 CLI User Manual 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.
  • Page 8 Protouch2 CLI User Manual 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.

  • Page 9: Logging

    Protouch2 CLI User Manual 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...

  • Page 10: Usb Devices

    Protouch2 CLI User Manual 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.

  • Page 11: Usb Devices

    Protouch2 CLI User Manual 9 USB Devices 9.1 Programming SPI Flash firmware 9.1.1 Programming SPI Flash firmware 1. Refer Appendix V to install HFC driver. One time installation is required per system. This step can be skipped if the HFC driver is already installed.

  • Page 12: Programming Spi Flash Firmware And Configuration File

    5. If the firmware location is SPI Flash ROM before SPI flash programming then the Protouch2 tool will try to boot the device from internal ROM where it may take time for USB enumeration (The driver loading time based on PC performance).
  • Page 13 7. If the firmware location is SPI Flash ROM before SPI flash programming then the Protouch2 tool will try to boot the device from internal ROM where it may take time for USB enumeration (The driver loading time based on PC performance).

  • Page 14: Production Line

    >pt2main.exe /pspi < firmware_filename.bin> /id <index> /e /e is the option to erase existing Pseudo-OTP configurations. 5. Program the configuration file generated by Protouch2 GUI tool. >pt2main.exe /p <config_file.cfg> /id <index> 6. Read the entire SPI flash firmware memory and Pseudo-OTP configuration memory.

  • Page 15: Erasing Spi Flash

    Protouch2 CLI User Manual >pt2main.exe /rspi /cfg /id <index> 7. Read_SPI_MM_DD_YYYY_HH_MM_SS.bin will be created in the same running directory based on current date and time. The newly read bin file will have the binary data‟s of firmware and configuration memory. This bin file can be used to program the SPI flash firmware along with configuration file in production line.

  • Page 16: Single Device Otp Programming

    Protouch2 CLI User Manual 9.2 Single Device OTP Programming 9.2.1 OTP Programming 1. Refer Appendix V to install HFC driver. One time installation is required per system. This step can be skipped if the HFC driver is already installed. 2. Hub filter driver installation is required if the internal hub feature controller is disabled by default in the hub.

  • Page 17: Program Otp And Usb Serial String

    Protouch2 CLI User Manual 9.3 Program OTP and USB serial string 1. Refer Appendix V to install HFC driver. One time installation is required per system. This step can be skipped if the HFC driver is already installed. 2. Hub filter driver installation is required if the internal hub feature controller is disabled by default in the hub.
  • Page 18 Protouch2 CLI User Manual 3. Find out the hub index by executing the command “pt2main.exe /l”. Refer Section 13.1 for more details. As an option, port chain method also can be used to program SPI flash firmware. Execute the command “pt2main.exe /lp” to get port chain of the hub.

  • Page 19: Batch Programming (Automated Execution)

    Protouch2 CLI User Manual 9.5 Batch Programming (Automated Execution) This option is used for programming devices one after the other in batch mode. This is used for mass programming. 9.5.1 Mass OTP Programming (Single device is connected) 1. Refer Appendix V to install HFC driver.

  • Page 20: Mass Otp Programming (Multiple Devices Are Connected)

    Protouch2 CLI User Manual 5. Press “CTRL+C” keys to abort the programming. 6. After each OTP programing, coloured status will be displayed in command line. GREEN – OTP Program success RED - OTP program failed 6. After each OTP programming, device reset will be done automatically.

  • Page 21: Mass Program Otp And Usb Serial String

    Protouch2 CLI User Manual /bp <config_filename.cfg> is to program configuration file into OTP memory in continuous mode. /devpath “VVVV/PPPP/portchain” is the port chain of the hub to be programmed. For device specific filter approach >pt2main.exe /bp < config_filename.cfg> [/id <index>] /iv 5.
  • Page 22 Protouch2 CLI User Manual /start_val <decimal> is the suffix start value of the serial string. /inc_val <decimal> is the value to be incremented for each serial string, max_val <decimal> is the maximum value of the serial string to be programmed. After the specified maximum value , the tool will stop the programming.

  • Page 23: Mass Program Otp And Verify Programmed Configuration Item

    Protouch2 CLI User Manual 7. After each OTP programming, device reset will be done automatically. 9.5.4 Mass program OTP and Verify Programmed Configuration Item 1. Refer Appendix V to install HFC driver. One time installation is required per system. This step can be skipped if the HFC driver is already installed.

  • Page 24: Verification Of Hub Configuration Items

    Protouch2 CLI User Manual 9.6 Verification of Hub Configuration Items The following configuration parameters can be read from a device to compare and verify correct operation (/cv): The configuration items supported by USB253X/USB4604 and USB57X4; 1. vid 2. pid 3. did 4.

  • Page 25: Manufacturer

    Protouch2 CLI User Manual 9.6.7 manufacturer Manufacturer String of the USB2 HUB. 9.6.8 product Product String of the USB2 HUB. 9.6.9 serial Serial String of the USB2 HUB. 9.6.10 usb3vid This is a 16-bit value that uniquely identifies the Vendor of the USB3 user device (idVendor: assigned by USB-Interface 9.6.11...

  • Page 26: Get Value Of Parameter

    Protouch2 CLI User Manual 9.6.19 Get value of parameter /cv command can also be used to verify the configuration parameters without programming, >pt2main.exe /cv “vid,pid,did,usbvcd,languageid,manufacturer,product,serial” /id <index> >pt2main.exe /cv “vid,pid” /id <index> 9.6.20 Compare value of a parameter with known value To compare and verify the configuration items, following format should be used /cv “<ConfigItem1>...

  • Page 27: Dump Memory

    Protouch2 CLI User Manual 9.7 Dump Memory 9.7.1 OTP Memory This option is used to dump OTP memory of the hub. Hub class filter approach, >pt2main.exe /rotp /id <index> Device specific filter approach, >pt2main.exe /rotp /id <index> /iv E.g.: pt2main.exe /rotp /id 0 9.7.2 SPI Memory...

  • Page 28: Changing Vendor Id/Product Id Of The Hub

    30000 9.9 Changing Vendor ID/Product ID of the Hub Controller If the default vendor ID/Product ID is changed for the hub controller, Protouch2 hub controller driver will not be loaded for the hub controller. New WinUSB driver package should be generated for the hub controller. Then the new Product ID of the hub controller should be added to the Protouch2.ini file.

  • Page 29: Program Eeprom And Usb Serial/Mac Address

    Protouch2 CLI User Manual 2. Find out the LAN adapter index by executing the command “pt2main.exe /le”. Refer Section 17.2 for more details. Note: Application should have administrator rights. 3. Following method can be used to program EEPROM. >pt2main.exe /pl < myfile.ini or .bin> [/id <index>] /p <...

  • Page 30: Program Eeprom And Verify Programmed Configuration Item

    Protouch2 CLI User Manual To program EEPROM with MAC address (Override Mac address) and serial number (Override serial number) >pt2main.exe /pl < myfile.ini or .bin> [/id <index>] /pmac <mac addr> /pser <serial_num> 4. After programing, reset will be done automatically for the device.

  • Page 31: Single Device Otp Programming

    Protouch2 CLI User Manual 10.2 Single Device OTP Programming 10.2.1 OTP Programming 1. Refer Appendix VI to install LAN78xx driver for windows. One time installation is required per system. This step can be skipped if the LAN78xx driver is already installed.

  • Page 32: Program Otp And Verify Programmed Configuration Item

    Protouch2 CLI User Manual /p < myfile.ini//bin> is to program configuration file into OTP memory. /id <index> is index of the LAN adapter to be programmed. /o – Memory selects to OTP /pmac <mac addr> is the Ethernet MAC address for LAN78xx with colon separated (XX:XX:XX:XX:XX).

  • Page 33: Batch Programming (Automated Execution)

    Protouch2 CLI User Manual 10.3 Batch Programming (Automated Execution) This option is used for programming devices one after the other in batch mode. This is used for mass programming. 10.3.1 Mass EEPROM/OTP Programming (Single device is connected) 1. Refer Appendix VI to install LAN78xx driver for windows.

  • Page 34: Mass Program Eeprom/Otp And Mac Address

    Protouch2 CLI User Manual 3. Following method can be used to program EEPROM/OTP along with different serial number. > pt2main.exe /bpl < myfile.ini or .bin> [/id <index>] /o /pser [/alpha_prefix <string>] [/start_val <decimal>] [/inc_val <decimal>] [/max_val <decimal>] /bpl < myfile.ini//bin > is to program configuration file into OTP memory in continuous mode /id <index>...

  • Page 35: Mass Program Eeprom/Otp With Mac Address And Serial Number

    Protouch2 CLI User Manual > pt2main.exe /bpl < myfile.ini or .bin> [/id <index>] /o [/pmac XX:XX:XX:XX:XX:XX] [ /inc_mac < decimal>] [max_mac <hex>] /bpl < myfile.ini//bin > is to program configuration file into OTP memory in continuous mode /id <index> is index of the LAN adapter to be programmed.

  • Page 36: Mass Program Otp And Verify Programmed Configuration Item

    Protouch2 CLI User Manual /bpl < myfile.ini//bin > is to program configuration file into OTP memory in continuous mode /id <index> is index of the LAN adapter to be programmed. /o – Memory selects to OTP, if this argument is not given default memory selects to EEPROM.

  • Page 37: Verification Of Hub Configuration Items

    Protouch2 CLI User Manual Note: Application should have administrator rights. 3. Verification will be done once the OTP is programmed and reset is done for the device. Sometimes the device enumeration may take time after reset due to the time taken of driver loading for the device. The default timeout value is 15 seconds.
  • Page 38 Protouch2 CLI User Manual This is a 16-bit device release number for USB2 user device in BCD format (bcdDevice) 5. usb3vid This is a 16-bit value that uniquely identifies the Vendor of the USB3 user device (idVendor: assigned by USB-Interface) 6.
  • Page 39 Protouch2 CLI User Manual It affects the values of the USB configuration descriptor. Maximum Power Consumption in mA for USB 2.0 operation (between 2mA and 500mA for BusPower; between 2mA and 100mA for SelfPower) 18. SSmaxpower It affects the values of the USB configuration descriptor. Maximum Power Consumption in mA for USB 3.0 operation (between 8mA and 896mA for...
  • Page 40 Protouch2 CLI User Manual 30. LED1Behavior The hex value of LED Link/pulse behaviour. 31. LED2Behavior The hex value of LED Link/pulse behaviour. 32. GPIOEnable Hex values of GPIO groups (0x0FFF) 1 - Disable GPIO 0 - Enable GPIO 33. GPIOBuffer...
  • Page 41 Protouch2 CLI User Manual This bit shows the status of whether the GPIO PME is signalled on the GPIO pin as a level or a pulse. 0 = GPIO PME is signalled via a level. 1 = GPIO PME is signalled via a pulse 40.

  • Page 42: Get Value Of Parameter Before And After Programming

    Protouch2 CLI User Manual 10.4.1 Get value of parameter before and after programming To display the configuration items before and after programming. >pt2main.exe /pl < config_filename.bin> /cvl “macaddr” /id <index> >pt2main.exe /bpl < config_filename.bin> /cvl “macaddr” /id <index> 10.4.2 Get value of parameter...

  • Page 43: Dump Memory

    Protouch2 CLI User Manual 10.5 Dump Memory 10.5.1 OTP Memory This option is used to dump OTP memory of the LAN78xx. >pt2main.exe /rl /id <index> /o E.g.: pt2main.exe /rl /id /o 10.5.2 EEPROM Memory This option is used to dump EEPROM Flash Memory of the LAN78xx.

  • Page 44: Serial Number Suppression

    Protouch2 CLI User Manual 11 Appendix I 11.1 Serial Number Suppression 11.1.1 Why is it required? When programming the serial number to the hub, driver loading may take time for unique serial numbers. If serial number suppression is enabled, it forces the USB driver stack to ignore the serial number of the device.

  • Page 45: Changing Filename Extension

    Protouch2 CLI User Manual 12 Appendix II 12.1 Changing filename extension The Protouch2 tool will support only the configuration files which have the extension of “*.cfg”. The following method can be used to change the filename extension to “*.cfg” if it was “*.bin”...
  • Page 46 Protouch2 CLI User Manual  2016 Microchip Technology Inc Page 46...

  • Page 47: Appendix Iii - Find Hub Index Or Path

    Protouch2 CLI User Manual 13 Appendix III – Find Hub Index or path The following one of the method can be selected to find the hub location 1. Index method 2. Port chain method Note: Both index and port chain method cannot be used together.

  • Page 48: To List The Hubs Or To Find The Index Of A Hub

    Protouch2 CLI User Manual 13.1.2 To List the hubs or to find the index of a hub Index of the hub can be found by using the below command >pt2main.exe /l Application will populate list of hubs connected to the computer with unique index numbers.

  • Page 49: Port Chain Method

    Protouch2 CLI User Manual 13.2 Port Chain Method The port chain is the format which is used to select the device for the programming. The port chain format is generated by the PT2 based on the USB device tree in the computer.
  • Page 50 Protouch2 CLI User Manual The port chain would be “3-6” (PortChain: 3-6 ,VID:0424,PID:2734) for the red highlighted hub as shown below. 3. Create the device path using port chain. E.g. The device path would be “0424/2734/3-6” (VendorID/ProductID/Portchain) for the highlighted as shown below.

  • Page 51: To Find The Port Chain Of A Hub

    Protouch2 CLI User Manual >> pt2main.exe /p mycfg.cfg /devpath 0424/2734/3-2 To read OTP >> pt2main.exe /rotp /devpath 0424/2734/3-3 To read SPI flash with configuration area >> pt2main.exe /rspi /cfg /devpath 0424/2734/3-6 13.2.2 To find the port chain of a hub Port chain of the hub can be found by using following command >>...

  • Page 52: Troubleshooting

    Protouch2 CLI User Manual 14 Appendix IV 14.1 Troubleshooting Review the log file for debugging failures.The error code described as shown in section 19.2 below. If debug assistance is required, save the log file and provide it to Microchip support.
  • Page 53 Protouch2 CLI User Manual 0x100E SRAM programming failed 0x100F SPI Flash Erase Signature Failed 0x1010 SPI Flash Chip Erase Failed 0x1011 Could not load the Json file 0x1012 Could not load the ini file 0x3000 OTP max number of configurations exceeded...

  • Page 54: Internal Hfc Device Enabled By Default

    Protouch2 CLI User Manual 15 Appendix V 15.1 Internal HFC device enabled by Default Internal HFC device is enabled by default for USB57x4 family hubs and USB4604 hub. To find internal HFC device enumeration, connect the hub to the computer and open device manager and verify as follows.

  • Page 55: Hfc Driver Installation

    Protouch2 CLI User Manual 15.1.2 HFC Driver Installation 15.1.2.1 Automatic HFC Driver installation The HFC driver will be installed automatically for the hub feature controller from windows update, once the hub is inserted to the host. The internet connection and windows update must be enabled for the automatic driver installation.

  • Page 56: Manual Hfc Driver Installation

    Protouch2 CLI User Manual (Note: If the “Driver Software installation” wizard is not started, then click “Scan for hardware changes” as shown below) 2. If the driver installation is completed successfully then the device will appear in device manager as shown below.

  • Page 57: Internal Hfc Device Disabled By Default

    Protouch2 CLI User Manual 15.2 Internal HFC device disabled by Default Connect the hub to the computer, after installing the hub feature controller driver (Either by manual or automatic from web) as mentioned in the section 20.1.2.The internal hub feature controller is enabled by default in the USB Hub, if the “Microchip Hub Controller”...

  • Page 58: Hub Class Filter Driver Uninstallation

    Protouch2 CLI User Manual Once installed, system reboot is required. After reboot, programming can be done any number of times and installation is not required for each new device insertion and removal. If the Hub class filter is installed, then the Device Specific filter (/iv command while programming) method should not be used.

  • Page 59: Hub Device Specific Filter Driver

    Protouch2 CLI User Manual 15.2.3 Hub device specific filter driver The WinUSB driver installation is required for the device. Refer Section 20.1.2 the details. Device specific VSM filter driver should be installed using /iv command while programming. If the VSM filter driver is not installed as Hub Class filter, then the device specific filter driver installation is required for each new device insertion and removal.

  • Page 60: To List The Lan78Xx Devices Or To Find The Index Of Lan78Xx

    Protouch2 CLI User Manual Example 1: >pt2main.exe /pl /id <index> 17.2 To List the LAN78xx devices or to find the index of LAN78xx Index of the LAN78xx can be found by using the below command with administrator rights. >pt2main.exe /le Application will populate list of connected LAN78xx devices to the computer with unique index numbers.

Table of Contents