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

Gui
Hide thumbs Also See for Protouch2:
Table of Contents

Advertisement

Quick Links

Download this manual
Protouch2 GUI User Manual
Protouch2 GUI 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 GUI User Manual Protouch2 GUI User Manual  2016 Microchip Technology Inc Page 1...
  • Page 2 Protouch2 GUI User Manual Microchip Technology, Incorporated 2355 W. Chandler Boulevard Chandler, Arizona 85224 Microchip Technology, Inc. 480/792-7416 DATE ORIGINATOR DESCRIPTION OF CHANGE 30-Dec- Vishnu P Initial version 2014 30-Apr- Vishnu P Offline support added 2015 30-May- Vishnu P Changes from version 1.3 to 1.4...

  • Page 3: Table Of Contents

    15 Appendix II- Disable Power Management ............63 16 Windows 7 ......................63 17 Windows 8.1 ......................66 18 Appendix III – Protouch/Protouch2 interoperability ........... 67 19 Appendix IV – Checking whether drivers were installed correctly for PT2 ..70 20 VSM as Class Filter ..................... 70 21 WinUSB Driver ....................

  • Page 4: Introduction

    Protouch2 GUI User Manual 1 Introduction Protouch2 GUI is a Configuration and Programming tool for the following Microchip products. LAN products:  LAN78XX USB Hub products:  USB253X/USB4604/USB3X13  USB57X4  USB5742 1.1 Abbreviations UCH – Universal Hub Controller HCE – Hub controller Enumeration Internal USB Device PT1 –...
  • Page 5 Protouch2 GUI User Manual SD is a trademark of the SD Association in the U.S.A and other countries  2016 Microchip Technology Inc Page 5...

  • Page 6: Drivers

    The version number of the tool can be found from the help page. Refer to Section 9.1 for more details. 6 Known Limitations Please refer to the release notes “Protouch2 release notes.pdf” for more information on OS Supported, SKUs supported, USB controllers supported and known limitations  2016 Microchip Technology Inc Page 6...

  • Page 7: Disable Power Management

    Protouch2 GUI User Manual 7 Disable Power Management Power Management should be disabled for the hub after plugging in the hub and before launching the tool. If it is a USB 3.1 Gen1 Hub, then power management should be disabled on both USB2.0 Hub and USB 3.1 Gen1 Hub. Power Management can be disabled by using the Device Manager as shown below.

  • Page 8: Configuration File Formats

    Protouch2 GUI User Manual 8 Configuration File formats Configuration file holds the data to be programmed to the hub. Configuration file used for programming can be in Binary format (.cfg) or JSON format (.json). Both the files are generated when changes are done to the configuration items in the Hub.
  • Page 9 Protouch2 GUI User Manual swapupstreamdpdm Swaps dp and dm “swapupstreamdpdm”:”1” swapport1dpdm Value : 1 – Swaps D+ and D- swapport2dpdm Value : 0 – Default behaviour swapport3dpdm swapport4dpdm nrdeviceport4 Configures Port as removable/non-removable “nrdeviceport4”:”1” nrdeviceport3 Value : 1 – Port Non-removable nrdeviceport2 Value : 0 –...
  • Page 10 Protouch2 GUI User Manual hce_did 16-bit device release number for HCE device in “hce_did”:”0x1234” BCD format hce_languageid Language id of HCE device “hce_languageid”:”0x0409” hce_manufacturer Manufacturer string of HCE device “hce_manufacturer”:”Microchip” hce_product Product string of HCE device “hce_product”:”Controller hub” hce_serial Serial String of HCE device “hce_serial”:”123456”...
  • Page 11 Protouch2 GUI User Manual usb2did 16-bit device release number for USB2,USB3 user “usb2did”:”0x101” device in BCD format (bcdDevice) langid Language ID of the device "langid":"0x409” manufacturer Manufacturer string of the device "manufacturer":"Microchip" product Product string of the device "product":"LAN7850” serial Serial string of the device "serial":"00800F785000”...
  • Page 12 Protouch2 GUI User Manual Collision: LED will monitor the Collision in Link Activity: LED will monitor the Activity in Link Auto-Negotiation Fault: LED will monitor the Auto- Negotiation Fault in Link Serial Mode: LED will monitor the Serial Stream Force LED OFF: This will De-assert the LED...
  • Page 13 Protouch2 GUI User Manual GPIOPMEEnable This bit shows the status of the assertion of the "GPIOPMEEnable":"1" GPIO5 pin, as a result of a Wakeup (GPIO) pin, Magic Packet, or PHY Link Up. The host processor may use the GPIO5 pin to asynchronously wake up, in a manner analogous to a PCI PME pin.

  • Page 14: Binary Format

    Protouch2 GUI User Manual descriptor. Maximum Power Consumption in mA for USB 3.0 operation (between 8mA and 896mA for BusPower; between 8mA and 100mA for SelfPower) SSinterruptEPinterval Super speed interrupt polling interval. The "SSinterruptEPinterval":"e" values are in decimal and in the range 0 - 16.

  • Page 15: Application

    There is a Help menu on all the PT2 pages on the top right corner as shown below 9.2 Landing Page This is the default screen that will be displayed once Protouch2 is launched. When “USB 57X4 Hub Online” is selected in landing page, it moves to the USB57X4 hub online configuration page and looks for USB57X4 Microchip Hubs in the system, after loading the appropriate drivers.

  • Page 16: Usb Hub Devices

    Protouch2 GUI User Manual In Offline mode, the Hub need not be connected to the system in which the tool is running. Only configuration generation can be done in this mode. Programming cannot be done in Offline Mode. 10 USB Hub Devices 10.1 Online Hub Configuration Page...
  • Page 17 10.1.2 Device Management Select USB Hub: This is the default screen that will be displayed once Protouch2 is launched. Once the Protouch2 is launched all the GUI elements (in all pages) will remain disabled except “Select USB Hub” and the default item selected will be “Hub at index 0”.
  • Page 18 For USB253x SKU, if Number of configuration programmed is 16+ and running from ROM, then Protouch2 will ask for default SKU to restore. 10.1.3 Device Identification USB 2.0 USB 2.0 Vendor id, Product id, bcdDevice, bcdUSB and String Descriptors can be customized by writing appropriate values.
  • Page 19 Protouch2 GUI User Manual 10.1.4 Device Identification USB 3.1 Gen1 USB 3.1 Gen1 Vendor id, Product id, bcdDevice, USBbcd, String Descriptors and UUID can be customized by writing appropriate values. 10.1.5 Downstream Port Configuration The hubs USB253X/(8)460X/57X4 have 4 downstream ports.

  • Page 20: Usb253X/(8)460X/3X13 Hub

    Protouch2 GUI User Manual USB3X13: 10.1.5.1 USB253X/(8)460X/3X13 Hub Port Enable/Disable: Physical port can be enabled / disabled through GUI. If any one of the physical port is enabled or disabled, GUI will remap appropriate logical ports internally. Non Removable ports: USB 2.0 ports can be configured as Non Removable ports.

  • Page 21: Additional Features

    Protouch2 GUI User Manual 10.1.5.2 Additional features 10.1.5.2.1 Battery Charging:  USB2.0 Standard USB Port-Max 500mA  BC 1.2 Compliant Port-Max 1.5A  Most Devices Supported Mode-Max 2A USB2.0 Standard USB Port-Max 500mA: USB2.0 Standard USB Port-Max 500mA is the default battery charging method. This also means battery charging is disabled and the device can draw only 500mA which is the standard for a USB device.
  • Page 22 Protouch2 GUI User Manual USB253X/USB4604/USB3X13: 10.2.1 Downstream Port Configuration (advanced) Swap D+/D-: USB2.0 DP and DM Pins can be swapped using GUI. PHY Boost and Varisense: USB signal drive strength in upstream and downstream transceivers can be changed using PHY Boost. USB signal receiver sensitivity can be changed by using Varisense.
  • Page 23 Protouch2 GUI User Manual Rise/Fall time for High Speed device gets varied based on cable length. This can be changed using High Speed Rise/Fall Adjust. 10.2.1.1 HSIC related configuration: The following are the HSIC related configurations which can be done on HSIC enabled ports.
  • Page 24 Protouch2 GUI User Manual Upstream port HSIC Configuration: 10.2.2 Upstream Port Configuration Flex connect USB 2.0/ USB 3.1 Gen1 downstream port 1 can be configured as Upstream Port.  „If check box is not checked‟ = Upstream port is not Flex connected – default behaviour ...
  • Page 25 HCE_DEV_INFO and VID should be added to "HUB_VID_LIST" in the INI file. 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 ...
  • Page 26 Protouch2 GUI User Manual (Note: The automatic & manual WinUSB driver installation will not work, if the hub controller Vendor ID & Product ID is changed) 10.2.4 Communication Device Class (CDC)  „If check box is not checked‟ = CDC not Enabled always, ...
  • Page 27 Protouch2 GUI User Manual USB57X4: USB253X/USB4604: Hub Max Power and Hub Circuit Max Power Hub Power mode is configured as a Self-Powered device, then <1mA of upstream VBUS current is consumed and all ports are available, with each port being capable of sourcing 500mA of current.
  • Page 28 Protouch2 GUI User Manual Upstream Charger Detection Battery Charger Detection is available USB253x/USB4604 hubs on the upstream facing port. The detection sequence will identify chargers which conform to the Chinese battery charger specification, chargers which conform to the USB-IF Battery Charger Specification 1.2, and single ended 1 charger (SE1).
  • Page 29 Protouch2 GUI User Manual 10.2.6 Direct Register Access XDATA Address can be programmed with desired value directly by using Direct Register Access option. This method follows Big endian. Example: Write value 1234 in register 0x3000 as shown below. Here 12 will be written to 0x3000 and 34 will be written to 0x3001 Alternatively, ini file can be given as input.
  • Page 30 Protouch2 GUI User Manual ; Example 1: write XDATA[3000]to 1234 XWRE_3000=12 XWRE_3001=34 ; Example 2: write XDATA[3000]to 1234 XWRE_3002=12 34 ; XDATA Set bits. i.e XDATA[address] |= yy ; XSET_ is the identifier to initiate xdata set bits operation. ; Example 1: XSET_3000=10 ;...
  • Page 31 Protouch2 GUI User Manual Example: To read Register value: Advanced Option: Values read are stored in File selected. This file can be used as an input when Write Option is selected. 10.2.8 Dump memory  2016 Microchip Technology Inc Page 31...
  • Page 32 Protouch2 GUI User Manual Dump memory allows user to dump OTP memory or SPI memory or SPI with Pseudo OTP memory present in device connected. OTP Memory Dump will be saved in a given file with extension .dump and SPI Memory, SPI with Pseudo OTP Dump will be saved in a given file with extension .bin.

  • Page 33: Preview Changes

    Protouch2 GUI User Manual 10.2.9 Flexconnect Feature This page is used to issue Flex Feature Command to the Hub. Both USB2530 as well as USB57x4 Hub will respond to valid Flexconnect command. 10.3 Preview Changes Preview changes allows user to view information such as Number of bytes to be programmed, Configuration memory usage before programming.
  • Page 34 Protouch2 GUI User Manual 10.3.1 Special Features Special feature tab is used for Demo purpose. It helps to explain the concept of Flexconnect, I2C Bridging, SPI Bridging, GPIO Bridging and UART Bridging. UART Bridging is available only for USB57x4 hub.
  • Page 35 Protouch2 GUI User Manual 10.3.3 USB-I2C Bridge Demo Microchip USB hubs facilitate USB-I2C bridging through USB control point of the embedded USB device (5th port). Example: To do I2C write. Step 1:  2016 Microchip Technology Inc Page 35...
  • Page 36 Protouch2 GUI User Manual  “0x50” is the I2C Slave address.  Data field has 3 entries, “00” represents the start address and “11 22” is the data that is to be written. Step 2: After this, do a write again for slave address “0x50”, data “00” and length “1”.
  • Page 37 Protouch2 GUI User Manual SPI Transfer It is a demo for low level SPI pass thru command read/write. All commands to the SPI interface are directed as SPI Pass thru write. SPI pass thru read is nothing but a XDATA read from a specified offset where the response is stored.
  • Page 38 Protouch2 GUI User Manual GPIO Get Operation This demo allows us to get the state of a specified GPIO pin. 10.3.6 USB-UART Bridge Demo UART demo The data is transferred through a serial port to the connected serial peripheral and received there.

  • Page 39: Programming Page

    Protouch2 GUI User Manual 11 Programming Page 11.1 Device Selection The hub of interest can be selected from the dropdown. 11.2 Configuration programming Both JSON and binary format configuration files are allowed. The configuration file saved by changing the configuration items of interest and clicking on the “Preview changes”...

  • Page 40: Configuration Programming Along With Spi Flash Firmware Programming

    Protouch2 GUI User Manual 11.4 Configuration programming along with SPI Flash Firmware programming Configuration file and Firmware file can be programmed in one shot. For USB253X/USB4604 Hubs this cannot be achieved. 11.5 Types of programming 11.5.1 Program Once Single device can be programmed at a time by using Program Once option. Select the hub of interest.
  • Page 41 Protouch2 GUI User Manual 11.5.3 Programming time It takes about 3 to 5 seconds for programming if the internal HCE (Hub Controller Enumeration) device is enabled. Otherwise it takes about 14 to 20 seconds depending on the OS (Win 7 or 8.1) and architecture (32 or 64 bit) ...

  • Page 42: Offline Hub Configuration Page

    Protouch2 GUI User Manual 12 Offline Hub Configuration Page Offline support allows for generation of configuration file even without the hub being connected to the system. Selecting Offline mode Select the radio button on the landing page as shown below...
  • Page 43 Protouch2 GUI User Manual “SAVE” button is inactive at this time since no changes are made to the configuration settings. Change configuration settings Configuration settings of the hub as desired can be changed from the default or default+ Load configuration settings as shown below...
  • Page 44 Protouch2 GUI User Manual  2016 Microchip Technology Inc Page 44...

  • Page 45: Lan78Xx Devices

    Protouch2 GUI User Manual 13 LAN78XX Devices 13.1 Online LAN78XX Configuration Page LAN78XX contain several registers that can change the behaviour of the Device. It can be changed to a new value through the PT2 application by programming the EEPROM or OTP Memory.
  • Page 46 This is the default screen that will be displayed once LAN78XX online page is launched. Once the Protouch2 is launched all the GUI elements (in all pages) will remain disabled except “Select USB Hub” and the default item selected will be “LAN at index 0”.
  • Page 47 Protouch2 GUI User Manual 13.1.1.3 Device Identification For LAN7850, the Device Descriptor fields configure USB 2.0 VID,USB 2.0 PID,USB 2.0 DID. For LAN7800, the Device Descriptor fields configure both the USB 2.0 and USB 3.0 VIDs,PIDs ,DIDs. USB String Descriptors can be disabled by programming empty string as shown below.
  • Page 48 Protouch2 GUI User Manual Remote wakeup for the device is used to wake up the device in U1/U2/U3 Low power state to U0 state. External supply of 5V is required for device operation when the device is in Self powered mode.
  • Page 49 Protouch2 GUI User Manual Auto-Negotiation Fault: LED will monitor the Auto-Negotiation Fault in Link Serial Mode: LED will monitor the Serial Stream Force LED OFF: This will De-assert the LED Force LED ON: This will assert the LED All the Four LEDs LED0, LED1, LED2, LED3 behaviour can be configured using the below fields.
  • Page 50 Protouch2 GUI User Manual 13.1.2.4 GPIO Configuration GPIO Configuration fields are used to Enable/Disable the all the 7 GPIOs GPIO0, GPIO1, GPIO2, GPIO3, GPIO4, GPIO5, GPIO6. Output buffer for the GPIO Pins can be configured as a push/pull driver or Open/Drain driver.
  • Page 51 Protouch2 GUI User Manual When the GPIO is set as Output, Output value has to be given in the GPIO data field. When the GPIO is set as Input, GPIO data field will be hidden. 13.1.2.5 Power Management LAN78XX can wake up the Host Processor via different types of PME wakeup events listed below: 1.
  • Page 52 Protouch2 GUI User Manual 3. PME Packet 4. PME WUFF GPIO pins: GPIO PME wakeup event can be enabled by GPIO PME field. GPIO PME event can be signalled via a level or pulse which can be set in GPIO PME configuration. GPIO PME polarity is used to specify the level as low or high.
  • Page 53 Protouch2 GUI User Manual 13.1.2.6 Live Update Live Update enables the option of Register Read/Write for LAN registers and PHY registers. Register Address and the length of bytes to read/write is given in Register Address and Length fields 13.1.2.7 OTP/EEPROM Dump Memory Dump memory allows user to dump OTP memory or EEPROM memory.
  • Page 54 Protouch2 GUI User Manual 13.1.3 Preview Changes Preview changes option allows the user to generate the Configuration file that is going to be programmed in the device. Configuration file with .bin extension is generated. 13.1.4 Programming Page Programming Page enables the user to program configuration file in EEPROM and OTP memory.
  • Page 55 Protouch2 GUI User Manual 3. Program Configuration file with MAC address alone Program Configuration file with Serial number and MAC address: Configuration file will be programmed in either OTP or EEPROM with the given serial number and MAC address overwriting the values in configuration file.
  • Page 56 Protouch2 GUI User Manual device in Mass program mode can be given in “prefix”, “Start”, “Maximum”, “Increment by” fields. Program Configuration file with Serial number alone: Configuration file will be programmed in either OTP or EEPROM with the given serial number overwriting the values in configuration file.

  • Page 57: Offline Lan78Xx Configuration Page

    Protouch2 GUI User Manual 13.2 Offline LAN78XX Configuration Page Offline support allows for generation of configuration file even without the hub being connected to the system. Selecting Offline mode Select the radio button on the landing page as shown below.
  • Page 58 Protouch2 GUI User Manual If EEPROM is chosen, then the size of EEPROM to be programmed has to be selected as shown below. Loading a configuration file on top of the default SKU settings If user wants to generate configuration file for a device whose configuration is already modified then that device‟s dump file should be loaded using “Load...
  • Page 59 Protouch2 GUI User Manual Note: If user wants to generate configuration file for a device whose OTP is already programmed once, then OTP dump file of the device should be loaded using “Load Configuration file” option. Change configuration settings Configuration settings of the hub as desired can be changed from the default or...

  • Page 60: Troubleshooting

    1. Please check if you have installed the VSM and WinUSB drivers before running this tool using the CLI. Navigate to PT2_CLI folder and run this command as administrator in CMD line for installing the drivers. Refer to “Protouch2 CLI User Manual.pdf” for more details >>pt2main.exe /i...
  • Page 61 Protouch2 GUI User Manual 0x0005 System reboot is required 0x0006 Error in installing VSM filter driver 0x0007 Operation successful but requires reboot 0x0008 Bin file size is invalid 0x0009 Error while reading cfg/bin file 0x0011 Error in installing WinUSB driver...
  • Page 62 Protouch2 GUI User Manual Communication at the specified baud rate will be error 0x4000 prone Cannot set USB2534 UART registers, probably command 0x4001 failure 0x4002 Transmit failed without transmitting any data 0x4003 Transmit failed after transmitting some data 0x4004 Receive failed due to buffer overrun, reduce baud rate...

  • Page 63: Appendix Ii- Disable Power Management

    Protouch2 GUI User Manual 15 Appendix II- Disable Power Management 16 Windows 7 1. Right click “My Computer” and choose “Manage”. 2. Select Device Manager.  2016 Microchip Technology Inc Page 63...
  • Page 64 Protouch2 GUI User Manual 3. Search the hub based upon the VID & PID. 4. Select the hub and Right click on it, choose Properties option.  2016 Microchip Technology Inc Page 64...
  • Page 65 Protouch2 GUI User Manual 5. Select Power Management option. 6. To disable a Power Management uncheck the checkbox (Allow the computer to turn this device off to save power).  2016 Microchip Technology Inc Page 65...

  • Page 66: Windows 8.1

    Protouch2 GUI User Manual 7. Repeat the procedure (Steps 3 to 6) for USB 3.0 MTT hub if the connected hub is USB3.1 Gen1 Hub. 17 Windows 8.1 Right click Mycomputer and choose Manage option. All the other steps are same as for Windows 7.

  • Page 67: Appendix Iii - Protouch/Protouch2 Interoperability

    Protouch2 GUI User Manual 18 Appendix III – Protouch/Protouch2 interoperability PT2 can be used on a system which has PT1 already installed on it. To use the PT2 application, user can install PT2 drivers and can start using PT2 GUI or CLI.
  • Page 68 Protouch2 GUI User Manual 5. Select SMSC WinUSB Device 6. Now WinUSB Device will be loaded with SMSC WinUSB device driver  2016 Microchip Technology Inc Page 68...
  • Page 69 Protouch2 GUI User Manual 7. Now User can use PT1 tool. 8. Install the PT2 drivers for running PT2.  2016 Microchip Technology Inc Page 69...

  • Page 70: Appendix Iv - Checking Whether Drivers Were Installed Correctly For Pt2

    Protouch2 GUI User Manual 19 Appendix IV – Checking whether drivers were installed correctly for PT2 To check whether the drivers (VSM and WinUSB) were installed correctly 20 VSM as Class Filter 1. Right click “My Computer” and select “Manage”...
  • Page 71 Protouch2 GUI User Manual 2. It will navigate to Computer Management Window. In this, click Device Manager.  2016 Microchip Technology Inc Page 71...
  • Page 72 Protouch2 GUI User Manual 3. Select any one of the hub, right click on it and choose “Properties”.  2016 Microchip Technology Inc Page 72...
  • Page 73 Protouch2 GUI User Manual 4. It will open Properties of the Hub. Choose Driver tab.  2016 Microchip Technology Inc Page 73...
  • Page 74 Protouch2 GUI User Manual 5. In the Driver tab, click Driver Details option. It will redirect to Driver File details dialogue box. 6. If the VSM driver was installed as a class filter, there will be an entry for “Smschubfilter.sys”.

  • Page 75: Winusb Driver

    Protouch2 GUI User Manual 21 WinUSB Driver It may take few seconds to load the WinUSB driver. While it is loading, its status can be monitored in the device manager. Following are the steps to check the installation of WinUSB driver.
  • Page 76 Protouch2 GUI User Manual 2. To check the Driver version. Right click the HCE in device manager and click “Properties”  2016 Microchip Technology Inc Page 76...
  • Page 77 Protouch2 GUI User Manual 3. It will open “Microchip Hub Controller properties”.  2016 Microchip Technology Inc Page 77...
  • Page 78 Protouch2 GUI User Manual 4. In the Properties of Microchip Hub controller, we can find the driver Version. The driver version should be 1.0.0.4  2016 Microchip Technology Inc Page 78...

Table of Contents