• Right-click on the project > Properties > Driver Settings > Target OS version > Windows 7

• Build with VS 2017(v141) is also possible if platform toolset in setting is configured to v141

• VS 2019(v142): requires >= 10.0.18xxx
• VS 2017(v141): requires >= 10.0.17xxx

• WDK 10.0.17134(1803), 10.0.17763(1809), 10.0.18346 are also tested

Open usbip_win.sln

If VS 2017 is used, SDK version for userspace projects(usbip, usbip_common, usbipd, stubctl) should be adjusted.

Set certificate driver signing for usbip_stub and usbip_vhci projects.

• Right-click on the project > Properties > Driver Signing > Test Certificate
• Browse to driver/usbip_test.pfx

Build solution or desired project.

All output files are created under {Debug,Release}/{x64,x86} folder

• Tested on Ubuntu 16.04
• Kernel 4.15.0-29 (USB/IP kernel module crash was observed on some other version)
• # modprobe vhci-hcd

• Install driver/usbip_test.pfx (password: usbip)
• Certificate should be installed into
  1. "Trusted Root Certification Authority" in "Local Computer" (not current user) and
  2. "Trusted Publishers" in "Local Computer" (not current user)

• > bcdedit.exe /set TESTSIGNING ON
• reboot the system to apply

• You can find usbip.exe, usbipd.exe, usbip_stub.sys in output folder after build or on release page.
• userspace/usb.ids
• driver/stub/usbip_stub.inx

• You can get device id from usbip listing
  • > usbip.exe list -l
• Bus id is always 1. So output from usbip.exe listing is shown as:

• This command replaces an existing function driver with usbip stub driver
  • This should be executed using administrator privilege
  • usbip_stub.inx and usbip_stub.sys files should be in the same folder as usbip.exe
• > usbip.exe bind -b 1-59

• > usbipd.exe -d -4
  • TCP port 3240 should be allowed by firewall

• # usbip attach -r <usbip server ip> -b 1-59

Currently, there are 2 versions for a vhci driver - vhci(wdm): original version, implemented via WDM(Windows Driver Model) - vhci(ude): newly developed version to fully support USB applications and implemented via UDE(USB Device Emulation) which is MS provided USB virtualization framework over KMDF(Kernel-Model Driver Framework) - Installation procedures for 2 versions are different.

Prepare a linux machine as a USB/IP server (or windows usbip-win stub server)

• tested on Ubuntu 16.04(Kernel 4.15.0-29), 18.04, 20.04
• # modprobe usbip-host
• You can use virtual usbip-vstub as a stub server

Run usbipd on a USB/IP server (Linux)

• # usbipd -4 -d

Install USB/IP test certificate

• Install driver/usbip_test.pfx (password: usbip)
• Certificate should be installed into
  1. "Trusted Root Certification Authority" in "Local Computer" (not current user) and
  2. "Trusted Publishers" in "Local Computer" (not current user)

Enable test signing

• > bcdedit.exe /set TESTSIGNING ON
• reboot the system to apply

Copy vhci driver files into a folder in target machine

• If you're testing vhci(ude), copy usbip.exe, usbip_vhci_udf.sys, usbip_vhci_udf.inf, usbip_vhci_udf.cat into a folder in target machine
• If you're testing vhci(wdm), copy usbip.exe, usbip_vhci.sys, usbip_vhci.inf, usbip_root.inf, usbip_vhci.cat into a folder in target machine
• You can find all files in output folder after build or on release page.

Install USB/IP VHCI driver

• You can install using usbip.exe or manually
• Using usbip.exe install command
  • Run PowerShell or CMD as an Administrator
  • PS> usbip.exe install
  • Upper command will install a ude driver, a wdm driver or both depending on the available files
• Manual Installation for vhci(ude)
  • Run PowerShell or CMD as an Administrator
  • PS> pnputil /add-driver usbip_vhci_ude.inf
  • Start Device manager
  • Choose "Add Legacy Hardware" from the "Action" menu.
  • Select "Install the hardware that I manually select from the list".
  • Click "Next".
  • Click "Have Disk", click "Browse", choose the copied folder, and click "OK".
  • Click on the "usbip-win VHCI(ude)", and then click "Next".
  • Click Finish at "Completing the Add/Remove Hardware Wizard".
• Manual Installation for vhci(wdm)
  • Run PowerShell or CMD as an Administrator
  • PS> pnputil /add-driver usbip_vhci.inf
  • Start Device manager
  • Choose "Add Legacy Hardware" from the "Action" menu.
  • Select "Install the hardware that I manually select from the list".
  • Click "Next".
  • Click "Have Disk", click "Browse", choose the copied folder, and click "OK".
  • Click on the "USB/IP VHCI Root", and then click "Next".
  • Click Finish at "Completing the Add/Remove Hardware Wizard".

Attach a remote USB device

• PS> usbip.exe attach -r <usbip server ip> -b 2-2

Uninstall driver

• PS> usbip.exe uninstall

Disable test signing

• > bcdedit.exe /set TESTSIGNING OFF
• reboot the system to apply

• usbip-win uses DbgPrintEx API for kernel logging.
• save following as .reg and run or manually insert a registry key
• restart is required

Run a debugging log viewer program before you test

• DebugView is a good tool to view the logs

If your testing machine suffer from BSOD (blue screen on death), you should get it via remote debugging.

• WinDbg on virtual machines would be good to get logs

• DebugView.exe cannot catch a vhci debug message
  • TraceView.exe is a good utility for a new approach, which is included in WDK.

• Choose PDB file radio button in "Provider Control GUID Setup" popup dialog
• Specify usbip_vhci_ude.pdb as a PDB file

• WinDbg on virtual machines would be good to get logs

• forwarder log is the best to look into usbip packet internals.