summaryrefslogtreecommitdiffstats
path: root/wiki/README.md
diff options
context:
space:
mode:
authorOpen-IOV <dev@open-iov.org>2026-09-23 05:44:08 -0400
committerOpen-IOV <dev@open-iov.org>2026-09-23 05:46:43 -0400
commit68cdd7728a7cc6715bbbff7decfe2b11c3bdf558 (patch)
tree3dc8ce2e6af313a97ec6852f5c663a9a93665d2e /wiki/README.md
downloadopen-iov-68cdd7728a7cc6715bbbff7decfe2b11c3bdf558.tar.gz
open-iov-68cdd7728a7cc6715bbbff7decfe2b11c3bdf558.zip
Open-IOV: initial public release
Open-IOV virtualizes NVIDIA GPUs so that unmodified guest drivers run with real GPU functionality - CUDA first, 3D and video to follow - on unmodified hosts, without a proprietary vGPU license and without patching any driver, firmware or hypervisor. Core principle: emulate the interface, pass through the work. kernel/ open-iov-vfio.ko - host VFIO mdev driver: virtual GPU device (PCI config space, BAR shadows, MSI-X), GSP boot emulation, GSP-RM message-queue/RPC emulation, memory model (GPU-VA to guest-PA discovery) and the semaphore-completion service that advances guest UVM progress. userspace/ libiov.so management API and examples. tools/ guest diagnostics, firmware analysis wrappers, RM probes. scripts/ stack manager, VM harness, build/load/test automation. config/ hardware/version profiles (the portability surface). docs/ documentation tree - start at docs/README.md. wiki/ long-form firmware and protocol deep dives. Status: initialization works end to end for a stock 570.144 Linux guest on Turing (TU104): driver probe, nvidia-smi, the full GSP-RM control battery, object creation and the early CUDA/UVM start-up path. GPU work forwarding - the step that makes CUDA kernels execute on real hardware - is the active work item; see docs/04-implementation/01-known-knowns-and-unknowns.md. License: BSD-3-Clause for the project; GPL-2.0 for kernel modules that link GPL-only kernel interfaces. See LICENSE and docs/09-reference/legal-and-licensing.md.
Diffstat (limited to 'wiki/README.md')
-rw-r--r--wiki/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/wiki/README.md b/wiki/README.md
new file mode 100644
index 0000000..a7fee86
--- /dev/null
+++ b/wiki/README.md
@@ -0,0 +1,21 @@
+# vGPU-IO Wiki
+
+## Documentation Index
+
+### Core Analysis
+- [GSP 570.144W Firmware Analysis](GSP-570.144W-Firmware-Analysis.md) - Complete firmware analysis
+- [RPC Message Format](RPC-Message-Format.md) - Wire protocol specification
+- [BAR Emulation Specification](BAR-Emulation-Specification.md) - BAR1/Bar1Rest/ForceBarAccess
+- [WPR Management](WPR-Management.md) - Write/Read Protect Region handling
+- [Migration Protocol](Migration-Protocol.md) - Live migration RPC 0x0B
+- [GSP RPC Emulation](GSP-RPC-Emulation.md) - Emulation mode for consumer/OpenRM GSP
+
+### Integration Guides
+- [vGPU-IO Integration Guide](vGPU-IO-Integration-Guide.md) - Kernel driver implementation
+- [Kernel RPC Client](Kernel-RPC-Client.md) - Calling convention & message building
+- [Testing & Validation](Testing-and-Validation.md) - Verification procedures
+
+### Reference
+- [Address Reference](Address-Reference.md) - All key addresses in one table
+- [Error Codes](Error-Codes.md) - GSP error code reference
+- [Glossary](Glossary.md) - Terms and abbreviations \ No newline at end of file