Renesas Application Note 2011-02-17
Renesas Application Note 2011-02-17
Renesas Application Note 2011-02-17
Introduction
This manual is intended for engineers who wish to utilize the RENESAS PD720200 and PD720200A USB
3.0 Host Controller in a Windows based system using RENESAS device drivers.
Notice
On April 1st, 2010, NEC Electronics Corporation merged with Renesas Technology Corporation, and
Renesas Electronics Corporation took over all the business of both companies. Therefore, we changed the
old company name to new company name in driver package from Ver.2.0.4.0.
Target Device
USB3.0 Host Controller PD720200 and PD720200A
Contents
1. Overview ........................................................................................................................................... 2
2. INSTALLING DRIVER....................................................................................................................... 8
1. Overview
This software is Renesas’ original device driver for Windows Operating System that operates USB 3.0 Host
controllers PD720200 and PD720200A.
1.2.1 Files
nusb3hub.cat : Catalog file for RENESAS Electronics USB 3.0 Root Hub Driver
nusb3hub.inf : INF file for installing RENESAS Electronics USB 3.0 Root Hub Driver
nusb3hub.sys : RENESAS Electronics USB 3.0 Hub controller Driver
nusb3xhc.cat : Catalog file for RENESAS Electronics xHCI Driver
nusb3xhc.inf : INF file for installing RENESAS Electronics xHCI Driver
nusb3xhc.sys : RENESAS Electronics eXtensible Host Controller Interface (xHCI) Driver
nusb3mon.exe : RENESAS Electronics USB3.0 Host Controller monitor application
nusb3mon.dll : RENESAS Electronics USB3.0 Host Controller monitor application DLL
nusb3utl.exe : RENESAS Electronics USB3.0 Host Controller Utility
nusb3ver.dll : RENESAS Electronics USB3.0 Host Controller driver version
nusb3mon.exe.mui : Monitor application Multi Language Interface file
nusb3utl.exe.mui : Utility Multi Language Interface file
If you want to disable the Selective Suspend function, use the install option (/v”SET_SELSUS_MODE1=1”).
Please see section 2.8.
When using this command line option, the Selective Suspend function can be disabled as follows. This is same as
in Ver2.0.4.0 or earlier.
Note : Selective Suspend function for External Hub is based upon Windows 7.
If you want to disable the Dynamic U1/U2 state control function, please use the install option
(/v”U1U2_DISABLE=1”). Please see section 2.10.
If you don’t want to display this check-box, use the install option (/v”U1U2_UTL_DISABLE=1”). Please see section
2.11. In using this command line option, the end user cannot change the setting of Dynamic U1/U2 state control
function on USB 3.0 Host controller Utility. This is same as in Ver2.0.4.0 or earlier.
To recover from the Over Current status, End Users have to reset the status with the
application or restart the PC. The reset method with the application is shown below.
1. Click the pop up message (“Power Surge On Hub Port”)
Note : RENSAS USB 3.0 Host Controller Driver’s behavior differs from Microsoft’ behavior.
2. INSTALLING DRIVER
This chapter describes how to install drivers for PD720200 and PD720200A. All the following sections are written
based on Windows 7. Note that the comments and conditions for other OS platforms may be different from these
sections.
5. Click on the Install button to start installing the Renesas Electronics drivers.
6. Click on the Finish button to exit the driver installation program.
2. When the following dialog box is displayed, select the Renesas Electronics USB3.0 Host
Controller Driver. Click Uninstall button.
2. From the Start menu, click on the Control Panel. From Control Panel, click on System and Security, and
then click on the Device Manager. You should find the RENESAS Electronics USB 3.0 Host Controller
and the RENESAS Electronics USB 3.0 Root Hub under the Universal Serial Bus Controllers entry in
the Device Manager. If there is not an “X” or “!” beside these entries, the driver installation for USB 3.0
Host Controller has finished successfully.
1. Start the Run… command on the Start menu and open command prompt.
2. Run one of the following Installing commands.
3. If USB 3.0 Host Controller doesn’t exist on your PC, Installer stops the installation. Also the
following pop-up is shown when using Ex. 1 command.
Note : If this pop-up message doesn’t need to show, please use the “NO_MESSAGE” option,
which is shown as Ex. 2 above and described in section 2.9 in more detail.
1. Start the Run… command on the Start menu and open command prompt.
2. Run the following Installing command.
1. Start the Run… command on the Start menu and open command prompt.
2. Run the following Installing command.
1. Start the Run… command on the Start menu and open command prompt.
2. Run the following Installing command.
1. Start the Run… command on the Start menu and open command prompt.
2. Run the following Installing command.
1. Start the Run… command on the Start menu and open command prompt.
2. Run the following Installing command.
2.11 Option: Disable the check-box on USB 3.0 Host Controller Utility
From ver2.0.26.0, the USB 3.0 Host controller Utility supported the check-box to disable the Dynamic
U1/U2 state control function. Please see section 3.1.1 for more detail. This check-box appears by
default with Ver2.0.26.0.
If you don’t want to display this check-box on the USB 3.0 Host controller Utility, please use this
option on the command prompt.
1. Start the Run… command on the Start menu and open command prompt.
2. Run the following Installing command.
From ver2.0.26.0, the end user can disable the Dynamic U1/U2 state control function (USB 3.0 power
management). This method is follows.
1. Run the “USB 3.0 Host Controller Utility (nusb3utl.exe)”.
2. Click the check box of “Disable USB3.0 power management functions”.
3. Click “OK” button.
4. When changing this setting, the following pop-up is shown.
Note: To update the settings, you must reconnect all currently connected USB 3.0 devices.
Example)
Host Controller
Port1 Port2
10%
Not enough
100%
bandwidth
Super-speed Super-speed
Webcam Webcam
4.1.1 Set the folder Renesas USB 3.0 Host Controller Driver file of Path Variables
At first you should set the absolute path of the source file folder to customize the driver installer at the
following locations:
CustomDLLSrcFolderX64 : Located the folder of Custom Action DLL(x64)
CustomDLLSrcFolderX86 : Located the folder of Custom Action DLL(x86)
LicenseSrcFolder : Located the folder of license file
VersionSrcFolder : Located the folder of version DLL
MonitorSrcFolder : Located the folder of Monitor application file
UtilitySrcFolder : Located the folder of Utility application file
DriverSrcFolderX64 : Located the folder of Driver(x64)
DriverSrcFolderX86 : Located the folder of Driver(x86)
When you set the path of Custom Action DLL(x86 or x64), the following pop-up is shown. You should
select “Yes” button, so the absolute path of all custom action DLL (x86 or x64) is replaced.
This menu is the general information for Driver Installer. For example, it is possible to change the
Supported Language of driver installer, Product Name, Product Version, and so on.
We offer the MUI (Multi User Interface) files for the mini application. MUI file is the display language
file for mini applications. If you change the support languages of the mini applications, you should
delete the mini application components (Monitor and Utility) from project file. See the following photo.
For example, Monitor0401 folder is stored the Arabic’s MUI file. So you need to delete the components
of languages which you don’t support. See the section 1.2 for more detail of LCID.
5. Appendix
5.1 Setup.exe Return Values and Run-Time Errors (Basic MSI and InstallScript MSI
Projects) InstallShield 2010
The table below lists the errors that might occur when Setup.exe runs in a Basic MSI or InstallScript MSI project.
For Setup.exe errors that might occur in an InstallScript project, see Setup.exe Return Values and Run-Time
Errors (InstallScript Projects).
You can capture these return values when you call the CreateProcess API to launch Setup.exe, or use a batch file
to launch Setup.exe.
Note : If an error occurs, the strings displayed might not be displayed in English if your operating system is not
running in English.
Error
Description Troubleshooting Tips
Number
Verify that a valid command line is passed to
-4 Invalid command line.
Setup.exe.
The installation exited because the
-3 Not applicable.
end user canceled the installation.
-1 General error.
0 Program terminated successfully. Not applicable.
String variable is not large enough
for string. InstallShield was
attempting to copy a text string into Check the declared length of the string variable.
401
a string variable. The text string Increase the length to the maximum allowed value.
was larger than the length declared
for that string variable.
Setup has detected an incompatible
Windows Installer is compatible with NT 4.0 and later,
version of Windows. Click OK and
1150 and Windows 9x and later. Check your version of
relaunch the setup on Windows 95,
Windows and upgrade if necessary.
Windows NT 4.0, or later.
To write to the temporary location, the environment
variable TEMP must be set. Verify that the Temp
Error writing to the temporary
1151 folder exists and has enough disk space to
location
accommodate the setup. If there are files in the Temp
folder, delete them and rerun Setup.exe.
Check to see that you are able to write to the Temp
folder (see errors above). If the Temp folder is valid,
Error extracting <file name> to the
1152 there may be corrupted files in the setup. Check the
temporary location
files to ensure none are corrupted and rerun
Setup.exe.
The Setup.ini file must be located in the same folder
1153 Error reading setup initialization file
as Setup.exe. If not, move Setup.ini to that location.
Windows Installer may not have been properly
1154 Installer not found in <path> installed, or you may have an older version. Reinstall if
necessary.
This chapter describes the InstallShield 2010 SP1 project file in more detail for customizing the driver installer.
InstallShild 2010 SP1 is necessary to customize a driver installer. All of the following sections are written based on
Windows XP. Note that the comments and conditions for other OS platforms may be different from these
descriptions.
All trademarks and registered trademarks are the property of their respective owners.
Revision Record
Description
Rev. Date Page Summary
0.01 July 13th, 2010 - First edition issued.(ISG-NC1-200020)
0.02 August 11th, 2010 - Second edition issued. (ISG-NC1-200030)
- Modified
- Section 1.1(Added the System Requirement)
- Section 1.2.3(Added the Command line option)
- Section 2.5(Added the explanation about the pop-up
message )
- Added
- Section 1.4(Selective Suspend function)
- Section 2.8(Option: Disable the Selective Suspend function)
- Section 2.9(Hide the pop-up message)
0.03 October 7th, 2010 - Third edition issued. (ISG-NC1-200040)
- Modified
- Section 1.2.3(Added the Command line option)
- Section 3.1.1(Added the explanation about Check-Box to
disable the Dynamic U1/U2 state control function)
- Added
- Section 1.5( Dynamic U1/U2 state control function)
- Section 2.10(Option: Disable the Dynamic U1/U2 state control
function)
- Section 2.11(Option: Disable the check-box on USB 3.0 Host
Controller Utility)
0.04 February 17th, 2011 - Forth edition issued. (ISG-NC1-200061)
- Added
- Section 1.6 (Over Current function)
- Section 5 (Appendix)
USB 3.0 Host controller Driver Driver Package Information