# 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_common_mod.ko server:# insmod usbip.ko - It was formerly named as stub.ko. server:# usbipd -D - Start usbip daemon. server:# bind_driver --list - List driver assignments for usb devices. server:# bind_driver --usbip 1-2 - Bind usbip.ko to the device of busid 1-2. - A usb device 1-2 is now exportable to other hosts! - Use 'bind_driver --other 1-2' when you want to shutdown exporting and use the device locally. client:# insmod usbip_common_mod.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_common_mod.ko trois:# insmod (somewhere)/usbip.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:# 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:# 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:# 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_common_mod.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.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