USBIP(8)

🎀 USBIP(8) 🎀

Okay bestie, this is the manual for usbipd, which lives in the System Administration Utilities crowd 💅 It's the section 8 page, so you know it's the admin stuff.

---

✨ NAME ✨

okay so usbipd is the USB/IP server daemon 🦋 It's the thing that shares USB devices with other machines over the network.

💻 SYNOPSIS ✨

usbipd [options]

📖 DESCRIPTION ✨

okay so usbipd gives USB/IP clients access to exported USB devices 💖

bestie, you have to explicitly export a device with usbip bind first. Until you do that, usbipd won't make it available to other hosts. No cap, it's a whole permission thing 🙈

The daemon listens for USB/IP clients on TCP port 3240 by default 🌸

🎀 OPTIONS ✨

• -4, --ipv4 — binds to IPv4. The default is both 🦋
• -6, --ipv6 — binds to IPv6. The default is both 🦋
• -e, --device — runs in device mode 🧚. Instead of driving an attached device, it creates a virtual UDC that you can bind gadgets to. Main character energy ✨
• -D, --daemon — runs as a daemon process 👑
• -d, --debug — prints debugging information 🔥
• -PFILE, --pid FILE — writes the process id to FILE 💜. If you don't specify a FILE, it uses /var/run/usbipd.pid 🍓
• -tPORT, --tcp-port PORT — listens on TCP/IP port PORT 🌈
• -h, --help — prints the program help message and exits 💅
• -v, --version — shows the version ⭐

🙈 LIMITATIONS ✨

bestie, be careful!! usbipd has no authentication or authorization for USB/IP. Any USB/IP client can connect and use your exported devices 💀

🧚 EXAMPLES ✨

Here's the basic flow for sharing a device 🫶

server:# modprobe usbip-host
server:# usbipd -D
server:# usbip list --local
server:# usbip bind --busid=1-2

• modprobe usbip-host loads the module 🌸
• usbipd -D starts the usbip daemon 💖
• usbip list --local lists driver assignments for USB devices 🦋
• usbip bind --busid=1-2 binds usbip-host.ko to the device with busid 1-2. Now USB device 1-2 is exportable to other hosts, periodt ✨
• When you want to stop exporting and use the device locally again, run usbip unbind --busid=1-2 🔥

The next example shows device mode 👑

server:# modprobe usbip-vudc
server:# usbipd -e -D
server:# modprobe g_mass_storage file=/tmp/tmp.img
server:# usbip list --device
server:# modprobe -r g_mass_storage

• modprobe usbip-vudc loads the module, and it's accessed through the /sys/class/udc/ interface 💜
• usbip-host is independent of this module, so no mixing them up 🙈
• usbipd -e -D starts the usbip daemon in device mode 🧚
• modprobe g_mass_storage file=/tmp/tmp.img binds a gadget to usbip-vudc. In this example, it's a mass storage gadget 💅
• usbip list --device lists the gadgets exported by the local usbipd server 🌈
• modprobe -r g_mass_storage unbinds the gadget from usbip-vudc. In this example, the previous mass storage gadget gets unbound 😭

🫶 SEE ALSO ✨

usbip(8) is your bestie for the client side 💖

---

okay that's the whole tea 🍓 this page is from usbip, dated February 2009, and it's the USBIP(8) page. Stay iconic, bestie 💜✨