[1b3c74]: trunk / userspace / README  Maximize  Restore  History

Download this file

216 lines (160 with data), 7.9 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# vim:tw=78:ts=4:expandtab:ai:sw=4
#
# README for usbip-utils
#
# Copyright (C) 2005-2008 Takahiro Hirofuchi


[Requirements]
    - USB/IP device drivers
        Its source code is included under $(top)/drivers/.

    - sysfsutils >= 2.0.0
        sysfsutils library

    - libwrap0-dev
        tcp wrapper library

    - gcc >= 4.0

    - libglib2.0-dev >= 2.6.0

    - libtool, automake >= 1.9, autoconf >= 2.5.0, pkg-config

[Install]
    0. Skip here if you see a configure script.
        $ ./autogen.sh

    1. Compile & install.
        $ ./configure
        $ make install

    2. Compile & install USB/IP drivers if not yet.

[Usage]
    server:# (Attach your USB device physically.)

    server:# insmod usbip-core.ko
    server:# insmod usbip-host.ko
        - It was formerly named as stub.ko.

    server:# usbipd -D
        - Start usbip daemon.

    server:# usbip_bind_driver --list
        - List driver assignments for usb devices.

    server:# usbip_bind_driver --usbip 1-2
        - Bind usbip-host.ko to the device of busid 1-2.
        - A usb device 1-2 is now exportable to other hosts!
        - Use 'usbip_bind_driver --other 1-2' when you want to shutdown exporting
          and use the device locally.


    client:# insmod usbip-core.ko
    client:# insmod vhci-hcd.ko
        - It was formerly named as vhci.ko.

    client:# usbip --list server
        - List exportable usb devices on the server.

    client:# usbip --attach server 1-2
        - Connect the remote USB device.

    client:# usbip --port
        - Show virtual port status.

    client:# usbip --detach 0
        - Detach the usb device.


[Output Example]
--------------------------------------------------------------------------------------------------------
- SERVER SIDE (physically attach your USB devices to this host) ----------------------------------------
--------------------------------------------------------------------------------------------------------
trois:# insmod (somewhere)/usbip-core.ko
trois:# insmod (somewhere)/usbip-host.ko
trois:# usbipd -D

--------------------------------------------------------------------------------------------------------
In another terminal, let's look up what usb devices are physically attached to
this host.  We can see a usb storage device of busid 3-3.2 is now bound to
usb-storage driver. To export this device, we first mark the device as
"exportable"; the device is bound to usbip driver. Please remember you can not
export a usb hub.

   trois:# usbip_bind_driver --list
   List USB devices
   - busid 3-3.2 (04bb:0206)
       3-3.2:1.0 -> usb-storage

   - busid 3-3.1 (08bb:2702)
       3-3.1:1.0 -> snd-usb-audio
       3-3.1:1.1 -> snd-usb-audio

   - busid 3-3 (0409:0058)
       3-3:1.0 -> hub

   - busid 3-2 (0711:0902)
       3-2:1.0 -> none

   - busid 1-1 (05a9:a511)
       1-1:1.0 -> ov511

   - busid 4-1 (046d:08b2)
       4-1:1.0 -> none
       4-1:1.1 -> none
       4-1:1.2 -> none

   - busid 5-2 (058f:9254)
       5-2:1.0 -> hub

--------------------------------------------------------------------------------------------------------
Mark the device of busid 3-3.2 as exportable.

   trois:# usbip_bind_driver --usbip 3-3.2
   ** (process:24621): DEBUG:  3-3.2:1.0   -> none
   ** (process:24621): DEBUG: write "add 3-3.2" to /sys/bus/usb/drivers/usbip/match_busid
   ** Message: bind 3-3.2 to usbip, complete!

   trois:# usbip_bind_driver --list
   List USB devices
   - busid 3-3.2 (04bb:0206)
           3-3.2:1.0 -> usbip
   (snip)

Iterate the above operation for other devices if you like.


--------------------------------------------------------------------------------------------------------
- CLIENT SIDE ------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------
First, let's list available remote devices which are marked as exportable in
the server host.

   deux:# insmod (somewhere)/usbip-core.ko
   deux:# insmod (somewhere)/vhci_hcd.ko

   deux:# usbip --list 10.0.0.3
   - 10.0.0.3
          1-1: Prolific Technology, Inc. : unknown product (067b:3507)
             : /sys/devices/pci0000:00/0000:00:1f.2/usb1/1-1
             : (Defined at Interface level) / unknown subclass / unknown protocol (00/00/00)
             :  0 - Mass Storage / SCSI / Bulk (Zip) (08/06/50)

      1-2.2.1: Apple Computer, Inc. : unknown product (05ac:0203)
             : /sys/devices/pci0000:00/0000:00:1f.2/usb1/1-2/1-2.2/1-2.2.1
             : (Defined at Interface level) / unknown subclass / unknown protocol (00/00/00)
             :  0 - Human Interface Devices / Boot Interface Subclass / Keyboard (03/01/01)

      1-2.2.3: OmniVision Technologies, Inc. : OV511+ WebCam (05a9:a511)
             : /sys/devices/pci0000:00/0000:00:1f.2/usb1/1-2/1-2.2/1-2.2.3
             : (Defined at Interface level) / unknown subclass / unknown protocol (00/00/00)
             :  0 - Vendor Specific Class / unknown subclass / unknown protocol (ff/00/00)

          3-1: Logitech, Inc. : QuickCam Pro 4000 (046d:08b2)
             : /sys/devices/pci0000:00/0000:00:1e.0/0000:02:0a.0/usb3/3-1
             : (Defined at Interface level) / unknown subclass / unknown protocol (00/00/00)
             :  0 - Data / unknown subclass / unknown protocol (0a/ff/00)
             :  1 - Audio / Control Device / unknown protocol (01/01/00)
             :  2 - Audio / Streaming / unknown protocol (01/02/00)

          4-1: Logitech, Inc. : QuickCam Express (046d:0870)
             : /sys/devices/pci0000:00/0000:00:1e.0/0000:02:0a.1/usb4/4-1
             : Vendor Specific Class / Vendor Specific Subclass / Vendor Specific Protocol (ff/ff/ff)
             :  0 - Vendor Specific Class / Vendor Specific Subclass / Vendor Specific Protocol (ff/ff/ff)

          4-2: Texas Instruments Japan : unknown product (08bb:2702)
             : /sys/devices/pci0000:00/0000:00:1e.0/0000:02:0a.1/usb4/4-2
             : (Defined at Interface level) / unknown subclass / unknown protocol (00/00/00)
             :  0 - Audio / Control Device / unknown protocol (01/01/00)
             :  1 - Audio / Streaming / unknown protocol (01/02/00)

--------------------------------------------------------------------------------------------------------
Attach a remote usb device!

   deux:# usbip --attach 10.0.0.3 1-1
   port 0 attached

--------------------------------------------------------------------------------------------------------
Show what devices are attached to this client.

   deux:# usbip --port
   Port 00: <Port in Use> at Full Speed(12Mbps)
          Prolific Technology, Inc. : unknown product (067b:3507)
          6-1 -> usbip://10.0.0.3:3240/1-1  (remote bus/dev 001/004)
          6-1:1.0 used by usb-storage
                         /sys/class/scsi_device/0:0:0:0/device
                         /sys/class/scsi_host/host0/device
                         /sys/block/sda/device

--------------------------------------------------------------------------------------------------------
Detach the imported device.

   deux:# usbip --detach 0
   port 0 detached

--------------------------------------------------------------------------------------------------------


[Check List]
    - See Debug Tips in the project wiki.
        - http://usbip.wiki.sourceforge.net/how-to-debug-usbip
    - usbip-host.ko must be bound to the target device.
        - See /proc/bus/usb/devices and find "Driver=..." lines of the device.
    - Shutdown firewall.
        - usbip now uses TCP port 3240.
    - Disable SELinux.
    - If possible, compile your kernel with CONFIG_USB_DEBUG flag and try
      again.
    - Check your kernel and daemon messages.
        ex. /var/log/{messages, kern.log, daemon.log, syslog}


[Contact]
    Mailing List: usbip-devel _at_ lists.sourceforge.net

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks