diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 22 insertions, 6 deletions
@@ -75,7 +75,8 @@ No Open-IOV component depends on a specific wrapper. kernel/ open-iov-vfio.ko host driver (mdev, VFIO, GSP emulation, firmware analyzer, dynamic RPC dispatcher, arch/version layers) userspace/ libiov.so management library, examples, tests -driver/ legacy guest driver (being removed in the host-only refactor) +legacy-driver-guest/ historical guest-side driver, preserved for reference + only - NOT built (see its README) firmware/ GSP analysis: scripts, docs, address maps (blobs NOT in git - fetched by install.sh from linux-firmware.git) patches/nvidia/ patch series applied to NVIDIA open-gpu-kernel-modules @@ -103,15 +104,30 @@ images/ISOs, Ghidra project databases, and any local VM-wrapper stacks. ## Documentation +Start here: **[Developer onboarding](docs/ONBOARDING.md)** — repo tour, +coding standards, first build & test. + - [STATE.md](STATE.md) — current state, limitations, bug tracker -- [Portable architecture](docs/PORTABLE_ARCHITECTURE.md) -- [Host-only GSP emulation design](docs/refactored-architecture.md) +- [GSP emulation engine architecture](docs/GSP_EMULATION_ARCHITECTURE.md) — + how the host-side emulator works (shadow BAR0, doorbell protocol, dispatch, + MSI-X injection) +- [Debugging guide](docs/DEBUGGING.md) — QEMU GDB stub, serial console, + failure taxonomy, bring-up validation checklist +- [Version upgrade guide](docs/VERSION_UPGRADE.md) — supporting a new NVIDIA + driver/GSP version end-to-end (Ghidra workflow) +- [Performance testing](docs/PERFORMANCE.md) — bare-metal A/B methodology +- [Portable architecture](docs/PORTABLE_ARCHITECTURE.md) — multi-version, + multi-hardware design +- [Host-only GSP emulation design](docs/refactored-architecture.md) — + original refactor plan - [Implementation TODO](docs/refactored-implementation-to-do.md) -- [Firmware analysis](wiki/GSP-570.144W-Firmware-Analysis.md) — +- [Development workflow reference](docs/DEVELOPMENT_WORKFLOW.md) — exhaustive + command reference +- Firmware canon: [analysis](wiki/GSP-570.144W-Firmware-Analysis.md) — [RPC format](wiki/RPC-Message-Format.md) — [BAR emulation](wiki/BAR-Emulation-Specification.md) — - [Migration protocol](wiki/Migration-Protocol.md) — - [Address reference](wiki/Address-Reference.md) + [migration protocol](wiki/Migration-Protocol.md) — + [address reference](wiki/Address-Reference.md) ## License |