This is a fork of cyberus-technology/usbvfiod, not affiliated with or supported by Cyberus Technology. It adds virtual USB 2.0 hubs with devices at port paths (Hubs and Port Paths), devices that another process serves (External Devices), QEMU's
vfio-user-pciclient (Using usbvfiod with QEMU) and what Windows 11 guests need (Windows Guests). A release holds static x86_64 Linux binaries ofusbvfiodandremote:gh release download -R infinitygp/usbvfiod -p 'usbvfiod-*.tar.gz', unpack it and run./install.sh, which puts them into~/.local/bin. To build it from source, runcargo install --locked --git https://github.com/infinitygp/usbvfiod usbvfiod. The changes of the fork are licensed like upstream, under MIT or Apache-2.0. The rest of this README is upstream's.
usbvfiod is a Rust-based tool designed to enable USB device passthrough to Cloud Hypervisor virtual machines using the vfio-user protocol. Other VMMs might also work, but are currently not the main target.
This project is under active development. We are planning to work on this project in the following order:
- Validating our Assumptions (Done)
- We are looking for suitable libraries to use and finalize our design.
- Towards USB Storage Passthrough (Done)
- We build up a virtual XHCI controller and the necessary plumbing to pass-through USB devices from the host.
- Our initial test target will be USB storage devices.
- Broaden Device Support (Done)
- We broaden the set of USB devices we support and actively test.
- Our current focus is enabling USB-2 devices and devices with interrupt endpoints.
- Hotplug Devices (Done)
- We enable attach and detach of exposed devices during runtime.
- Stability & Error Recovery (Done)
- We seek out points where we currently panic but should not have to panic.
- Windows Guest Support (🚧 Ongoing 🚧)
- Enable all features required for the Windows xHCI driver to interact with devices through the controller.
- Everything Beyond
- Many topics remain open. We stay flexible regarding upcoming features.
- Missing features include isochronous endpoint support, non-Linux Host support, and support for other VMMs than Cloud Hypervisor.
If you want to use this code in production and need professional support, please get in touch.
Find the overview of documentation here.
This open-source project was developed within the Edge Gateway Platform project and is sponsored by secunet Security Networks AG. This project has received public funding from the European Union NextGenerationEU within the Important Project of Common European Interest – Cloud Infrastructures and Services (IPCEI-CIS) under grant agreement 13IPC022.
