Microchip Technology Protouch2 User Manual
  1. Manuals
  2. Brands
  3. Microchip Technology Manuals
  4. Microcontrollers
  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
MICROCHIP CONFIDENTIAL
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 MICROCHIP CONFIDENTIAL 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

    Protouch2 GUI User Manual Table of Contents Introduction ......................5 Abbreviations ....................5 Legal Information ....................5 Drivers........................6 Logging ........................6 Version ........................6 Known Limitations ....................6 Disable Power Management .................. 7 Configuration File formats ..................8 JSON Format ....................8 Binary Format ....................
  • Page 4 Protouch2 GUI User Manual 10.1 Selecting Offline mode ................31 10.2 Selecting the part number ................. 31 10.3 Loading a configuration file on top of the default SKU settings ....31 10.3.1 Straps..................... 32 10.4 Change configuration settings ..............33 10.5...

  • Page 5: Introduction

    Protouch2 GUI User Manual 1 Introduction Protouch2 GUI is a Configuration and Programming tool for USB57X4 and other families of Microchip USB hub products. 1.1 Abbreviations UCH – Universal Hub Controller HCE – Hub controller Enumeration Internal USB Device PT2 – Protouch2 UUID –...

  • Page 6: Drivers

    3 Drivers WinUSB driver needs to be installed before launching the tool. Hub Class Filter installation can be done by using Command Line Tool. Please refer to “Protouch2 CLI User Manual.pdf” Section 3 for driver installation driver uninstallation. Please run the following command in Command line using PT2_CLI as administrator for installing the drivers >>Pt2main.exe /iw...

  • 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 3.0 Hub, then power management should be disabled on both 2.0 Hub and 3.0 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. Both the files are generated when changes are done to the configuration items in the Hub.
  • Page 9 Protouch2 GUI User Manual usb3serial Serial String of the USB3 HUB “usb3serial”:”456789” hceenable Force enable 5 endpoint device “hceenable”:”1” Value : 1 – Force enable Value : 0 – Default behaviour swapupstreamdpdm Swaps dp and dm “swapupstreamdpdm”:”1” swapport1dpdm Value : 1 – Swaps D+ and D- swapport2dpdm Value : 0 –...

  • Page 10: Binary Format

    Protouch2 GUI User Manual cdcenable Communication Device class “cdcenable”:”1” Value:0 – Disable CDC Value:1 – Enable CDC at interface 1 Value:2 – Enable CDC at interface 0 8.2 Binary Format Configuration files in binary format can be also generated and programmed using this tool.

  • Page 11: 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 3.0 Hub Online” is selected in landing page, it moves to the configuration page and looks for Microchip Hubs in the system after loading the appropriate drivers.

  • Page 12: Online Hub Configuration Page

    Protouch2 GUI User Manual 9.3 Online Hub Configuration Page MCHP hubs contain several registers that can change the behavior of the hub. It can be changed to a new value through the PT2 application by programming the configuration memory. MCHP Hub configuration items are divided into the following three categories and are available under 3 different tabs as shown below ...

  • Page 13: Basic Features

    9.3.1.1 Device Management 9.3.1.1.1 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 14: Device Identification Usb 2.0

    Protouch2 GUI User Manual For example, Green if usage < 50%, Yellow if usage between 50-75%, red if usage > 75%. 9.3.1.1.6 Restore Factory Defaults Restore Factory Defaults is a restoration of a hub to its original system state by erasing all of the information stored on the device in an attempt to restore the device to its original manufacturer settings.

  • Page 15: Device Identification Usb 3.0

    Protouch2 GUI User Manual 9.3.1.3 Device Identification USB 3.0 USB 3.0 Vendor id, Product id, bcdDevice, String Descriptors and UUID can be customized by writing appropriate values. 9.3.1.4 Downstream Port Configuration 9.3.1.4.1 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.
  • Page 16 Protouch2 GUI User Manual  „If check box is not checked‟ = port is removable,  „If check box is checked‟ = port is non- removable. This configuration item informs the Host that one of the active ports has a permanent device that is non-detachable from the Hub.
  • Page 17 Protouch2 GUI User Manual MICROCHIP CONFIDENTIAL Page 17...

  • Page 18: Advanced Features

    Protouch2 GUI User Manual 9.3.2 Advanced Features 9.3.2.1 Downstream Port Configuration (advanced) 9.3.2.1.1 Swap D+/D-: USB2.0 DP and DM Pins can be swapped using GUI. 9.3.2.1.2 PHY Boost and Varisense: USB signal drive strength in upstream and downstream transceivers can be changed using PHY Boost.

  • Page 19: Upstream Port Configuration

    Protouch2 GUI User Manual 9.3.2.2 Upstream Port Configuration 9.3.2.2.1 Flex connect USB 2.0/3.0 downstream port 1 can be configured as Upstream Port.  „If check box is not checked‟ = Upstream port is not Flex connected – default behaviour  „If check box is checked‟ = Upstream port is Flex connected , meaning the upstream port is downstream port and downstream port1 is the upstream port.

  • Page 20: Hce (Internal Usb Device)

    Protouch2 GUI User Manual 9.3.2.3 HCE (Internal USB Device) 9.3.2.3.1 Enable HCE HCE (Hub controller Enumeration Device) is used for programming the OTP by communicating with the UCH (Universal controller Hub) device. HCE can be enabled always by using the GUI and programming the configuration memory.

  • Page 21: Communication Device Class (Cdc)

    Protouch2 GUI User Manual 9.3.2.4 Communication Device Class (CDC) 9.3.2.5 Advanced Settings 9.3.2.5.1 Hub Power Mode Hub power mode can be configured by using this GUI. If the hub is self-powered, then external power supply is applied to hub. If the hub is bus-powered, then power is obtained from the USB port to which the hub is connected.
  • Page 22 Protouch2 GUI User Manual 9.3.2.5.3 SUSP_IND USB 2.0 If the Suspend indicator is enabled, then Device is configured and is active (not in suspend). If Resume inhibit is enabled, then if hub detects any wakeup event then suspend indication will be driven for some time. SUSP_IND Pin can be configured by using GUI.

  • Page 23: Direct Register Access

    Protouch2 GUI User Manual 9.3.2.6 Direct Register Access XDATA Address can be programmed with desired value directly by using Direct Register Access option. Example: Write value 1234 in register 0x3000 as shown below 9.3.2.6.1 INI Format [OTPGEN_CONFIG] ; XDATA Write byte. i.e XDATA[address] = yy ;...

  • Page 24: Live Update

    Protouch2 GUI User Manual ; XDATA Clear bits. i.e XDATA[address] &= (~yy) ; XCLR_ is the identifier to initiate xdata clear bits operation. ; Example 1: XCLR _3000=13 ; clears bit 0,1,4 in xdata address 0x3000 XCLR_3001=01 ; clears bit 2 in...

  • Page 25: Dump Memory

    Protouch2 GUI User Manual Example: To read Register value: 9.3.2.8 Dump memory Dump memory allows user to dump OTP memory or SPI memory or SPI with Pseudo OTP memory present in device connected. MICROCHIP CONFIDENTIAL Page 25...

  • Page 26: Preview Changes

    Protouch2 GUI User Manual 9.3.3 Preview Changes Preview changes allows user to view information such as Number of bytes to be programmed, Configuration memory usage before programming. User can also save configuration file without programming. MICROCHIP CONFIDENTIAL Page 26...

  • Page 27: Special Features

    Protouch2 GUI User Manual 9.3.4 Special Features 9.3.4.1 Enable Live Flexconnect USB 2.0/3.0 Downstream Port 1 can be configured as Upstream Port. Upstream port can be configured as downstream Port 1.  „If check box is not checked‟ = Upstream port is not Flex connected, ...

  • Page 28: Programming Page

    Protouch2 GUI User Manual 9.4 Programming Page 9.4.1 Device Selection The hub of interest can be selected from the dropdown. 9.4.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 29: Configuration Programming Along With Spi Flash Firmware Programming

    Protouch2 GUI User Manual 9.4.4 Configuration programming along with SPI Flash Firmware programming Configuration file and Firmware file can be programmed in one shot. 9.4.5 Types of programming 9.4.5.1 Program Once Single device can be programmed at a time by using Program Once option. Select the hub of interest.

  • Page 30: Mass Program

    Protouch2 GUI User Manual 9.4.5.2 Mass Program Multiple devices can be programmed one after the other by using the Mass Program option. Select the hub of interest. Configuration file and/or Firmware File should be selected one time before programming. 9.4.6 Programming time It takes about 3 to 5 seconds for programming if the internal HCE (Hub Controller Enumeration) device is enabled.

  • Page 31: Offline Support

    Protouch2 GUI User Manual 10 Offline Support Offline support allows for generation of configuration file even without the hub being connected to the system. 10.1 Selecting Offline mode Select the radio button on the landing page as shown below 10.2 Selecting the part number Select the part number of interest from the drop down shown below 10.3 Loading a configuration file on top of the default SKU...

  • Page 32: Straps

    Protouch2 GUI User Manual “SAVE” button is inactive at this time since no changes are made to the configuration settings. 10.3.1 Straps If loaded configuration file does not have Non- Removable, Battery Charging and Port Enable/Disable related changes then static text will be set as "Can be Configured using strap"...

  • Page 33: Change Configuration Settings

    Protouch2 GUI User Manual 10.4 Change configuration settings Configuration settings of the hub as desired can be changed from the default or default+ Load configuration settings as shown below The SAVE button becomes active as soon as any changes are done 10.5 RESET...

  • Page 34: 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 35 Protouch2 GUI User Manual 0x1003 SPI pass through write command failed 0x1004 SPI pass through Enter command failed 1 0x1005 SPI flash could not be detected or was not present 0x1006 SPI Cancel Download 0x1007 SPI flash programming failed 0x1008...

  • Page 36: Appendix Ii- Disable Power Management

    Protouch2 GUI User Manual 12 Appendix II- Disable Power Management 12.1 Windows 7 1. Right click Mycomputer and choose Manage option. 2. Select Device Manager. MICROCHIP CONFIDENTIAL Page 36...
  • Page 37 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. 5. Select Power Management option. MICROCHIP CONFIDENTIAL Page 37...
  • Page 38 Protouch2 GUI User Manual 6. To disable a Power Management uncheck the checkbox (Allow the computer to turn off this device to save power). 7. Repeat the procedure (Steps 3 to 6) for USB 3.0 MTT hub if the connected hub is 3.0 Hub.

  • Page 39: Windows 8.1

    Protouch2 GUI User Manual 12.2 Windows 8.1 Right click Mycomputer and choose Manage option. All the other steps are same as for Windows 7. MICROCHIP CONFIDENTIAL Page 39...

  • Page 40: Appendix Iii - Pt1/Pt2 Interoperability

    Protouch2 GUI User Manual 13 Appendix III – PT1/PT2 interoperability PT1 is installed previously on a system. Now user wants to install PT2. Uninstallation of PT1 is not required. User can install PT2 drivers and use PT2 GUI or CLI.
  • Page 41 Protouch2 GUI User Manual 5. Select SMSC WinUSB Device 6. Now WinUSB Device will be loaded with SMSC WinUSB device driver MICROCHIP CONFIDENTIAL Page 41...
  • Page 42 Protouch2 GUI User Manual 7. Now User can use PT1 tool. 8. Install the PT2 drivers for running PT2. MICROCHIP CONFIDENTIAL Page 42...

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

    Protouch2 GUI User Manual 14 Appendix IV – Checking whether drivers were installed correctly for PT2 To check whether the drivers(VSM and WinUSB) were installed correctly 14.1 VSM as Class Filter 1. Right click Mycomputer and select Manage option 2. It will navigate to Computer Management Window. In this, click Device Manager.
  • Page 44 Protouch2 GUI User Manual 3. Select any one of the hub and Right click choose Properties option. 4. It will open Properties of the Hub. Choose Driver tab MICROCHIP CONFIDENTIAL Page 44...
  • Page 45 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, Smschubfilter.sys entry will be there. MICROCHIP CONFIDENTIAL...

  • Page 46: Winusb Driver

    Protouch2 GUI User Manual 14.2 WinUSB Driver Sometimes it may take some time to load the WinUSB driver. While loading status can be monitored in the device manager. Following are the steps to check whether WinUSB driver was installed properly.
  • Page 47 Protouch2 GUI User Manual 2. To check the Driver version. Right click the HCE in device manager-> click properties option 3. It will redirect to Microchip Hub Controller properties MICROCHIP CONFIDENTIAL Page 47...
  • Page 48 Protouch2 GUI User Manual 4. In Microchip Hub controller Properties page we can find the Version of the driver. The driver version should be 1.0.0.4 MICROCHIP CONFIDENTIAL Page 48...
  • Page 49 Protouch2 GUI User Manual MICROCHIP CONFIDENTIAL Page 49...

Table of Contents