Rust usbip protocol library and tooling

Find a file

Jiajie Chen 6fd28e9076 Bump dependencies		2025-03-24 13:47:39 +08:00
.github/workflows	Use nightly for coveralls	2024-10-26 10:49:05 +08:00
examples	Add unset string fuctions	2024-10-26 09:35:32 +08:00
src	#[cfg] is required	2024-10-26 10:55:41 +08:00
.gitignore	Initial usbip server based on tokio	2020-05-15 21:18:28 +08:00
Cargo.toml	Bump dependencies	2025-03-24 13:47:39 +08:00
LICENSE	Add LICENSE and README	2020-05-16 11:19:04 +08:00
NOTES.md	Add notes	2022-12-05 17:39:37 +08:00
README.md	Add crates.io badge	2020-11-08 11:00:40 +08:00

README.md

usbip

A Rust library to run a USB/IP server to simulate USB devices.

It also enables sharing devices from an OS supporting libusb(libusb claims that it supports Linux, macOS, Windows, OpenBSD/NetBSD, Haiku and Solaris) to another OS supporting USB/IP(Linux, Windows). Sharing an CCID SmartCard from macOS to Linux is tested by running gpg --card-status.

How to use

See examples directory. Three examples are provided:

hid_keyboard: Simulate a hid keyboard that types something every second.
cdc_acm_serial: Simulate a serial that gets a character every second.
host: Act like original usb/ip sharing server, sharing one device from one machine to another. Also supports sharing from macOS to Linux!

To run example, run:

$ env RUST_LOG=info cargo run --example hid_keyboard

Then, in a USB/IP client environment:

$ usbip list -r $remote_ip
$ usbip attach -r $remote_ip -b $bus_id

Then, you can inspect the simulated USB device behavior in both sides.

API

See code comments. Not finalized yet, so get prepared for api breaking changes.