Microchip Technology Protouch2 User manual

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 1
Protouch2 GUI User Manual

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 2
Microchip Technology, Inc.
Microchip Technology,
Incorporated
2355 W. Chandler Boulevard
Chandler, Arizona 85224
480/792-7416
RE
V
DATE
ORIGINATOR
DESCRIPTION OF CHANGE
0.9
30-Dec-
2014
Vishnu P
Initial version
1.3
30-Apr-
2015
Vishnu P
Offline support added
1.4
30-May-
2015
Vishnu P
Changes from version 1.3 to 1.4

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 3
Table of Contents
1Introduction............................................................................................................5
1.1 Abbreviations................................................................................................. 5
2Legal Information ..................................................................................................5
3Drivers....................................................................................................................6
4Logging..................................................................................................................6
5Version...................................................................................................................6
6Known Limitations ................................................................................................6
7Disable Power Management..................................................................................7
8Configuration File formats.....................................................................................8
8.1 JSON Format.................................................................................................. 8
8.2 Binary Format .............................................................................................. 10
9Application...........................................................................................................11
9.1 Help Page ..................................................................................................... 11
9.2 Landing Page................................................................................................ 11
9.3 Online Hub Configuration Page................................................................... 12
9.3.1 Basic Features....................................................................................... 13
9.3.1.1 Device Management...................................................................... 13
9.3.1.2 Device Identification USB 2.0....................................................... 14
9.3.1.3 Device Identification USB 3.0....................................................... 15
9.3.1.4 Downstream Port Configuration.................................................... 15
9.3.2 Advanced Features................................................................................ 18
9.3.2.1 Downstream Port Configuration (advanced)................................. 18
9.3.2.2 Upstream Port Configuration......................................................... 19
9.3.2.3 HCE (Internal USB Device).......................................................... 20
9.3.2.4 Communication Device Class (CDC)............................................ 21
9.3.2.5 Advanced Settings......................................................................... 21
9.3.2.6 Direct Register Access................................................................... 23
9.3.2.7 Live Update ................................................................................... 24
9.3.2.8 Dump memory............................................................................... 25
9.3.3 Preview Changes................................................................................... 26
9.3.4 Special Features .................................................................................... 27
9.3.4.1 Enable Live Flexconnect ............................................................... 27
9.4 Programming Page....................................................................................... 28
9.4.1 Device Selection ................................................................................... 28
9.4.2 Configuration programming ................................................................. 28
9.4.3 Firmware programming........................................................................ 28
9.4.4 Configuration programming along with SPI Flash Firmware
programming....................................................................................................... 29
9.4.5 Types of programming.......................................................................... 29
9.4.5.1 Program Once................................................................................ 29
9.4.5.2 Mass Program................................................................................ 30
9.4.6 Programming time ................................................................................ 30
10 Offline Support ....................................................................................................31

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 4
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 RESET...................................................................................................... 33
10.6 Save the new configuration file................................................................ 33
11 Appendix I ...........................................................................................................34
12.1 Troubleshooting.............................................................................................. 34
12.2 Error codes...................................................................................................... 34
12 Appendix II- Disable Power Management ..........................................................36
12.1 Windows 7................................................................................................ 36
12.2 Windows 8.1............................................................................................. 39
13 Appendix III –PT1/PT2 interoperability.............................................................40
14 Appendix IV –Checking whether drivers were installed correctly for PT2 .......43
14.1 VSM as Class Filter.................................................................................. 43
14.2 WinUSB Driver........................................................................................ 46

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 5
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 –Universal Unique Identifier
2 Legal Information
Software License Agreement
(c) 2004 - 2015 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 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 6
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
Note: VSM Filter driver needs to be installed if the internal HCE device is disabled.
4 Logging
Log file with detailed messages will get created in the same path from where the
application is running in the name of “PT2.log”.
5 Version
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

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 7
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. Please refer to Appendix II for more
details
Uncheck the Checkbox so that the computer will not put the hub to sleep.

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 8
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.
8.1 JSON Format
JSON file uses human readable text to program. Json file starts with open brace “{”
and end with close brace “}”. Number of properties using "name": "value" pairing,
separated by commas can be declared inside these braces. There should not be any
empty space or empty line. Use only below mentioned names (case-sensitive) in Json
File. Json file should be in the below given format.
Format:
{
"name":"value"
}
*use comma to separate when there are more entries.
Example:
{
"pid":"0x1234",
"did":"0x5678"
}
In this example, pid and did are configuration items and 0x1234and 0x5678 are the
new values.
Below is the list of supported configuration items:
Name
Explanation
Example
vid
16-bit value that uniquely identifies the Vendor
ID of the USB2 device
“vid”:”0x0424”
pid
16-bit value that the Vendor can assign that
uniquely identifies particular Product ID for
USB2 device
“pid”:”0x2744”
did
16-bit device release number for USB2 device
in BCD format
“did”:”0x1234”
usbvcd
USB2 Specification Release Number in BCD
format
“usbvcd”:”2.10”
languageid
USB2 LANGUAGE ID
“languageid”:”0x4009”
manufacturer
Manufacturer String of the USB2 HUB
“manufacturer”:”Microchip”
product
Product String of the USB2 HUB
“product”:”Tyler”
serial
Serial String of the USB2 HUB
“serial”:”123456”
usb3vid
16-bit value that uniquely identifies the Vendor
ID of the USB3 device
“usb3vid”:”0x0424”
usb3pid
16-bit value that the Vendor can assign that
uniquely identifies particular Product ID for
USB3 device
“usb3pid”:”0x5744”
usb3did
16-bit device release number for USB3 device
in BCD format
“usb3did”:”0x5678”
usb3languageid
USB3 LANGUAGE ID
“usb3languageid”:”0x4009”
usb3manufacturer
Manufacturer String of the USB3 HUB
“usb3manufacturer”:”Microchip”
usb3product
Product String of the USB3 HUB
“usb3product”:”USB5734”

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 9
usb3serial
Serial String of the USB3 HUB
“usb3serial”:”456789”
hceenable
Force enable 5th endpoint device
Value : 1 –Force enable
Value : 0 –Default behaviour
“hceenable”:”1”
swapupstreamdpdm
swapport1dpdm
swapport2dpdm
swapport3dpdm
swapport4dpdm
Swaps dp and dm
Value : 1 –Swaps D+ and D-
Value : 0 –Default behaviour
“swapupstreamdpdm”:”1”
nrdeviceport4
nrdeviceport3
nrdeviceport2
nrdeviceport1
Configures Port as removable/non-removable
Value : 1 –Port Non-removable
Value : 0 –Port Removable
“nrdeviceport4”:”1”
flexconnect
Enables flexconnect. Swaps downstream port1
and upstream
Value : 1 –Enable Flexconnect
Value : 0 –Disable Flexconnect
“flexconnect”:”1”
hubpower
Configures hubpower as self-power or bus-
power
Value : 1 –Self-power
Value : 0 –Bus-power
“hubpower”:”1”
PHYBOOST
PHYBOOSTdownstream
port1
PHYBOOSTdownstream
port2
PHYBOOSTdownstream
port3
PHYBOOSTdownstream
port4
Configures phy boost Value
0 –5% below nominal
1 –Nominal 17.78 mA
2 –5% above nominal
3 –10% above nominal
4 –15% above nominal
5 –20% above nominal
6 –25% above nominal
7 –30% above nominal
“PHYBOOSTdownstreamport1”:”
1”
SQUELCH
SQUELCHdownstreamp
ort1
SQUELCHdownstreamp
ort2
SQUELCHdownstreamp
ort3
SQUELCHdownstreamp
ort4
Configures Varisense of hub
0 –62.5mV below nominal
1 –50mV below nominal
2 –37.5mV below nominal
3 –25mV below nominal
4 –12.5mV below nominal
5 –Nominal 100mV
6 –12.5mV above nominal
7 –25mV below nominal
“SQUELCHdownstreamport1”:”2”
downstreamBCsettingp
ort1
downstreamBCsettingp
ort2
downstreamBCsettingp
ort3
downstreamBCsettingp
ort4
Configures Battery charging of port
0 –Standard USB port Max-500mA
1 –BC 1.2 Compliant Port Max-1.5A
2 –Most Devices supported mode Max-2A
“downstreamBCsettingport1”:”1”
hce_vid
16-bit value that uniquely identifies the Vendor
ID of the HCE device
“hce_vid”:”0x0424”
hce_pid
16-bit value that the Vendor can assign that
uniquely identifies particular Product for HCE
ID Device
“hce_pid”:”0x2740”
hce_did
16-bit device release number for HCE device in
BCD format
“hce_did”:”0x1234”
hce_languageid
Language id of HCE device
“hce_languageid”:”0x4009”
hce_manufacturer
Manufacturer string of HCE device
“hce_manufacturer”:”Microchip”
hce_product
Product string of HCE device
“hce_product”:”Controller hub”

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 10
cdcenable
Communication Device class
Value:0 –Disable CDC
Value:1 –Enable CDC at interface 1
Value:2 –Enable CDC at interface 0
“cdcenable”:”1”
8.2 Binary Format
Configuration files in binary format can be also generated and programmed using this
tool. This is the format in which data will be stored in the Configuration memory and
is not human readable. These files are generated and accepted with extension .cfg

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 11
9 Application
The following pages are available in the tool
9.1 Help Page
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.
There are two main use cases for PT2 USB 3.0 Hub application in Online mode
1. Configuration File Generation –User experiments with MCHP hub and
selects the features in the hub and provides new values for the configuration
items he wants to change.
2. Mass Programming –Tool for programming several MCHP Hubs for
production.
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.

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 12
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
Basic Features ( Shown by default)
Advanced Features
Special Features

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 13
9.3.1 Basic Features
Features that are widely used and modified by several customers are grouped in the
Basic features Tab
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”.
9.3.1.1.2 Auto Identified Part Number
This will give information about the SKU which is nothing but default PID of the
SKU. The Auto-identification is independent of VID/PID changes.
9.3.1.1.3 Config Memory and Firmware Memory
There can be only two possibilities as follows
1. Firmware is running from ROM, configuration is always loaded from OTP
2. Firmware is running from SPI Flash, configuration is always loaded from SPI
9.3.1.1.4 No of configurations programmed
No of configurations Programmed will be displayed based on the information read
from the hub. The tool allows programming as long as there is free configuration
memory space.
9.3.1.1.5 Configuration Memory Usage
Configuration space usage progress bar shows the % of configuration memory used.
Colour coding is based on the usage %.

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 14
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.
9.3.1.2 Device Identification USB 2.0
USB 2.0 Vendor id, Product id, bcdDevice, bcdUSB and String Descriptors can be
customized by writing appropriate values.
USB 2.0 String can be disabled by programming empty string as shown below. USB
3.0 and HCE strings can also be disabled by this method.

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 15
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.
9.3.1.4.2 Non Removable ports:
USB 2.0/3.0 ports can be configured as Non Removable ports. It indicates whether
the ports have non- removable devices.

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 16
„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.
9.3.1.4.3 Battery Charging:
USB2.0 Standard USB Port-Max 500mA
BC 1.2 Compliant Port-Max 1.5A
Most Devices Supported Mode-Max 2A
9.3.1.4.3.1 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.
9.3.1.4.3.2 BC 1.2 Compliant Port-Max 1.5A:
When there is no upstream VBUS, and consequently no USB host connected on the
upstream port, the downstream battery charging enabled ports will operate as BC 1.2
compliant Port-Max 1.5 A.
9.3.1.4.3.3 Most Devices supported Mode-Max 2A
When there is an upstream VBUS and an upstream connection, the downstream
battery charging enabled ports will operated as Most Devices supported Mode-Max
2A.

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 17

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 18
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. USB signal receiver sensitivity can be changed by using Varisense.
Downstream Ports PHY Boost and Varisense value can be changed by using GUI as
shown below

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 19
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.
9.3.2.2.2 Swap D+/D-
USB 2.0 Upstream DP and DM Pins can be swapped using the GUI.
9.3.2.2.3 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.
Downstream Ports PHY Boost and Varisense value can be changed by using GUI as
shown below

Protouch2 GUI User Manual
MICROCHIP CONFIDENTIAL
Page 20
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.
„If check box is not checked‟ = UCH not Enabled always,
„If check box is checked‟ = UCH Enabled always,
UCH Vendor id, Product id, bcdDevice and String Descriptors can be customized by
writing appropriate values. If the VID or PID of the HCE device is changed from
the default value, the new VID and PID needs to be added into the INI file .PID
should be added to HCE_DEV_INFO and VID should be added to
"HUB_VID_LIST" in the INI file.