Skip to content

Commit

Permalink
Fix typos, uniformize "USB/IP", clarify some details.
Browse files Browse the repository at this point in the history
Signed-off-by: Alexandre Demers <alexandre.f.demers@gmail.com>
  • Loading branch information
Oxalin committed Mar 24, 2019
1 parent 80733de commit b16d2c8
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# USB/IP for Windows

- This project aims to support both a USBIP server and a client on Windows platform.
- This project aims to support both a USB/IP server and a client on Windows platform.


## Build
Expand All @@ -27,15 +27,15 @@

## Install

### Usbip server
### Windows USB/IP server

- Prepare a linux machine as a USBIP client
- tested on Ubuntu 16.04
- Kernel 4.15.0-29 (usbip kernel module crash was observed on some other version)
- Prepare a linux machine as a USB/IP client
- 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 USBIP test certificate
- Install driver/usbip\_test.pfx(password: usbip)
- Install USB/IP test certificate
- Install driver/usbip\_test.pfx (password: usbip)
- Certificate should be installed into "Trusted Root Certification Authority" and "Trusted Publishers"
on local machine (not current user)
- Enable test signing
Expand All @@ -45,57 +45,59 @@
- You can find usbip.exe, usbipd.exe, usbip\_stub.sys in output folder.
- userspace/usb.ids
- driver/stub/usbip\_stub.inx
- Find usb device id
- Find USB device id
- You can get device id from usbip listing
- &lt;target dir&gt;\usbip.exe list -l
- usbip.exe list -l
- Bus id is always 1. So output from usbip.exe listing is shown as:

<pre><code>
C:\work\usbip.exe list -l
usbip.exe list -l
- busid 1-59 (045e:00cb)
Microsoft Corp. : Basic Optical Mouse v2.0 (045e:00cb)
- busid 1-30 (80ee:0021)
VirtualBox : USB Tablet (80ee:0021)
</code></pre>

- Bind usb device to usbip stub
- Bind USB device to usbip stub
- This command replaces an existing function driver with usbip stub driver
- Should be executed with an administrator privilege
- usbip bind -b 1-59
- usbip\_stub.inx, usbip\_stub.sys files should be exist in the same folder with usbip.exe
- 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
- Run usbipd.exe
- usbipd.exe -d -4
- TCP port 3240 should be allowed by firewall
- TCP port 3240 should be allowed by firewall

- Attach usbip device on linux machine
- Attach USB/IP device on linux machine
- \# usbip attach -r &lt;usbip server ip&gt; -p 1-59

### USBIP client
### Windows USB/IP client

- Prepare a linux machine as a usbip server
- Prepare a linux machine as a USB/IP server
- tested on Ubuntu 16.04(Kernerl 4.15.0-29)
- \# modprobe usbip-host

- Run usbipd on a usbip server(Linux)
- Run usbipd on a USB/IP server(Linux)
- \# usbipd -4 -d

- Install USBIP test certificate
- Install USB/IP test certificate
- Install driver/usbip\_test.pfx(password: usbip)
- Certificate should be installed into "Trusted Root Certification Authority" on local machine(not current user)
- Enable test signing
- bcdedit.exe /set TESTSIGNING ON
- reboot the system to apply
- Copy usbip.exe, usbip\_vhci.sys, usbip\_vhci.inf, usbip\_vhci.cer, usbip\_vhci.cat into a folder in target machine
- You can find usbip.exe, usbip\_vhci.sys, usbip\_vhci.cer, usbip\_vhci.inf in output folder.
- usbip\_vhci.cat can be found from usbip\_vhci subfolder of output folder
- Install USBIP vhci driver
- Start a device manager
- Install USB/IP vhci driver
- Start Device manager

This comment has been minimized.

Copy link
@cezuni

cezuni Mar 24, 2019

Is "a" front of device manager awkward? And does capital "D" in device have a special meaning ?

This comment has been minimized.

Copy link
@Oxalin

Oxalin Mar 25, 2019

Author

Using the formulation "a device manager" is not wrong. However, in Windows context, we are talking about a specific tool called "Device manager". To be completely right, this should be written "Device Manager" now that I look at it closely. So "Start Device Manager" has the same syntax as "Launch Microsoft Word" for instance, there is no need for "a" or "the".

- 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, and then click Next.
- Click Finish at 'Completing the Add/Remove Hardware Wizard.'
- Attach a remote USB device
- C:\usbip.exe attach -r &lt;usbip server ip&gt; -b 2-2
- usbip.exe attach -r &lt;usbip server ip&gt; -b 2-2

<hr>
<sub>This project was supported by Basic Science Research Program through the National Research Foundation of Korea(NRF) funded by the Ministry of Education(2016R1A6A3A11930295).</sub>

0 comments on commit b16d2c8

Please sign in to comment.